babylon.module.d.ts 6.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944155945155946155947155948155949155950155951155952155953155954155955155956155957155958155959155960155961155962155963155964155965155966155967155968155969155970155971155972155973155974155975155976155977155978155979155980155981155982155983155984155985155986155987155988155989155990155991155992155993155994155995155996155997155998155999156000156001156002156003156004156005156006156007156008156009156010156011156012156013156014156015156016156017156018156019156020156021156022156023156024156025156026156027156028156029156030156031156032156033156034156035156036156037156038156039156040156041156042156043156044156045156046156047156048156049156050156051156052156053156054156055156056156057156058156059156060156061156062156063156064156065156066156067156068156069156070156071156072156073156074156075156076156077156078156079156080156081156082156083156084156085156086156087156088156089156090156091156092156093156094156095156096156097156098156099156100156101156102156103156104156105156106156107156108156109156110156111156112156113156114156115156116156117156118156119156120156121156122156123156124156125156126156127156128156129156130156131156132156133156134156135156136156137156138156139156140156141156142156143156144156145156146156147156148156149156150156151156152156153156154156155156156156157156158156159156160156161156162156163156164156165156166156167156168156169156170156171156172156173156174156175156176156177156178156179156180156181156182156183156184156185156186156187156188156189156190156191156192156193156194156195156196156197156198156199156200156201156202156203156204156205156206156207156208156209156210156211156212156213156214156215156216156217156218156219156220156221156222156223156224156225156226156227156228156229156230156231156232156233156234156235156236156237156238156239156240156241156242156243156244156245156246156247156248156249156250156251156252156253156254156255156256156257156258156259156260156261156262156263156264156265156266156267156268156269156270156271156272156273156274156275156276156277156278156279156280156281156282156283156284156285156286156287156288156289156290156291156292156293156294156295156296156297156298156299156300156301156302156303156304156305156306156307156308156309156310156311156312156313156314156315156316156317156318156319156320156321156322156323156324156325156326156327156328156329156330156331156332156333156334156335156336156337156338156339156340156341156342156343156344156345156346156347156348156349156350156351156352156353156354156355156356156357156358156359156360156361156362156363156364156365156366156367156368156369156370156371156372156373156374156375156376156377156378156379156380156381156382156383156384156385156386156387156388156389156390156391156392156393156394156395156396156397156398156399156400156401156402156403156404156405156406156407156408156409156410156411156412156413156414156415156416156417156418156419156420156421156422156423156424156425156426156427156428156429156430156431156432156433156434156435156436156437156438156439156440156441156442156443156444156445156446156447156448156449156450156451156452156453156454156455156456156457156458156459156460156461156462156463156464156465156466156467156468156469156470156471156472156473156474156475156476156477156478156479156480156481156482156483156484156485156486156487156488156489156490156491156492156493156494156495156496156497156498156499156500156501156502156503156504156505156506156507156508156509156510156511156512156513156514156515156516156517156518156519156520156521156522156523156524156525156526156527156528156529156530156531156532156533156534156535156536156537156538156539156540156541156542156543156544156545156546156547156548156549156550156551156552156553156554156555156556156557156558156559156560156561156562156563156564156565156566156567156568156569156570156571156572156573156574156575156576156577156578156579156580156581156582156583156584156585156586156587156588156589156590156591156592156593156594156595156596156597156598156599156600156601156602156603156604156605156606156607156608156609156610156611156612156613156614156615156616156617156618156619156620156621156622156623156624156625156626156627156628156629156630156631156632156633156634156635156636156637156638156639156640156641156642156643156644156645156646156647156648156649156650156651156652156653156654156655156656156657156658156659156660156661156662156663156664156665156666156667156668156669156670156671156672156673156674156675156676156677156678156679156680156681156682156683156684156685156686156687156688156689156690156691156692156693156694156695156696156697156698156699156700156701156702156703156704156705156706156707156708156709156710156711156712156713156714156715156716156717156718156719156720156721156722156723156724156725156726156727156728156729156730156731156732156733156734156735156736156737156738156739156740156741156742156743156744156745156746156747156748156749156750156751156752156753156754156755156756156757156758156759156760156761156762156763156764156765156766156767156768156769156770156771156772156773156774156775156776156777156778156779156780156781156782156783156784156785156786156787156788156789156790156791156792156793156794156795156796156797156798156799156800156801156802156803156804156805156806156807156808156809156810156811156812156813156814156815156816156817156818156819156820156821156822156823156824156825156826156827156828156829156830156831156832156833156834156835156836156837156838156839156840156841156842156843156844156845156846156847156848156849156850156851156852156853156854156855156856156857156858156859156860156861156862156863156864156865156866156867156868156869156870156871156872156873156874156875156876156877156878156879156880156881156882156883156884156885156886156887156888156889156890156891156892156893156894156895156896156897156898156899156900156901156902156903156904156905156906156907156908156909156910156911156912156913156914156915156916156917156918156919156920156921156922156923156924156925156926156927156928156929156930156931156932156933156934156935156936156937156938156939156940156941156942156943156944156945156946156947156948156949156950156951156952156953156954156955156956156957156958156959156960156961156962156963156964156965156966156967156968156969156970156971156972156973156974156975156976156977156978156979156980156981
  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. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  1058. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  1059. */
  1060. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  1061. /**
  1062. * Constant used to retrieve the position texture index in the textures array in the prepass
  1063. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  1064. */
  1065. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  1066. /**
  1067. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  1068. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  1069. */
  1070. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  1071. /**
  1072. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  1073. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  1074. */
  1075. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  1076. /**
  1077. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  1078. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  1079. */
  1080. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  1081. /**
  1082. * Constant used to retrieve depth + normal index in the textures array in the prepass
  1083. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  1084. */
  1085. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  1086. /**
  1087. * Constant used to retrieve albedo index in the textures array in the prepass
  1088. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  1089. */
  1090. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  1091. }
  1092. }
  1093. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1094. import { Nullable } from "babylonjs/types";
  1095. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1096. /**
  1097. * This represents the required contract to create a new type of texture loader.
  1098. */
  1099. export interface IInternalTextureLoader {
  1100. /**
  1101. * Defines wether the loader supports cascade loading the different faces.
  1102. */
  1103. supportCascades: boolean;
  1104. /**
  1105. * This returns if the loader support the current file information.
  1106. * @param extension defines the file extension of the file being loaded
  1107. * @param mimeType defines the optional mime type of the file being loaded
  1108. * @returns true if the loader can load the specified file
  1109. */
  1110. canLoad(extension: string, mimeType?: string): boolean;
  1111. /**
  1112. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1113. * @param data contains the texture data
  1114. * @param texture defines the BabylonJS internal texture
  1115. * @param createPolynomials will be true if polynomials have been requested
  1116. * @param onLoad defines the callback to trigger once the texture is ready
  1117. * @param onError defines the callback to trigger in case of error
  1118. */
  1119. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1120. /**
  1121. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1122. * @param data contains the texture data
  1123. * @param texture defines the BabylonJS internal texture
  1124. * @param callback defines the method to call once ready to upload
  1125. */
  1126. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1127. }
  1128. }
  1129. declare module "babylonjs/Engines/IPipelineContext" {
  1130. /**
  1131. * Class used to store and describe the pipeline context associated with an effect
  1132. */
  1133. export interface IPipelineContext {
  1134. /**
  1135. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1136. */
  1137. isAsync: boolean;
  1138. /**
  1139. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1140. */
  1141. isReady: boolean;
  1142. /** @hidden */
  1143. _getVertexShaderCode(): string | null;
  1144. /** @hidden */
  1145. _getFragmentShaderCode(): string | null;
  1146. /** @hidden */
  1147. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1148. }
  1149. }
  1150. declare module "babylonjs/Meshes/dataBuffer" {
  1151. /**
  1152. * Class used to store gfx data (like WebGLBuffer)
  1153. */
  1154. export class DataBuffer {
  1155. /**
  1156. * Gets or sets the number of objects referencing this buffer
  1157. */
  1158. references: number;
  1159. /** Gets or sets the size of the underlying buffer */
  1160. capacity: number;
  1161. /**
  1162. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1163. */
  1164. is32Bits: boolean;
  1165. /**
  1166. * Gets the underlying buffer
  1167. */
  1168. get underlyingResource(): any;
  1169. }
  1170. }
  1171. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1172. /** @hidden */
  1173. export interface IShaderProcessor {
  1174. attributeProcessor?: (attribute: string) => string;
  1175. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1176. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1177. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1178. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1179. lineProcessor?: (line: string, isFragment: boolean) => string;
  1180. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1181. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1185. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1186. /** @hidden */
  1187. export interface ProcessingOptions {
  1188. defines: string[];
  1189. indexParameters: any;
  1190. isFragment: boolean;
  1191. shouldUseHighPrecisionShader: boolean;
  1192. supportsUniformBuffers: boolean;
  1193. shadersRepository: string;
  1194. includesShadersStore: {
  1195. [key: string]: string;
  1196. };
  1197. processor?: IShaderProcessor;
  1198. version: string;
  1199. platformName: string;
  1200. lookForClosingBracketForUniformBuffer?: boolean;
  1201. }
  1202. }
  1203. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1204. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1205. /** @hidden */
  1206. export class ShaderCodeNode {
  1207. line: string;
  1208. children: ShaderCodeNode[];
  1209. additionalDefineKey?: string;
  1210. additionalDefineValue?: string;
  1211. isValid(preprocessors: {
  1212. [key: string]: string;
  1213. }): boolean;
  1214. process(preprocessors: {
  1215. [key: string]: string;
  1216. }, options: ProcessingOptions): string;
  1217. }
  1218. }
  1219. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1220. /** @hidden */
  1221. export class ShaderCodeCursor {
  1222. private _lines;
  1223. lineIndex: number;
  1224. get currentLine(): string;
  1225. get canRead(): boolean;
  1226. set lines(value: string[]);
  1227. }
  1228. }
  1229. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1230. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1231. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1232. /** @hidden */
  1233. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1234. process(preprocessors: {
  1235. [key: string]: string;
  1236. }, options: ProcessingOptions): string;
  1237. }
  1238. }
  1239. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1240. /** @hidden */
  1241. export class ShaderDefineExpression {
  1242. isTrue(preprocessors: {
  1243. [key: string]: string;
  1244. }): boolean;
  1245. private static _OperatorPriority;
  1246. private static _Stack;
  1247. static postfixToInfix(postfix: string[]): string;
  1248. static infixToPostfix(infix: string): string[];
  1249. }
  1250. }
  1251. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1252. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1253. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1254. /** @hidden */
  1255. export class ShaderCodeTestNode extends ShaderCodeNode {
  1256. testExpression: ShaderDefineExpression;
  1257. isValid(preprocessors: {
  1258. [key: string]: string;
  1259. }): boolean;
  1260. }
  1261. }
  1262. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1263. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1264. /** @hidden */
  1265. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1266. define: string;
  1267. not: boolean;
  1268. constructor(define: string, not?: boolean);
  1269. isTrue(preprocessors: {
  1270. [key: string]: string;
  1271. }): boolean;
  1272. }
  1273. }
  1274. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1275. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1276. /** @hidden */
  1277. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1278. leftOperand: ShaderDefineExpression;
  1279. rightOperand: ShaderDefineExpression;
  1280. isTrue(preprocessors: {
  1281. [key: string]: string;
  1282. }): boolean;
  1283. }
  1284. }
  1285. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1286. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1287. /** @hidden */
  1288. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1289. leftOperand: ShaderDefineExpression;
  1290. rightOperand: ShaderDefineExpression;
  1291. isTrue(preprocessors: {
  1292. [key: string]: string;
  1293. }): boolean;
  1294. }
  1295. }
  1296. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1297. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1298. /** @hidden */
  1299. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1300. define: string;
  1301. operand: string;
  1302. testValue: string;
  1303. constructor(define: string, operand: string, testValue: string);
  1304. isTrue(preprocessors: {
  1305. [key: string]: string;
  1306. }): boolean;
  1307. }
  1308. }
  1309. declare module "babylonjs/Offline/IOfflineProvider" {
  1310. /**
  1311. * Class used to enable access to offline support
  1312. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1313. */
  1314. export interface IOfflineProvider {
  1315. /**
  1316. * Gets a boolean indicating if scene must be saved in the database
  1317. */
  1318. enableSceneOffline: boolean;
  1319. /**
  1320. * Gets a boolean indicating if textures must be saved in the database
  1321. */
  1322. enableTexturesOffline: boolean;
  1323. /**
  1324. * Open the offline support and make it available
  1325. * @param successCallback defines the callback to call on success
  1326. * @param errorCallback defines the callback to call on error
  1327. */
  1328. open(successCallback: () => void, errorCallback: () => void): void;
  1329. /**
  1330. * Loads an image from the offline support
  1331. * @param url defines the url to load from
  1332. * @param image defines the target DOM image
  1333. */
  1334. loadImage(url: string, image: HTMLImageElement): void;
  1335. /**
  1336. * Loads a file from offline support
  1337. * @param url defines the URL to load from
  1338. * @param sceneLoaded defines a callback to call on success
  1339. * @param progressCallBack defines a callback to call when progress changed
  1340. * @param errorCallback defines a callback to call on error
  1341. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1342. */
  1343. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1344. }
  1345. }
  1346. declare module "babylonjs/Misc/filesInputStore" {
  1347. /**
  1348. * Class used to help managing file picking and drag'n'drop
  1349. * File Storage
  1350. */
  1351. export class FilesInputStore {
  1352. /**
  1353. * List of files ready to be loaded
  1354. */
  1355. static FilesToLoad: {
  1356. [key: string]: File;
  1357. };
  1358. }
  1359. }
  1360. declare module "babylonjs/Misc/retryStrategy" {
  1361. import { WebRequest } from "babylonjs/Misc/webRequest";
  1362. /**
  1363. * Class used to define a retry strategy when error happens while loading assets
  1364. */
  1365. export class RetryStrategy {
  1366. /**
  1367. * Function used to defines an exponential back off strategy
  1368. * @param maxRetries defines the maximum number of retries (3 by default)
  1369. * @param baseInterval defines the interval between retries
  1370. * @returns the strategy function to use
  1371. */
  1372. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1373. }
  1374. }
  1375. declare module "babylonjs/Misc/baseError" {
  1376. /**
  1377. * @ignore
  1378. * Application error to support additional information when loading a file
  1379. */
  1380. export abstract class BaseError extends Error {
  1381. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1382. }
  1383. }
  1384. declare module "babylonjs/Misc/fileTools" {
  1385. import { WebRequest } from "babylonjs/Misc/webRequest";
  1386. import { Nullable } from "babylonjs/types";
  1387. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1388. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1389. import { BaseError } from "babylonjs/Misc/baseError";
  1390. /** @ignore */
  1391. export class LoadFileError extends BaseError {
  1392. request?: WebRequest;
  1393. file?: File;
  1394. /**
  1395. * Creates a new LoadFileError
  1396. * @param message defines the message of the error
  1397. * @param request defines the optional web request
  1398. * @param file defines the optional file
  1399. */
  1400. constructor(message: string, object?: WebRequest | File);
  1401. }
  1402. /** @ignore */
  1403. export class RequestFileError extends BaseError {
  1404. request: WebRequest;
  1405. /**
  1406. * Creates a new LoadFileError
  1407. * @param message defines the message of the error
  1408. * @param request defines the optional web request
  1409. */
  1410. constructor(message: string, request: WebRequest);
  1411. }
  1412. /** @ignore */
  1413. export class ReadFileError extends BaseError {
  1414. file: File;
  1415. /**
  1416. * Creates a new ReadFileError
  1417. * @param message defines the message of the error
  1418. * @param file defines the optional file
  1419. */
  1420. constructor(message: string, file: File);
  1421. }
  1422. /**
  1423. * @hidden
  1424. */
  1425. export class FileTools {
  1426. /**
  1427. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1428. */
  1429. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1430. /**
  1431. * Gets or sets the base URL to use to load assets
  1432. */
  1433. static BaseUrl: string;
  1434. /**
  1435. * Default behaviour for cors in the application.
  1436. * It can be a string if the expected behavior is identical in the entire app.
  1437. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1438. */
  1439. static CorsBehavior: string | ((url: string | string[]) => string);
  1440. /**
  1441. * Gets or sets a function used to pre-process url before using them to load assets
  1442. */
  1443. static PreprocessUrl: (url: string) => string;
  1444. /**
  1445. * Removes unwanted characters from an url
  1446. * @param url defines the url to clean
  1447. * @returns the cleaned url
  1448. */
  1449. private static _CleanUrl;
  1450. /**
  1451. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1452. * @param url define the url we are trying
  1453. * @param element define the dom element where to configure the cors policy
  1454. */
  1455. static SetCorsBehavior(url: string | string[], element: {
  1456. crossOrigin: string | null;
  1457. }): void;
  1458. /**
  1459. * Loads an image as an HTMLImageElement.
  1460. * @param input url string, ArrayBuffer, or Blob to load
  1461. * @param onLoad callback called when the image successfully loads
  1462. * @param onError callback called when the image fails to load
  1463. * @param offlineProvider offline provider for caching
  1464. * @param mimeType optional mime type
  1465. * @returns the HTMLImageElement of the loaded image
  1466. */
  1467. 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>;
  1468. /**
  1469. * Reads a file from a File object
  1470. * @param file defines the file to load
  1471. * @param onSuccess defines the callback to call when data is loaded
  1472. * @param onProgress defines the callback to call during loading process
  1473. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1474. * @param onError defines the callback to call when an error occurs
  1475. * @returns a file request object
  1476. */
  1477. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1478. /**
  1479. * Loads a file from a url
  1480. * @param url url to load
  1481. * @param onSuccess callback called when the file successfully loads
  1482. * @param onProgress callback called while file is loading (if the server supports this mode)
  1483. * @param offlineProvider defines the offline provider for caching
  1484. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1485. * @param onError callback called when the file fails to load
  1486. * @returns a file request object
  1487. */
  1488. 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;
  1489. /**
  1490. * Loads a file
  1491. * @param url url to load
  1492. * @param onSuccess callback called when the file successfully loads
  1493. * @param onProgress callback called while file is loading (if the server supports this mode)
  1494. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1495. * @param onError callback called when the file fails to load
  1496. * @param onOpened callback called when the web request is opened
  1497. * @returns a file request object
  1498. */
  1499. 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;
  1500. /**
  1501. * Checks if the loaded document was accessed via `file:`-Protocol.
  1502. * @returns boolean
  1503. */
  1504. static IsFileURL(): boolean;
  1505. }
  1506. }
  1507. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1508. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1509. import { WebRequest } from "babylonjs/Misc/webRequest";
  1510. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1511. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1512. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1513. /** @hidden */
  1514. export class ShaderProcessor {
  1515. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1516. private static _ProcessPrecision;
  1517. private static _ExtractOperation;
  1518. private static _BuildSubExpression;
  1519. private static _BuildExpression;
  1520. private static _MoveCursorWithinIf;
  1521. private static _MoveCursor;
  1522. private static _EvaluatePreProcessors;
  1523. private static _PreparePreProcessors;
  1524. private static _ProcessShaderConversion;
  1525. private static _ProcessIncludes;
  1526. /**
  1527. * Loads a file from a url
  1528. * @param url url to load
  1529. * @param onSuccess callback called when the file successfully loads
  1530. * @param onProgress callback called while file is loading (if the server supports this mode)
  1531. * @param offlineProvider defines the offline provider for caching
  1532. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1533. * @param onError callback called when the file fails to load
  1534. * @returns a file request object
  1535. * @hidden
  1536. */
  1537. 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;
  1538. }
  1539. }
  1540. declare module "babylonjs/Maths/math.like" {
  1541. import { float, int, DeepImmutable } from "babylonjs/types";
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IColor4Like {
  1546. r: float;
  1547. g: float;
  1548. b: float;
  1549. a: float;
  1550. }
  1551. /**
  1552. * @hidden
  1553. */
  1554. export interface IColor3Like {
  1555. r: float;
  1556. g: float;
  1557. b: float;
  1558. }
  1559. /**
  1560. * @hidden
  1561. */
  1562. export interface IVector4Like {
  1563. x: float;
  1564. y: float;
  1565. z: float;
  1566. w: float;
  1567. }
  1568. /**
  1569. * @hidden
  1570. */
  1571. export interface IVector3Like {
  1572. x: float;
  1573. y: float;
  1574. z: float;
  1575. }
  1576. /**
  1577. * @hidden
  1578. */
  1579. export interface IVector2Like {
  1580. x: float;
  1581. y: float;
  1582. }
  1583. /**
  1584. * @hidden
  1585. */
  1586. export interface IMatrixLike {
  1587. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1588. updateFlag: int;
  1589. }
  1590. /**
  1591. * @hidden
  1592. */
  1593. export interface IViewportLike {
  1594. x: float;
  1595. y: float;
  1596. width: float;
  1597. height: float;
  1598. }
  1599. /**
  1600. * @hidden
  1601. */
  1602. export interface IPlaneLike {
  1603. normal: IVector3Like;
  1604. d: float;
  1605. normalize(): void;
  1606. }
  1607. }
  1608. declare module "babylonjs/Materials/iEffectFallbacks" {
  1609. import { Effect } from "babylonjs/Materials/effect";
  1610. /**
  1611. * Interface used to define common properties for effect fallbacks
  1612. */
  1613. export interface IEffectFallbacks {
  1614. /**
  1615. * Removes the defines that should be removed when falling back.
  1616. * @param currentDefines defines the current define statements for the shader.
  1617. * @param effect defines the current effect we try to compile
  1618. * @returns The resulting defines with defines of the current rank removed.
  1619. */
  1620. reduce(currentDefines: string, effect: Effect): string;
  1621. /**
  1622. * Removes the fallback from the bound mesh.
  1623. */
  1624. unBindMesh(): void;
  1625. /**
  1626. * Checks to see if more fallbacks are still availible.
  1627. */
  1628. hasMoreFallbacks: boolean;
  1629. }
  1630. }
  1631. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1632. /**
  1633. * Class used to evalaute queries containing `and` and `or` operators
  1634. */
  1635. export class AndOrNotEvaluator {
  1636. /**
  1637. * Evaluate a query
  1638. * @param query defines the query to evaluate
  1639. * @param evaluateCallback defines the callback used to filter result
  1640. * @returns true if the query matches
  1641. */
  1642. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1643. private static _HandleParenthesisContent;
  1644. private static _SimplifyNegation;
  1645. }
  1646. }
  1647. declare module "babylonjs/Misc/tags" {
  1648. /**
  1649. * Class used to store custom tags
  1650. */
  1651. export class Tags {
  1652. /**
  1653. * Adds support for tags on the given object
  1654. * @param obj defines the object to use
  1655. */
  1656. static EnableFor(obj: any): void;
  1657. /**
  1658. * Removes tags support
  1659. * @param obj defines the object to use
  1660. */
  1661. static DisableFor(obj: any): void;
  1662. /**
  1663. * Gets a boolean indicating if the given object has tags
  1664. * @param obj defines the object to use
  1665. * @returns a boolean
  1666. */
  1667. static HasTags(obj: any): boolean;
  1668. /**
  1669. * Gets the tags available on a given object
  1670. * @param obj defines the object to use
  1671. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1672. * @returns the tags
  1673. */
  1674. static GetTags(obj: any, asString?: boolean): any;
  1675. /**
  1676. * Adds tags to an object
  1677. * @param obj defines the object to use
  1678. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1679. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1680. */
  1681. static AddTagsTo(obj: any, tagsString: string): void;
  1682. /**
  1683. * @hidden
  1684. */
  1685. static _AddTagTo(obj: any, tag: string): void;
  1686. /**
  1687. * Removes specific tags from a specific object
  1688. * @param obj defines the object to use
  1689. * @param tagsString defines the tags to remove
  1690. */
  1691. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1692. /**
  1693. * @hidden
  1694. */
  1695. static _RemoveTagFrom(obj: any, tag: string): void;
  1696. /**
  1697. * Defines if tags hosted on an object match a given query
  1698. * @param obj defines the object to use
  1699. * @param tagsQuery defines the tag query
  1700. * @returns a boolean
  1701. */
  1702. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1703. }
  1704. }
  1705. declare module "babylonjs/Maths/math.scalar" {
  1706. /**
  1707. * Scalar computation library
  1708. */
  1709. export class Scalar {
  1710. /**
  1711. * Two pi constants convenient for computation.
  1712. */
  1713. static TwoPi: number;
  1714. /**
  1715. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1716. * @param a number
  1717. * @param b number
  1718. * @param epsilon (default = 1.401298E-45)
  1719. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1720. */
  1721. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1722. /**
  1723. * Returns a string : the upper case translation of the number i to hexadecimal.
  1724. * @param i number
  1725. * @returns the upper case translation of the number i to hexadecimal.
  1726. */
  1727. static ToHex(i: number): string;
  1728. /**
  1729. * Returns -1 if value is negative and +1 is value is positive.
  1730. * @param value the value
  1731. * @returns the value itself if it's equal to zero.
  1732. */
  1733. static Sign(value: number): number;
  1734. /**
  1735. * Returns the value itself if it's between min and max.
  1736. * Returns min if the value is lower than min.
  1737. * Returns max if the value is greater than max.
  1738. * @param value the value to clmap
  1739. * @param min the min value to clamp to (default: 0)
  1740. * @param max the max value to clamp to (default: 1)
  1741. * @returns the clamped value
  1742. */
  1743. static Clamp(value: number, min?: number, max?: number): number;
  1744. /**
  1745. * the log2 of value.
  1746. * @param value the value to compute log2 of
  1747. * @returns the log2 of value.
  1748. */
  1749. static Log2(value: number): number;
  1750. /**
  1751. * Loops the value, so that it is never larger than length and never smaller than 0.
  1752. *
  1753. * This is similar to the modulo operator but it works with floating point numbers.
  1754. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1755. * With t = 5 and length = 2.5, the result would be 0.0.
  1756. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1757. * @param value the value
  1758. * @param length the length
  1759. * @returns the looped value
  1760. */
  1761. static Repeat(value: number, length: number): number;
  1762. /**
  1763. * Normalize the value between 0.0 and 1.0 using min and max values
  1764. * @param value value to normalize
  1765. * @param min max to normalize between
  1766. * @param max min to normalize between
  1767. * @returns the normalized value
  1768. */
  1769. static Normalize(value: number, min: number, max: number): number;
  1770. /**
  1771. * Denormalize the value from 0.0 and 1.0 using min and max values
  1772. * @param normalized value to denormalize
  1773. * @param min max to denormalize between
  1774. * @param max min to denormalize between
  1775. * @returns the denormalized value
  1776. */
  1777. static Denormalize(normalized: number, min: number, max: number): number;
  1778. /**
  1779. * Calculates the shortest difference between two given angles given in degrees.
  1780. * @param current current angle in degrees
  1781. * @param target target angle in degrees
  1782. * @returns the delta
  1783. */
  1784. static DeltaAngle(current: number, target: number): number;
  1785. /**
  1786. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1787. * @param tx value
  1788. * @param length length
  1789. * @returns The returned value will move back and forth between 0 and length
  1790. */
  1791. static PingPong(tx: number, length: number): number;
  1792. /**
  1793. * Interpolates between min and max with smoothing at the limits.
  1794. *
  1795. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1796. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1797. * @param from from
  1798. * @param to to
  1799. * @param tx value
  1800. * @returns the smooth stepped value
  1801. */
  1802. static SmoothStep(from: number, to: number, tx: number): number;
  1803. /**
  1804. * Moves a value current towards target.
  1805. *
  1806. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1807. * Negative values of maxDelta pushes the value away from target.
  1808. * @param current current value
  1809. * @param target target value
  1810. * @param maxDelta max distance to move
  1811. * @returns resulting value
  1812. */
  1813. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1814. /**
  1815. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. *
  1817. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1818. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1819. * @param current current value
  1820. * @param target target value
  1821. * @param maxDelta max distance to move
  1822. * @returns resulting angle
  1823. */
  1824. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1825. /**
  1826. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1827. * @param start start value
  1828. * @param end target value
  1829. * @param amount amount to lerp between
  1830. * @returns the lerped value
  1831. */
  1832. static Lerp(start: number, end: number, amount: number): number;
  1833. /**
  1834. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1835. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1836. * @param start start value
  1837. * @param end target value
  1838. * @param amount amount to lerp between
  1839. * @returns the lerped value
  1840. */
  1841. static LerpAngle(start: number, end: number, amount: number): number;
  1842. /**
  1843. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1844. * @param a start value
  1845. * @param b target value
  1846. * @param value value between a and b
  1847. * @returns the inverseLerp value
  1848. */
  1849. static InverseLerp(a: number, b: number, value: number): number;
  1850. /**
  1851. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1852. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1853. * @param value1 spline value
  1854. * @param tangent1 spline value
  1855. * @param value2 spline value
  1856. * @param tangent2 spline value
  1857. * @param amount input value
  1858. * @returns hermite result
  1859. */
  1860. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1861. /**
  1862. * Returns a random float number between and min and max values
  1863. * @param min min value of random
  1864. * @param max max value of random
  1865. * @returns random value
  1866. */
  1867. static RandomRange(min: number, max: number): number;
  1868. /**
  1869. * This function returns percentage of a number in a given range.
  1870. *
  1871. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1872. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1873. * @param number to convert to percentage
  1874. * @param min min range
  1875. * @param max max range
  1876. * @returns the percentage
  1877. */
  1878. static RangeToPercent(number: number, min: number, max: number): number;
  1879. /**
  1880. * This function returns number that corresponds to the percentage in a given range.
  1881. *
  1882. * PercentToRange(0.34,0,100) will return 34.
  1883. * @param percent to convert to number
  1884. * @param min min range
  1885. * @param max max range
  1886. * @returns the number
  1887. */
  1888. static PercentToRange(percent: number, min: number, max: number): number;
  1889. /**
  1890. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1891. * @param angle The angle to normalize in radian.
  1892. * @return The converted angle.
  1893. */
  1894. static NormalizeRadians(angle: number): number;
  1895. }
  1896. }
  1897. declare module "babylonjs/Maths/math.constants" {
  1898. /**
  1899. * Constant used to convert a value to gamma space
  1900. * @ignorenaming
  1901. */
  1902. export const ToGammaSpace: number;
  1903. /**
  1904. * Constant used to convert a value to linear space
  1905. * @ignorenaming
  1906. */
  1907. export const ToLinearSpace = 2.2;
  1908. /**
  1909. * Constant used to define the minimal number value in Babylon.js
  1910. * @ignorenaming
  1911. */
  1912. let Epsilon: number;
  1913. export { Epsilon };
  1914. }
  1915. declare module "babylonjs/Maths/math.viewport" {
  1916. /**
  1917. * Class used to represent a viewport on screen
  1918. */
  1919. export class Viewport {
  1920. /** viewport left coordinate */
  1921. x: number;
  1922. /** viewport top coordinate */
  1923. y: number;
  1924. /**viewport width */
  1925. width: number;
  1926. /** viewport height */
  1927. height: number;
  1928. /**
  1929. * Creates a Viewport object located at (x, y) and sized (width, height)
  1930. * @param x defines viewport left coordinate
  1931. * @param y defines viewport top coordinate
  1932. * @param width defines the viewport width
  1933. * @param height defines the viewport height
  1934. */
  1935. constructor(
  1936. /** viewport left coordinate */
  1937. x: number,
  1938. /** viewport top coordinate */
  1939. y: number,
  1940. /**viewport width */
  1941. width: number,
  1942. /** viewport height */
  1943. height: number);
  1944. /**
  1945. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1946. * @param renderWidth defines the rendering width
  1947. * @param renderHeight defines the rendering height
  1948. * @returns a new Viewport
  1949. */
  1950. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1951. /**
  1952. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1953. * @param renderWidth defines the rendering width
  1954. * @param renderHeight defines the rendering height
  1955. * @param ref defines the target viewport
  1956. * @returns the current viewport
  1957. */
  1958. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1959. /**
  1960. * Returns a new Viewport copied from the current one
  1961. * @returns a new Viewport
  1962. */
  1963. clone(): Viewport;
  1964. }
  1965. }
  1966. declare module "babylonjs/Misc/arrayTools" {
  1967. /**
  1968. * Class containing a set of static utilities functions for arrays.
  1969. */
  1970. export class ArrayTools {
  1971. /**
  1972. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1973. * @param size the number of element to construct and put in the array
  1974. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1975. * @returns a new array filled with new objects
  1976. */
  1977. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1978. }
  1979. }
  1980. declare module "babylonjs/Maths/math.plane" {
  1981. import { DeepImmutable } from "babylonjs/types";
  1982. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1983. /**
  1984. * Represents a plane by the equation ax + by + cz + d = 0
  1985. */
  1986. export class Plane {
  1987. private static _TmpMatrix;
  1988. /**
  1989. * Normal of the plane (a,b,c)
  1990. */
  1991. normal: Vector3;
  1992. /**
  1993. * d component of the plane
  1994. */
  1995. d: number;
  1996. /**
  1997. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1998. * @param a a component of the plane
  1999. * @param b b component of the plane
  2000. * @param c c component of the plane
  2001. * @param d d component of the plane
  2002. */
  2003. constructor(a: number, b: number, c: number, d: number);
  2004. /**
  2005. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  2006. */
  2007. asArray(): number[];
  2008. /**
  2009. * @returns a new plane copied from the current Plane.
  2010. */
  2011. clone(): Plane;
  2012. /**
  2013. * @returns the string "Plane".
  2014. */
  2015. getClassName(): string;
  2016. /**
  2017. * @returns the Plane hash code.
  2018. */
  2019. getHashCode(): number;
  2020. /**
  2021. * Normalize the current Plane in place.
  2022. * @returns the updated Plane.
  2023. */
  2024. normalize(): Plane;
  2025. /**
  2026. * Applies a transformation the plane and returns the result
  2027. * @param transformation the transformation matrix to be applied to the plane
  2028. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2029. */
  2030. transform(transformation: DeepImmutable<Matrix>): Plane;
  2031. /**
  2032. * Compute the dot product between the point and the plane normal
  2033. * @param point point to calculate the dot product with
  2034. * @returns the dot product (float) of the point coordinates and the plane normal.
  2035. */
  2036. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2037. /**
  2038. * Updates the current Plane from the plane defined by the three given points.
  2039. * @param point1 one of the points used to contruct the plane
  2040. * @param point2 one of the points used to contruct the plane
  2041. * @param point3 one of the points used to contruct the plane
  2042. * @returns the updated Plane.
  2043. */
  2044. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2045. /**
  2046. * Checks if the plane is facing a given direction
  2047. * @param direction the direction to check if the plane is facing
  2048. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2049. * @returns True is the vector "direction" is the same side than the plane normal.
  2050. */
  2051. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2052. /**
  2053. * Calculates the distance to a point
  2054. * @param point point to calculate distance to
  2055. * @returns the signed distance (float) from the given point to the Plane.
  2056. */
  2057. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2058. /**
  2059. * Creates a plane from an array
  2060. * @param array the array to create a plane from
  2061. * @returns a new Plane from the given array.
  2062. */
  2063. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2064. /**
  2065. * Creates a plane from three points
  2066. * @param point1 point used to create the plane
  2067. * @param point2 point used to create the plane
  2068. * @param point3 point used to create the plane
  2069. * @returns a new Plane defined by the three given points.
  2070. */
  2071. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2072. /**
  2073. * Creates a plane from an origin point and a normal
  2074. * @param origin origin of the plane to be constructed
  2075. * @param normal normal of the plane to be constructed
  2076. * @returns a new Plane the normal vector to this plane at the given origin point.
  2077. * Note : the vector "normal" is updated because normalized.
  2078. */
  2079. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2080. /**
  2081. * Calculates the distance from a plane and a point
  2082. * @param origin origin of the plane to be constructed
  2083. * @param normal normal of the plane to be constructed
  2084. * @param point point to calculate distance to
  2085. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2086. */
  2087. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2088. }
  2089. }
  2090. declare module "babylonjs/Engines/performanceConfigurator" {
  2091. /** @hidden */
  2092. export class PerformanceConfigurator {
  2093. /** @hidden */
  2094. static MatrixUse64Bits: boolean;
  2095. /** @hidden */
  2096. static MatrixTrackPrecisionChange: boolean;
  2097. /** @hidden */
  2098. static MatrixCurrentType: any;
  2099. /** @hidden */
  2100. static MatrixTrackedMatrices: Array<any> | null;
  2101. /** @hidden */
  2102. static SetMatrixPrecision(use64bits: boolean): void;
  2103. }
  2104. }
  2105. declare module "babylonjs/Maths/math.vector" {
  2106. import { Viewport } from "babylonjs/Maths/math.viewport";
  2107. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2108. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2109. import { Plane } from "babylonjs/Maths/math.plane";
  2110. /**
  2111. * Class representing a vector containing 2 coordinates
  2112. */
  2113. export class Vector2 {
  2114. /** defines the first coordinate */
  2115. x: number;
  2116. /** defines the second coordinate */
  2117. y: number;
  2118. /**
  2119. * Creates a new Vector2 from the given x and y coordinates
  2120. * @param x defines the first coordinate
  2121. * @param y defines the second coordinate
  2122. */
  2123. constructor(
  2124. /** defines the first coordinate */
  2125. x?: number,
  2126. /** defines the second coordinate */
  2127. y?: number);
  2128. /**
  2129. * Gets a string with the Vector2 coordinates
  2130. * @returns a string with the Vector2 coordinates
  2131. */
  2132. toString(): string;
  2133. /**
  2134. * Gets class name
  2135. * @returns the string "Vector2"
  2136. */
  2137. getClassName(): string;
  2138. /**
  2139. * Gets current vector hash code
  2140. * @returns the Vector2 hash code as a number
  2141. */
  2142. getHashCode(): number;
  2143. /**
  2144. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2145. * @param array defines the source array
  2146. * @param index defines the offset in source array
  2147. * @returns the current Vector2
  2148. */
  2149. toArray(array: FloatArray, index?: number): Vector2;
  2150. /**
  2151. * Update the current vector from an array
  2152. * @param array defines the destination array
  2153. * @param index defines the offset in the destination array
  2154. * @returns the current Vector3
  2155. */
  2156. fromArray(array: FloatArray, index?: number): Vector2;
  2157. /**
  2158. * Copy the current vector to an array
  2159. * @returns a new array with 2 elements: the Vector2 coordinates.
  2160. */
  2161. asArray(): number[];
  2162. /**
  2163. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2164. * @param source defines the source Vector2
  2165. * @returns the current updated Vector2
  2166. */
  2167. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2168. /**
  2169. * Sets the Vector2 coordinates with the given floats
  2170. * @param x defines the first coordinate
  2171. * @param y defines the second coordinate
  2172. * @returns the current updated Vector2
  2173. */
  2174. copyFromFloats(x: number, y: number): Vector2;
  2175. /**
  2176. * Sets the Vector2 coordinates with the given floats
  2177. * @param x defines the first coordinate
  2178. * @param y defines the second coordinate
  2179. * @returns the current updated Vector2
  2180. */
  2181. set(x: number, y: number): Vector2;
  2182. /**
  2183. * Add another vector with the current one
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2186. */
  2187. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2188. /**
  2189. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2190. * @param otherVector defines the other vector
  2191. * @param result defines the target vector
  2192. * @returns the unmodified current Vector2
  2193. */
  2194. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2195. /**
  2196. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2197. * @param otherVector defines the other vector
  2198. * @returns the current updated Vector2
  2199. */
  2200. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2201. /**
  2202. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns a new Vector2
  2205. */
  2206. addVector3(otherVector: Vector3): Vector2;
  2207. /**
  2208. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2209. * @param otherVector defines the other vector
  2210. * @returns a new Vector2
  2211. */
  2212. subtract(otherVector: Vector2): Vector2;
  2213. /**
  2214. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2215. * @param otherVector defines the other vector
  2216. * @param result defines the target vector
  2217. * @returns the unmodified current Vector2
  2218. */
  2219. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2220. /**
  2221. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2222. * @param otherVector defines the other vector
  2223. * @returns the current updated Vector2
  2224. */
  2225. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2226. /**
  2227. * Multiplies in place the current Vector2 coordinates by the given ones
  2228. * @param otherVector defines the other vector
  2229. * @returns the current updated Vector2
  2230. */
  2231. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2232. /**
  2233. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2234. * @param otherVector defines the other vector
  2235. * @returns a new Vector2
  2236. */
  2237. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2238. /**
  2239. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2240. * @param otherVector defines the other vector
  2241. * @param result defines the target vector
  2242. * @returns the unmodified current Vector2
  2243. */
  2244. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2245. /**
  2246. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2247. * @param x defines the first coordinate
  2248. * @param y defines the second coordinate
  2249. * @returns a new Vector2
  2250. */
  2251. multiplyByFloats(x: number, y: number): Vector2;
  2252. /**
  2253. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2254. * @param otherVector defines the other vector
  2255. * @returns a new Vector2
  2256. */
  2257. divide(otherVector: Vector2): Vector2;
  2258. /**
  2259. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2260. * @param otherVector defines the other vector
  2261. * @param result defines the target vector
  2262. * @returns the unmodified current Vector2
  2263. */
  2264. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2265. /**
  2266. * Divides the current Vector2 coordinates by the given ones
  2267. * @param otherVector defines the other vector
  2268. * @returns the current updated Vector2
  2269. */
  2270. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2271. /**
  2272. * Gets a new Vector2 with current Vector2 negated coordinates
  2273. * @returns a new Vector2
  2274. */
  2275. negate(): Vector2;
  2276. /**
  2277. * Negate this vector in place
  2278. * @returns this
  2279. */
  2280. negateInPlace(): Vector2;
  2281. /**
  2282. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2283. * @param result defines the Vector3 object where to store the result
  2284. * @returns the current Vector2
  2285. */
  2286. negateToRef(result: Vector2): Vector2;
  2287. /**
  2288. * Multiply the Vector2 coordinates by scale
  2289. * @param scale defines the scaling factor
  2290. * @returns the current updated Vector2
  2291. */
  2292. scaleInPlace(scale: number): Vector2;
  2293. /**
  2294. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2295. * @param scale defines the scaling factor
  2296. * @returns a new Vector2
  2297. */
  2298. scale(scale: number): Vector2;
  2299. /**
  2300. * Scale the current Vector2 values by a factor to a given Vector2
  2301. * @param scale defines the scale factor
  2302. * @param result defines the Vector2 object where to store the result
  2303. * @returns the unmodified current Vector2
  2304. */
  2305. scaleToRef(scale: number, result: Vector2): Vector2;
  2306. /**
  2307. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2308. * @param scale defines the scale factor
  2309. * @param result defines the Vector2 object where to store the result
  2310. * @returns the unmodified current Vector2
  2311. */
  2312. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2313. /**
  2314. * Gets a boolean if two vectors are equals
  2315. * @param otherVector defines the other vector
  2316. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2317. */
  2318. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2319. /**
  2320. * Gets a boolean if two vectors are equals (using an epsilon value)
  2321. * @param otherVector defines the other vector
  2322. * @param epsilon defines the minimal distance to consider equality
  2323. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2324. */
  2325. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2326. /**
  2327. * Gets a new Vector2 from current Vector2 floored values
  2328. * @returns a new Vector2
  2329. */
  2330. floor(): Vector2;
  2331. /**
  2332. * Gets a new Vector2 from current Vector2 floored values
  2333. * @returns a new Vector2
  2334. */
  2335. fract(): Vector2;
  2336. /**
  2337. * Gets the length of the vector
  2338. * @returns the vector length (float)
  2339. */
  2340. length(): number;
  2341. /**
  2342. * Gets the vector squared length
  2343. * @returns the vector squared length (float)
  2344. */
  2345. lengthSquared(): number;
  2346. /**
  2347. * Normalize the vector
  2348. * @returns the current updated Vector2
  2349. */
  2350. normalize(): Vector2;
  2351. /**
  2352. * Gets a new Vector2 copied from the Vector2
  2353. * @returns a new Vector2
  2354. */
  2355. clone(): Vector2;
  2356. /**
  2357. * Gets a new Vector2(0, 0)
  2358. * @returns a new Vector2
  2359. */
  2360. static Zero(): Vector2;
  2361. /**
  2362. * Gets a new Vector2(1, 1)
  2363. * @returns a new Vector2
  2364. */
  2365. static One(): Vector2;
  2366. /**
  2367. * Gets a new Vector2 set from the given index element of the given array
  2368. * @param array defines the data source
  2369. * @param offset defines the offset in the data source
  2370. * @returns a new Vector2
  2371. */
  2372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2373. /**
  2374. * Sets "result" from the given index element of the given array
  2375. * @param array defines the data source
  2376. * @param offset defines the offset in the data source
  2377. * @param result defines the target vector
  2378. */
  2379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2380. /**
  2381. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2382. * @param value1 defines 1st point of control
  2383. * @param value2 defines 2nd point of control
  2384. * @param value3 defines 3rd point of control
  2385. * @param value4 defines 4th point of control
  2386. * @param amount defines the interpolation factor
  2387. * @returns a new Vector2
  2388. */
  2389. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2390. /**
  2391. * 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".
  2392. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2393. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2394. * @param value defines the value to clamp
  2395. * @param min defines the lower limit
  2396. * @param max defines the upper limit
  2397. * @returns a new Vector2
  2398. */
  2399. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2400. /**
  2401. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2402. * @param value1 defines the 1st control point
  2403. * @param tangent1 defines the outgoing tangent
  2404. * @param value2 defines the 2nd control point
  2405. * @param tangent2 defines the incoming tangent
  2406. * @param amount defines the interpolation factor
  2407. * @returns a new Vector2
  2408. */
  2409. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2410. /**
  2411. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2412. * @param start defines the start vector
  2413. * @param end defines the end vector
  2414. * @param amount defines the interpolation factor
  2415. * @returns a new Vector2
  2416. */
  2417. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2418. /**
  2419. * Gets the dot product of the vector "left" and the vector "right"
  2420. * @param left defines first vector
  2421. * @param right defines second vector
  2422. * @returns the dot product (float)
  2423. */
  2424. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2425. /**
  2426. * Returns a new Vector2 equal to the normalized given vector
  2427. * @param vector defines the vector to normalize
  2428. * @returns a new Vector2
  2429. */
  2430. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2431. /**
  2432. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2433. * @param left defines 1st vector
  2434. * @param right defines 2nd vector
  2435. * @returns a new Vector2
  2436. */
  2437. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2438. /**
  2439. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2440. * @param left defines 1st vector
  2441. * @param right defines 2nd vector
  2442. * @returns a new Vector2
  2443. */
  2444. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2445. /**
  2446. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2447. * @param vector defines the vector to transform
  2448. * @param transformation defines the matrix to apply
  2449. * @returns a new Vector2
  2450. */
  2451. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2452. /**
  2453. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2454. * @param vector defines the vector to transform
  2455. * @param transformation defines the matrix to apply
  2456. * @param result defines the target vector
  2457. */
  2458. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2459. /**
  2460. * Determines if a given vector is included in a triangle
  2461. * @param p defines the vector to test
  2462. * @param p0 defines 1st triangle point
  2463. * @param p1 defines 2nd triangle point
  2464. * @param p2 defines 3rd triangle point
  2465. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2466. */
  2467. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2468. /**
  2469. * Gets the distance between the vectors "value1" and "value2"
  2470. * @param value1 defines first vector
  2471. * @param value2 defines second vector
  2472. * @returns the distance between vectors
  2473. */
  2474. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2475. /**
  2476. * Returns the squared distance between the vectors "value1" and "value2"
  2477. * @param value1 defines first vector
  2478. * @param value2 defines second vector
  2479. * @returns the squared distance between vectors
  2480. */
  2481. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2482. /**
  2483. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2484. * @param value1 defines first vector
  2485. * @param value2 defines second vector
  2486. * @returns a new Vector2
  2487. */
  2488. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2489. /**
  2490. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2491. * @param p defines the middle point
  2492. * @param segA defines one point of the segment
  2493. * @param segB defines the other point of the segment
  2494. * @returns the shortest distance
  2495. */
  2496. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2497. }
  2498. /**
  2499. * Class used to store (x,y,z) vector representation
  2500. * A Vector3 is the main object used in 3D geometry
  2501. * It can represent etiher the coordinates of a point the space, either a direction
  2502. * Reminder: js uses a left handed forward facing system
  2503. */
  2504. export class Vector3 {
  2505. private static _UpReadOnly;
  2506. private static _ZeroReadOnly;
  2507. /** @hidden */
  2508. _x: number;
  2509. /** @hidden */
  2510. _y: number;
  2511. /** @hidden */
  2512. _z: number;
  2513. /** @hidden */
  2514. _isDirty: boolean;
  2515. /** Gets or sets the x coordinate */
  2516. get x(): number;
  2517. set x(value: number);
  2518. /** Gets or sets the y coordinate */
  2519. get y(): number;
  2520. set y(value: number);
  2521. /** Gets or sets the z coordinate */
  2522. get z(): number;
  2523. set z(value: number);
  2524. /**
  2525. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2526. * @param x defines the first coordinates (on X axis)
  2527. * @param y defines the second coordinates (on Y axis)
  2528. * @param z defines the third coordinates (on Z axis)
  2529. */
  2530. constructor(x?: number, y?: number, z?: number);
  2531. /**
  2532. * Creates a string representation of the Vector3
  2533. * @returns a string with the Vector3 coordinates.
  2534. */
  2535. toString(): string;
  2536. /**
  2537. * Gets the class name
  2538. * @returns the string "Vector3"
  2539. */
  2540. getClassName(): string;
  2541. /**
  2542. * Creates the Vector3 hash code
  2543. * @returns a number which tends to be unique between Vector3 instances
  2544. */
  2545. getHashCode(): number;
  2546. /**
  2547. * Creates an array containing three elements : the coordinates of the Vector3
  2548. * @returns a new array of numbers
  2549. */
  2550. asArray(): number[];
  2551. /**
  2552. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2553. * @param array defines the destination array
  2554. * @param index defines the offset in the destination array
  2555. * @returns the current Vector3
  2556. */
  2557. toArray(array: FloatArray, index?: number): Vector3;
  2558. /**
  2559. * Update the current vector from an array
  2560. * @param array defines the destination array
  2561. * @param index defines the offset in the destination array
  2562. * @returns the current Vector3
  2563. */
  2564. fromArray(array: FloatArray, index?: number): Vector3;
  2565. /**
  2566. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2567. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2568. */
  2569. toQuaternion(): Quaternion;
  2570. /**
  2571. * Adds the given vector to the current Vector3
  2572. * @param otherVector defines the second operand
  2573. * @returns the current updated Vector3
  2574. */
  2575. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2576. /**
  2577. * Adds the given coordinates to the current Vector3
  2578. * @param x defines the x coordinate of the operand
  2579. * @param y defines the y coordinate of the operand
  2580. * @param z defines the z coordinate of the operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2584. /**
  2585. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Adds the current Vector3 to the given one 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. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Subtract the given vector from the current Vector3
  2599. * @param otherVector defines the second operand
  2600. * @returns the current updated Vector3
  2601. */
  2602. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2603. /**
  2604. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2605. * @param otherVector defines the second operand
  2606. * @returns the resulting Vector3
  2607. */
  2608. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2609. /**
  2610. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2611. * @param otherVector defines the second operand
  2612. * @param result defines the Vector3 object where to store the result
  2613. * @returns the current Vector3
  2614. */
  2615. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2618. * @param x defines the x coordinate of the operand
  2619. * @param y defines the y coordinate of the operand
  2620. * @param z defines the z coordinate of the operand
  2621. * @returns the resulting Vector3
  2622. */
  2623. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2624. /**
  2625. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2626. * @param x defines the x coordinate of the operand
  2627. * @param y defines the y coordinate of the operand
  2628. * @param z defines the z coordinate of the operand
  2629. * @param result defines the Vector3 object where to store the result
  2630. * @returns the current Vector3
  2631. */
  2632. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2633. /**
  2634. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2635. * @returns a new Vector3
  2636. */
  2637. negate(): Vector3;
  2638. /**
  2639. * Negate this vector in place
  2640. * @returns this
  2641. */
  2642. negateInPlace(): Vector3;
  2643. /**
  2644. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. negateToRef(result: Vector3): Vector3;
  2649. /**
  2650. * Multiplies the Vector3 coordinates by the float "scale"
  2651. * @param scale defines the multiplier factor
  2652. * @returns the current updated Vector3
  2653. */
  2654. scaleInPlace(scale: number): Vector3;
  2655. /**
  2656. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2657. * @param scale defines the multiplier factor
  2658. * @returns a new Vector3
  2659. */
  2660. scale(scale: number): Vector3;
  2661. /**
  2662. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2663. * @param scale defines the multiplier factor
  2664. * @param result defines the Vector3 object where to store the result
  2665. * @returns the current Vector3
  2666. */
  2667. scaleToRef(scale: number, result: Vector3): Vector3;
  2668. /**
  2669. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2670. * @param scale defines the scale factor
  2671. * @param result defines the Vector3 object where to store the result
  2672. * @returns the unmodified current Vector3
  2673. */
  2674. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2675. /**
  2676. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2677. * @param origin defines the origin of the projection ray
  2678. * @param plane defines the plane to project to
  2679. * @returns the projected vector3
  2680. */
  2681. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2682. /**
  2683. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2684. * @param origin defines the origin of the projection ray
  2685. * @param plane defines the plane to project to
  2686. * @param result defines the Vector3 where to store the result
  2687. */
  2688. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2689. /**
  2690. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2691. * @param otherVector defines the second operand
  2692. * @returns true if both vectors are equals
  2693. */
  2694. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2695. /**
  2696. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2697. * @param otherVector defines the second operand
  2698. * @param epsilon defines the minimal distance to define values as equals
  2699. * @returns true if both vectors are distant less than epsilon
  2700. */
  2701. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2702. /**
  2703. * Returns true if the current Vector3 coordinates equals the given floats
  2704. * @param x defines the x coordinate of the operand
  2705. * @param y defines the y coordinate of the operand
  2706. * @param z defines the z coordinate of the operand
  2707. * @returns true if both vectors are equals
  2708. */
  2709. equalsToFloats(x: number, y: number, z: number): boolean;
  2710. /**
  2711. * Multiplies the current Vector3 coordinates by the given ones
  2712. * @param otherVector defines the second operand
  2713. * @returns the current updated Vector3
  2714. */
  2715. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2716. /**
  2717. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2718. * @param otherVector defines the second operand
  2719. * @returns the new Vector3
  2720. */
  2721. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2722. /**
  2723. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2724. * @param otherVector defines the second operand
  2725. * @param result defines the Vector3 object where to store the result
  2726. * @returns the current Vector3
  2727. */
  2728. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2729. /**
  2730. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2731. * @param x defines the x coordinate of the operand
  2732. * @param y defines the y coordinate of the operand
  2733. * @param z defines the z coordinate of the operand
  2734. * @returns the new Vector3
  2735. */
  2736. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2737. /**
  2738. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2739. * @param otherVector defines the second operand
  2740. * @returns the new Vector3
  2741. */
  2742. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2745. * @param otherVector defines the second operand
  2746. * @param result defines the Vector3 object where to store the result
  2747. * @returns the current Vector3
  2748. */
  2749. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2750. /**
  2751. * Divides the current Vector3 coordinates by the given ones.
  2752. * @param otherVector defines the second operand
  2753. * @returns the current updated Vector3
  2754. */
  2755. divideInPlace(otherVector: Vector3): Vector3;
  2756. /**
  2757. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2758. * @param other defines the second operand
  2759. * @returns the current updated Vector3
  2760. */
  2761. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2762. /**
  2763. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2764. * @param other defines the second operand
  2765. * @returns the current updated Vector3
  2766. */
  2767. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2768. /**
  2769. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2770. * @param x defines the x coordinate of the operand
  2771. * @param y defines the y coordinate of the operand
  2772. * @param z defines the z coordinate of the operand
  2773. * @returns the current updated Vector3
  2774. */
  2775. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2776. /**
  2777. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2778. * @param x defines the x coordinate of the operand
  2779. * @param y defines the y coordinate of the operand
  2780. * @param z defines the z coordinate of the operand
  2781. * @returns the current updated Vector3
  2782. */
  2783. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2784. /**
  2785. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2786. * Check if is non uniform within a certain amount of decimal places to account for this
  2787. * @param epsilon the amount the values can differ
  2788. * @returns if the the vector is non uniform to a certain number of decimal places
  2789. */
  2790. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2791. /**
  2792. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2793. */
  2794. get isNonUniform(): boolean;
  2795. /**
  2796. * Gets a new Vector3 from current Vector3 floored values
  2797. * @returns a new Vector3
  2798. */
  2799. floor(): Vector3;
  2800. /**
  2801. * Gets a new Vector3 from current Vector3 floored values
  2802. * @returns a new Vector3
  2803. */
  2804. fract(): Vector3;
  2805. /**
  2806. * Gets the length of the Vector3
  2807. * @returns the length of the Vector3
  2808. */
  2809. length(): number;
  2810. /**
  2811. * Gets the squared length of the Vector3
  2812. * @returns squared length of the Vector3
  2813. */
  2814. lengthSquared(): number;
  2815. /**
  2816. * Normalize the current Vector3.
  2817. * Please note that this is an in place operation.
  2818. * @returns the current updated Vector3
  2819. */
  2820. normalize(): Vector3;
  2821. /**
  2822. * Reorders the x y z properties of the vector in place
  2823. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2824. * @returns the current updated vector
  2825. */
  2826. reorderInPlace(order: string): this;
  2827. /**
  2828. * Rotates the vector around 0,0,0 by a quaternion
  2829. * @param quaternion the rotation quaternion
  2830. * @param result vector to store the result
  2831. * @returns the resulting vector
  2832. */
  2833. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2834. /**
  2835. * Rotates a vector around a given point
  2836. * @param quaternion the rotation quaternion
  2837. * @param point the point to rotate around
  2838. * @param result vector to store the result
  2839. * @returns the resulting vector
  2840. */
  2841. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2842. /**
  2843. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2844. * The cross product is then orthogonal to both current and "other"
  2845. * @param other defines the right operand
  2846. * @returns the cross product
  2847. */
  2848. cross(other: Vector3): Vector3;
  2849. /**
  2850. * Normalize the current Vector3 with the given input length.
  2851. * Please note that this is an in place operation.
  2852. * @param len the length of the vector
  2853. * @returns the current updated Vector3
  2854. */
  2855. normalizeFromLength(len: number): Vector3;
  2856. /**
  2857. * Normalize the current Vector3 to a new vector
  2858. * @returns the new Vector3
  2859. */
  2860. normalizeToNew(): Vector3;
  2861. /**
  2862. * Normalize the current Vector3 to the reference
  2863. * @param reference define the Vector3 to update
  2864. * @returns the updated Vector3
  2865. */
  2866. normalizeToRef(reference: Vector3): Vector3;
  2867. /**
  2868. * Creates a new Vector3 copied from the current Vector3
  2869. * @returns the new Vector3
  2870. */
  2871. clone(): Vector3;
  2872. /**
  2873. * Copies the given vector coordinates to the current Vector3 ones
  2874. * @param source defines the source Vector3
  2875. * @returns the current updated Vector3
  2876. */
  2877. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2878. /**
  2879. * Copies the given floats to the current Vector3 coordinates
  2880. * @param x defines the x coordinate of the operand
  2881. * @param y defines the y coordinate of the operand
  2882. * @param z defines the z coordinate of the operand
  2883. * @returns the current updated Vector3
  2884. */
  2885. copyFromFloats(x: number, y: number, z: number): Vector3;
  2886. /**
  2887. * Copies the given floats to the current Vector3 coordinates
  2888. * @param x defines the x coordinate of the operand
  2889. * @param y defines the y coordinate of the operand
  2890. * @param z defines the z coordinate of the operand
  2891. * @returns the current updated Vector3
  2892. */
  2893. set(x: number, y: number, z: number): Vector3;
  2894. /**
  2895. * Copies the given float to the current Vector3 coordinates
  2896. * @param v defines the x, y and z coordinates of the operand
  2897. * @returns the current updated Vector3
  2898. */
  2899. setAll(v: number): Vector3;
  2900. /**
  2901. * Get the clip factor between two vectors
  2902. * @param vector0 defines the first operand
  2903. * @param vector1 defines the second operand
  2904. * @param axis defines the axis to use
  2905. * @param size defines the size along the axis
  2906. * @returns the clip factor
  2907. */
  2908. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2909. /**
  2910. * Get angle between two vectors
  2911. * @param vector0 angle between vector0 and vector1
  2912. * @param vector1 angle between vector0 and vector1
  2913. * @param normal direction of the normal
  2914. * @return the angle between vector0 and vector1
  2915. */
  2916. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2917. /**
  2918. * Returns a new Vector3 set from the index "offset" of the given array
  2919. * @param array defines the source array
  2920. * @param offset defines the offset in the source array
  2921. * @returns the new Vector3
  2922. */
  2923. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2924. /**
  2925. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2926. * @param array defines the source array
  2927. * @param offset defines the offset in the source array
  2928. * @returns the new Vector3
  2929. * @deprecated Please use FromArray instead.
  2930. */
  2931. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2932. /**
  2933. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2934. * @param array defines the source array
  2935. * @param offset defines the offset in the source array
  2936. * @param result defines the Vector3 where to store the result
  2937. */
  2938. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2939. /**
  2940. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2941. * @param array defines the source array
  2942. * @param offset defines the offset in the source array
  2943. * @param result defines the Vector3 where to store the result
  2944. * @deprecated Please use FromArrayToRef instead.
  2945. */
  2946. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2947. /**
  2948. * Sets the given vector "result" with the given floats.
  2949. * @param x defines the x coordinate of the source
  2950. * @param y defines the y coordinate of the source
  2951. * @param z defines the z coordinate of the source
  2952. * @param result defines the Vector3 where to store the result
  2953. */
  2954. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2955. /**
  2956. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2957. * @returns a new empty Vector3
  2958. */
  2959. static Zero(): Vector3;
  2960. /**
  2961. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2962. * @returns a new unit Vector3
  2963. */
  2964. static One(): Vector3;
  2965. /**
  2966. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2967. * @returns a new up Vector3
  2968. */
  2969. static Up(): Vector3;
  2970. /**
  2971. * Gets a up Vector3 that must not be updated
  2972. */
  2973. static get UpReadOnly(): DeepImmutable<Vector3>;
  2974. /**
  2975. * Gets a zero Vector3 that must not be updated
  2976. */
  2977. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2978. /**
  2979. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2980. * @returns a new down Vector3
  2981. */
  2982. static Down(): Vector3;
  2983. /**
  2984. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2985. * @param rightHandedSystem is the scene right-handed (negative z)
  2986. * @returns a new forward Vector3
  2987. */
  2988. static Forward(rightHandedSystem?: boolean): Vector3;
  2989. /**
  2990. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2991. * @param rightHandedSystem is the scene right-handed (negative-z)
  2992. * @returns a new forward Vector3
  2993. */
  2994. static Backward(rightHandedSystem?: boolean): Vector3;
  2995. /**
  2996. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2997. * @returns a new right Vector3
  2998. */
  2999. static Right(): Vector3;
  3000. /**
  3001. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  3002. * @returns a new left Vector3
  3003. */
  3004. static Left(): Vector3;
  3005. /**
  3006. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  3007. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3008. * @param vector defines the Vector3 to transform
  3009. * @param transformation defines the transformation matrix
  3010. * @returns the transformed Vector3
  3011. */
  3012. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3013. /**
  3014. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  3015. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3016. * @param vector defines the Vector3 to transform
  3017. * @param transformation defines the transformation matrix
  3018. * @param result defines the Vector3 where to store the result
  3019. */
  3020. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3021. /**
  3022. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3023. * This method computes tranformed coordinates only, not transformed direction vectors
  3024. * @param x define the x coordinate of the source vector
  3025. * @param y define the y coordinate of the source vector
  3026. * @param z define the z coordinate of the source vector
  3027. * @param transformation defines the transformation matrix
  3028. * @param result defines the Vector3 where to store the result
  3029. */
  3030. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3031. /**
  3032. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3033. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3034. * @param vector defines the Vector3 to transform
  3035. * @param transformation defines the transformation matrix
  3036. * @returns the new Vector3
  3037. */
  3038. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3039. /**
  3040. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3041. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3042. * @param vector defines the Vector3 to transform
  3043. * @param transformation defines the transformation matrix
  3044. * @param result defines the Vector3 where to store the result
  3045. */
  3046. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3047. /**
  3048. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3049. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3050. * @param x define the x coordinate of the source vector
  3051. * @param y define the y coordinate of the source vector
  3052. * @param z define the z coordinate of the source vector
  3053. * @param transformation defines the transformation matrix
  3054. * @param result defines the Vector3 where to store the result
  3055. */
  3056. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3057. /**
  3058. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3059. * @param value1 defines the first control point
  3060. * @param value2 defines the second control point
  3061. * @param value3 defines the third control point
  3062. * @param value4 defines the fourth control point
  3063. * @param amount defines the amount on the spline to use
  3064. * @returns the new Vector3
  3065. */
  3066. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3067. /**
  3068. * 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"
  3069. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3070. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3071. * @param value defines the current value
  3072. * @param min defines the lower range value
  3073. * @param max defines the upper range value
  3074. * @returns the new Vector3
  3075. */
  3076. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3077. /**
  3078. * 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"
  3079. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3080. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3081. * @param value defines the current value
  3082. * @param min defines the lower range value
  3083. * @param max defines the upper range value
  3084. * @param result defines the Vector3 where to store the result
  3085. */
  3086. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3087. /**
  3088. * Checks if a given vector is inside a specific range
  3089. * @param v defines the vector to test
  3090. * @param min defines the minimum range
  3091. * @param max defines the maximum range
  3092. */
  3093. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3094. /**
  3095. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3096. * @param value1 defines the first control point
  3097. * @param tangent1 defines the first tangent vector
  3098. * @param value2 defines the second control point
  3099. * @param tangent2 defines the second tangent vector
  3100. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3101. * @returns the new Vector3
  3102. */
  3103. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3104. /**
  3105. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3106. * @param start defines the start value
  3107. * @param end defines the end value
  3108. * @param amount max defines amount between both (between 0 and 1)
  3109. * @returns the new Vector3
  3110. */
  3111. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3112. /**
  3113. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3114. * @param start defines the start value
  3115. * @param end defines the end value
  3116. * @param amount max defines amount between both (between 0 and 1)
  3117. * @param result defines the Vector3 where to store the result
  3118. */
  3119. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3120. /**
  3121. * Returns the dot product (float) between the vectors "left" and "right"
  3122. * @param left defines the left operand
  3123. * @param right defines the right operand
  3124. * @returns the dot product
  3125. */
  3126. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3127. /**
  3128. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3129. * The cross product is then orthogonal to both "left" and "right"
  3130. * @param left defines the left operand
  3131. * @param right defines the right operand
  3132. * @returns the cross product
  3133. */
  3134. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3135. /**
  3136. * Sets the given vector "result" with the cross product of "left" and "right"
  3137. * The cross product is then orthogonal to both "left" and "right"
  3138. * @param left defines the left operand
  3139. * @param right defines the right operand
  3140. * @param result defines the Vector3 where to store the result
  3141. */
  3142. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3143. /**
  3144. * Returns a new Vector3 as the normalization of the given vector
  3145. * @param vector defines the Vector3 to normalize
  3146. * @returns the new Vector3
  3147. */
  3148. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3149. /**
  3150. * Sets the given vector "result" with the normalization of the given first vector
  3151. * @param vector defines the Vector3 to normalize
  3152. * @param result defines the Vector3 where to store the result
  3153. */
  3154. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3155. /**
  3156. * Project a Vector3 onto screen space
  3157. * @param vector defines the Vector3 to project
  3158. * @param world defines the world matrix to use
  3159. * @param transform defines the transform (view x projection) matrix to use
  3160. * @param viewport defines the screen viewport to use
  3161. * @returns the new Vector3
  3162. */
  3163. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3164. /** @hidden */
  3165. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3166. /**
  3167. * Unproject from screen space to object space
  3168. * @param source defines the screen space Vector3 to use
  3169. * @param viewportWidth defines the current width of the viewport
  3170. * @param viewportHeight defines the current height of the viewport
  3171. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3172. * @param transform defines the transform (view x projection) matrix to use
  3173. * @returns the new Vector3
  3174. */
  3175. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3176. /**
  3177. * Unproject from screen space to object space
  3178. * @param source defines the screen space Vector3 to use
  3179. * @param viewportWidth defines the current width of the viewport
  3180. * @param viewportHeight defines the current height of the viewport
  3181. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3182. * @param view defines the view matrix to use
  3183. * @param projection defines the projection matrix to use
  3184. * @returns the new Vector3
  3185. */
  3186. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3187. /**
  3188. * Unproject from screen space to object space
  3189. * @param source defines the screen space Vector3 to use
  3190. * @param viewportWidth defines the current width of the viewport
  3191. * @param viewportHeight defines the current height of the viewport
  3192. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3193. * @param view defines the view matrix to use
  3194. * @param projection defines the projection matrix to use
  3195. * @param result defines the Vector3 where to store the result
  3196. */
  3197. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3198. /**
  3199. * Unproject from screen space to object space
  3200. * @param sourceX defines the screen space x coordinate to use
  3201. * @param sourceY defines the screen space y coordinate to use
  3202. * @param sourceZ defines the screen space z coordinate to use
  3203. * @param viewportWidth defines the current width of the viewport
  3204. * @param viewportHeight defines the current height of the viewport
  3205. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3206. * @param view defines the view matrix to use
  3207. * @param projection defines the projection matrix to use
  3208. * @param result defines the Vector3 where to store the result
  3209. */
  3210. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3211. /**
  3212. * Gets the minimal coordinate values between two Vector3
  3213. * @param left defines the first operand
  3214. * @param right defines the second operand
  3215. * @returns the new Vector3
  3216. */
  3217. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3218. /**
  3219. * Gets the maximal coordinate values between two Vector3
  3220. * @param left defines the first operand
  3221. * @param right defines the second operand
  3222. * @returns the new Vector3
  3223. */
  3224. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3225. /**
  3226. * Returns the distance between the vectors "value1" and "value2"
  3227. * @param value1 defines the first operand
  3228. * @param value2 defines the second operand
  3229. * @returns the distance
  3230. */
  3231. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3232. /**
  3233. * Returns the squared distance between the vectors "value1" and "value2"
  3234. * @param value1 defines the first operand
  3235. * @param value2 defines the second operand
  3236. * @returns the squared distance
  3237. */
  3238. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3239. /**
  3240. * Returns a new Vector3 located at the center between "value1" and "value2"
  3241. * @param value1 defines the first operand
  3242. * @param value2 defines the second operand
  3243. * @returns the new Vector3
  3244. */
  3245. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3246. /**
  3247. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3248. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3249. * to something in order to rotate it from its local system to the given target system
  3250. * Note: axis1, axis2 and axis3 are normalized during this operation
  3251. * @param axis1 defines the first axis
  3252. * @param axis2 defines the second axis
  3253. * @param axis3 defines the third axis
  3254. * @returns a new Vector3
  3255. */
  3256. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3257. /**
  3258. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3259. * @param axis1 defines the first axis
  3260. * @param axis2 defines the second axis
  3261. * @param axis3 defines the third axis
  3262. * @param ref defines the Vector3 where to store the result
  3263. */
  3264. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3265. }
  3266. /**
  3267. * Vector4 class created for EulerAngle class conversion to Quaternion
  3268. */
  3269. export class Vector4 {
  3270. /** x value of the vector */
  3271. x: number;
  3272. /** y value of the vector */
  3273. y: number;
  3274. /** z value of the vector */
  3275. z: number;
  3276. /** w value of the vector */
  3277. w: number;
  3278. /**
  3279. * Creates a Vector4 object from the given floats.
  3280. * @param x x value of the vector
  3281. * @param y y value of the vector
  3282. * @param z z value of the vector
  3283. * @param w w value of the vector
  3284. */
  3285. constructor(
  3286. /** x value of the vector */
  3287. x: number,
  3288. /** y value of the vector */
  3289. y: number,
  3290. /** z value of the vector */
  3291. z: number,
  3292. /** w value of the vector */
  3293. w: number);
  3294. /**
  3295. * Returns the string with the Vector4 coordinates.
  3296. * @returns a string containing all the vector values
  3297. */
  3298. toString(): string;
  3299. /**
  3300. * Returns the string "Vector4".
  3301. * @returns "Vector4"
  3302. */
  3303. getClassName(): string;
  3304. /**
  3305. * Returns the Vector4 hash code.
  3306. * @returns a unique hash code
  3307. */
  3308. getHashCode(): number;
  3309. /**
  3310. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3311. * @returns the resulting array
  3312. */
  3313. asArray(): number[];
  3314. /**
  3315. * Populates the given array from the given index with the Vector4 coordinates.
  3316. * @param array array to populate
  3317. * @param index index of the array to start at (default: 0)
  3318. * @returns the Vector4.
  3319. */
  3320. toArray(array: FloatArray, index?: number): Vector4;
  3321. /**
  3322. * Update the current vector from an array
  3323. * @param array defines the destination array
  3324. * @param index defines the offset in the destination array
  3325. * @returns the current Vector3
  3326. */
  3327. fromArray(array: FloatArray, index?: number): Vector4;
  3328. /**
  3329. * Adds the given vector to the current Vector4.
  3330. * @param otherVector the vector to add
  3331. * @returns the updated Vector4.
  3332. */
  3333. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3336. * @param otherVector the vector to add
  3337. * @returns the resulting vector
  3338. */
  3339. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3342. * @param otherVector the vector to add
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Subtract in place the given vector from the current Vector4.
  3349. * @param otherVector the vector to subtract
  3350. * @returns the updated Vector4.
  3351. */
  3352. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3353. /**
  3354. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3355. * @param otherVector the vector to add
  3356. * @returns the new vector with the result
  3357. */
  3358. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3359. /**
  3360. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3361. * @param otherVector the vector to subtract
  3362. * @param result the vector to store the result
  3363. * @returns the current Vector4.
  3364. */
  3365. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3366. /**
  3367. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3368. */
  3369. /**
  3370. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3371. * @param x value to subtract
  3372. * @param y value to subtract
  3373. * @param z value to subtract
  3374. * @param w value to subtract
  3375. * @returns new vector containing the result
  3376. */
  3377. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3378. /**
  3379. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3380. * @param x value to subtract
  3381. * @param y value to subtract
  3382. * @param z value to subtract
  3383. * @param w value to subtract
  3384. * @param result the vector to store the result in
  3385. * @returns the current Vector4.
  3386. */
  3387. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3388. /**
  3389. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3390. * @returns a new vector with the negated values
  3391. */
  3392. negate(): Vector4;
  3393. /**
  3394. * Negate this vector in place
  3395. * @returns this
  3396. */
  3397. negateInPlace(): Vector4;
  3398. /**
  3399. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3400. * @param result defines the Vector3 object where to store the result
  3401. * @returns the current Vector4
  3402. */
  3403. negateToRef(result: Vector4): Vector4;
  3404. /**
  3405. * Multiplies the current Vector4 coordinates by scale (float).
  3406. * @param scale the number to scale with
  3407. * @returns the updated Vector4.
  3408. */
  3409. scaleInPlace(scale: number): Vector4;
  3410. /**
  3411. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3412. * @param scale the number to scale with
  3413. * @returns a new vector with the result
  3414. */
  3415. scale(scale: number): Vector4;
  3416. /**
  3417. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3418. * @param scale the number to scale with
  3419. * @param result a vector to store the result in
  3420. * @returns the current Vector4.
  3421. */
  3422. scaleToRef(scale: number, result: Vector4): Vector4;
  3423. /**
  3424. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3425. * @param scale defines the scale factor
  3426. * @param result defines the Vector4 object where to store the result
  3427. * @returns the unmodified current Vector4
  3428. */
  3429. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3430. /**
  3431. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3432. * @param otherVector the vector to compare against
  3433. * @returns true if they are equal
  3434. */
  3435. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3436. /**
  3437. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3438. * @param otherVector vector to compare against
  3439. * @param epsilon (Default: very small number)
  3440. * @returns true if they are equal
  3441. */
  3442. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3443. /**
  3444. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3445. * @param x x value to compare against
  3446. * @param y y value to compare against
  3447. * @param z z value to compare against
  3448. * @param w w value to compare against
  3449. * @returns true if equal
  3450. */
  3451. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3452. /**
  3453. * Multiplies in place the current Vector4 by the given one.
  3454. * @param otherVector vector to multiple with
  3455. * @returns the updated Vector4.
  3456. */
  3457. multiplyInPlace(otherVector: Vector4): Vector4;
  3458. /**
  3459. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3460. * @param otherVector vector to multiple with
  3461. * @returns resulting new vector
  3462. */
  3463. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3464. /**
  3465. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3466. * @param otherVector vector to multiple with
  3467. * @param result vector to store the result
  3468. * @returns the current Vector4.
  3469. */
  3470. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3471. /**
  3472. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3473. * @param x x value multiply with
  3474. * @param y y value multiply with
  3475. * @param z z value multiply with
  3476. * @param w w value multiply with
  3477. * @returns resulting new vector
  3478. */
  3479. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3480. /**
  3481. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3482. * @param otherVector vector to devide with
  3483. * @returns resulting new vector
  3484. */
  3485. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3488. * @param otherVector vector to devide with
  3489. * @param result vector to store the result
  3490. * @returns the current Vector4.
  3491. */
  3492. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3493. /**
  3494. * Divides the current Vector3 coordinates by the given ones.
  3495. * @param otherVector vector to devide with
  3496. * @returns the updated Vector3.
  3497. */
  3498. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3499. /**
  3500. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3501. * @param other defines the second operand
  3502. * @returns the current updated Vector4
  3503. */
  3504. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3505. /**
  3506. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3507. * @param other defines the second operand
  3508. * @returns the current updated Vector4
  3509. */
  3510. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3511. /**
  3512. * Gets a new Vector4 from current Vector4 floored values
  3513. * @returns a new Vector4
  3514. */
  3515. floor(): Vector4;
  3516. /**
  3517. * Gets a new Vector4 from current Vector3 floored values
  3518. * @returns a new Vector4
  3519. */
  3520. fract(): Vector4;
  3521. /**
  3522. * Returns the Vector4 length (float).
  3523. * @returns the length
  3524. */
  3525. length(): number;
  3526. /**
  3527. * Returns the Vector4 squared length (float).
  3528. * @returns the length squared
  3529. */
  3530. lengthSquared(): number;
  3531. /**
  3532. * Normalizes in place the Vector4.
  3533. * @returns the updated Vector4.
  3534. */
  3535. normalize(): Vector4;
  3536. /**
  3537. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3538. * @returns this converted to a new vector3
  3539. */
  3540. toVector3(): Vector3;
  3541. /**
  3542. * Returns a new Vector4 copied from the current one.
  3543. * @returns the new cloned vector
  3544. */
  3545. clone(): Vector4;
  3546. /**
  3547. * Updates the current Vector4 with the given one coordinates.
  3548. * @param source the source vector to copy from
  3549. * @returns the updated Vector4.
  3550. */
  3551. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3552. /**
  3553. * Updates the current Vector4 coordinates with the given floats.
  3554. * @param x float to copy from
  3555. * @param y float to copy from
  3556. * @param z float to copy from
  3557. * @param w float to copy from
  3558. * @returns the updated Vector4.
  3559. */
  3560. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3561. /**
  3562. * Updates the current Vector4 coordinates with the given floats.
  3563. * @param x float to set from
  3564. * @param y float to set from
  3565. * @param z float to set from
  3566. * @param w float to set from
  3567. * @returns the updated Vector4.
  3568. */
  3569. set(x: number, y: number, z: number, w: number): Vector4;
  3570. /**
  3571. * Copies the given float to the current Vector3 coordinates
  3572. * @param v defines the x, y, z and w coordinates of the operand
  3573. * @returns the current updated Vector3
  3574. */
  3575. setAll(v: number): Vector4;
  3576. /**
  3577. * Returns a new Vector4 set from the starting index of the given array.
  3578. * @param array the array to pull values from
  3579. * @param offset the offset into the array to start at
  3580. * @returns the new vector
  3581. */
  3582. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3583. /**
  3584. * Updates the given vector "result" from the starting index of the given array.
  3585. * @param array the array to pull values from
  3586. * @param offset the offset into the array to start at
  3587. * @param result the vector to store the result in
  3588. */
  3589. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3590. /**
  3591. * Updates the given vector "result" from the starting index of the given Float32Array.
  3592. * @param array the array to pull values from
  3593. * @param offset the offset into the array to start at
  3594. * @param result the vector to store the result in
  3595. */
  3596. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3597. /**
  3598. * Updates the given vector "result" coordinates from the given floats.
  3599. * @param x float to set from
  3600. * @param y float to set from
  3601. * @param z float to set from
  3602. * @param w float to set from
  3603. * @param result the vector to the floats in
  3604. */
  3605. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3606. /**
  3607. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3608. * @returns the new vector
  3609. */
  3610. static Zero(): Vector4;
  3611. /**
  3612. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3613. * @returns the new vector
  3614. */
  3615. static One(): Vector4;
  3616. /**
  3617. * Returns a new normalized Vector4 from the given one.
  3618. * @param vector the vector to normalize
  3619. * @returns the vector
  3620. */
  3621. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3622. /**
  3623. * Updates the given vector "result" from the normalization of the given one.
  3624. * @param vector the vector to normalize
  3625. * @param result the vector to store the result in
  3626. */
  3627. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3628. /**
  3629. * Returns a vector with the minimum values from the left and right vectors
  3630. * @param left left vector to minimize
  3631. * @param right right vector to minimize
  3632. * @returns a new vector with the minimum of the left and right vector values
  3633. */
  3634. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3635. /**
  3636. * Returns a vector with the maximum values from the left and right vectors
  3637. * @param left left vector to maximize
  3638. * @param right right vector to maximize
  3639. * @returns a new vector with the maximum of the left and right vector values
  3640. */
  3641. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3642. /**
  3643. * Returns the distance (float) between the vectors "value1" and "value2".
  3644. * @param value1 value to calulate the distance between
  3645. * @param value2 value to calulate the distance between
  3646. * @return the distance between the two vectors
  3647. */
  3648. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3649. /**
  3650. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3651. * @param value1 value to calulate the distance between
  3652. * @param value2 value to calulate the distance between
  3653. * @return the distance between the two vectors squared
  3654. */
  3655. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3656. /**
  3657. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3658. * @param value1 value to calulate the center between
  3659. * @param value2 value to calulate the center between
  3660. * @return the center between the two vectors
  3661. */
  3662. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3663. /**
  3664. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3665. * This methods computes transformed normalized direction vectors only.
  3666. * @param vector the vector to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @returns the new vector
  3669. */
  3670. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3671. /**
  3672. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3673. * This methods computes transformed normalized direction vectors only.
  3674. * @param vector the vector to transform
  3675. * @param transformation the transformation matrix to apply
  3676. * @param result the vector to store the result in
  3677. */
  3678. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3679. /**
  3680. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3681. * This methods computes transformed normalized direction vectors only.
  3682. * @param x value to transform
  3683. * @param y value to transform
  3684. * @param z value to transform
  3685. * @param w value to transform
  3686. * @param transformation the transformation matrix to apply
  3687. * @param result the vector to store the results in
  3688. */
  3689. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3690. /**
  3691. * Creates a new Vector4 from a Vector3
  3692. * @param source defines the source data
  3693. * @param w defines the 4th component (default is 0)
  3694. * @returns a new Vector4
  3695. */
  3696. static FromVector3(source: Vector3, w?: number): Vector4;
  3697. }
  3698. /**
  3699. * Class used to store quaternion data
  3700. * @see https://en.wikipedia.org/wiki/Quaternion
  3701. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3702. */
  3703. export class Quaternion {
  3704. /** @hidden */
  3705. _x: number;
  3706. /** @hidden */
  3707. _y: number;
  3708. /** @hidden */
  3709. _z: number;
  3710. /** @hidden */
  3711. _w: number;
  3712. /** @hidden */
  3713. _isDirty: boolean;
  3714. /** Gets or sets the x coordinate */
  3715. get x(): number;
  3716. set x(value: number);
  3717. /** Gets or sets the y coordinate */
  3718. get y(): number;
  3719. set y(value: number);
  3720. /** Gets or sets the z coordinate */
  3721. get z(): number;
  3722. set z(value: number);
  3723. /** Gets or sets the w coordinate */
  3724. get w(): number;
  3725. set w(value: number);
  3726. /**
  3727. * Creates a new Quaternion from the given floats
  3728. * @param x defines the first component (0 by default)
  3729. * @param y defines the second component (0 by default)
  3730. * @param z defines the third component (0 by default)
  3731. * @param w defines the fourth component (1.0 by default)
  3732. */
  3733. constructor(x?: number, y?: number, z?: number, w?: number);
  3734. /**
  3735. * Gets a string representation for the current quaternion
  3736. * @returns a string with the Quaternion coordinates
  3737. */
  3738. toString(): string;
  3739. /**
  3740. * Gets the class name of the quaternion
  3741. * @returns the string "Quaternion"
  3742. */
  3743. getClassName(): string;
  3744. /**
  3745. * Gets a hash code for this quaternion
  3746. * @returns the quaternion hash code
  3747. */
  3748. getHashCode(): number;
  3749. /**
  3750. * Copy the quaternion to an array
  3751. * @returns a new array populated with 4 elements from the quaternion coordinates
  3752. */
  3753. asArray(): number[];
  3754. /**
  3755. * Check if two quaternions are equals
  3756. * @param otherQuaternion defines the second operand
  3757. * @return true if the current quaternion and the given one coordinates are strictly equals
  3758. */
  3759. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3760. /**
  3761. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3762. * @param otherQuaternion defines the other quaternion
  3763. * @param epsilon defines the minimal distance to consider equality
  3764. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3765. */
  3766. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3767. /**
  3768. * Clone the current quaternion
  3769. * @returns a new quaternion copied from the current one
  3770. */
  3771. clone(): Quaternion;
  3772. /**
  3773. * Copy a quaternion to the current one
  3774. * @param other defines the other quaternion
  3775. * @returns the updated current quaternion
  3776. */
  3777. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3778. /**
  3779. * Updates the current quaternion with the given float coordinates
  3780. * @param x defines the x coordinate
  3781. * @param y defines the y coordinate
  3782. * @param z defines the z coordinate
  3783. * @param w defines the w coordinate
  3784. * @returns the updated current quaternion
  3785. */
  3786. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3787. /**
  3788. * Updates the current quaternion from the given float coordinates
  3789. * @param x defines the x coordinate
  3790. * @param y defines the y coordinate
  3791. * @param z defines the z coordinate
  3792. * @param w defines the w coordinate
  3793. * @returns the updated current quaternion
  3794. */
  3795. set(x: number, y: number, z: number, w: number): Quaternion;
  3796. /**
  3797. * Adds two quaternions
  3798. * @param other defines the second operand
  3799. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3800. */
  3801. add(other: DeepImmutable<Quaternion>): Quaternion;
  3802. /**
  3803. * Add a quaternion to the current one
  3804. * @param other defines the quaternion to add
  3805. * @returns the current quaternion
  3806. */
  3807. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3808. /**
  3809. * Subtract two quaternions
  3810. * @param other defines the second operand
  3811. * @returns a new quaternion as the subtraction result of the given one from the current one
  3812. */
  3813. subtract(other: Quaternion): Quaternion;
  3814. /**
  3815. * Multiplies the current quaternion by a scale factor
  3816. * @param value defines the scale factor
  3817. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3818. */
  3819. scale(value: number): Quaternion;
  3820. /**
  3821. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3822. * @param scale defines the scale factor
  3823. * @param result defines the Quaternion object where to store the result
  3824. * @returns the unmodified current quaternion
  3825. */
  3826. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3827. /**
  3828. * Multiplies in place the current quaternion by a scale factor
  3829. * @param value defines the scale factor
  3830. * @returns the current modified quaternion
  3831. */
  3832. scaleInPlace(value: number): Quaternion;
  3833. /**
  3834. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3835. * @param scale defines the scale factor
  3836. * @param result defines the Quaternion object where to store the result
  3837. * @returns the unmodified current quaternion
  3838. */
  3839. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3840. /**
  3841. * Multiplies two quaternions
  3842. * @param q1 defines the second operand
  3843. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3844. */
  3845. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3846. /**
  3847. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3848. * @param q1 defines the second operand
  3849. * @param result defines the target quaternion
  3850. * @returns the current quaternion
  3851. */
  3852. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3853. /**
  3854. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3855. * @param q1 defines the second operand
  3856. * @returns the currentupdated quaternion
  3857. */
  3858. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3859. /**
  3860. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3861. * @param ref defines the target quaternion
  3862. * @returns the current quaternion
  3863. */
  3864. conjugateToRef(ref: Quaternion): Quaternion;
  3865. /**
  3866. * Conjugates in place (1-q) the current quaternion
  3867. * @returns the current updated quaternion
  3868. */
  3869. conjugateInPlace(): Quaternion;
  3870. /**
  3871. * Conjugates in place (1-q) the current quaternion
  3872. * @returns a new quaternion
  3873. */
  3874. conjugate(): Quaternion;
  3875. /**
  3876. * Gets length of current quaternion
  3877. * @returns the quaternion length (float)
  3878. */
  3879. length(): number;
  3880. /**
  3881. * Normalize in place the current quaternion
  3882. * @returns the current updated quaternion
  3883. */
  3884. normalize(): Quaternion;
  3885. /**
  3886. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3887. * @param order is a reserved parameter and is ignored for now
  3888. * @returns a new Vector3 containing the Euler angles
  3889. */
  3890. toEulerAngles(order?: string): Vector3;
  3891. /**
  3892. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3893. * @param result defines the vector which will be filled with the Euler angles
  3894. * @returns the current unchanged quaternion
  3895. */
  3896. toEulerAnglesToRef(result: Vector3): Quaternion;
  3897. /**
  3898. * Updates the given rotation matrix with the current quaternion values
  3899. * @param result defines the target matrix
  3900. * @returns the current unchanged quaternion
  3901. */
  3902. toRotationMatrix(result: Matrix): Quaternion;
  3903. /**
  3904. * Updates the current quaternion from the given rotation matrix values
  3905. * @param matrix defines the source matrix
  3906. * @returns the current updated quaternion
  3907. */
  3908. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3909. /**
  3910. * Creates a new quaternion from a rotation matrix
  3911. * @param matrix defines the source matrix
  3912. * @returns a new quaternion created from the given rotation matrix values
  3913. */
  3914. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3915. /**
  3916. * Updates the given quaternion with the given rotation matrix values
  3917. * @param matrix defines the source matrix
  3918. * @param result defines the target quaternion
  3919. */
  3920. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3921. /**
  3922. * Returns the dot product (float) between the quaternions "left" and "right"
  3923. * @param left defines the left operand
  3924. * @param right defines the right operand
  3925. * @returns the dot product
  3926. */
  3927. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3928. /**
  3929. * Checks if the two quaternions are close to each other
  3930. * @param quat0 defines the first quaternion to check
  3931. * @param quat1 defines the second quaternion to check
  3932. * @returns true if the two quaternions are close to each other
  3933. */
  3934. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3935. /**
  3936. * Creates an empty quaternion
  3937. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3938. */
  3939. static Zero(): Quaternion;
  3940. /**
  3941. * Inverse a given quaternion
  3942. * @param q defines the source quaternion
  3943. * @returns a new quaternion as the inverted current quaternion
  3944. */
  3945. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3946. /**
  3947. * Inverse a given quaternion
  3948. * @param q defines the source quaternion
  3949. * @param result the quaternion the result will be stored in
  3950. * @returns the result quaternion
  3951. */
  3952. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3953. /**
  3954. * Creates an identity quaternion
  3955. * @returns the identity quaternion
  3956. */
  3957. static Identity(): Quaternion;
  3958. /**
  3959. * Gets a boolean indicating if the given quaternion is identity
  3960. * @param quaternion defines the quaternion to check
  3961. * @returns true if the quaternion is identity
  3962. */
  3963. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3964. /**
  3965. * Creates a quaternion from a rotation around an axis
  3966. * @param axis defines the axis to use
  3967. * @param angle defines the angle to use
  3968. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3969. */
  3970. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3971. /**
  3972. * Creates a rotation around an axis and stores it into the given quaternion
  3973. * @param axis defines the axis to use
  3974. * @param angle defines the angle to use
  3975. * @param result defines the target quaternion
  3976. * @returns the target quaternion
  3977. */
  3978. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3979. /**
  3980. * Creates a new quaternion from data stored into an array
  3981. * @param array defines the data source
  3982. * @param offset defines the offset in the source array where the data starts
  3983. * @returns a new quaternion
  3984. */
  3985. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3986. /**
  3987. * Updates the given quaternion "result" from the starting index of the given array.
  3988. * @param array the array to pull values from
  3989. * @param offset the offset into the array to start at
  3990. * @param result the quaternion to store the result in
  3991. */
  3992. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3993. /**
  3994. * Create a quaternion from Euler rotation angles
  3995. * @param x Pitch
  3996. * @param y Yaw
  3997. * @param z Roll
  3998. * @returns the new Quaternion
  3999. */
  4000. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  4001. /**
  4002. * Updates a quaternion from Euler rotation angles
  4003. * @param x Pitch
  4004. * @param y Yaw
  4005. * @param z Roll
  4006. * @param result the quaternion to store the result
  4007. * @returns the updated quaternion
  4008. */
  4009. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  4010. /**
  4011. * Create a quaternion from Euler rotation vector
  4012. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4013. * @returns the new Quaternion
  4014. */
  4015. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  4016. /**
  4017. * Updates a quaternion from Euler rotation vector
  4018. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4019. * @param result the quaternion to store the result
  4020. * @returns the updated quaternion
  4021. */
  4022. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4023. /**
  4024. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4025. * @param yaw defines the rotation around Y axis
  4026. * @param pitch defines the rotation around X axis
  4027. * @param roll defines the rotation around Z axis
  4028. * @returns the new quaternion
  4029. */
  4030. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4031. /**
  4032. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4033. * @param yaw defines the rotation around Y axis
  4034. * @param pitch defines the rotation around X axis
  4035. * @param roll defines the rotation around Z axis
  4036. * @param result defines the target quaternion
  4037. */
  4038. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4039. /**
  4040. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4041. * @param alpha defines the rotation around first axis
  4042. * @param beta defines the rotation around second axis
  4043. * @param gamma defines the rotation around third axis
  4044. * @returns the new quaternion
  4045. */
  4046. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4047. /**
  4048. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4049. * @param alpha defines the rotation around first axis
  4050. * @param beta defines the rotation around second axis
  4051. * @param gamma defines the rotation around third axis
  4052. * @param result defines the target quaternion
  4053. */
  4054. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4055. /**
  4056. * 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)
  4057. * @param axis1 defines the first axis
  4058. * @param axis2 defines the second axis
  4059. * @param axis3 defines the third axis
  4060. * @returns the new quaternion
  4061. */
  4062. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4063. /**
  4064. * 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
  4065. * @param axis1 defines the first axis
  4066. * @param axis2 defines the second axis
  4067. * @param axis3 defines the third axis
  4068. * @param ref defines the target quaternion
  4069. */
  4070. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4071. /**
  4072. * Interpolates between two quaternions
  4073. * @param left defines first quaternion
  4074. * @param right defines second quaternion
  4075. * @param amount defines the gradient to use
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. /**
  4080. * Interpolates between two quaternions and stores it into a target quaternion
  4081. * @param left defines first quaternion
  4082. * @param right defines second quaternion
  4083. * @param amount defines the gradient to use
  4084. * @param result defines the target quaternion
  4085. */
  4086. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4087. /**
  4088. * Interpolate between two quaternions using Hermite interpolation
  4089. * @param value1 defines first quaternion
  4090. * @param tangent1 defines the incoming tangent
  4091. * @param value2 defines second quaternion
  4092. * @param tangent2 defines the outgoing tangent
  4093. * @param amount defines the target quaternion
  4094. * @returns the new interpolated quaternion
  4095. */
  4096. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4097. }
  4098. /**
  4099. * Class used to store matrix data (4x4)
  4100. */
  4101. export class Matrix {
  4102. /**
  4103. * Gets the precision of matrix computations
  4104. */
  4105. static get Use64Bits(): boolean;
  4106. private static _updateFlagSeed;
  4107. private static _identityReadOnly;
  4108. private _isIdentity;
  4109. private _isIdentityDirty;
  4110. private _isIdentity3x2;
  4111. private _isIdentity3x2Dirty;
  4112. /**
  4113. * Gets the update flag of the matrix which is an unique number for the matrix.
  4114. * It will be incremented every time the matrix data change.
  4115. * You can use it to speed the comparison between two versions of the same matrix.
  4116. */
  4117. updateFlag: number;
  4118. private readonly _m;
  4119. /**
  4120. * Gets the internal data of the matrix
  4121. */
  4122. get m(): DeepImmutable<Float32Array | Array<number>>;
  4123. /** @hidden */
  4124. _markAsUpdated(): void;
  4125. /** @hidden */
  4126. private _updateIdentityStatus;
  4127. /**
  4128. * Creates an empty matrix (filled with zeros)
  4129. */
  4130. constructor();
  4131. /**
  4132. * Check if the current matrix is identity
  4133. * @returns true is the matrix is the identity matrix
  4134. */
  4135. isIdentity(): boolean;
  4136. /**
  4137. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4138. * @returns true is the matrix is the identity matrix
  4139. */
  4140. isIdentityAs3x2(): boolean;
  4141. /**
  4142. * Gets the determinant of the matrix
  4143. * @returns the matrix determinant
  4144. */
  4145. determinant(): number;
  4146. /**
  4147. * Returns the matrix as a Float32Array or Array<number>
  4148. * @returns the matrix underlying array
  4149. */
  4150. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4151. /**
  4152. * Returns the matrix as a Float32Array or Array<number>
  4153. * @returns the matrix underlying array.
  4154. */
  4155. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4156. /**
  4157. * Inverts the current matrix in place
  4158. * @returns the current inverted matrix
  4159. */
  4160. invert(): Matrix;
  4161. /**
  4162. * Sets all the matrix elements to zero
  4163. * @returns the current matrix
  4164. */
  4165. reset(): Matrix;
  4166. /**
  4167. * Adds the current matrix with a second one
  4168. * @param other defines the matrix to add
  4169. * @returns a new matrix as the addition of the current matrix and the given one
  4170. */
  4171. add(other: DeepImmutable<Matrix>): Matrix;
  4172. /**
  4173. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4174. * @param other defines the matrix to add
  4175. * @param result defines the target matrix
  4176. * @returns the current matrix
  4177. */
  4178. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4179. /**
  4180. * Adds in place the given matrix to the current matrix
  4181. * @param other defines the second operand
  4182. * @returns the current updated matrix
  4183. */
  4184. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4185. /**
  4186. * Sets the given matrix to the current inverted Matrix
  4187. * @param other defines the target matrix
  4188. * @returns the unmodified current matrix
  4189. */
  4190. invertToRef(other: Matrix): Matrix;
  4191. /**
  4192. * add a value at the specified position in the current Matrix
  4193. * @param index the index of the value within the matrix. between 0 and 15.
  4194. * @param value the value to be added
  4195. * @returns the current updated matrix
  4196. */
  4197. addAtIndex(index: number, value: number): Matrix;
  4198. /**
  4199. * mutiply the specified position in the current Matrix by a value
  4200. * @param index the index of the value within the matrix. between 0 and 15.
  4201. * @param value the value to be added
  4202. * @returns the current updated matrix
  4203. */
  4204. multiplyAtIndex(index: number, value: number): Matrix;
  4205. /**
  4206. * Inserts the translation vector (using 3 floats) in the current matrix
  4207. * @param x defines the 1st component of the translation
  4208. * @param y defines the 2nd component of the translation
  4209. * @param z defines the 3rd component of the translation
  4210. * @returns the current updated matrix
  4211. */
  4212. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4213. /**
  4214. * Adds the translation vector (using 3 floats) in the current matrix
  4215. * @param x defines the 1st component of the translation
  4216. * @param y defines the 2nd component of the translation
  4217. * @param z defines the 3rd component of the translation
  4218. * @returns the current updated matrix
  4219. */
  4220. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4221. /**
  4222. * Inserts the translation vector in the current matrix
  4223. * @param vector3 defines the translation to insert
  4224. * @returns the current updated matrix
  4225. */
  4226. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4227. /**
  4228. * Gets the translation value of the current matrix
  4229. * @returns a new Vector3 as the extracted translation from the matrix
  4230. */
  4231. getTranslation(): Vector3;
  4232. /**
  4233. * Fill a Vector3 with the extracted translation from the matrix
  4234. * @param result defines the Vector3 where to store the translation
  4235. * @returns the current matrix
  4236. */
  4237. getTranslationToRef(result: Vector3): Matrix;
  4238. /**
  4239. * Remove rotation and scaling part from the matrix
  4240. * @returns the updated matrix
  4241. */
  4242. removeRotationAndScaling(): Matrix;
  4243. /**
  4244. * Multiply two matrices
  4245. * @param other defines the second operand
  4246. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4247. */
  4248. multiply(other: DeepImmutable<Matrix>): Matrix;
  4249. /**
  4250. * Copy the current matrix from the given one
  4251. * @param other defines the source matrix
  4252. * @returns the current updated matrix
  4253. */
  4254. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4255. /**
  4256. * Populates the given array from the starting index with the current matrix values
  4257. * @param array defines the target array
  4258. * @param offset defines the offset in the target array where to start storing values
  4259. * @returns the current matrix
  4260. */
  4261. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4262. /**
  4263. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4264. * @param other defines the second operand
  4265. * @param result defines the matrix where to store the multiplication
  4266. * @returns the current matrix
  4267. */
  4268. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4269. /**
  4270. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4271. * @param other defines the second operand
  4272. * @param result defines the array where to store the multiplication
  4273. * @param offset defines the offset in the target array where to start storing values
  4274. * @returns the current matrix
  4275. */
  4276. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4277. /**
  4278. * Check equality between this matrix and a second one
  4279. * @param value defines the second matrix to compare
  4280. * @returns true is the current matrix and the given one values are strictly equal
  4281. */
  4282. equals(value: DeepImmutable<Matrix>): boolean;
  4283. /**
  4284. * Clone the current matrix
  4285. * @returns a new matrix from the current matrix
  4286. */
  4287. clone(): Matrix;
  4288. /**
  4289. * Returns the name of the current matrix class
  4290. * @returns the string "Matrix"
  4291. */
  4292. getClassName(): string;
  4293. /**
  4294. * Gets the hash code of the current matrix
  4295. * @returns the hash code
  4296. */
  4297. getHashCode(): number;
  4298. /**
  4299. * Decomposes the current Matrix into a translation, rotation and scaling components
  4300. * @param scale defines the scale vector3 given as a reference to update
  4301. * @param rotation defines the rotation quaternion given as a reference to update
  4302. * @param translation defines the translation vector3 given as a reference to update
  4303. * @returns true if operation was successful
  4304. */
  4305. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4306. /**
  4307. * Gets specific row of the matrix
  4308. * @param index defines the number of the row to get
  4309. * @returns the index-th row of the current matrix as a new Vector4
  4310. */
  4311. getRow(index: number): Nullable<Vector4>;
  4312. /**
  4313. * Sets the index-th row of the current matrix to the vector4 values
  4314. * @param index defines the number of the row to set
  4315. * @param row defines the target vector4
  4316. * @returns the updated current matrix
  4317. */
  4318. setRow(index: number, row: Vector4): Matrix;
  4319. /**
  4320. * Compute the transpose of the matrix
  4321. * @returns the new transposed matrix
  4322. */
  4323. transpose(): Matrix;
  4324. /**
  4325. * Compute the transpose of the matrix and store it in a given matrix
  4326. * @param result defines the target matrix
  4327. * @returns the current matrix
  4328. */
  4329. transposeToRef(result: Matrix): Matrix;
  4330. /**
  4331. * Sets the index-th row of the current matrix with the given 4 x float values
  4332. * @param index defines the row index
  4333. * @param x defines the x component to set
  4334. * @param y defines the y component to set
  4335. * @param z defines the z component to set
  4336. * @param w defines the w component to set
  4337. * @returns the updated current matrix
  4338. */
  4339. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4340. /**
  4341. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4342. * @param scale defines the scale factor
  4343. * @returns a new matrix
  4344. */
  4345. scale(scale: number): Matrix;
  4346. /**
  4347. * Scale the current matrix values by a factor to a given result matrix
  4348. * @param scale defines the scale factor
  4349. * @param result defines the matrix to store the result
  4350. * @returns the current matrix
  4351. */
  4352. scaleToRef(scale: number, result: Matrix): Matrix;
  4353. /**
  4354. * Scale the current matrix values by a factor and add the result to a given matrix
  4355. * @param scale defines the scale factor
  4356. * @param result defines the Matrix to store the result
  4357. * @returns the current matrix
  4358. */
  4359. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4360. /**
  4361. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4362. * @param ref matrix to store the result
  4363. */
  4364. toNormalMatrix(ref: Matrix): void;
  4365. /**
  4366. * Gets only rotation part of the current matrix
  4367. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4368. */
  4369. getRotationMatrix(): Matrix;
  4370. /**
  4371. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4372. * @param result defines the target matrix to store data to
  4373. * @returns the current matrix
  4374. */
  4375. getRotationMatrixToRef(result: Matrix): Matrix;
  4376. /**
  4377. * Toggles model matrix from being right handed to left handed in place and vice versa
  4378. */
  4379. toggleModelMatrixHandInPlace(): void;
  4380. /**
  4381. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4382. */
  4383. toggleProjectionMatrixHandInPlace(): void;
  4384. /**
  4385. * Creates a matrix from an array
  4386. * @param array defines the source array
  4387. * @param offset defines an offset in the source array
  4388. * @returns a new Matrix set from the starting index of the given array
  4389. */
  4390. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4391. /**
  4392. * Copy the content of an array into a given matrix
  4393. * @param array defines the source array
  4394. * @param offset defines an offset in the source array
  4395. * @param result defines the target matrix
  4396. */
  4397. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4398. /**
  4399. * Stores an array into a matrix after having multiplied each component by a given factor
  4400. * @param array defines the source array
  4401. * @param offset defines the offset in the source array
  4402. * @param scale defines the scaling factor
  4403. * @param result defines the target matrix
  4404. */
  4405. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4406. /**
  4407. * Gets an identity matrix that must not be updated
  4408. */
  4409. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4410. /**
  4411. * Stores a list of values (16) inside a given matrix
  4412. * @param initialM11 defines 1st value of 1st row
  4413. * @param initialM12 defines 2nd value of 1st row
  4414. * @param initialM13 defines 3rd value of 1st row
  4415. * @param initialM14 defines 4th value of 1st row
  4416. * @param initialM21 defines 1st value of 2nd row
  4417. * @param initialM22 defines 2nd value of 2nd row
  4418. * @param initialM23 defines 3rd value of 2nd row
  4419. * @param initialM24 defines 4th value of 2nd row
  4420. * @param initialM31 defines 1st value of 3rd row
  4421. * @param initialM32 defines 2nd value of 3rd row
  4422. * @param initialM33 defines 3rd value of 3rd row
  4423. * @param initialM34 defines 4th value of 3rd row
  4424. * @param initialM41 defines 1st value of 4th row
  4425. * @param initialM42 defines 2nd value of 4th row
  4426. * @param initialM43 defines 3rd value of 4th row
  4427. * @param initialM44 defines 4th value of 4th row
  4428. * @param result defines the target matrix
  4429. */
  4430. 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;
  4431. /**
  4432. * Creates new matrix from a list of values (16)
  4433. * @param initialM11 defines 1st value of 1st row
  4434. * @param initialM12 defines 2nd value of 1st row
  4435. * @param initialM13 defines 3rd value of 1st row
  4436. * @param initialM14 defines 4th value of 1st row
  4437. * @param initialM21 defines 1st value of 2nd row
  4438. * @param initialM22 defines 2nd value of 2nd row
  4439. * @param initialM23 defines 3rd value of 2nd row
  4440. * @param initialM24 defines 4th value of 2nd row
  4441. * @param initialM31 defines 1st value of 3rd row
  4442. * @param initialM32 defines 2nd value of 3rd row
  4443. * @param initialM33 defines 3rd value of 3rd row
  4444. * @param initialM34 defines 4th value of 3rd row
  4445. * @param initialM41 defines 1st value of 4th row
  4446. * @param initialM42 defines 2nd value of 4th row
  4447. * @param initialM43 defines 3rd value of 4th row
  4448. * @param initialM44 defines 4th value of 4th row
  4449. * @returns the new matrix
  4450. */
  4451. 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;
  4452. /**
  4453. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4454. * @param scale defines the scale vector3
  4455. * @param rotation defines the rotation quaternion
  4456. * @param translation defines the translation vector3
  4457. * @returns a new matrix
  4458. */
  4459. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4460. /**
  4461. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4462. * @param scale defines the scale vector3
  4463. * @param rotation defines the rotation quaternion
  4464. * @param translation defines the translation vector3
  4465. * @param result defines the target matrix
  4466. */
  4467. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4468. /**
  4469. * Creates a new identity matrix
  4470. * @returns a new identity matrix
  4471. */
  4472. static Identity(): Matrix;
  4473. /**
  4474. * Creates a new identity matrix and stores the result in a given matrix
  4475. * @param result defines the target matrix
  4476. */
  4477. static IdentityToRef(result: Matrix): void;
  4478. /**
  4479. * Creates a new zero matrix
  4480. * @returns a new zero matrix
  4481. */
  4482. static Zero(): Matrix;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the X axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationX(angle: number): Matrix;
  4489. /**
  4490. * Creates a new matrix as the invert of a given matrix
  4491. * @param source defines the source matrix
  4492. * @returns the new matrix
  4493. */
  4494. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4497. * @param angle defines the angle (in radians) to use
  4498. * @param result defines the target matrix
  4499. */
  4500. static RotationXToRef(angle: number, result: Matrix): void;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Y axis
  4503. * @param angle defines the angle (in radians) to use
  4504. * @return the new matrix
  4505. */
  4506. static RotationY(angle: number): Matrix;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4509. * @param angle defines the angle (in radians) to use
  4510. * @param result defines the target matrix
  4511. */
  4512. static RotationYToRef(angle: number, result: Matrix): void;
  4513. /**
  4514. * Creates a new rotation matrix for "angle" radians around the Z axis
  4515. * @param angle defines the angle (in radians) to use
  4516. * @return the new matrix
  4517. */
  4518. static RotationZ(angle: number): Matrix;
  4519. /**
  4520. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4521. * @param angle defines the angle (in radians) to use
  4522. * @param result defines the target matrix
  4523. */
  4524. static RotationZToRef(angle: number, result: Matrix): void;
  4525. /**
  4526. * Creates a new rotation matrix for "angle" radians around the given axis
  4527. * @param axis defines the axis to use
  4528. * @param angle defines the angle (in radians) to use
  4529. * @return the new matrix
  4530. */
  4531. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4532. /**
  4533. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4534. * @param axis defines the axis to use
  4535. * @param angle defines the angle (in radians) to use
  4536. * @param result defines the target matrix
  4537. */
  4538. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4539. /**
  4540. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4541. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4542. * @param from defines the vector to align
  4543. * @param to defines the vector to align to
  4544. * @param result defines the target matrix
  4545. */
  4546. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4547. /**
  4548. * Creates a rotation matrix
  4549. * @param yaw defines the yaw angle in radians (Y axis)
  4550. * @param pitch defines the pitch angle in radians (X axis)
  4551. * @param roll defines the roll angle in radians (Z axis)
  4552. * @returns the new rotation matrix
  4553. */
  4554. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4555. /**
  4556. * Creates a rotation matrix and stores it in a given matrix
  4557. * @param yaw defines the yaw angle in radians (Y axis)
  4558. * @param pitch defines the pitch angle in radians (X axis)
  4559. * @param roll defines the roll angle in radians (Z axis)
  4560. * @param result defines the target matrix
  4561. */
  4562. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4563. /**
  4564. * Creates a scaling matrix
  4565. * @param x defines the scale factor on X axis
  4566. * @param y defines the scale factor on Y axis
  4567. * @param z defines the scale factor on Z axis
  4568. * @returns the new matrix
  4569. */
  4570. static Scaling(x: number, y: number, z: number): Matrix;
  4571. /**
  4572. * Creates a scaling matrix and stores it in a given matrix
  4573. * @param x defines the scale factor on X axis
  4574. * @param y defines the scale factor on Y axis
  4575. * @param z defines the scale factor on Z axis
  4576. * @param result defines the target matrix
  4577. */
  4578. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4579. /**
  4580. * Creates a translation matrix
  4581. * @param x defines the translation on X axis
  4582. * @param y defines the translation on Y axis
  4583. * @param z defines the translationon Z axis
  4584. * @returns the new matrix
  4585. */
  4586. static Translation(x: number, y: number, z: number): Matrix;
  4587. /**
  4588. * Creates a translation matrix and stores it in a given matrix
  4589. * @param x defines the translation on X axis
  4590. * @param y defines the translation on Y axis
  4591. * @param z defines the translationon Z axis
  4592. * @param result defines the target matrix
  4593. */
  4594. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4595. /**
  4596. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4597. * @param startValue defines the start value
  4598. * @param endValue defines the end value
  4599. * @param gradient defines the gradient factor
  4600. * @returns the new matrix
  4601. */
  4602. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4603. /**
  4604. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4605. * @param startValue defines the start value
  4606. * @param endValue defines the end value
  4607. * @param gradient defines the gradient factor
  4608. * @param result defines the Matrix object where to store data
  4609. */
  4610. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4611. /**
  4612. * Builds a new matrix whose values are computed by:
  4613. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4614. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4615. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4616. * @param startValue defines the first matrix
  4617. * @param endValue defines the second matrix
  4618. * @param gradient defines the gradient between the two matrices
  4619. * @returns the new matrix
  4620. */
  4621. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4622. /**
  4623. * Update a matrix to values which are computed by:
  4624. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4625. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4626. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4627. * @param startValue defines the first matrix
  4628. * @param endValue defines the second matrix
  4629. * @param gradient defines the gradient between the two matrices
  4630. * @param result defines the target matrix
  4631. */
  4632. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, 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 left 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 LookAtLH(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 left 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 LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * 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"
  4653. * This function works in right handed mode
  4654. * @param eye defines the final position of the entity
  4655. * @param target defines where the entity should look at
  4656. * @param up defines the up vector for the entity
  4657. * @returns the new matrix
  4658. */
  4659. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4660. /**
  4661. * 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".
  4662. * This function works in right handed mode
  4663. * @param eye defines the final position of the entity
  4664. * @param target defines where the entity should look at
  4665. * @param up defines the up vector for the entity
  4666. * @param result defines the target matrix
  4667. */
  4668. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param width defines the viewport width
  4672. * @param height defines the viewport height
  4673. * @param znear defines the near clip plane
  4674. * @param zfar defines the far clip plane
  4675. * @returns a new matrix as a left-handed orthographic projection matrix
  4676. */
  4677. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4678. /**
  4679. * Store a left-handed orthographic projection to a given matrix
  4680. * @param width defines the viewport width
  4681. * @param height defines the viewport height
  4682. * @param znear defines the near clip plane
  4683. * @param zfar defines the far clip plane
  4684. * @param result defines the target matrix
  4685. */
  4686. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4687. /**
  4688. * Create a left-handed orthographic projection matrix
  4689. * @param left defines the viewport left coordinate
  4690. * @param right defines the viewport right coordinate
  4691. * @param bottom defines the viewport bottom coordinate
  4692. * @param top defines the viewport top coordinate
  4693. * @param znear defines the near clip plane
  4694. * @param zfar defines the far clip plane
  4695. * @returns a new matrix as a left-handed orthographic projection matrix
  4696. */
  4697. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4698. /**
  4699. * Stores a left-handed orthographic projection into a given matrix
  4700. * @param left defines the viewport left coordinate
  4701. * @param right defines the viewport right coordinate
  4702. * @param bottom defines the viewport bottom coordinate
  4703. * @param top defines the viewport top coordinate
  4704. * @param znear defines the near clip plane
  4705. * @param zfar defines the far clip plane
  4706. * @param result defines the target matrix
  4707. */
  4708. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4709. /**
  4710. * Creates a right-handed orthographic projection matrix
  4711. * @param left defines the viewport left coordinate
  4712. * @param right defines the viewport right coordinate
  4713. * @param bottom defines the viewport bottom coordinate
  4714. * @param top defines the viewport top coordinate
  4715. * @param znear defines the near clip plane
  4716. * @param zfar defines the far clip plane
  4717. * @returns a new matrix as a right-handed orthographic projection matrix
  4718. */
  4719. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4720. /**
  4721. * Stores a right-handed orthographic projection into a given matrix
  4722. * @param left defines the viewport left coordinate
  4723. * @param right defines the viewport right coordinate
  4724. * @param bottom defines the viewport bottom coordinate
  4725. * @param top defines the viewport top coordinate
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @param result defines the target matrix
  4729. */
  4730. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4731. /**
  4732. * Creates a left-handed perspective projection matrix
  4733. * @param width defines the viewport width
  4734. * @param height defines the viewport height
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @returns a new matrix as a left-handed perspective projection matrix
  4738. */
  4739. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4740. /**
  4741. * Creates a left-handed perspective projection matrix
  4742. * @param fov defines the horizontal field of view
  4743. * @param aspect defines the aspect ratio
  4744. * @param znear defines the near clip plane
  4745. * @param zfar defines the far clip plane
  4746. * @returns a new matrix as a left-handed perspective projection matrix
  4747. */
  4748. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4749. /**
  4750. * Stores a left-handed perspective projection into a given matrix
  4751. * @param fov defines the horizontal field of view
  4752. * @param aspect defines the aspect ratio
  4753. * @param znear defines the near clip plane
  4754. * @param zfar defines the far clip plane
  4755. * @param result defines the target matrix
  4756. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4757. */
  4758. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4759. /**
  4760. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4761. * @param fov defines the horizontal field of view
  4762. * @param aspect defines the aspect ratio
  4763. * @param znear defines the near clip plane
  4764. * @param zfar not used as infinity is used as far clip
  4765. * @param result defines the target matrix
  4766. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4767. */
  4768. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4769. /**
  4770. * Creates a right-handed perspective projection matrix
  4771. * @param fov defines the horizontal field of view
  4772. * @param aspect defines the aspect ratio
  4773. * @param znear defines the near clip plane
  4774. * @param zfar defines the far clip plane
  4775. * @returns a new matrix as a right-handed perspective projection matrix
  4776. */
  4777. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4778. /**
  4779. * Stores a right-handed perspective projection into a given matrix
  4780. * @param fov defines the horizontal field of view
  4781. * @param aspect defines the aspect ratio
  4782. * @param znear defines the near clip plane
  4783. * @param zfar defines the far clip plane
  4784. * @param result defines the target matrix
  4785. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4786. */
  4787. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4788. /**
  4789. * Stores a right-handed perspective projection into a given matrix
  4790. * @param fov defines the horizontal field of view
  4791. * @param aspect defines the aspect ratio
  4792. * @param znear defines the near clip plane
  4793. * @param zfar not used as infinity is used as far clip
  4794. * @param result defines the target matrix
  4795. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4796. */
  4797. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4798. /**
  4799. * Stores a perspective projection for WebVR info a given matrix
  4800. * @param fov defines the field of view
  4801. * @param znear defines the near clip plane
  4802. * @param zfar defines the far clip plane
  4803. * @param result defines the target matrix
  4804. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4805. */
  4806. static PerspectiveFovWebVRToRef(fov: {
  4807. upDegrees: number;
  4808. downDegrees: number;
  4809. leftDegrees: number;
  4810. rightDegrees: number;
  4811. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4812. /**
  4813. * Computes a complete transformation matrix
  4814. * @param viewport defines the viewport to use
  4815. * @param world defines the world matrix
  4816. * @param view defines the view matrix
  4817. * @param projection defines the projection matrix
  4818. * @param zmin defines the near clip plane
  4819. * @param zmax defines the far clip plane
  4820. * @returns the transformation matrix
  4821. */
  4822. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4823. /**
  4824. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4825. * @param matrix defines the matrix to use
  4826. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4827. */
  4828. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4829. /**
  4830. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4831. * @param matrix defines the matrix to use
  4832. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4833. */
  4834. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4835. /**
  4836. * Compute the transpose of a given matrix
  4837. * @param matrix defines the matrix to transpose
  4838. * @returns the new matrix
  4839. */
  4840. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4841. /**
  4842. * Compute the transpose of a matrix and store it in a target matrix
  4843. * @param matrix defines the matrix to transpose
  4844. * @param result defines the target matrix
  4845. */
  4846. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4847. /**
  4848. * Computes a reflection matrix from a plane
  4849. * @param plane defines the reflection plane
  4850. * @returns a new matrix
  4851. */
  4852. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4853. /**
  4854. * Computes a reflection matrix from a plane
  4855. * @param plane defines the reflection plane
  4856. * @param result defines the target matrix
  4857. */
  4858. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4859. /**
  4860. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4861. * @param xaxis defines the value of the 1st axis
  4862. * @param yaxis defines the value of the 2nd axis
  4863. * @param zaxis defines the value of the 3rd axis
  4864. * @param result defines the target matrix
  4865. */
  4866. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4867. /**
  4868. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4869. * @param quat defines the quaternion to use
  4870. * @param result defines the target matrix
  4871. */
  4872. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4873. }
  4874. /**
  4875. * @hidden
  4876. */
  4877. export class TmpVectors {
  4878. static Vector2: Vector2[];
  4879. static Vector3: Vector3[];
  4880. static Vector4: Vector4[];
  4881. static Quaternion: Quaternion[];
  4882. static Matrix: Matrix[];
  4883. }
  4884. }
  4885. declare module "babylonjs/Maths/math.path" {
  4886. import { DeepImmutable, Nullable } from "babylonjs/types";
  4887. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4888. /**
  4889. * Defines potential orientation for back face culling
  4890. */
  4891. export enum Orientation {
  4892. /**
  4893. * Clockwise
  4894. */
  4895. CW = 0,
  4896. /** Counter clockwise */
  4897. CCW = 1
  4898. }
  4899. /** Class used to represent a Bezier curve */
  4900. export class BezierCurve {
  4901. /**
  4902. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4903. * @param t defines the time
  4904. * @param x1 defines the left coordinate on X axis
  4905. * @param y1 defines the left coordinate on Y axis
  4906. * @param x2 defines the right coordinate on X axis
  4907. * @param y2 defines the right coordinate on Y axis
  4908. * @returns the interpolated value
  4909. */
  4910. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4911. }
  4912. /**
  4913. * Defines angle representation
  4914. */
  4915. export class Angle {
  4916. private _radians;
  4917. /**
  4918. * Creates an Angle object of "radians" radians (float).
  4919. * @param radians the angle in radians
  4920. */
  4921. constructor(radians: number);
  4922. /**
  4923. * Get value in degrees
  4924. * @returns the Angle value in degrees (float)
  4925. */
  4926. degrees(): number;
  4927. /**
  4928. * Get value in radians
  4929. * @returns the Angle value in radians (float)
  4930. */
  4931. radians(): number;
  4932. /**
  4933. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4934. * @param a defines first point as the origin
  4935. * @param b defines point
  4936. * @returns a new Angle
  4937. */
  4938. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4939. /**
  4940. * Gets a new Angle object from the given float in radians
  4941. * @param radians defines the angle value in radians
  4942. * @returns a new Angle
  4943. */
  4944. static FromRadians(radians: number): Angle;
  4945. /**
  4946. * Gets a new Angle object from the given float in degrees
  4947. * @param degrees defines the angle value in degrees
  4948. * @returns a new Angle
  4949. */
  4950. static FromDegrees(degrees: number): Angle;
  4951. }
  4952. /**
  4953. * This represents an arc in a 2d space.
  4954. */
  4955. export class Arc2 {
  4956. /** Defines the start point of the arc */
  4957. startPoint: Vector2;
  4958. /** Defines the mid point of the arc */
  4959. midPoint: Vector2;
  4960. /** Defines the end point of the arc */
  4961. endPoint: Vector2;
  4962. /**
  4963. * Defines the center point of the arc.
  4964. */
  4965. centerPoint: Vector2;
  4966. /**
  4967. * Defines the radius of the arc.
  4968. */
  4969. radius: number;
  4970. /**
  4971. * Defines the angle of the arc (from mid point to end point).
  4972. */
  4973. angle: Angle;
  4974. /**
  4975. * Defines the start angle of the arc (from start point to middle point).
  4976. */
  4977. startAngle: Angle;
  4978. /**
  4979. * Defines the orientation of the arc (clock wise/counter clock wise).
  4980. */
  4981. orientation: Orientation;
  4982. /**
  4983. * Creates an Arc object from the three given points : start, middle and end.
  4984. * @param startPoint Defines the start point of the arc
  4985. * @param midPoint Defines the midlle point of the arc
  4986. * @param endPoint Defines the end point of the arc
  4987. */
  4988. constructor(
  4989. /** Defines the start point of the arc */
  4990. startPoint: Vector2,
  4991. /** Defines the mid point of the arc */
  4992. midPoint: Vector2,
  4993. /** Defines the end point of the arc */
  4994. endPoint: Vector2);
  4995. }
  4996. /**
  4997. * Represents a 2D path made up of multiple 2D points
  4998. */
  4999. export class Path2 {
  5000. private _points;
  5001. private _length;
  5002. /**
  5003. * If the path start and end point are the same
  5004. */
  5005. closed: boolean;
  5006. /**
  5007. * Creates a Path2 object from the starting 2D coordinates x and y.
  5008. * @param x the starting points x value
  5009. * @param y the starting points y value
  5010. */
  5011. constructor(x: number, y: number);
  5012. /**
  5013. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  5014. * @param x the added points x value
  5015. * @param y the added points y value
  5016. * @returns the updated Path2.
  5017. */
  5018. addLineTo(x: number, y: number): Path2;
  5019. /**
  5020. * 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.
  5021. * @param midX middle point x value
  5022. * @param midY middle point y value
  5023. * @param endX end point x value
  5024. * @param endY end point y value
  5025. * @param numberOfSegments (default: 36)
  5026. * @returns the updated Path2.
  5027. */
  5028. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5029. /**
  5030. * Closes the Path2.
  5031. * @returns the Path2.
  5032. */
  5033. close(): Path2;
  5034. /**
  5035. * Gets the sum of the distance between each sequential point in the path
  5036. * @returns the Path2 total length (float).
  5037. */
  5038. length(): number;
  5039. /**
  5040. * Gets the points which construct the path
  5041. * @returns the Path2 internal array of points.
  5042. */
  5043. getPoints(): Vector2[];
  5044. /**
  5045. * Retreives the point at the distance aways from the starting point
  5046. * @param normalizedLengthPosition the length along the path to retreive the point from
  5047. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5048. */
  5049. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5050. /**
  5051. * Creates a new path starting from an x and y position
  5052. * @param x starting x value
  5053. * @param y starting y value
  5054. * @returns a new Path2 starting at the coordinates (x, y).
  5055. */
  5056. static StartingAt(x: number, y: number): Path2;
  5057. }
  5058. /**
  5059. * Represents a 3D path made up of multiple 3D points
  5060. */
  5061. export class Path3D {
  5062. /**
  5063. * an array of Vector3, the curve axis of the Path3D
  5064. */
  5065. path: Vector3[];
  5066. private _curve;
  5067. private _distances;
  5068. private _tangents;
  5069. private _normals;
  5070. private _binormals;
  5071. private _raw;
  5072. private _alignTangentsWithPath;
  5073. private readonly _pointAtData;
  5074. /**
  5075. * new Path3D(path, normal, raw)
  5076. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5077. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5078. * @param path an array of Vector3, the curve axis of the Path3D
  5079. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5080. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5081. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5082. */
  5083. constructor(
  5084. /**
  5085. * an array of Vector3, the curve axis of the Path3D
  5086. */
  5087. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5088. /**
  5089. * Returns the Path3D array of successive Vector3 designing its curve.
  5090. * @returns the Path3D array of successive Vector3 designing its curve.
  5091. */
  5092. getCurve(): Vector3[];
  5093. /**
  5094. * Returns the Path3D array of successive Vector3 designing its curve.
  5095. * @returns the Path3D array of successive Vector3 designing its curve.
  5096. */
  5097. getPoints(): Vector3[];
  5098. /**
  5099. * @returns the computed length (float) of the path.
  5100. */
  5101. length(): number;
  5102. /**
  5103. * Returns an array populated with tangent vectors on each Path3D curve point.
  5104. * @returns an array populated with tangent vectors on each Path3D curve point.
  5105. */
  5106. getTangents(): Vector3[];
  5107. /**
  5108. * Returns an array populated with normal vectors on each Path3D curve point.
  5109. * @returns an array populated with normal vectors on each Path3D curve point.
  5110. */
  5111. getNormals(): Vector3[];
  5112. /**
  5113. * Returns an array populated with binormal vectors on each Path3D curve point.
  5114. * @returns an array populated with binormal vectors on each Path3D curve point.
  5115. */
  5116. getBinormals(): Vector3[];
  5117. /**
  5118. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5119. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5120. */
  5121. getDistances(): number[];
  5122. /**
  5123. * Returns an interpolated point along this path
  5124. * @param position the position of the point along this path, from 0.0 to 1.0
  5125. * @returns a new Vector3 as the point
  5126. */
  5127. getPointAt(position: number): Vector3;
  5128. /**
  5129. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5130. * @param position the position of the point along this path, from 0.0 to 1.0
  5131. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5132. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5133. */
  5134. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5135. /**
  5136. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5137. * @param position the position of the point along this path, from 0.0 to 1.0
  5138. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5139. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5140. */
  5141. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5142. /**
  5143. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5144. * @param position the position of the point along this path, from 0.0 to 1.0
  5145. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5146. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5147. */
  5148. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5149. /**
  5150. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5151. * @param position the position of the point along this path, from 0.0 to 1.0
  5152. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5153. */
  5154. getDistanceAt(position: number): number;
  5155. /**
  5156. * Returns the array index of the previous point of an interpolated point along this path
  5157. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5158. * @returns the array index
  5159. */
  5160. getPreviousPointIndexAt(position: number): number;
  5161. /**
  5162. * 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)
  5163. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5164. * @returns the sub position
  5165. */
  5166. getSubPositionAt(position: number): number;
  5167. /**
  5168. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5169. * @param target the vector of which to get the closest position to
  5170. * @returns the position of the closest virtual point on this path to the target vector
  5171. */
  5172. getClosestPositionTo(target: Vector3): number;
  5173. /**
  5174. * Returns a sub path (slice) of this path
  5175. * @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
  5176. * @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
  5177. * @returns a sub path (slice) of this path
  5178. */
  5179. slice(start?: number, end?: number): Path3D;
  5180. /**
  5181. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5182. * @param path path which all values are copied into the curves points
  5183. * @param firstNormal which should be projected onto the curve
  5184. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5185. * @returns the same object updated.
  5186. */
  5187. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5188. private _compute;
  5189. private _getFirstNonNullVector;
  5190. private _getLastNonNullVector;
  5191. private _normalVector;
  5192. /**
  5193. * Updates the point at data for an interpolated point along this curve
  5194. * @param position the position of the point along this curve, from 0.0 to 1.0
  5195. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5196. * @returns the (updated) point at data
  5197. */
  5198. private _updatePointAtData;
  5199. /**
  5200. * Updates the point at data from the specified parameters
  5201. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5202. * @param point the interpolated point
  5203. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5204. */
  5205. private _setPointAtData;
  5206. /**
  5207. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5208. */
  5209. private _updateInterpolationMatrix;
  5210. }
  5211. /**
  5212. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5213. * A Curve3 is designed from a series of successive Vector3.
  5214. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5215. */
  5216. export class Curve3 {
  5217. private _points;
  5218. private _length;
  5219. /**
  5220. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5221. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5222. * @param v1 (Vector3) the control point
  5223. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5224. * @param nbPoints (integer) the wanted number of points in the curve
  5225. * @returns the created Curve3
  5226. */
  5227. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5228. /**
  5229. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5230. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5231. * @param v1 (Vector3) the first control point
  5232. * @param v2 (Vector3) the second control point
  5233. * @param v3 (Vector3) the end point of the Cubic Bezier
  5234. * @param nbPoints (integer) the wanted number of points in the curve
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5238. /**
  5239. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5240. * @param p1 (Vector3) the origin point of the Hermite Spline
  5241. * @param t1 (Vector3) the tangent vector at the origin point
  5242. * @param p2 (Vector3) the end point of the Hermite Spline
  5243. * @param t2 (Vector3) the tangent vector at the end point
  5244. * @param nbPoints (integer) the wanted number of points in the curve
  5245. * @returns the created Curve3
  5246. */
  5247. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5248. /**
  5249. * Returns a Curve3 object along a CatmullRom Spline curve :
  5250. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5251. * @param nbPoints (integer) the wanted number of points between each curve control points
  5252. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5253. * @returns the created Curve3
  5254. */
  5255. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5256. /**
  5257. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5258. * A Curve3 is designed from a series of successive Vector3.
  5259. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5260. * @param points points which make up the curve
  5261. */
  5262. constructor(points: Vector3[]);
  5263. /**
  5264. * @returns the Curve3 stored array of successive Vector3
  5265. */
  5266. getPoints(): Vector3[];
  5267. /**
  5268. * @returns the computed length (float) of the curve.
  5269. */
  5270. length(): number;
  5271. /**
  5272. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5273. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5274. * curveA and curveB keep unchanged.
  5275. * @param curve the curve to continue from this curve
  5276. * @returns the newly constructed curve
  5277. */
  5278. continue(curve: DeepImmutable<Curve3>): Curve3;
  5279. private _computeLength;
  5280. }
  5281. }
  5282. declare module "babylonjs/Animations/easing" {
  5283. /**
  5284. * This represents the main contract an easing function should follow.
  5285. * Easing functions are used throughout the animation system.
  5286. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5287. */
  5288. export interface IEasingFunction {
  5289. /**
  5290. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5291. * of the easing function.
  5292. * The link below provides some of the most common examples of easing functions.
  5293. * @see https://easings.net/
  5294. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5295. * @returns the corresponding value on the curve defined by the easing function
  5296. */
  5297. ease(gradient: number): number;
  5298. }
  5299. /**
  5300. * Base class used for every default easing function.
  5301. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5302. */
  5303. export class EasingFunction implements IEasingFunction {
  5304. /**
  5305. * Interpolation follows the mathematical formula associated with the easing function.
  5306. */
  5307. static readonly EASINGMODE_EASEIN: number;
  5308. /**
  5309. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5310. */
  5311. static readonly EASINGMODE_EASEOUT: number;
  5312. /**
  5313. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5314. */
  5315. static readonly EASINGMODE_EASEINOUT: number;
  5316. private _easingMode;
  5317. /**
  5318. * Sets the easing mode of the current function.
  5319. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5320. */
  5321. setEasingMode(easingMode: number): void;
  5322. /**
  5323. * Gets the current easing mode.
  5324. * @returns the easing mode
  5325. */
  5326. getEasingMode(): number;
  5327. /**
  5328. * @hidden
  5329. */
  5330. easeInCore(gradient: number): number;
  5331. /**
  5332. * Given an input gradient between 0 and 1, this returns the corresponding value
  5333. * of the easing function.
  5334. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5335. * @returns the corresponding value on the curve defined by the easing function
  5336. */
  5337. ease(gradient: number): number;
  5338. }
  5339. /**
  5340. * Easing function with a circle shape (see link below).
  5341. * @see https://easings.net/#easeInCirc
  5342. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5343. */
  5344. export class CircleEase extends EasingFunction implements IEasingFunction {
  5345. /** @hidden */
  5346. easeInCore(gradient: number): number;
  5347. }
  5348. /**
  5349. * Easing function with a ease back shape (see link below).
  5350. * @see https://easings.net/#easeInBack
  5351. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5352. */
  5353. export class BackEase extends EasingFunction implements IEasingFunction {
  5354. /** Defines the amplitude of the function */
  5355. amplitude: number;
  5356. /**
  5357. * Instantiates a back ease easing
  5358. * @see https://easings.net/#easeInBack
  5359. * @param amplitude Defines the amplitude of the function
  5360. */
  5361. constructor(
  5362. /** Defines the amplitude of the function */
  5363. amplitude?: number);
  5364. /** @hidden */
  5365. easeInCore(gradient: number): number;
  5366. }
  5367. /**
  5368. * Easing function with a bouncing shape (see link below).
  5369. * @see https://easings.net/#easeInBounce
  5370. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5371. */
  5372. export class BounceEase extends EasingFunction implements IEasingFunction {
  5373. /** Defines the number of bounces */
  5374. bounces: number;
  5375. /** Defines the amplitude of the bounce */
  5376. bounciness: number;
  5377. /**
  5378. * Instantiates a bounce easing
  5379. * @see https://easings.net/#easeInBounce
  5380. * @param bounces Defines the number of bounces
  5381. * @param bounciness Defines the amplitude of the bounce
  5382. */
  5383. constructor(
  5384. /** Defines the number of bounces */
  5385. bounces?: number,
  5386. /** Defines the amplitude of the bounce */
  5387. bounciness?: number);
  5388. /** @hidden */
  5389. easeInCore(gradient: number): number;
  5390. }
  5391. /**
  5392. * Easing function with a power of 3 shape (see link below).
  5393. * @see https://easings.net/#easeInCubic
  5394. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5395. */
  5396. export class CubicEase extends EasingFunction implements IEasingFunction {
  5397. /** @hidden */
  5398. easeInCore(gradient: number): number;
  5399. }
  5400. /**
  5401. * Easing function with an elastic shape (see link below).
  5402. * @see https://easings.net/#easeInElastic
  5403. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5404. */
  5405. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5406. /** Defines the number of oscillations*/
  5407. oscillations: number;
  5408. /** Defines the amplitude of the oscillations*/
  5409. springiness: number;
  5410. /**
  5411. * Instantiates an elastic easing function
  5412. * @see https://easings.net/#easeInElastic
  5413. * @param oscillations Defines the number of oscillations
  5414. * @param springiness Defines the amplitude of the oscillations
  5415. */
  5416. constructor(
  5417. /** Defines the number of oscillations*/
  5418. oscillations?: number,
  5419. /** Defines the amplitude of the oscillations*/
  5420. springiness?: number);
  5421. /** @hidden */
  5422. easeInCore(gradient: number): number;
  5423. }
  5424. /**
  5425. * Easing function with an exponential shape (see link below).
  5426. * @see https://easings.net/#easeInExpo
  5427. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5428. */
  5429. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5430. /** Defines the exponent of the function */
  5431. exponent: number;
  5432. /**
  5433. * Instantiates an exponential easing function
  5434. * @see https://easings.net/#easeInExpo
  5435. * @param exponent Defines the exponent of the function
  5436. */
  5437. constructor(
  5438. /** Defines the exponent of the function */
  5439. exponent?: number);
  5440. /** @hidden */
  5441. easeInCore(gradient: number): number;
  5442. }
  5443. /**
  5444. * Easing function with a power shape (see link below).
  5445. * @see https://easings.net/#easeInQuad
  5446. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5447. */
  5448. export class PowerEase extends EasingFunction implements IEasingFunction {
  5449. /** Defines the power of the function */
  5450. power: number;
  5451. /**
  5452. * Instantiates an power base easing function
  5453. * @see https://easings.net/#easeInQuad
  5454. * @param power Defines the power of the function
  5455. */
  5456. constructor(
  5457. /** Defines the power of the function */
  5458. power?: number);
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 2 shape (see link below).
  5464. * @see https://easings.net/#easeInQuad
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a power of 4 shape (see link below).
  5473. * @see https://easings.net/#easeInQuart
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a power of 5 shape (see link below).
  5482. * @see https://easings.net/#easeInQuint
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5486. /** @hidden */
  5487. easeInCore(gradient: number): number;
  5488. }
  5489. /**
  5490. * Easing function with a sin shape (see link below).
  5491. * @see https://easings.net/#easeInSine
  5492. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5493. */
  5494. export class SineEase extends EasingFunction implements IEasingFunction {
  5495. /** @hidden */
  5496. easeInCore(gradient: number): number;
  5497. }
  5498. /**
  5499. * Easing function with a bezier shape (see link below).
  5500. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5501. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5502. */
  5503. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5504. /** Defines the x component of the start tangent in the bezier curve */
  5505. x1: number;
  5506. /** Defines the y component of the start tangent in the bezier curve */
  5507. y1: number;
  5508. /** Defines the x component of the end tangent in the bezier curve */
  5509. x2: number;
  5510. /** Defines the y component of the end tangent in the bezier curve */
  5511. y2: number;
  5512. /**
  5513. * Instantiates a bezier function
  5514. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5515. * @param x1 Defines the x component of the start tangent in the bezier curve
  5516. * @param y1 Defines the y component of the start tangent in the bezier curve
  5517. * @param x2 Defines the x component of the end tangent in the bezier curve
  5518. * @param y2 Defines the y component of the end tangent in the bezier curve
  5519. */
  5520. constructor(
  5521. /** Defines the x component of the start tangent in the bezier curve */
  5522. x1?: number,
  5523. /** Defines the y component of the start tangent in the bezier curve */
  5524. y1?: number,
  5525. /** Defines the x component of the end tangent in the bezier curve */
  5526. x2?: number,
  5527. /** Defines the y component of the end tangent in the bezier curve */
  5528. y2?: number);
  5529. /** @hidden */
  5530. easeInCore(gradient: number): number;
  5531. }
  5532. }
  5533. declare module "babylonjs/Maths/math.color" {
  5534. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5535. /**
  5536. * Class used to hold a RBG color
  5537. */
  5538. export class Color3 {
  5539. /**
  5540. * Defines the red component (between 0 and 1, default is 0)
  5541. */
  5542. r: number;
  5543. /**
  5544. * Defines the green component (between 0 and 1, default is 0)
  5545. */
  5546. g: number;
  5547. /**
  5548. * Defines the blue component (between 0 and 1, default is 0)
  5549. */
  5550. b: number;
  5551. /**
  5552. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5553. * @param r defines the red component (between 0 and 1, default is 0)
  5554. * @param g defines the green component (between 0 and 1, default is 0)
  5555. * @param b defines the blue component (between 0 and 1, default is 0)
  5556. */
  5557. constructor(
  5558. /**
  5559. * Defines the red component (between 0 and 1, default is 0)
  5560. */
  5561. r?: number,
  5562. /**
  5563. * Defines the green component (between 0 and 1, default is 0)
  5564. */
  5565. g?: number,
  5566. /**
  5567. * Defines the blue component (between 0 and 1, default is 0)
  5568. */
  5569. b?: number);
  5570. /**
  5571. * Creates a string with the Color3 current values
  5572. * @returns the string representation of the Color3 object
  5573. */
  5574. toString(): string;
  5575. /**
  5576. * Returns the string "Color3"
  5577. * @returns "Color3"
  5578. */
  5579. getClassName(): string;
  5580. /**
  5581. * Compute the Color3 hash code
  5582. * @returns an unique number that can be used to hash Color3 objects
  5583. */
  5584. getHashCode(): number;
  5585. /**
  5586. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5587. * @param array defines the array where to store the r,g,b components
  5588. * @param index defines an optional index in the target array to define where to start storing values
  5589. * @returns the current Color3 object
  5590. */
  5591. toArray(array: FloatArray, index?: number): Color3;
  5592. /**
  5593. * Update the current color with values stored in an array from the starting index of the given array
  5594. * @param array defines the source array
  5595. * @param offset defines an offset in the source array
  5596. * @returns the current Color3 object
  5597. */
  5598. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5599. /**
  5600. * Returns a new Color4 object from the current Color3 and the given alpha
  5601. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5602. * @returns a new Color4 object
  5603. */
  5604. toColor4(alpha?: number): Color4;
  5605. /**
  5606. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5607. * @returns the new array
  5608. */
  5609. asArray(): number[];
  5610. /**
  5611. * Returns the luminance value
  5612. * @returns a float value
  5613. */
  5614. toLuminance(): number;
  5615. /**
  5616. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5617. * @param otherColor defines the second operand
  5618. * @returns the new Color3 object
  5619. */
  5620. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5621. /**
  5622. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5623. * @param otherColor defines the second operand
  5624. * @param result defines the Color3 object where to store the result
  5625. * @returns the current Color3
  5626. */
  5627. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5628. /**
  5629. * Determines equality between Color3 objects
  5630. * @param otherColor defines the second operand
  5631. * @returns true if the rgb values are equal to the given ones
  5632. */
  5633. equals(otherColor: DeepImmutable<Color3>): boolean;
  5634. /**
  5635. * Determines equality between the current Color3 object and a set of r,b,g values
  5636. * @param r defines the red component to check
  5637. * @param g defines the green component to check
  5638. * @param b defines the blue component to check
  5639. * @returns true if the rgb values are equal to the given ones
  5640. */
  5641. equalsFloats(r: number, g: number, b: number): boolean;
  5642. /**
  5643. * Multiplies in place each rgb value by scale
  5644. * @param scale defines the scaling factor
  5645. * @returns the updated Color3
  5646. */
  5647. scale(scale: number): Color3;
  5648. /**
  5649. * Multiplies the rgb values by scale and stores the result into "result"
  5650. * @param scale defines the scaling factor
  5651. * @param result defines the Color3 object where to store the result
  5652. * @returns the unmodified current Color3
  5653. */
  5654. scaleToRef(scale: number, result: Color3): Color3;
  5655. /**
  5656. * Scale the current Color3 values by a factor and add the result to a given Color3
  5657. * @param scale defines the scale factor
  5658. * @param result defines color to store the result into
  5659. * @returns the unmodified current Color3
  5660. */
  5661. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5662. /**
  5663. * Clamps the rgb values by the min and max values and stores the result into "result"
  5664. * @param min defines minimum clamping value (default is 0)
  5665. * @param max defines maximum clamping value (default is 1)
  5666. * @param result defines color to store the result into
  5667. * @returns the original Color3
  5668. */
  5669. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5670. /**
  5671. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5672. * @param otherColor defines the second operand
  5673. * @returns the new Color3
  5674. */
  5675. add(otherColor: DeepImmutable<Color3>): Color3;
  5676. /**
  5677. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5678. * @param otherColor defines the second operand
  5679. * @param result defines Color3 object to store the result into
  5680. * @returns the unmodified current Color3
  5681. */
  5682. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5683. /**
  5684. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5685. * @param otherColor defines the second operand
  5686. * @returns the new Color3
  5687. */
  5688. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5691. * @param otherColor defines the second operand
  5692. * @param result defines Color3 object to store the result into
  5693. * @returns the unmodified current Color3
  5694. */
  5695. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5696. /**
  5697. * Copy the current object
  5698. * @returns a new Color3 copied the current one
  5699. */
  5700. clone(): Color3;
  5701. /**
  5702. * Copies the rgb values from the source in the current Color3
  5703. * @param source defines the source Color3 object
  5704. * @returns the updated Color3 object
  5705. */
  5706. copyFrom(source: DeepImmutable<Color3>): Color3;
  5707. /**
  5708. * Updates the Color3 rgb values from the given floats
  5709. * @param r defines the red component to read from
  5710. * @param g defines the green component to read from
  5711. * @param b defines the blue component to read from
  5712. * @returns the current Color3 object
  5713. */
  5714. copyFromFloats(r: number, g: number, b: number): Color3;
  5715. /**
  5716. * Updates the Color3 rgb values from the given floats
  5717. * @param r defines the red component to read from
  5718. * @param g defines the green component to read from
  5719. * @param b defines the blue component to read from
  5720. * @returns the current Color3 object
  5721. */
  5722. set(r: number, g: number, b: number): Color3;
  5723. /**
  5724. * Compute the Color3 hexadecimal code as a string
  5725. * @returns a string containing the hexadecimal representation of the Color3 object
  5726. */
  5727. toHexString(): string;
  5728. /**
  5729. * Computes a new Color3 converted from the current one to linear space
  5730. * @returns a new Color3 object
  5731. */
  5732. toLinearSpace(): Color3;
  5733. /**
  5734. * Converts current color in rgb space to HSV values
  5735. * @returns a new color3 representing the HSV values
  5736. */
  5737. toHSV(): Color3;
  5738. /**
  5739. * Converts current color in rgb space to HSV values
  5740. * @param result defines the Color3 where to store the HSV values
  5741. */
  5742. toHSVToRef(result: Color3): void;
  5743. /**
  5744. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5745. * @param convertedColor defines the Color3 object where to store the linear space version
  5746. * @returns the unmodified Color3
  5747. */
  5748. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5749. /**
  5750. * Computes a new Color3 converted from the current one to gamma space
  5751. * @returns a new Color3 object
  5752. */
  5753. toGammaSpace(): Color3;
  5754. /**
  5755. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5756. * @param convertedColor defines the Color3 object where to store the gamma space version
  5757. * @returns the unmodified Color3
  5758. */
  5759. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5760. private static _BlackReadOnly;
  5761. /**
  5762. * Convert Hue, saturation and value to a Color3 (RGB)
  5763. * @param hue defines the hue
  5764. * @param saturation defines the saturation
  5765. * @param value defines the value
  5766. * @param result defines the Color3 where to store the RGB values
  5767. */
  5768. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5769. /**
  5770. * Creates a new Color3 from the string containing valid hexadecimal values
  5771. * @param hex defines a string containing valid hexadecimal values
  5772. * @returns a new Color3 object
  5773. */
  5774. static FromHexString(hex: string): Color3;
  5775. /**
  5776. * Creates a new Color3 from the starting index of the given array
  5777. * @param array defines the source array
  5778. * @param offset defines an offset in the source array
  5779. * @returns a new Color3 object
  5780. */
  5781. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5782. /**
  5783. * Creates a new Color3 from the starting index element of the given array
  5784. * @param array defines the source array to read from
  5785. * @param offset defines the offset in the source array
  5786. * @param result defines the target Color3 object
  5787. */
  5788. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5789. /**
  5790. * Creates a new Color3 from integer values (< 256)
  5791. * @param r defines the red component to read from (value between 0 and 255)
  5792. * @param g defines the green component to read from (value between 0 and 255)
  5793. * @param b defines the blue component to read from (value between 0 and 255)
  5794. * @returns a new Color3 object
  5795. */
  5796. static FromInts(r: number, g: number, b: number): Color3;
  5797. /**
  5798. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5799. * @param start defines the start Color3 value
  5800. * @param end defines the end Color3 value
  5801. * @param amount defines the gradient value between start and end
  5802. * @returns a new Color3 object
  5803. */
  5804. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5805. /**
  5806. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5807. * @param left defines the start value
  5808. * @param right defines the end value
  5809. * @param amount defines the gradient factor
  5810. * @param result defines the Color3 object where to store the result
  5811. */
  5812. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5813. /**
  5814. * Returns a Color3 value containing a red color
  5815. * @returns a new Color3 object
  5816. */
  5817. static Red(): Color3;
  5818. /**
  5819. * Returns a Color3 value containing a green color
  5820. * @returns a new Color3 object
  5821. */
  5822. static Green(): Color3;
  5823. /**
  5824. * Returns a Color3 value containing a blue color
  5825. * @returns a new Color3 object
  5826. */
  5827. static Blue(): Color3;
  5828. /**
  5829. * Returns a Color3 value containing a black color
  5830. * @returns a new Color3 object
  5831. */
  5832. static Black(): Color3;
  5833. /**
  5834. * Gets a Color3 value containing a black color that must not be updated
  5835. */
  5836. static get BlackReadOnly(): DeepImmutable<Color3>;
  5837. /**
  5838. * Returns a Color3 value containing a white color
  5839. * @returns a new Color3 object
  5840. */
  5841. static White(): Color3;
  5842. /**
  5843. * Returns a Color3 value containing a purple color
  5844. * @returns a new Color3 object
  5845. */
  5846. static Purple(): Color3;
  5847. /**
  5848. * Returns a Color3 value containing a magenta color
  5849. * @returns a new Color3 object
  5850. */
  5851. static Magenta(): Color3;
  5852. /**
  5853. * Returns a Color3 value containing a yellow color
  5854. * @returns a new Color3 object
  5855. */
  5856. static Yellow(): Color3;
  5857. /**
  5858. * Returns a Color3 value containing a gray color
  5859. * @returns a new Color3 object
  5860. */
  5861. static Gray(): Color3;
  5862. /**
  5863. * Returns a Color3 value containing a teal color
  5864. * @returns a new Color3 object
  5865. */
  5866. static Teal(): Color3;
  5867. /**
  5868. * Returns a Color3 value containing a random color
  5869. * @returns a new Color3 object
  5870. */
  5871. static Random(): Color3;
  5872. }
  5873. /**
  5874. * Class used to hold a RBGA color
  5875. */
  5876. export class Color4 {
  5877. /**
  5878. * Defines the red component (between 0 and 1, default is 0)
  5879. */
  5880. r: number;
  5881. /**
  5882. * Defines the green component (between 0 and 1, default is 0)
  5883. */
  5884. g: number;
  5885. /**
  5886. * Defines the blue component (between 0 and 1, default is 0)
  5887. */
  5888. b: number;
  5889. /**
  5890. * Defines the alpha component (between 0 and 1, default is 1)
  5891. */
  5892. a: number;
  5893. /**
  5894. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5895. * @param r defines the red component (between 0 and 1, default is 0)
  5896. * @param g defines the green component (between 0 and 1, default is 0)
  5897. * @param b defines the blue component (between 0 and 1, default is 0)
  5898. * @param a defines the alpha component (between 0 and 1, default is 1)
  5899. */
  5900. constructor(
  5901. /**
  5902. * Defines the red component (between 0 and 1, default is 0)
  5903. */
  5904. r?: number,
  5905. /**
  5906. * Defines the green component (between 0 and 1, default is 0)
  5907. */
  5908. g?: number,
  5909. /**
  5910. * Defines the blue component (between 0 and 1, default is 0)
  5911. */
  5912. b?: number,
  5913. /**
  5914. * Defines the alpha component (between 0 and 1, default is 1)
  5915. */
  5916. a?: number);
  5917. /**
  5918. * Adds in place the given Color4 values to the current Color4 object
  5919. * @param right defines the second operand
  5920. * @returns the current updated Color4 object
  5921. */
  5922. addInPlace(right: DeepImmutable<Color4>): Color4;
  5923. /**
  5924. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5925. * @returns the new array
  5926. */
  5927. asArray(): number[];
  5928. /**
  5929. * Stores from the starting index in the given array the Color4 successive values
  5930. * @param array defines the array where to store the r,g,b components
  5931. * @param index defines an optional index in the target array to define where to start storing values
  5932. * @returns the current Color4 object
  5933. */
  5934. toArray(array: number[], index?: number): Color4;
  5935. /**
  5936. * Update the current color with values stored in an array from the starting index of the given array
  5937. * @param array defines the source array
  5938. * @param offset defines an offset in the source array
  5939. * @returns the current Color4 object
  5940. */
  5941. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5942. /**
  5943. * Determines equality between Color4 objects
  5944. * @param otherColor defines the second operand
  5945. * @returns true if the rgba values are equal to the given ones
  5946. */
  5947. equals(otherColor: DeepImmutable<Color4>): boolean;
  5948. /**
  5949. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5950. * @param right defines the second operand
  5951. * @returns a new Color4 object
  5952. */
  5953. add(right: DeepImmutable<Color4>): Color4;
  5954. /**
  5955. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5956. * @param right defines the second operand
  5957. * @returns a new Color4 object
  5958. */
  5959. subtract(right: DeepImmutable<Color4>): Color4;
  5960. /**
  5961. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5962. * @param right defines the second operand
  5963. * @param result defines the Color4 object where to store the result
  5964. * @returns the current Color4 object
  5965. */
  5966. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5967. /**
  5968. * Creates a new Color4 with the current Color4 values multiplied by scale
  5969. * @param scale defines the scaling factor to apply
  5970. * @returns a new Color4 object
  5971. */
  5972. scale(scale: number): Color4;
  5973. /**
  5974. * Multiplies the current Color4 values by scale and stores the result in "result"
  5975. * @param scale defines the scaling factor to apply
  5976. * @param result defines the Color4 object where to store the result
  5977. * @returns the current unmodified Color4
  5978. */
  5979. scaleToRef(scale: number, result: Color4): Color4;
  5980. /**
  5981. * Scale the current Color4 values by a factor and add the result to a given Color4
  5982. * @param scale defines the scale factor
  5983. * @param result defines the Color4 object where to store the result
  5984. * @returns the unmodified current Color4
  5985. */
  5986. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5987. /**
  5988. * Clamps the rgb values by the min and max values and stores the result into "result"
  5989. * @param min defines minimum clamping value (default is 0)
  5990. * @param max defines maximum clamping value (default is 1)
  5991. * @param result defines color to store the result into.
  5992. * @returns the cuurent Color4
  5993. */
  5994. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5995. /**
  5996. * Multipy an Color4 value by another and return a new Color4 object
  5997. * @param color defines the Color4 value to multiply by
  5998. * @returns a new Color4 object
  5999. */
  6000. multiply(color: Color4): Color4;
  6001. /**
  6002. * Multipy a Color4 value by another and push the result in a reference value
  6003. * @param color defines the Color4 value to multiply by
  6004. * @param result defines the Color4 to fill the result in
  6005. * @returns the result Color4
  6006. */
  6007. multiplyToRef(color: Color4, result: Color4): Color4;
  6008. /**
  6009. * Creates a string with the Color4 current values
  6010. * @returns the string representation of the Color4 object
  6011. */
  6012. toString(): string;
  6013. /**
  6014. * Returns the string "Color4"
  6015. * @returns "Color4"
  6016. */
  6017. getClassName(): string;
  6018. /**
  6019. * Compute the Color4 hash code
  6020. * @returns an unique number that can be used to hash Color4 objects
  6021. */
  6022. getHashCode(): number;
  6023. /**
  6024. * Creates a new Color4 copied from the current one
  6025. * @returns a new Color4 object
  6026. */
  6027. clone(): Color4;
  6028. /**
  6029. * Copies the given Color4 values into the current one
  6030. * @param source defines the source Color4 object
  6031. * @returns the current updated Color4 object
  6032. */
  6033. copyFrom(source: Color4): Color4;
  6034. /**
  6035. * Copies the given float values into the current one
  6036. * @param r defines the red component to read from
  6037. * @param g defines the green component to read from
  6038. * @param b defines the blue component to read from
  6039. * @param a defines the alpha component to read from
  6040. * @returns the current updated Color4 object
  6041. */
  6042. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6043. /**
  6044. * Copies the given float values into the current one
  6045. * @param r defines the red component to read from
  6046. * @param g defines the green component to read from
  6047. * @param b defines the blue component to read from
  6048. * @param a defines the alpha component to read from
  6049. * @returns the current updated Color4 object
  6050. */
  6051. set(r: number, g: number, b: number, a: number): Color4;
  6052. /**
  6053. * Compute the Color4 hexadecimal code as a string
  6054. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6055. * @returns a string containing the hexadecimal representation of the Color4 object
  6056. */
  6057. toHexString(returnAsColor3?: boolean): string;
  6058. /**
  6059. * Computes a new Color4 converted from the current one to linear space
  6060. * @returns a new Color4 object
  6061. */
  6062. toLinearSpace(): Color4;
  6063. /**
  6064. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6065. * @param convertedColor defines the Color4 object where to store the linear space version
  6066. * @returns the unmodified Color4
  6067. */
  6068. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6069. /**
  6070. * Computes a new Color4 converted from the current one to gamma space
  6071. * @returns a new Color4 object
  6072. */
  6073. toGammaSpace(): Color4;
  6074. /**
  6075. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6076. * @param convertedColor defines the Color4 object where to store the gamma space version
  6077. * @returns the unmodified Color4
  6078. */
  6079. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6080. /**
  6081. * Creates a new Color4 from the string containing valid hexadecimal values
  6082. * @param hex defines a string containing valid hexadecimal values
  6083. * @returns a new Color4 object
  6084. */
  6085. static FromHexString(hex: string): Color4;
  6086. /**
  6087. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6088. * @param left defines the start value
  6089. * @param right defines the end value
  6090. * @param amount defines the gradient factor
  6091. * @returns a new Color4 object
  6092. */
  6093. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6094. /**
  6095. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6096. * @param left defines the start value
  6097. * @param right defines the end value
  6098. * @param amount defines the gradient factor
  6099. * @param result defines the Color4 object where to store data
  6100. */
  6101. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6102. /**
  6103. * Creates a new Color4 from a Color3 and an alpha value
  6104. * @param color3 defines the source Color3 to read from
  6105. * @param alpha defines the alpha component (1.0 by default)
  6106. * @returns a new Color4 object
  6107. */
  6108. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6109. /**
  6110. * Creates a new Color4 from the starting index element of the given array
  6111. * @param array defines the source array to read from
  6112. * @param offset defines the offset in the source array
  6113. * @returns a new Color4 object
  6114. */
  6115. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6116. /**
  6117. * Creates a new Color4 from the starting index element of the given array
  6118. * @param array defines the source array to read from
  6119. * @param offset defines the offset in the source array
  6120. * @param result defines the target Color4 object
  6121. */
  6122. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6123. /**
  6124. * Creates a new Color3 from integer values (< 256)
  6125. * @param r defines the red component to read from (value between 0 and 255)
  6126. * @param g defines the green component to read from (value between 0 and 255)
  6127. * @param b defines the blue component to read from (value between 0 and 255)
  6128. * @param a defines the alpha component to read from (value between 0 and 255)
  6129. * @returns a new Color3 object
  6130. */
  6131. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6132. /**
  6133. * Check the content of a given array and convert it to an array containing RGBA data
  6134. * If the original array was already containing count * 4 values then it is returned directly
  6135. * @param colors defines the array to check
  6136. * @param count defines the number of RGBA data to expect
  6137. * @returns an array containing count * 4 values (RGBA)
  6138. */
  6139. static CheckColors4(colors: number[], count: number): number[];
  6140. }
  6141. /**
  6142. * @hidden
  6143. */
  6144. export class TmpColors {
  6145. static Color3: Color3[];
  6146. static Color4: Color4[];
  6147. }
  6148. }
  6149. declare module "babylonjs/Animations/animationKey" {
  6150. /**
  6151. * Defines an interface which represents an animation key frame
  6152. */
  6153. export interface IAnimationKey {
  6154. /**
  6155. * Frame of the key frame
  6156. */
  6157. frame: number;
  6158. /**
  6159. * Value at the specifies key frame
  6160. */
  6161. value: any;
  6162. /**
  6163. * The input tangent for the cubic hermite spline
  6164. */
  6165. inTangent?: any;
  6166. /**
  6167. * The output tangent for the cubic hermite spline
  6168. */
  6169. outTangent?: any;
  6170. /**
  6171. * The animation interpolation type
  6172. */
  6173. interpolation?: AnimationKeyInterpolation;
  6174. }
  6175. /**
  6176. * Enum for the animation key frame interpolation type
  6177. */
  6178. export enum AnimationKeyInterpolation {
  6179. /**
  6180. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6181. */
  6182. STEP = 1
  6183. }
  6184. }
  6185. declare module "babylonjs/Animations/animationRange" {
  6186. /**
  6187. * Represents the range of an animation
  6188. */
  6189. export class AnimationRange {
  6190. /**The name of the animation range**/
  6191. name: string;
  6192. /**The starting frame of the animation */
  6193. from: number;
  6194. /**The ending frame of the animation*/
  6195. to: number;
  6196. /**
  6197. * Initializes the range of an animation
  6198. * @param name The name of the animation range
  6199. * @param from The starting frame of the animation
  6200. * @param to The ending frame of the animation
  6201. */
  6202. constructor(
  6203. /**The name of the animation range**/
  6204. name: string,
  6205. /**The starting frame of the animation */
  6206. from: number,
  6207. /**The ending frame of the animation*/
  6208. to: number);
  6209. /**
  6210. * Makes a copy of the animation range
  6211. * @returns A copy of the animation range
  6212. */
  6213. clone(): AnimationRange;
  6214. }
  6215. }
  6216. declare module "babylonjs/Animations/animationEvent" {
  6217. /**
  6218. * Composed of a frame, and an action function
  6219. */
  6220. export class AnimationEvent {
  6221. /** The frame for which the event is triggered **/
  6222. frame: number;
  6223. /** The event to perform when triggered **/
  6224. action: (currentFrame: number) => void;
  6225. /** Specifies if the event should be triggered only once**/
  6226. onlyOnce?: boolean | undefined;
  6227. /**
  6228. * Specifies if the animation event is done
  6229. */
  6230. isDone: boolean;
  6231. /**
  6232. * Initializes the animation event
  6233. * @param frame The frame for which the event is triggered
  6234. * @param action The event to perform when triggered
  6235. * @param onlyOnce Specifies if the event should be triggered only once
  6236. */
  6237. constructor(
  6238. /** The frame for which the event is triggered **/
  6239. frame: number,
  6240. /** The event to perform when triggered **/
  6241. action: (currentFrame: number) => void,
  6242. /** Specifies if the event should be triggered only once**/
  6243. onlyOnce?: boolean | undefined);
  6244. /** @hidden */
  6245. _clone(): AnimationEvent;
  6246. }
  6247. }
  6248. declare module "babylonjs/Behaviors/behavior" {
  6249. import { Nullable } from "babylonjs/types";
  6250. /**
  6251. * Interface used to define a behavior
  6252. */
  6253. export interface Behavior<T> {
  6254. /** gets or sets behavior's name */
  6255. name: string;
  6256. /**
  6257. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6258. */
  6259. init(): void;
  6260. /**
  6261. * Called when the behavior is attached to a target
  6262. * @param target defines the target where the behavior is attached to
  6263. */
  6264. attach(target: T): void;
  6265. /**
  6266. * Called when the behavior is detached from its target
  6267. */
  6268. detach(): void;
  6269. }
  6270. /**
  6271. * Interface implemented by classes supporting behaviors
  6272. */
  6273. export interface IBehaviorAware<T> {
  6274. /**
  6275. * Attach a behavior
  6276. * @param behavior defines the behavior to attach
  6277. * @returns the current host
  6278. */
  6279. addBehavior(behavior: Behavior<T>): T;
  6280. /**
  6281. * Remove a behavior from the current object
  6282. * @param behavior defines the behavior to detach
  6283. * @returns the current host
  6284. */
  6285. removeBehavior(behavior: Behavior<T>): T;
  6286. /**
  6287. * Gets a behavior using its name to search
  6288. * @param name defines the name to search
  6289. * @returns the behavior or null if not found
  6290. */
  6291. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6292. }
  6293. }
  6294. declare module "babylonjs/Misc/smartArray" {
  6295. /**
  6296. * Defines an array and its length.
  6297. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6298. */
  6299. export interface ISmartArrayLike<T> {
  6300. /**
  6301. * The data of the array.
  6302. */
  6303. data: Array<T>;
  6304. /**
  6305. * The active length of the array.
  6306. */
  6307. length: number;
  6308. }
  6309. /**
  6310. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6311. */
  6312. export class SmartArray<T> implements ISmartArrayLike<T> {
  6313. /**
  6314. * The full set of data from the array.
  6315. */
  6316. data: Array<T>;
  6317. /**
  6318. * The active length of the array.
  6319. */
  6320. length: number;
  6321. protected _id: number;
  6322. /**
  6323. * Instantiates a Smart Array.
  6324. * @param capacity defines the default capacity of the array.
  6325. */
  6326. constructor(capacity: number);
  6327. /**
  6328. * Pushes a value at the end of the active data.
  6329. * @param value defines the object to push in the array.
  6330. */
  6331. push(value: T): void;
  6332. /**
  6333. * Iterates over the active data and apply the lambda to them.
  6334. * @param func defines the action to apply on each value.
  6335. */
  6336. forEach(func: (content: T) => void): void;
  6337. /**
  6338. * Sorts the full sets of data.
  6339. * @param compareFn defines the comparison function to apply.
  6340. */
  6341. sort(compareFn: (a: T, b: T) => number): void;
  6342. /**
  6343. * Resets the active data to an empty array.
  6344. */
  6345. reset(): void;
  6346. /**
  6347. * Releases all the data from the array as well as the array.
  6348. */
  6349. dispose(): void;
  6350. /**
  6351. * Concats the active data with a given array.
  6352. * @param array defines the data to concatenate with.
  6353. */
  6354. concat(array: any): void;
  6355. /**
  6356. * Returns the position of a value in the active data.
  6357. * @param value defines the value to find the index for
  6358. * @returns the index if found in the active data otherwise -1
  6359. */
  6360. indexOf(value: T): number;
  6361. /**
  6362. * Returns whether an element is part of the active data.
  6363. * @param value defines the value to look for
  6364. * @returns true if found in the active data otherwise false
  6365. */
  6366. contains(value: T): boolean;
  6367. private static _GlobalId;
  6368. }
  6369. /**
  6370. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6371. * The data in this array can only be present once
  6372. */
  6373. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6374. private _duplicateId;
  6375. /**
  6376. * Pushes a value at the end of the active data.
  6377. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6378. * @param value defines the object to push in the array.
  6379. */
  6380. push(value: T): void;
  6381. /**
  6382. * Pushes a value at the end of the active data.
  6383. * If the data is already present, it won t be added again
  6384. * @param value defines the object to push in the array.
  6385. * @returns true if added false if it was already present
  6386. */
  6387. pushNoDuplicate(value: T): boolean;
  6388. /**
  6389. * Resets the active data to an empty array.
  6390. */
  6391. reset(): void;
  6392. /**
  6393. * Concats the active data with a given array.
  6394. * This ensures no dupplicate will be present in the result.
  6395. * @param array defines the data to concatenate with.
  6396. */
  6397. concatWithNoDuplicate(array: any): void;
  6398. }
  6399. }
  6400. declare module "babylonjs/Cameras/cameraInputsManager" {
  6401. import { Nullable } from "babylonjs/types";
  6402. import { Camera } from "babylonjs/Cameras/camera";
  6403. /**
  6404. * @ignore
  6405. * This is a list of all the different input types that are available in the application.
  6406. * Fo instance: ArcRotateCameraGamepadInput...
  6407. */
  6408. export var CameraInputTypes: {};
  6409. /**
  6410. * This is the contract to implement in order to create a new input class.
  6411. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6412. */
  6413. export interface ICameraInput<TCamera extends Camera> {
  6414. /**
  6415. * Defines the camera the input is attached to.
  6416. */
  6417. camera: Nullable<TCamera>;
  6418. /**
  6419. * Gets the class name of the current intput.
  6420. * @returns the class name
  6421. */
  6422. getClassName(): string;
  6423. /**
  6424. * Get the friendly name associated with the input class.
  6425. * @returns the input friendly name
  6426. */
  6427. getSimpleName(): string;
  6428. /**
  6429. * Attach the input controls to a specific dom element to get the input from.
  6430. * @param element Defines the element the controls should be listened from
  6431. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6432. */
  6433. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6434. /**
  6435. * Detach the current controls from the specified dom element.
  6436. * @param element Defines the element to stop listening the inputs from
  6437. */
  6438. detachControl(element: Nullable<HTMLElement>): void;
  6439. /**
  6440. * Update the current camera state depending on the inputs that have been used this frame.
  6441. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6442. */
  6443. checkInputs?: () => void;
  6444. }
  6445. /**
  6446. * Represents a map of input types to input instance or input index to input instance.
  6447. */
  6448. export interface CameraInputsMap<TCamera extends Camera> {
  6449. /**
  6450. * Accessor to the input by input type.
  6451. */
  6452. [name: string]: ICameraInput<TCamera>;
  6453. /**
  6454. * Accessor to the input by input index.
  6455. */
  6456. [idx: number]: ICameraInput<TCamera>;
  6457. }
  6458. /**
  6459. * This represents the input manager used within a camera.
  6460. * It helps dealing with all the different kind of input attached to a camera.
  6461. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6462. */
  6463. export class CameraInputsManager<TCamera extends Camera> {
  6464. /**
  6465. * Defines the list of inputs attahed to the camera.
  6466. */
  6467. attached: CameraInputsMap<TCamera>;
  6468. /**
  6469. * Defines the dom element the camera is collecting inputs from.
  6470. * This is null if the controls have not been attached.
  6471. */
  6472. attachedElement: Nullable<HTMLElement>;
  6473. /**
  6474. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6475. */
  6476. noPreventDefault: boolean;
  6477. /**
  6478. * Defined the camera the input manager belongs to.
  6479. */
  6480. camera: TCamera;
  6481. /**
  6482. * Update the current camera state depending on the inputs that have been used this frame.
  6483. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6484. */
  6485. checkInputs: () => void;
  6486. /**
  6487. * Instantiate a new Camera Input Manager.
  6488. * @param camera Defines the camera the input manager blongs to
  6489. */
  6490. constructor(camera: TCamera);
  6491. /**
  6492. * Add an input method to a camera
  6493. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6494. * @param input camera input method
  6495. */
  6496. add(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Remove a specific input method from a camera
  6499. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6500. * @param inputToRemove camera input method
  6501. */
  6502. remove(inputToRemove: ICameraInput<TCamera>): void;
  6503. /**
  6504. * Remove a specific input type from a camera
  6505. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6506. * @param inputType the type of the input to remove
  6507. */
  6508. removeByType(inputType: string): void;
  6509. private _addCheckInputs;
  6510. /**
  6511. * Attach the input controls to the currently attached dom element to listen the events from.
  6512. * @param input Defines the input to attach
  6513. */
  6514. attachInput(input: ICameraInput<TCamera>): void;
  6515. /**
  6516. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6517. * @param element Defines the dom element to collect the events from
  6518. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6519. */
  6520. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6521. /**
  6522. * Detach the current manager inputs controls from a specific dom element.
  6523. * @param element Defines the dom element to collect the events from
  6524. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6525. */
  6526. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6527. /**
  6528. * Rebuild the dynamic inputCheck function from the current list of
  6529. * defined inputs in the manager.
  6530. */
  6531. rebuildInputCheck(): void;
  6532. /**
  6533. * Remove all attached input methods from a camera
  6534. */
  6535. clear(): void;
  6536. /**
  6537. * Serialize the current input manager attached to a camera.
  6538. * This ensures than once parsed,
  6539. * the input associated to the camera will be identical to the current ones
  6540. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6541. */
  6542. serialize(serializedCamera: any): void;
  6543. /**
  6544. * Parses an input manager serialized JSON to restore the previous list of inputs
  6545. * and states associated to a camera.
  6546. * @param parsedCamera Defines the JSON to parse
  6547. */
  6548. parse(parsedCamera: any): void;
  6549. }
  6550. }
  6551. declare module "babylonjs/Meshes/buffer" {
  6552. import { Nullable, DataArray } from "babylonjs/types";
  6553. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6554. /**
  6555. * Class used to store data that will be store in GPU memory
  6556. */
  6557. export class Buffer {
  6558. private _engine;
  6559. private _buffer;
  6560. /** @hidden */
  6561. _data: Nullable<DataArray>;
  6562. private _updatable;
  6563. private _instanced;
  6564. private _divisor;
  6565. /**
  6566. * Gets the byte stride.
  6567. */
  6568. readonly byteStride: number;
  6569. /**
  6570. * Constructor
  6571. * @param engine the engine
  6572. * @param data the data to use for this buffer
  6573. * @param updatable whether the data is updatable
  6574. * @param stride the stride (optional)
  6575. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6576. * @param instanced whether the buffer is instanced (optional)
  6577. * @param useBytes set to true if the stride in in bytes (optional)
  6578. * @param divisor sets an optional divisor for instances (1 by default)
  6579. */
  6580. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6581. /**
  6582. * Create a new VertexBuffer based on the current buffer
  6583. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6584. * @param offset defines offset in the buffer (0 by default)
  6585. * @param size defines the size in floats of attributes (position is 3 for instance)
  6586. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6587. * @param instanced defines if the vertex buffer contains indexed data
  6588. * @param useBytes defines if the offset and stride are in bytes *
  6589. * @param divisor sets an optional divisor for instances (1 by default)
  6590. * @returns the new vertex buffer
  6591. */
  6592. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6593. /**
  6594. * Gets a boolean indicating if the Buffer is updatable?
  6595. * @returns true if the buffer is updatable
  6596. */
  6597. isUpdatable(): boolean;
  6598. /**
  6599. * Gets current buffer's data
  6600. * @returns a DataArray or null
  6601. */
  6602. getData(): Nullable<DataArray>;
  6603. /**
  6604. * Gets underlying native buffer
  6605. * @returns underlying native buffer
  6606. */
  6607. getBuffer(): Nullable<DataBuffer>;
  6608. /**
  6609. * Gets the stride in float32 units (i.e. byte stride / 4).
  6610. * May not be an integer if the byte stride is not divisible by 4.
  6611. * @returns the stride in float32 units
  6612. * @deprecated Please use byteStride instead.
  6613. */
  6614. getStrideSize(): number;
  6615. /**
  6616. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6617. * @param data defines the data to store
  6618. */
  6619. create(data?: Nullable<DataArray>): void;
  6620. /** @hidden */
  6621. _rebuild(): void;
  6622. /**
  6623. * Update current buffer data
  6624. * @param data defines the data to store
  6625. */
  6626. update(data: DataArray): void;
  6627. /**
  6628. * Updates the data directly.
  6629. * @param data the new data
  6630. * @param offset the new offset
  6631. * @param vertexCount the vertex count (optional)
  6632. * @param useBytes set to true if the offset is in bytes
  6633. */
  6634. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6635. /**
  6636. * Release all resources
  6637. */
  6638. dispose(): void;
  6639. }
  6640. /**
  6641. * Specialized buffer used to store vertex data
  6642. */
  6643. export class VertexBuffer {
  6644. /** @hidden */
  6645. _buffer: Buffer;
  6646. private _kind;
  6647. private _size;
  6648. private _ownsBuffer;
  6649. private _instanced;
  6650. private _instanceDivisor;
  6651. /**
  6652. * The byte type.
  6653. */
  6654. static readonly BYTE: number;
  6655. /**
  6656. * The unsigned byte type.
  6657. */
  6658. static readonly UNSIGNED_BYTE: number;
  6659. /**
  6660. * The short type.
  6661. */
  6662. static readonly SHORT: number;
  6663. /**
  6664. * The unsigned short type.
  6665. */
  6666. static readonly UNSIGNED_SHORT: number;
  6667. /**
  6668. * The integer type.
  6669. */
  6670. static readonly INT: number;
  6671. /**
  6672. * The unsigned integer type.
  6673. */
  6674. static readonly UNSIGNED_INT: number;
  6675. /**
  6676. * The float type.
  6677. */
  6678. static readonly FLOAT: number;
  6679. /**
  6680. * Gets or sets the instance divisor when in instanced mode
  6681. */
  6682. get instanceDivisor(): number;
  6683. set instanceDivisor(value: number);
  6684. /**
  6685. * Gets the byte stride.
  6686. */
  6687. readonly byteStride: number;
  6688. /**
  6689. * Gets the byte offset.
  6690. */
  6691. readonly byteOffset: number;
  6692. /**
  6693. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6694. */
  6695. readonly normalized: boolean;
  6696. /**
  6697. * Gets the data type of each component in the array.
  6698. */
  6699. readonly type: number;
  6700. /**
  6701. * Constructor
  6702. * @param engine the engine
  6703. * @param data the data to use for this vertex buffer
  6704. * @param kind the vertex buffer kind
  6705. * @param updatable whether the data is updatable
  6706. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6707. * @param stride the stride (optional)
  6708. * @param instanced whether the buffer is instanced (optional)
  6709. * @param offset the offset of the data (optional)
  6710. * @param size the number of components (optional)
  6711. * @param type the type of the component (optional)
  6712. * @param normalized whether the data contains normalized data (optional)
  6713. * @param useBytes set to true if stride and offset are in bytes (optional)
  6714. * @param divisor defines the instance divisor to use (1 by default)
  6715. */
  6716. 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);
  6717. /** @hidden */
  6718. _rebuild(): void;
  6719. /**
  6720. * Returns the kind of the VertexBuffer (string)
  6721. * @returns a string
  6722. */
  6723. getKind(): string;
  6724. /**
  6725. * Gets a boolean indicating if the VertexBuffer is updatable?
  6726. * @returns true if the buffer is updatable
  6727. */
  6728. isUpdatable(): boolean;
  6729. /**
  6730. * Gets current buffer's data
  6731. * @returns a DataArray or null
  6732. */
  6733. getData(): Nullable<DataArray>;
  6734. /**
  6735. * Gets underlying native buffer
  6736. * @returns underlying native buffer
  6737. */
  6738. getBuffer(): Nullable<DataBuffer>;
  6739. /**
  6740. * Gets the stride in float32 units (i.e. byte stride / 4).
  6741. * May not be an integer if the byte stride is not divisible by 4.
  6742. * @returns the stride in float32 units
  6743. * @deprecated Please use byteStride instead.
  6744. */
  6745. getStrideSize(): number;
  6746. /**
  6747. * Returns the offset as a multiple of the type byte length.
  6748. * @returns the offset in bytes
  6749. * @deprecated Please use byteOffset instead.
  6750. */
  6751. getOffset(): number;
  6752. /**
  6753. * Returns the number of components per vertex attribute (integer)
  6754. * @returns the size in float
  6755. */
  6756. getSize(): number;
  6757. /**
  6758. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6759. * @returns true if this buffer is instanced
  6760. */
  6761. getIsInstanced(): boolean;
  6762. /**
  6763. * Returns the instancing divisor, zero for non-instanced (integer).
  6764. * @returns a number
  6765. */
  6766. getInstanceDivisor(): number;
  6767. /**
  6768. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6769. * @param data defines the data to store
  6770. */
  6771. create(data?: DataArray): void;
  6772. /**
  6773. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6774. * This function will create a new buffer if the current one is not updatable
  6775. * @param data defines the data to store
  6776. */
  6777. update(data: DataArray): void;
  6778. /**
  6779. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6780. * Returns the directly updated WebGLBuffer.
  6781. * @param data the new data
  6782. * @param offset the new offset
  6783. * @param useBytes set to true if the offset is in bytes
  6784. */
  6785. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6786. /**
  6787. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6788. */
  6789. dispose(): void;
  6790. /**
  6791. * Enumerates each value of this vertex buffer as numbers.
  6792. * @param count the number of values to enumerate
  6793. * @param callback the callback function called for each value
  6794. */
  6795. forEach(count: number, callback: (value: number, index: number) => void): void;
  6796. /**
  6797. * Positions
  6798. */
  6799. static readonly PositionKind: string;
  6800. /**
  6801. * Normals
  6802. */
  6803. static readonly NormalKind: string;
  6804. /**
  6805. * Tangents
  6806. */
  6807. static readonly TangentKind: string;
  6808. /**
  6809. * Texture coordinates
  6810. */
  6811. static readonly UVKind: string;
  6812. /**
  6813. * Texture coordinates 2
  6814. */
  6815. static readonly UV2Kind: string;
  6816. /**
  6817. * Texture coordinates 3
  6818. */
  6819. static readonly UV3Kind: string;
  6820. /**
  6821. * Texture coordinates 4
  6822. */
  6823. static readonly UV4Kind: string;
  6824. /**
  6825. * Texture coordinates 5
  6826. */
  6827. static readonly UV5Kind: string;
  6828. /**
  6829. * Texture coordinates 6
  6830. */
  6831. static readonly UV6Kind: string;
  6832. /**
  6833. * Colors
  6834. */
  6835. static readonly ColorKind: string;
  6836. /**
  6837. * Matrix indices (for bones)
  6838. */
  6839. static readonly MatricesIndicesKind: string;
  6840. /**
  6841. * Matrix weights (for bones)
  6842. */
  6843. static readonly MatricesWeightsKind: string;
  6844. /**
  6845. * Additional matrix indices (for bones)
  6846. */
  6847. static readonly MatricesIndicesExtraKind: string;
  6848. /**
  6849. * Additional matrix weights (for bones)
  6850. */
  6851. static readonly MatricesWeightsExtraKind: string;
  6852. /**
  6853. * Deduces the stride given a kind.
  6854. * @param kind The kind string to deduce
  6855. * @returns The deduced stride
  6856. */
  6857. static DeduceStride(kind: string): number;
  6858. /**
  6859. * Gets the byte length of the given type.
  6860. * @param type the type
  6861. * @returns the number of bytes
  6862. */
  6863. static GetTypeByteLength(type: number): number;
  6864. /**
  6865. * Enumerates each value of the given parameters as numbers.
  6866. * @param data the data to enumerate
  6867. * @param byteOffset the byte offset of the data
  6868. * @param byteStride the byte stride of the data
  6869. * @param componentCount the number of components per element
  6870. * @param componentType the type of the component
  6871. * @param count the number of values to enumerate
  6872. * @param normalized whether the data is normalized
  6873. * @param callback the callback function called for each value
  6874. */
  6875. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6876. private static _GetFloatValue;
  6877. }
  6878. }
  6879. declare module "babylonjs/Meshes/Builders/capsuleBuilder" {
  6880. import { Vector3 } from "babylonjs/Maths/math.vector";
  6881. import { Mesh } from "babylonjs/Meshes/mesh";
  6882. /**
  6883. * The options Interface for creating a Capsule Mesh
  6884. */
  6885. export interface ICreateCapsuleOptions {
  6886. /** The Orientation of the capsule. Default : Vector3.Up() */
  6887. orientation?: Vector3;
  6888. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  6889. subdivisions: number;
  6890. /** Number of cylindrical segments on the capsule. */
  6891. tessellation: number;
  6892. /** Height or Length of the capsule. */
  6893. height: number;
  6894. /** Radius of the capsule. */
  6895. radius: number;
  6896. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  6897. capSubdivisions: number;
  6898. /** Overwrite for the top radius. */
  6899. radiusTop?: number;
  6900. /** Overwrite for the bottom radius. */
  6901. radiusBottom?: number;
  6902. /** Overwrite for the top capSubdivisions. */
  6903. topCapSubdivisions?: number;
  6904. /** Overwrite for the bottom capSubdivisions. */
  6905. bottomCapSubdivisions?: number;
  6906. }
  6907. /**
  6908. * Class containing static functions to help procedurally build meshes
  6909. */
  6910. export class CapsuleBuilder {
  6911. /**
  6912. * Creates a capsule or a pill mesh
  6913. * @param name defines the name of the mesh
  6914. * @param options The constructors options.
  6915. * @param scene The scene the mesh is scoped to.
  6916. * @returns Capsule Mesh
  6917. */
  6918. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  6919. }
  6920. }
  6921. declare module "babylonjs/Collisions/intersectionInfo" {
  6922. import { Nullable } from "babylonjs/types";
  6923. /**
  6924. * @hidden
  6925. */
  6926. export class IntersectionInfo {
  6927. bu: Nullable<number>;
  6928. bv: Nullable<number>;
  6929. distance: number;
  6930. faceId: number;
  6931. subMeshId: number;
  6932. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6933. }
  6934. }
  6935. declare module "babylonjs/Culling/boundingSphere" {
  6936. import { DeepImmutable } from "babylonjs/types";
  6937. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6938. import { Plane } from "babylonjs/Maths/math.plane";
  6939. /**
  6940. * Class used to store bounding sphere information
  6941. */
  6942. export class BoundingSphere {
  6943. /**
  6944. * Gets the center of the bounding sphere in local space
  6945. */
  6946. readonly center: Vector3;
  6947. /**
  6948. * Radius of the bounding sphere in local space
  6949. */
  6950. radius: number;
  6951. /**
  6952. * Gets the center of the bounding sphere in world space
  6953. */
  6954. readonly centerWorld: Vector3;
  6955. /**
  6956. * Radius of the bounding sphere in world space
  6957. */
  6958. radiusWorld: number;
  6959. /**
  6960. * Gets the minimum vector in local space
  6961. */
  6962. readonly minimum: Vector3;
  6963. /**
  6964. * Gets the maximum vector in local space
  6965. */
  6966. readonly maximum: Vector3;
  6967. private _worldMatrix;
  6968. private static readonly TmpVector3;
  6969. /**
  6970. * Creates a new bounding sphere
  6971. * @param min defines the minimum vector (in local space)
  6972. * @param max defines the maximum vector (in local space)
  6973. * @param worldMatrix defines the new world matrix
  6974. */
  6975. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6976. /**
  6977. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6978. * @param min defines the new minimum vector (in local space)
  6979. * @param max defines the new maximum vector (in local space)
  6980. * @param worldMatrix defines the new world matrix
  6981. */
  6982. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6983. /**
  6984. * Scale the current bounding sphere by applying a scale factor
  6985. * @param factor defines the scale factor to apply
  6986. * @returns the current bounding box
  6987. */
  6988. scale(factor: number): BoundingSphere;
  6989. /**
  6990. * Gets the world matrix of the bounding box
  6991. * @returns a matrix
  6992. */
  6993. getWorldMatrix(): DeepImmutable<Matrix>;
  6994. /** @hidden */
  6995. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6996. /**
  6997. * Tests if the bounding sphere is intersecting the frustum planes
  6998. * @param frustumPlanes defines the frustum planes to test
  6999. * @returns true if there is an intersection
  7000. */
  7001. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7002. /**
  7003. * Tests if the bounding sphere center is in between the frustum planes.
  7004. * Used for optimistic fast inclusion.
  7005. * @param frustumPlanes defines the frustum planes to test
  7006. * @returns true if the sphere center is in between the frustum planes
  7007. */
  7008. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7009. /**
  7010. * Tests if a point is inside the bounding sphere
  7011. * @param point defines the point to test
  7012. * @returns true if the point is inside the bounding sphere
  7013. */
  7014. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7015. /**
  7016. * Checks if two sphere intersct
  7017. * @param sphere0 sphere 0
  7018. * @param sphere1 sphere 1
  7019. * @returns true if the speres intersect
  7020. */
  7021. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  7022. }
  7023. }
  7024. declare module "babylonjs/Culling/boundingBox" {
  7025. import { DeepImmutable } from "babylonjs/types";
  7026. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7027. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7028. import { ICullable } from "babylonjs/Culling/boundingInfo";
  7029. import { Plane } from "babylonjs/Maths/math.plane";
  7030. /**
  7031. * Class used to store bounding box information
  7032. */
  7033. export class BoundingBox implements ICullable {
  7034. /**
  7035. * Gets the 8 vectors representing the bounding box in local space
  7036. */
  7037. readonly vectors: Vector3[];
  7038. /**
  7039. * Gets the center of the bounding box in local space
  7040. */
  7041. readonly center: Vector3;
  7042. /**
  7043. * Gets the center of the bounding box in world space
  7044. */
  7045. readonly centerWorld: Vector3;
  7046. /**
  7047. * Gets the extend size in local space
  7048. */
  7049. readonly extendSize: Vector3;
  7050. /**
  7051. * Gets the extend size in world space
  7052. */
  7053. readonly extendSizeWorld: Vector3;
  7054. /**
  7055. * Gets the OBB (object bounding box) directions
  7056. */
  7057. readonly directions: Vector3[];
  7058. /**
  7059. * Gets the 8 vectors representing the bounding box in world space
  7060. */
  7061. readonly vectorsWorld: Vector3[];
  7062. /**
  7063. * Gets the minimum vector in world space
  7064. */
  7065. readonly minimumWorld: Vector3;
  7066. /**
  7067. * Gets the maximum vector in world space
  7068. */
  7069. readonly maximumWorld: Vector3;
  7070. /**
  7071. * Gets the minimum vector in local space
  7072. */
  7073. readonly minimum: Vector3;
  7074. /**
  7075. * Gets the maximum vector in local space
  7076. */
  7077. readonly maximum: Vector3;
  7078. private _worldMatrix;
  7079. private static readonly TmpVector3;
  7080. /**
  7081. * @hidden
  7082. */
  7083. _tag: number;
  7084. /**
  7085. * Creates a new bounding box
  7086. * @param min defines the minimum vector (in local space)
  7087. * @param max defines the maximum vector (in local space)
  7088. * @param worldMatrix defines the new world matrix
  7089. */
  7090. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7091. /**
  7092. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7093. * @param min defines the new minimum vector (in local space)
  7094. * @param max defines the new maximum vector (in local space)
  7095. * @param worldMatrix defines the new world matrix
  7096. */
  7097. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7098. /**
  7099. * Scale the current bounding box by applying a scale factor
  7100. * @param factor defines the scale factor to apply
  7101. * @returns the current bounding box
  7102. */
  7103. scale(factor: number): BoundingBox;
  7104. /**
  7105. * Gets the world matrix of the bounding box
  7106. * @returns a matrix
  7107. */
  7108. getWorldMatrix(): DeepImmutable<Matrix>;
  7109. /** @hidden */
  7110. _update(world: DeepImmutable<Matrix>): void;
  7111. /**
  7112. * Tests if the bounding box is intersecting the frustum planes
  7113. * @param frustumPlanes defines the frustum planes to test
  7114. * @returns true if there is an intersection
  7115. */
  7116. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7117. /**
  7118. * Tests if the bounding box is entirely inside the frustum planes
  7119. * @param frustumPlanes defines the frustum planes to test
  7120. * @returns true if there is an inclusion
  7121. */
  7122. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7123. /**
  7124. * Tests if a point is inside the bounding box
  7125. * @param point defines the point to test
  7126. * @returns true if the point is inside the bounding box
  7127. */
  7128. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7129. /**
  7130. * Tests if the bounding box intersects with a bounding sphere
  7131. * @param sphere defines the sphere to test
  7132. * @returns true if there is an intersection
  7133. */
  7134. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7135. /**
  7136. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7137. * @param min defines the min vector to use
  7138. * @param max defines the max vector to use
  7139. * @returns true if there is an intersection
  7140. */
  7141. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7142. /**
  7143. * Tests if two bounding boxes are intersections
  7144. * @param box0 defines the first box to test
  7145. * @param box1 defines the second box to test
  7146. * @returns true if there is an intersection
  7147. */
  7148. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7149. /**
  7150. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7151. * @param minPoint defines the minimum vector of the bounding box
  7152. * @param maxPoint defines the maximum vector of the bounding box
  7153. * @param sphereCenter defines the sphere center
  7154. * @param sphereRadius defines the sphere radius
  7155. * @returns true if there is an intersection
  7156. */
  7157. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7158. /**
  7159. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7160. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7161. * @param frustumPlanes defines the frustum planes to test
  7162. * @return true if there is an inclusion
  7163. */
  7164. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7165. /**
  7166. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7167. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7168. * @param frustumPlanes defines the frustum planes to test
  7169. * @return true if there is an intersection
  7170. */
  7171. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7172. }
  7173. }
  7174. declare module "babylonjs/Collisions/collider" {
  7175. import { Nullable, IndicesArray } from "babylonjs/types";
  7176. import { Vector3 } from "babylonjs/Maths/math.vector";
  7177. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7178. import { Plane } from "babylonjs/Maths/math.plane";
  7179. /** @hidden */
  7180. export class Collider {
  7181. /** Define if a collision was found */
  7182. collisionFound: boolean;
  7183. /**
  7184. * Define last intersection point in local space
  7185. */
  7186. intersectionPoint: Vector3;
  7187. /**
  7188. * Define last collided mesh
  7189. */
  7190. collidedMesh: Nullable<AbstractMesh>;
  7191. private _collisionPoint;
  7192. private _planeIntersectionPoint;
  7193. private _tempVector;
  7194. private _tempVector2;
  7195. private _tempVector3;
  7196. private _tempVector4;
  7197. private _edge;
  7198. private _baseToVertex;
  7199. private _destinationPoint;
  7200. private _slidePlaneNormal;
  7201. private _displacementVector;
  7202. /** @hidden */
  7203. _radius: Vector3;
  7204. /** @hidden */
  7205. _retry: number;
  7206. private _velocity;
  7207. private _basePoint;
  7208. private _epsilon;
  7209. /** @hidden */
  7210. _velocityWorldLength: number;
  7211. /** @hidden */
  7212. _basePointWorld: Vector3;
  7213. private _velocityWorld;
  7214. private _normalizedVelocity;
  7215. /** @hidden */
  7216. _initialVelocity: Vector3;
  7217. /** @hidden */
  7218. _initialPosition: Vector3;
  7219. private _nearestDistance;
  7220. private _collisionMask;
  7221. get collisionMask(): number;
  7222. set collisionMask(mask: number);
  7223. /**
  7224. * Gets the plane normal used to compute the sliding response (in local space)
  7225. */
  7226. get slidePlaneNormal(): Vector3;
  7227. /** @hidden */
  7228. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7229. /** @hidden */
  7230. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7231. /** @hidden */
  7232. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7233. /** @hidden */
  7234. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7235. /** @hidden */
  7236. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7237. /** @hidden */
  7238. _getResponse(pos: Vector3, vel: Vector3): void;
  7239. }
  7240. }
  7241. declare module "babylonjs/Culling/boundingInfo" {
  7242. import { DeepImmutable } from "babylonjs/types";
  7243. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7244. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7245. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7246. import { Plane } from "babylonjs/Maths/math.plane";
  7247. import { Collider } from "babylonjs/Collisions/collider";
  7248. /**
  7249. * Interface for cullable objects
  7250. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7251. */
  7252. export interface ICullable {
  7253. /**
  7254. * Checks if the object or part of the object is in the frustum
  7255. * @param frustumPlanes Camera near/planes
  7256. * @returns true if the object is in frustum otherwise false
  7257. */
  7258. isInFrustum(frustumPlanes: Plane[]): boolean;
  7259. /**
  7260. * Checks if a cullable object (mesh...) is in the camera frustum
  7261. * Unlike isInFrustum this cheks the full bounding box
  7262. * @param frustumPlanes Camera near/planes
  7263. * @returns true if the object is in frustum otherwise false
  7264. */
  7265. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7266. }
  7267. /**
  7268. * Info for a bounding data of a mesh
  7269. */
  7270. export class BoundingInfo implements ICullable {
  7271. /**
  7272. * Bounding box for the mesh
  7273. */
  7274. readonly boundingBox: BoundingBox;
  7275. /**
  7276. * Bounding sphere for the mesh
  7277. */
  7278. readonly boundingSphere: BoundingSphere;
  7279. private _isLocked;
  7280. private static readonly TmpVector3;
  7281. /**
  7282. * Constructs bounding info
  7283. * @param minimum min vector of the bounding box/sphere
  7284. * @param maximum max vector of the bounding box/sphere
  7285. * @param worldMatrix defines the new world matrix
  7286. */
  7287. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7288. /**
  7289. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7290. * @param min defines the new minimum vector (in local space)
  7291. * @param max defines the new maximum vector (in local space)
  7292. * @param worldMatrix defines the new world matrix
  7293. */
  7294. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7295. /**
  7296. * min vector of the bounding box/sphere
  7297. */
  7298. get minimum(): Vector3;
  7299. /**
  7300. * max vector of the bounding box/sphere
  7301. */
  7302. get maximum(): Vector3;
  7303. /**
  7304. * If the info is locked and won't be updated to avoid perf overhead
  7305. */
  7306. get isLocked(): boolean;
  7307. set isLocked(value: boolean);
  7308. /**
  7309. * Updates the bounding sphere and box
  7310. * @param world world matrix to be used to update
  7311. */
  7312. update(world: DeepImmutable<Matrix>): void;
  7313. /**
  7314. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7315. * @param center New center of the bounding info
  7316. * @param extend New extend of the bounding info
  7317. * @returns the current bounding info
  7318. */
  7319. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7320. /**
  7321. * Scale the current bounding info by applying a scale factor
  7322. * @param factor defines the scale factor to apply
  7323. * @returns the current bounding info
  7324. */
  7325. scale(factor: number): BoundingInfo;
  7326. /**
  7327. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7328. * @param frustumPlanes defines the frustum to test
  7329. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7330. * @returns true if the bounding info is in the frustum planes
  7331. */
  7332. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7333. /**
  7334. * Gets the world distance between the min and max points of the bounding box
  7335. */
  7336. get diagonalLength(): number;
  7337. /**
  7338. * Checks if a cullable object (mesh...) is in the camera frustum
  7339. * Unlike isInFrustum this cheks the full bounding box
  7340. * @param frustumPlanes Camera near/planes
  7341. * @returns true if the object is in frustum otherwise false
  7342. */
  7343. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7344. /** @hidden */
  7345. _checkCollision(collider: Collider): boolean;
  7346. /**
  7347. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7348. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7349. * @param point the point to check intersection with
  7350. * @returns if the point intersects
  7351. */
  7352. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7353. /**
  7354. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7355. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7356. * @param boundingInfo the bounding info to check intersection with
  7357. * @param precise if the intersection should be done using OBB
  7358. * @returns if the bounding info intersects
  7359. */
  7360. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7361. }
  7362. }
  7363. declare module "babylonjs/Maths/math.functions" {
  7364. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7365. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7366. /**
  7367. * Extracts minimum and maximum values from a list of indexed positions
  7368. * @param positions defines the positions to use
  7369. * @param indices defines the indices to the positions
  7370. * @param indexStart defines the start index
  7371. * @param indexCount defines the end index
  7372. * @param bias defines bias value to add to the result
  7373. * @return minimum and maximum values
  7374. */
  7375. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7376. minimum: Vector3;
  7377. maximum: Vector3;
  7378. };
  7379. /**
  7380. * Extracts minimum and maximum values from a list of positions
  7381. * @param positions defines the positions to use
  7382. * @param start defines the start index in the positions array
  7383. * @param count defines the number of positions to handle
  7384. * @param bias defines bias value to add to the result
  7385. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7386. * @return minimum and maximum values
  7387. */
  7388. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7389. minimum: Vector3;
  7390. maximum: Vector3;
  7391. };
  7392. }
  7393. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7394. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7395. /** @hidden */
  7396. export class WebGLDataBuffer extends DataBuffer {
  7397. private _buffer;
  7398. constructor(resource: WebGLBuffer);
  7399. get underlyingResource(): any;
  7400. }
  7401. }
  7402. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7403. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7404. import { Nullable } from "babylonjs/types";
  7405. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7406. /** @hidden */
  7407. export class WebGLPipelineContext implements IPipelineContext {
  7408. engine: ThinEngine;
  7409. program: Nullable<WebGLProgram>;
  7410. context?: WebGLRenderingContext;
  7411. vertexShader?: WebGLShader;
  7412. fragmentShader?: WebGLShader;
  7413. isParallelCompiled: boolean;
  7414. onCompiled?: () => void;
  7415. transformFeedback?: WebGLTransformFeedback | null;
  7416. vertexCompilationError: Nullable<string>;
  7417. fragmentCompilationError: Nullable<string>;
  7418. programLinkError: Nullable<string>;
  7419. programValidationError: Nullable<string>;
  7420. get isAsync(): boolean;
  7421. get isReady(): boolean;
  7422. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7423. _getVertexShaderCode(): string | null;
  7424. _getFragmentShaderCode(): string | null;
  7425. }
  7426. }
  7427. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7428. import { FloatArray, Nullable } from "babylonjs/types";
  7429. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7430. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7431. module "babylonjs/Engines/thinEngine" {
  7432. interface ThinEngine {
  7433. /**
  7434. * Create an uniform buffer
  7435. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7436. * @param elements defines the content of the uniform buffer
  7437. * @returns the webGL uniform buffer
  7438. */
  7439. createUniformBuffer(elements: FloatArray): DataBuffer;
  7440. /**
  7441. * Create a dynamic uniform buffer
  7442. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7443. * @param elements defines the content of the uniform buffer
  7444. * @returns the webGL uniform buffer
  7445. */
  7446. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7447. /**
  7448. * Update an existing uniform buffer
  7449. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7450. * @param uniformBuffer defines the target uniform buffer
  7451. * @param elements defines the content to update
  7452. * @param offset defines the offset in the uniform buffer where update should start
  7453. * @param count defines the size of the data to update
  7454. */
  7455. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7456. /**
  7457. * Bind an uniform buffer to the current webGL context
  7458. * @param buffer defines the buffer to bind
  7459. */
  7460. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7461. /**
  7462. * Bind a buffer to the current webGL context at a given location
  7463. * @param buffer defines the buffer to bind
  7464. * @param location defines the index where to bind the buffer
  7465. */
  7466. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7467. /**
  7468. * Bind a specific block at a given index in a specific shader program
  7469. * @param pipelineContext defines the pipeline context to use
  7470. * @param blockName defines the block name
  7471. * @param index defines the index where to bind the block
  7472. */
  7473. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7474. }
  7475. }
  7476. }
  7477. declare module "babylonjs/Materials/uniformBuffer" {
  7478. import { Nullable, FloatArray } from "babylonjs/types";
  7479. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7480. import { Engine } from "babylonjs/Engines/engine";
  7481. import { Effect } from "babylonjs/Materials/effect";
  7482. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7483. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7484. import { Color3 } from "babylonjs/Maths/math.color";
  7485. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7486. /**
  7487. * Uniform buffer objects.
  7488. *
  7489. * Handles blocks of uniform on the GPU.
  7490. *
  7491. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7492. *
  7493. * For more information, please refer to :
  7494. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7495. */
  7496. export class UniformBuffer {
  7497. private _engine;
  7498. private _buffer;
  7499. private _data;
  7500. private _bufferData;
  7501. private _dynamic?;
  7502. private _uniformLocations;
  7503. private _uniformSizes;
  7504. private _uniformLocationPointer;
  7505. private _needSync;
  7506. private _noUBO;
  7507. private _currentEffect;
  7508. /** @hidden */
  7509. _alreadyBound: boolean;
  7510. private static _MAX_UNIFORM_SIZE;
  7511. private static _tempBuffer;
  7512. /**
  7513. * Lambda to Update a 3x3 Matrix 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. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7518. /**
  7519. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7520. * This is dynamic to allow compat with webgl 1 and 2.
  7521. * You will need to pass the name of the uniform as well as the value.
  7522. */
  7523. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7524. /**
  7525. * Lambda to Update a single float in a uniform buffer.
  7526. * This is dynamic to allow compat with webgl 1 and 2.
  7527. * You will need to pass the name of the uniform as well as the value.
  7528. */
  7529. updateFloat: (name: string, x: number) => void;
  7530. /**
  7531. * Lambda to Update a vec2 of float in a uniform buffer.
  7532. * This is dynamic to allow compat with webgl 1 and 2.
  7533. * You will need to pass the name of the uniform as well as the value.
  7534. */
  7535. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7536. /**
  7537. * Lambda to Update a vec3 of float in a uniform buffer.
  7538. * This is dynamic to allow compat with webgl 1 and 2.
  7539. * You will need to pass the name of the uniform as well as the value.
  7540. */
  7541. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7542. /**
  7543. * Lambda to Update a vec4 of float in a uniform buffer.
  7544. * This is dynamic to allow compat with webgl 1 and 2.
  7545. * You will need to pass the name of the uniform as well as the value.
  7546. */
  7547. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7548. /**
  7549. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7550. * This is dynamic to allow compat with webgl 1 and 2.
  7551. * You will need to pass the name of the uniform as well as the value.
  7552. */
  7553. updateMatrix: (name: string, mat: Matrix) => void;
  7554. /**
  7555. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7556. * This is dynamic to allow compat with webgl 1 and 2.
  7557. * You will need to pass the name of the uniform as well as the value.
  7558. */
  7559. updateVector3: (name: string, vector: Vector3) => void;
  7560. /**
  7561. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7562. * This is dynamic to allow compat with webgl 1 and 2.
  7563. * You will need to pass the name of the uniform as well as the value.
  7564. */
  7565. updateVector4: (name: string, vector: Vector4) => void;
  7566. /**
  7567. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7568. * This is dynamic to allow compat with webgl 1 and 2.
  7569. * You will need to pass the name of the uniform as well as the value.
  7570. */
  7571. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7572. /**
  7573. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7574. * This is dynamic to allow compat with webgl 1 and 2.
  7575. * You will need to pass the name of the uniform as well as the value.
  7576. */
  7577. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7578. /**
  7579. * Instantiates a new Uniform buffer objects.
  7580. *
  7581. * Handles blocks of uniform on the GPU.
  7582. *
  7583. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7584. *
  7585. * For more information, please refer to :
  7586. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7587. * @param engine Define the engine the buffer is associated with
  7588. * @param data Define the data contained in the buffer
  7589. * @param dynamic Define if the buffer is updatable
  7590. */
  7591. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7592. /**
  7593. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7594. * or just falling back on setUniformXXX calls.
  7595. */
  7596. get useUbo(): boolean;
  7597. /**
  7598. * Indicates if the WebGL underlying uniform buffer is in sync
  7599. * with the javascript cache data.
  7600. */
  7601. get isSync(): boolean;
  7602. /**
  7603. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7604. * Also, a dynamic UniformBuffer will disable cache verification and always
  7605. * update the underlying WebGL uniform buffer to the GPU.
  7606. * @returns if Dynamic, otherwise false
  7607. */
  7608. isDynamic(): boolean;
  7609. /**
  7610. * The data cache on JS side.
  7611. * @returns the underlying data as a float array
  7612. */
  7613. getData(): Float32Array;
  7614. /**
  7615. * The underlying WebGL Uniform buffer.
  7616. * @returns the webgl buffer
  7617. */
  7618. getBuffer(): Nullable<DataBuffer>;
  7619. /**
  7620. * std140 layout specifies how to align data within an UBO structure.
  7621. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7622. * for specs.
  7623. */
  7624. private _fillAlignment;
  7625. /**
  7626. * Adds an uniform in the buffer.
  7627. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7628. * for the layout to be correct !
  7629. * @param name Name of the uniform, as used in the uniform block in the shader.
  7630. * @param size Data size, or data directly.
  7631. */
  7632. addUniform(name: string, size: number | number[]): void;
  7633. /**
  7634. * Adds a Matrix 4x4 to the uniform buffer.
  7635. * @param name Name of the uniform, as used in the uniform block in the shader.
  7636. * @param mat A 4x4 matrix.
  7637. */
  7638. addMatrix(name: string, mat: Matrix): void;
  7639. /**
  7640. * Adds a vec2 to the uniform buffer.
  7641. * @param name Name of the uniform, as used in the uniform block in the shader.
  7642. * @param x Define the x component value of the vec2
  7643. * @param y Define the y component value of the vec2
  7644. */
  7645. addFloat2(name: string, x: number, y: number): void;
  7646. /**
  7647. * Adds a vec3 to the uniform buffer.
  7648. * @param name Name of the uniform, as used in the uniform block in the shader.
  7649. * @param x Define the x component value of the vec3
  7650. * @param y Define the y component value of the vec3
  7651. * @param z Define the z component value of the vec3
  7652. */
  7653. addFloat3(name: string, x: number, y: number, z: number): void;
  7654. /**
  7655. * Adds a vec3 to the uniform buffer.
  7656. * @param name Name of the uniform, as used in the uniform block in the shader.
  7657. * @param color Define the vec3 from a Color
  7658. */
  7659. addColor3(name: string, color: Color3): void;
  7660. /**
  7661. * Adds a vec4 to the uniform buffer.
  7662. * @param name Name of the uniform, as used in the uniform block in the shader.
  7663. * @param color Define the rgb components from a Color
  7664. * @param alpha Define the a component of the vec4
  7665. */
  7666. addColor4(name: string, color: Color3, alpha: number): void;
  7667. /**
  7668. * Adds a vec3 to the uniform buffer.
  7669. * @param name Name of the uniform, as used in the uniform block in the shader.
  7670. * @param vector Define the vec3 components from a Vector
  7671. */
  7672. addVector3(name: string, vector: Vector3): void;
  7673. /**
  7674. * Adds a Matrix 3x3 to the uniform buffer.
  7675. * @param name Name of the uniform, as used in the uniform block in the shader.
  7676. */
  7677. addMatrix3x3(name: string): void;
  7678. /**
  7679. * Adds a Matrix 2x2 to the uniform buffer.
  7680. * @param name Name of the uniform, as used in the uniform block in the shader.
  7681. */
  7682. addMatrix2x2(name: string): void;
  7683. /**
  7684. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7685. */
  7686. create(): void;
  7687. /** @hidden */
  7688. _rebuild(): void;
  7689. /**
  7690. * Updates the WebGL Uniform Buffer on the GPU.
  7691. * If the `dynamic` flag is set to true, no cache comparison is done.
  7692. * Otherwise, the buffer will be updated only if the cache differs.
  7693. */
  7694. update(): void;
  7695. /**
  7696. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7697. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7698. * @param data Define the flattened data
  7699. * @param size Define the size of the data.
  7700. */
  7701. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7702. private _valueCache;
  7703. private _cacheMatrix;
  7704. private _updateMatrix3x3ForUniform;
  7705. private _updateMatrix3x3ForEffect;
  7706. private _updateMatrix2x2ForEffect;
  7707. private _updateMatrix2x2ForUniform;
  7708. private _updateFloatForEffect;
  7709. private _updateFloatForUniform;
  7710. private _updateFloat2ForEffect;
  7711. private _updateFloat2ForUniform;
  7712. private _updateFloat3ForEffect;
  7713. private _updateFloat3ForUniform;
  7714. private _updateFloat4ForEffect;
  7715. private _updateFloat4ForUniform;
  7716. private _updateMatrixForEffect;
  7717. private _updateMatrixForUniform;
  7718. private _updateVector3ForEffect;
  7719. private _updateVector3ForUniform;
  7720. private _updateVector4ForEffect;
  7721. private _updateVector4ForUniform;
  7722. private _updateColor3ForEffect;
  7723. private _updateColor3ForUniform;
  7724. private _updateColor4ForEffect;
  7725. private _updateColor4ForUniform;
  7726. /**
  7727. * Sets a sampler uniform on the effect.
  7728. * @param name Define the name of the sampler.
  7729. * @param texture Define the texture to set in the sampler
  7730. */
  7731. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7732. /**
  7733. * Directly updates the value of the uniform in the cache AND on the GPU.
  7734. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7735. * @param data Define the flattened data
  7736. */
  7737. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7738. /**
  7739. * Binds this uniform buffer to an effect.
  7740. * @param effect Define the effect to bind the buffer to
  7741. * @param name Name of the uniform block in the shader.
  7742. */
  7743. bindToEffect(effect: Effect, name: string): void;
  7744. /**
  7745. * Disposes the uniform buffer.
  7746. */
  7747. dispose(): void;
  7748. }
  7749. }
  7750. declare module "babylonjs/Misc/iInspectable" {
  7751. /**
  7752. * Enum that determines the text-wrapping mode to use.
  7753. */
  7754. export enum InspectableType {
  7755. /**
  7756. * Checkbox for booleans
  7757. */
  7758. Checkbox = 0,
  7759. /**
  7760. * Sliders for numbers
  7761. */
  7762. Slider = 1,
  7763. /**
  7764. * Vector3
  7765. */
  7766. Vector3 = 2,
  7767. /**
  7768. * Quaternions
  7769. */
  7770. Quaternion = 3,
  7771. /**
  7772. * Color3
  7773. */
  7774. Color3 = 4,
  7775. /**
  7776. * String
  7777. */
  7778. String = 5
  7779. }
  7780. /**
  7781. * Interface used to define custom inspectable properties.
  7782. * This interface is used by the inspector to display custom property grids
  7783. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7784. */
  7785. export interface IInspectable {
  7786. /**
  7787. * Gets the label to display
  7788. */
  7789. label: string;
  7790. /**
  7791. * Gets the name of the property to edit
  7792. */
  7793. propertyName: string;
  7794. /**
  7795. * Gets the type of the editor to use
  7796. */
  7797. type: InspectableType;
  7798. /**
  7799. * Gets the minimum value of the property when using in "slider" mode
  7800. */
  7801. min?: number;
  7802. /**
  7803. * Gets the maximum value of the property when using in "slider" mode
  7804. */
  7805. max?: number;
  7806. /**
  7807. * Gets the setp to use when using in "slider" mode
  7808. */
  7809. step?: number;
  7810. }
  7811. }
  7812. declare module "babylonjs/Misc/timingTools" {
  7813. /**
  7814. * Class used to provide helper for timing
  7815. */
  7816. export class TimingTools {
  7817. /**
  7818. * Polyfill for setImmediate
  7819. * @param action defines the action to execute after the current execution block
  7820. */
  7821. static SetImmediate(action: () => void): void;
  7822. }
  7823. }
  7824. declare module "babylonjs/Misc/instantiationTools" {
  7825. /**
  7826. * Class used to enable instatition of objects by class name
  7827. */
  7828. export class InstantiationTools {
  7829. /**
  7830. * Use this object to register external classes like custom textures or material
  7831. * to allow the laoders to instantiate them
  7832. */
  7833. static RegisteredExternalClasses: {
  7834. [key: string]: Object;
  7835. };
  7836. /**
  7837. * Tries to instantiate a new object from a given class name
  7838. * @param className defines the class name to instantiate
  7839. * @returns the new object or null if the system was not able to do the instantiation
  7840. */
  7841. static Instantiate(className: string): any;
  7842. }
  7843. }
  7844. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7845. /**
  7846. * Define options used to create a depth texture
  7847. */
  7848. export class DepthTextureCreationOptions {
  7849. /** Specifies whether or not a stencil should be allocated in the texture */
  7850. generateStencil?: boolean;
  7851. /** Specifies whether or not bilinear filtering is enable on the texture */
  7852. bilinearFiltering?: boolean;
  7853. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7854. comparisonFunction?: number;
  7855. /** Specifies if the created texture is a cube texture */
  7856. isCube?: boolean;
  7857. }
  7858. }
  7859. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7860. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7861. import { Nullable } from "babylonjs/types";
  7862. import { Scene } from "babylonjs/scene";
  7863. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7864. module "babylonjs/Engines/thinEngine" {
  7865. interface ThinEngine {
  7866. /**
  7867. * Creates a depth stencil cube texture.
  7868. * This is only available in WebGL 2.
  7869. * @param size The size of face edge in the cube texture.
  7870. * @param options The options defining the cube texture.
  7871. * @returns The cube texture
  7872. */
  7873. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7874. /**
  7875. * Creates a cube texture
  7876. * @param rootUrl defines the url where the files to load is located
  7877. * @param scene defines the current scene
  7878. * @param files defines the list of files to load (1 per face)
  7879. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7880. * @param onLoad defines an optional callback raised when the texture is loaded
  7881. * @param onError defines an optional callback raised if there is an issue to load the texture
  7882. * @param format defines the format of the data
  7883. * @param forcedExtension defines the extension to use to pick the right loader
  7884. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7885. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7886. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7887. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7888. * @returns the cube texture as an InternalTexture
  7889. */
  7890. 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;
  7891. /**
  7892. * Creates a cube texture
  7893. * @param rootUrl defines the url where the files to load is located
  7894. * @param scene defines the current scene
  7895. * @param files defines the list of files to load (1 per face)
  7896. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7897. * @param onLoad defines an optional callback raised when the texture is loaded
  7898. * @param onError defines an optional callback raised if there is an issue to load the texture
  7899. * @param format defines the format of the data
  7900. * @param forcedExtension defines the extension to use to pick the right loader
  7901. * @returns the cube texture as an InternalTexture
  7902. */
  7903. 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;
  7904. /**
  7905. * Creates a cube texture
  7906. * @param rootUrl defines the url where the files to load is located
  7907. * @param scene defines the current scene
  7908. * @param files defines the list of files to load (1 per face)
  7909. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7910. * @param onLoad defines an optional callback raised when the texture is loaded
  7911. * @param onError defines an optional callback raised if there is an issue to load the texture
  7912. * @param format defines the format of the data
  7913. * @param forcedExtension defines the extension to use to pick the right loader
  7914. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7915. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7916. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7917. * @returns the cube texture as an InternalTexture
  7918. */
  7919. 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;
  7920. /** @hidden */
  7921. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7922. /** @hidden */
  7923. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7924. /** @hidden */
  7925. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7926. /** @hidden */
  7927. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7928. /**
  7929. * @hidden
  7930. */
  7931. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7932. }
  7933. }
  7934. }
  7935. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7936. import { Nullable } from "babylonjs/types";
  7937. import { Scene } from "babylonjs/scene";
  7938. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7939. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7940. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7941. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7942. import { Observable } from "babylonjs/Misc/observable";
  7943. /**
  7944. * Class for creating a cube texture
  7945. */
  7946. export class CubeTexture extends BaseTexture {
  7947. private _delayedOnLoad;
  7948. /**
  7949. * Observable triggered once the texture has been loaded.
  7950. */
  7951. onLoadObservable: Observable<CubeTexture>;
  7952. /**
  7953. * The url of the texture
  7954. */
  7955. url: string;
  7956. /**
  7957. * Gets or sets the center of the bounding box associated with the cube texture.
  7958. * It must define where the camera used to render the texture was set
  7959. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7960. */
  7961. boundingBoxPosition: Vector3;
  7962. private _boundingBoxSize;
  7963. /**
  7964. * Gets or sets the size of the bounding box associated with the cube texture
  7965. * When defined, the cubemap will switch to local mode
  7966. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7967. * @example https://www.babylonjs-playground.com/#RNASML
  7968. */
  7969. set boundingBoxSize(value: Vector3);
  7970. /**
  7971. * Returns the bounding box size
  7972. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7973. */
  7974. get boundingBoxSize(): Vector3;
  7975. protected _rotationY: number;
  7976. /**
  7977. * Sets texture matrix rotation angle around Y axis in radians.
  7978. */
  7979. set rotationY(value: number);
  7980. /**
  7981. * Gets texture matrix rotation angle around Y axis radians.
  7982. */
  7983. get rotationY(): number;
  7984. /**
  7985. * Are mip maps generated for this texture or not.
  7986. */
  7987. get noMipmap(): boolean;
  7988. private _noMipmap;
  7989. private _files;
  7990. protected _forcedExtension: Nullable<string>;
  7991. private _extensions;
  7992. private _textureMatrix;
  7993. private _format;
  7994. private _createPolynomials;
  7995. /**
  7996. * Creates a cube texture from an array of image urls
  7997. * @param files defines an array of image urls
  7998. * @param scene defines the hosting scene
  7999. * @param noMipmap specifies if mip maps are not used
  8000. * @returns a cube texture
  8001. */
  8002. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  8003. /**
  8004. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  8005. * @param url defines the url of the prefiltered texture
  8006. * @param scene defines the scene the texture is attached to
  8007. * @param forcedExtension defines the extension of the file if different from the url
  8008. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  8009. * @return the prefiltered texture
  8010. */
  8011. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  8012. /**
  8013. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  8014. * as prefiltered data.
  8015. * @param rootUrl defines the url of the texture or the root name of the six images
  8016. * @param null defines the scene or engine the texture is attached to
  8017. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  8018. * @param noMipmap defines if mipmaps should be created or not
  8019. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  8020. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  8021. * @param onError defines a callback triggered in case of error during load
  8022. * @param format defines the internal format to use for the texture once loaded
  8023. * @param prefiltered defines whether or not the texture is created from prefiltered data
  8024. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  8025. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  8026. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  8027. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  8028. * @return the cube texture
  8029. */
  8030. 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);
  8031. /**
  8032. * Get the current class name of the texture useful for serialization or dynamic coding.
  8033. * @returns "CubeTexture"
  8034. */
  8035. getClassName(): string;
  8036. /**
  8037. * Update the url (and optional buffer) of this texture if url was null during construction.
  8038. * @param url the url of the texture
  8039. * @param forcedExtension defines the extension to use
  8040. * @param onLoad callback called when the texture is loaded (defaults to null)
  8041. * @param prefiltered Defines whether the updated texture is prefiltered or not
  8042. */
  8043. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  8044. /**
  8045. * Delays loading of the cube texture
  8046. * @param forcedExtension defines the extension to use
  8047. */
  8048. delayLoad(forcedExtension?: string): void;
  8049. /**
  8050. * Returns the reflection texture matrix
  8051. * @returns the reflection texture matrix
  8052. */
  8053. getReflectionTextureMatrix(): Matrix;
  8054. /**
  8055. * Sets the reflection texture matrix
  8056. * @param value Reflection texture matrix
  8057. */
  8058. setReflectionTextureMatrix(value: Matrix): void;
  8059. /**
  8060. * Parses text to create a cube texture
  8061. * @param parsedTexture define the serialized text to read from
  8062. * @param scene defines the hosting scene
  8063. * @param rootUrl defines the root url of the cube texture
  8064. * @returns a cube texture
  8065. */
  8066. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8067. /**
  8068. * Makes a clone, or deep copy, of the cube texture
  8069. * @returns a new cube texture
  8070. */
  8071. clone(): CubeTexture;
  8072. }
  8073. }
  8074. declare module "babylonjs/Materials/materialDefines" {
  8075. /**
  8076. * Manages the defines for the Material
  8077. */
  8078. export class MaterialDefines {
  8079. /** @hidden */
  8080. protected _keys: string[];
  8081. private _isDirty;
  8082. /** @hidden */
  8083. _renderId: number;
  8084. /** @hidden */
  8085. _areLightsDirty: boolean;
  8086. /** @hidden */
  8087. _areLightsDisposed: boolean;
  8088. /** @hidden */
  8089. _areAttributesDirty: boolean;
  8090. /** @hidden */
  8091. _areTexturesDirty: boolean;
  8092. /** @hidden */
  8093. _areFresnelDirty: boolean;
  8094. /** @hidden */
  8095. _areMiscDirty: boolean;
  8096. /** @hidden */
  8097. _areImageProcessingDirty: boolean;
  8098. /** @hidden */
  8099. _normals: boolean;
  8100. /** @hidden */
  8101. _uvs: boolean;
  8102. /** @hidden */
  8103. _needNormals: boolean;
  8104. /** @hidden */
  8105. _needUVs: boolean;
  8106. [id: string]: any;
  8107. /**
  8108. * Specifies if the material needs to be re-calculated
  8109. */
  8110. get isDirty(): boolean;
  8111. /**
  8112. * Marks the material to indicate that it has been re-calculated
  8113. */
  8114. markAsProcessed(): void;
  8115. /**
  8116. * Marks the material to indicate that it needs to be re-calculated
  8117. */
  8118. markAsUnprocessed(): void;
  8119. /**
  8120. * Marks the material to indicate all of its defines need to be re-calculated
  8121. */
  8122. markAllAsDirty(): void;
  8123. /**
  8124. * Marks the material to indicate that image processing needs to be re-calculated
  8125. */
  8126. markAsImageProcessingDirty(): void;
  8127. /**
  8128. * Marks the material to indicate the lights need to be re-calculated
  8129. * @param disposed Defines whether the light is dirty due to dispose or not
  8130. */
  8131. markAsLightDirty(disposed?: boolean): void;
  8132. /**
  8133. * Marks the attribute state as changed
  8134. */
  8135. markAsAttributesDirty(): void;
  8136. /**
  8137. * Marks the texture state as changed
  8138. */
  8139. markAsTexturesDirty(): void;
  8140. /**
  8141. * Marks the fresnel state as changed
  8142. */
  8143. markAsFresnelDirty(): void;
  8144. /**
  8145. * Marks the misc state as changed
  8146. */
  8147. markAsMiscDirty(): void;
  8148. /**
  8149. * Rebuilds the material defines
  8150. */
  8151. rebuild(): void;
  8152. /**
  8153. * Specifies if two material defines are equal
  8154. * @param other - A material define instance to compare to
  8155. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8156. */
  8157. isEqual(other: MaterialDefines): boolean;
  8158. /**
  8159. * Clones this instance's defines to another instance
  8160. * @param other - material defines to clone values to
  8161. */
  8162. cloneTo(other: MaterialDefines): void;
  8163. /**
  8164. * Resets the material define values
  8165. */
  8166. reset(): void;
  8167. /**
  8168. * Converts the material define values to a string
  8169. * @returns - String of material define information
  8170. */
  8171. toString(): string;
  8172. }
  8173. }
  8174. declare module "babylonjs/Materials/colorCurves" {
  8175. import { Effect } from "babylonjs/Materials/effect";
  8176. /**
  8177. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8178. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8179. * 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;
  8180. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8181. */
  8182. export class ColorCurves {
  8183. private _dirty;
  8184. private _tempColor;
  8185. private _globalCurve;
  8186. private _highlightsCurve;
  8187. private _midtonesCurve;
  8188. private _shadowsCurve;
  8189. private _positiveCurve;
  8190. private _negativeCurve;
  8191. private _globalHue;
  8192. private _globalDensity;
  8193. private _globalSaturation;
  8194. private _globalExposure;
  8195. /**
  8196. * Gets the global Hue value.
  8197. * 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).
  8198. */
  8199. get globalHue(): number;
  8200. /**
  8201. * Sets the global Hue value.
  8202. * 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).
  8203. */
  8204. set globalHue(value: number);
  8205. /**
  8206. * Gets the global Density value.
  8207. * 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.
  8208. * Values less than zero provide a filter of opposite hue.
  8209. */
  8210. get globalDensity(): number;
  8211. /**
  8212. * Sets the global Density value.
  8213. * 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.
  8214. * Values less than zero provide a filter of opposite hue.
  8215. */
  8216. set globalDensity(value: number);
  8217. /**
  8218. * Gets the global Saturation value.
  8219. * 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.
  8220. */
  8221. get globalSaturation(): number;
  8222. /**
  8223. * Sets the global Saturation value.
  8224. * 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.
  8225. */
  8226. set globalSaturation(value: number);
  8227. /**
  8228. * Gets the global Exposure value.
  8229. * 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.
  8230. */
  8231. get globalExposure(): number;
  8232. /**
  8233. * Sets the global Exposure value.
  8234. * 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.
  8235. */
  8236. set globalExposure(value: number);
  8237. private _highlightsHue;
  8238. private _highlightsDensity;
  8239. private _highlightsSaturation;
  8240. private _highlightsExposure;
  8241. /**
  8242. * Gets the highlights Hue value.
  8243. * 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).
  8244. */
  8245. get highlightsHue(): number;
  8246. /**
  8247. * Sets the highlights Hue value.
  8248. * 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).
  8249. */
  8250. set highlightsHue(value: number);
  8251. /**
  8252. * Gets the highlights Density value.
  8253. * 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.
  8254. * Values less than zero provide a filter of opposite hue.
  8255. */
  8256. get highlightsDensity(): number;
  8257. /**
  8258. * Sets the highlights Density value.
  8259. * 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.
  8260. * Values less than zero provide a filter of opposite hue.
  8261. */
  8262. set highlightsDensity(value: number);
  8263. /**
  8264. * Gets the highlights Saturation value.
  8265. * 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.
  8266. */
  8267. get highlightsSaturation(): number;
  8268. /**
  8269. * Sets the highlights Saturation value.
  8270. * 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.
  8271. */
  8272. set highlightsSaturation(value: number);
  8273. /**
  8274. * Gets the highlights Exposure value.
  8275. * 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.
  8276. */
  8277. get highlightsExposure(): number;
  8278. /**
  8279. * Sets the highlights Exposure value.
  8280. * 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.
  8281. */
  8282. set highlightsExposure(value: number);
  8283. private _midtonesHue;
  8284. private _midtonesDensity;
  8285. private _midtonesSaturation;
  8286. private _midtonesExposure;
  8287. /**
  8288. * Gets the midtones Hue value.
  8289. * 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).
  8290. */
  8291. get midtonesHue(): number;
  8292. /**
  8293. * Sets the midtones Hue value.
  8294. * 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).
  8295. */
  8296. set midtonesHue(value: number);
  8297. /**
  8298. * Gets the midtones Density value.
  8299. * 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.
  8300. * Values less than zero provide a filter of opposite hue.
  8301. */
  8302. get midtonesDensity(): number;
  8303. /**
  8304. * Sets the midtones Density value.
  8305. * 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.
  8306. * Values less than zero provide a filter of opposite hue.
  8307. */
  8308. set midtonesDensity(value: number);
  8309. /**
  8310. * Gets the midtones Saturation value.
  8311. * 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.
  8312. */
  8313. get midtonesSaturation(): number;
  8314. /**
  8315. * Sets the midtones Saturation value.
  8316. * 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.
  8317. */
  8318. set midtonesSaturation(value: number);
  8319. /**
  8320. * Gets the midtones Exposure value.
  8321. * 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.
  8322. */
  8323. get midtonesExposure(): number;
  8324. /**
  8325. * Sets the midtones Exposure value.
  8326. * 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.
  8327. */
  8328. set midtonesExposure(value: number);
  8329. private _shadowsHue;
  8330. private _shadowsDensity;
  8331. private _shadowsSaturation;
  8332. private _shadowsExposure;
  8333. /**
  8334. * Gets the shadows Hue value.
  8335. * 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).
  8336. */
  8337. get shadowsHue(): number;
  8338. /**
  8339. * Sets the shadows Hue value.
  8340. * 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).
  8341. */
  8342. set shadowsHue(value: number);
  8343. /**
  8344. * Gets the shadows Density value.
  8345. * 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.
  8346. * Values less than zero provide a filter of opposite hue.
  8347. */
  8348. get shadowsDensity(): number;
  8349. /**
  8350. * Sets the shadows Density value.
  8351. * 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.
  8352. * Values less than zero provide a filter of opposite hue.
  8353. */
  8354. set shadowsDensity(value: number);
  8355. /**
  8356. * Gets the shadows Saturation value.
  8357. * 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.
  8358. */
  8359. get shadowsSaturation(): number;
  8360. /**
  8361. * Sets the shadows Saturation value.
  8362. * 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.
  8363. */
  8364. set shadowsSaturation(value: number);
  8365. /**
  8366. * Gets the shadows Exposure value.
  8367. * 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.
  8368. */
  8369. get shadowsExposure(): number;
  8370. /**
  8371. * Sets the shadows Exposure value.
  8372. * 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.
  8373. */
  8374. set shadowsExposure(value: number);
  8375. /**
  8376. * Returns the class name
  8377. * @returns The class name
  8378. */
  8379. getClassName(): string;
  8380. /**
  8381. * Binds the color curves to the shader.
  8382. * @param colorCurves The color curve to bind
  8383. * @param effect The effect to bind to
  8384. * @param positiveUniform The positive uniform shader parameter
  8385. * @param neutralUniform The neutral uniform shader parameter
  8386. * @param negativeUniform The negative uniform shader parameter
  8387. */
  8388. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8389. /**
  8390. * Prepare the list of uniforms associated with the ColorCurves effects.
  8391. * @param uniformsList The list of uniforms used in the effect
  8392. */
  8393. static PrepareUniforms(uniformsList: string[]): void;
  8394. /**
  8395. * Returns color grading data based on a hue, density, saturation and exposure value.
  8396. * @param filterHue The hue of the color filter.
  8397. * @param filterDensity The density of the color filter.
  8398. * @param saturation The saturation.
  8399. * @param exposure The exposure.
  8400. * @param result The result data container.
  8401. */
  8402. private getColorGradingDataToRef;
  8403. /**
  8404. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8405. * @param value The input slider value in range [-100,100].
  8406. * @returns Adjusted value.
  8407. */
  8408. private static applyColorGradingSliderNonlinear;
  8409. /**
  8410. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8411. * @param hue The hue (H) input.
  8412. * @param saturation The saturation (S) input.
  8413. * @param brightness The brightness (B) input.
  8414. * @result An RGBA color represented as Vector4.
  8415. */
  8416. private static fromHSBToRef;
  8417. /**
  8418. * Returns a value clamped between min and max
  8419. * @param value The value to clamp
  8420. * @param min The minimum of value
  8421. * @param max The maximum of value
  8422. * @returns The clamped value.
  8423. */
  8424. private static clamp;
  8425. /**
  8426. * Clones the current color curve instance.
  8427. * @return The cloned curves
  8428. */
  8429. clone(): ColorCurves;
  8430. /**
  8431. * Serializes the current color curve instance to a json representation.
  8432. * @return a JSON representation
  8433. */
  8434. serialize(): any;
  8435. /**
  8436. * Parses the color curve from a json representation.
  8437. * @param source the JSON source to parse
  8438. * @return The parsed curves
  8439. */
  8440. static Parse(source: any): ColorCurves;
  8441. }
  8442. }
  8443. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8444. import { Observable } from "babylonjs/Misc/observable";
  8445. import { Nullable } from "babylonjs/types";
  8446. import { Color4 } from "babylonjs/Maths/math.color";
  8447. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8448. import { Effect } from "babylonjs/Materials/effect";
  8449. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8450. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8451. /**
  8452. * Interface to follow in your material defines to integrate easily the
  8453. * Image proccessing functions.
  8454. * @hidden
  8455. */
  8456. export interface IImageProcessingConfigurationDefines {
  8457. IMAGEPROCESSING: boolean;
  8458. VIGNETTE: boolean;
  8459. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8460. VIGNETTEBLENDMODEOPAQUE: boolean;
  8461. TONEMAPPING: boolean;
  8462. TONEMAPPING_ACES: boolean;
  8463. CONTRAST: boolean;
  8464. EXPOSURE: boolean;
  8465. COLORCURVES: boolean;
  8466. COLORGRADING: boolean;
  8467. COLORGRADING3D: boolean;
  8468. SAMPLER3DGREENDEPTH: boolean;
  8469. SAMPLER3DBGRMAP: boolean;
  8470. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8471. }
  8472. /**
  8473. * @hidden
  8474. */
  8475. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8476. IMAGEPROCESSING: boolean;
  8477. VIGNETTE: boolean;
  8478. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8479. VIGNETTEBLENDMODEOPAQUE: boolean;
  8480. TONEMAPPING: boolean;
  8481. TONEMAPPING_ACES: boolean;
  8482. CONTRAST: boolean;
  8483. COLORCURVES: boolean;
  8484. COLORGRADING: boolean;
  8485. COLORGRADING3D: boolean;
  8486. SAMPLER3DGREENDEPTH: boolean;
  8487. SAMPLER3DBGRMAP: boolean;
  8488. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8489. EXPOSURE: boolean;
  8490. constructor();
  8491. }
  8492. /**
  8493. * This groups together the common properties used for image processing either in direct forward pass
  8494. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8495. * or not.
  8496. */
  8497. export class ImageProcessingConfiguration {
  8498. /**
  8499. * Default tone mapping applied in BabylonJS.
  8500. */
  8501. static readonly TONEMAPPING_STANDARD: number;
  8502. /**
  8503. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8504. * to other engines rendering to increase portability.
  8505. */
  8506. static readonly TONEMAPPING_ACES: number;
  8507. /**
  8508. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8509. */
  8510. colorCurves: Nullable<ColorCurves>;
  8511. private _colorCurvesEnabled;
  8512. /**
  8513. * Gets wether the color curves effect is enabled.
  8514. */
  8515. get colorCurvesEnabled(): boolean;
  8516. /**
  8517. * Sets wether the color curves effect is enabled.
  8518. */
  8519. set colorCurvesEnabled(value: boolean);
  8520. private _colorGradingTexture;
  8521. /**
  8522. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8523. */
  8524. get colorGradingTexture(): Nullable<BaseTexture>;
  8525. /**
  8526. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8527. */
  8528. set colorGradingTexture(value: Nullable<BaseTexture>);
  8529. private _colorGradingEnabled;
  8530. /**
  8531. * Gets wether the color grading effect is enabled.
  8532. */
  8533. get colorGradingEnabled(): boolean;
  8534. /**
  8535. * Sets wether the color grading effect is enabled.
  8536. */
  8537. set colorGradingEnabled(value: boolean);
  8538. private _colorGradingWithGreenDepth;
  8539. /**
  8540. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8541. */
  8542. get colorGradingWithGreenDepth(): boolean;
  8543. /**
  8544. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8545. */
  8546. set colorGradingWithGreenDepth(value: boolean);
  8547. private _colorGradingBGR;
  8548. /**
  8549. * Gets wether the color grading texture contains BGR values.
  8550. */
  8551. get colorGradingBGR(): boolean;
  8552. /**
  8553. * Sets wether the color grading texture contains BGR values.
  8554. */
  8555. set colorGradingBGR(value: boolean);
  8556. /** @hidden */
  8557. _exposure: number;
  8558. /**
  8559. * Gets the Exposure used in the effect.
  8560. */
  8561. get exposure(): number;
  8562. /**
  8563. * Sets the Exposure used in the effect.
  8564. */
  8565. set exposure(value: number);
  8566. private _toneMappingEnabled;
  8567. /**
  8568. * Gets wether the tone mapping effect is enabled.
  8569. */
  8570. get toneMappingEnabled(): boolean;
  8571. /**
  8572. * Sets wether the tone mapping effect is enabled.
  8573. */
  8574. set toneMappingEnabled(value: boolean);
  8575. private _toneMappingType;
  8576. /**
  8577. * Gets the type of tone mapping effect.
  8578. */
  8579. get toneMappingType(): number;
  8580. /**
  8581. * Sets the type of tone mapping effect used in BabylonJS.
  8582. */
  8583. set toneMappingType(value: number);
  8584. protected _contrast: number;
  8585. /**
  8586. * Gets the contrast used in the effect.
  8587. */
  8588. get contrast(): number;
  8589. /**
  8590. * Sets the contrast used in the effect.
  8591. */
  8592. set contrast(value: number);
  8593. /**
  8594. * Vignette stretch size.
  8595. */
  8596. vignetteStretch: number;
  8597. /**
  8598. * Vignette centre X Offset.
  8599. */
  8600. vignetteCentreX: number;
  8601. /**
  8602. * Vignette centre Y Offset.
  8603. */
  8604. vignetteCentreY: number;
  8605. /**
  8606. * Vignette weight or intensity of the vignette effect.
  8607. */
  8608. vignetteWeight: number;
  8609. /**
  8610. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8611. * if vignetteEnabled is set to true.
  8612. */
  8613. vignetteColor: Color4;
  8614. /**
  8615. * Camera field of view used by the Vignette effect.
  8616. */
  8617. vignetteCameraFov: number;
  8618. private _vignetteBlendMode;
  8619. /**
  8620. * Gets the vignette blend mode allowing different kind of effect.
  8621. */
  8622. get vignetteBlendMode(): number;
  8623. /**
  8624. * Sets the vignette blend mode allowing different kind of effect.
  8625. */
  8626. set vignetteBlendMode(value: number);
  8627. private _vignetteEnabled;
  8628. /**
  8629. * Gets wether the vignette effect is enabled.
  8630. */
  8631. get vignetteEnabled(): boolean;
  8632. /**
  8633. * Sets wether the vignette effect is enabled.
  8634. */
  8635. set vignetteEnabled(value: boolean);
  8636. private _applyByPostProcess;
  8637. /**
  8638. * Gets wether the image processing is applied through a post process or not.
  8639. */
  8640. get applyByPostProcess(): boolean;
  8641. /**
  8642. * Sets wether the image processing is applied through a post process or not.
  8643. */
  8644. set applyByPostProcess(value: boolean);
  8645. private _isEnabled;
  8646. /**
  8647. * Gets wether the image processing is enabled or not.
  8648. */
  8649. get isEnabled(): boolean;
  8650. /**
  8651. * Sets wether the image processing is enabled or not.
  8652. */
  8653. set isEnabled(value: boolean);
  8654. /**
  8655. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8656. */
  8657. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8658. /**
  8659. * Method called each time the image processing information changes requires to recompile the effect.
  8660. */
  8661. protected _updateParameters(): void;
  8662. /**
  8663. * Gets the current class name.
  8664. * @return "ImageProcessingConfiguration"
  8665. */
  8666. getClassName(): string;
  8667. /**
  8668. * Prepare the list of uniforms associated with the Image Processing effects.
  8669. * @param uniforms The list of uniforms used in the effect
  8670. * @param defines the list of defines currently in use
  8671. */
  8672. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8673. /**
  8674. * Prepare the list of samplers associated with the Image Processing effects.
  8675. * @param samplersList The list of uniforms used in the effect
  8676. * @param defines the list of defines currently in use
  8677. */
  8678. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8679. /**
  8680. * Prepare the list of defines associated to the shader.
  8681. * @param defines the list of defines to complete
  8682. * @param forPostProcess Define if we are currently in post process mode or not
  8683. */
  8684. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8685. /**
  8686. * Returns true if all the image processing information are ready.
  8687. * @returns True if ready, otherwise, false
  8688. */
  8689. isReady(): boolean;
  8690. /**
  8691. * Binds the image processing to the shader.
  8692. * @param effect The effect to bind to
  8693. * @param overrideAspectRatio Override the aspect ratio of the effect
  8694. */
  8695. bind(effect: Effect, overrideAspectRatio?: number): void;
  8696. /**
  8697. * Clones the current image processing instance.
  8698. * @return The cloned image processing
  8699. */
  8700. clone(): ImageProcessingConfiguration;
  8701. /**
  8702. * Serializes the current image processing instance to a json representation.
  8703. * @return a JSON representation
  8704. */
  8705. serialize(): any;
  8706. /**
  8707. * Parses the image processing from a json representation.
  8708. * @param source the JSON source to parse
  8709. * @return The parsed image processing
  8710. */
  8711. static Parse(source: any): ImageProcessingConfiguration;
  8712. private static _VIGNETTEMODE_MULTIPLY;
  8713. private static _VIGNETTEMODE_OPAQUE;
  8714. /**
  8715. * Used to apply the vignette as a mix with the pixel color.
  8716. */
  8717. static get VIGNETTEMODE_MULTIPLY(): number;
  8718. /**
  8719. * Used to apply the vignette as a replacement of the pixel color.
  8720. */
  8721. static get VIGNETTEMODE_OPAQUE(): number;
  8722. }
  8723. }
  8724. declare module "babylonjs/Shaders/postprocess.vertex" {
  8725. /** @hidden */
  8726. export var postprocessVertexShader: {
  8727. name: string;
  8728. shader: string;
  8729. };
  8730. }
  8731. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8732. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8733. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8734. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8735. /**
  8736. * Type used to define a render target texture size (either with a number or with a rect width and height)
  8737. */
  8738. export type RenderTargetTextureSize = number | {
  8739. width: number;
  8740. height: number;
  8741. layers?: number;
  8742. };
  8743. module "babylonjs/Engines/thinEngine" {
  8744. interface ThinEngine {
  8745. /**
  8746. * Creates a new render target texture
  8747. * @param size defines the size of the texture
  8748. * @param options defines the options used to create the texture
  8749. * @returns a new render target texture stored in an InternalTexture
  8750. */
  8751. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8752. /**
  8753. * Creates a depth stencil texture.
  8754. * This is only available in WebGL 2 or with the depth texture extension available.
  8755. * @param size The size of face edge in the texture.
  8756. * @param options The options defining the texture.
  8757. * @returns The texture
  8758. */
  8759. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  8760. /** @hidden */
  8761. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  8762. }
  8763. }
  8764. }
  8765. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8766. /**
  8767. * Defines the kind of connection point for node based material
  8768. */
  8769. export enum NodeMaterialBlockConnectionPointTypes {
  8770. /** Float */
  8771. Float = 1,
  8772. /** Int */
  8773. Int = 2,
  8774. /** Vector2 */
  8775. Vector2 = 4,
  8776. /** Vector3 */
  8777. Vector3 = 8,
  8778. /** Vector4 */
  8779. Vector4 = 16,
  8780. /** Color3 */
  8781. Color3 = 32,
  8782. /** Color4 */
  8783. Color4 = 64,
  8784. /** Matrix */
  8785. Matrix = 128,
  8786. /** Custom object */
  8787. Object = 256,
  8788. /** Detect type based on connection */
  8789. AutoDetect = 1024,
  8790. /** Output type that will be defined by input type */
  8791. BasedOnInput = 2048
  8792. }
  8793. }
  8794. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8795. /**
  8796. * Enum used to define the target of a block
  8797. */
  8798. export enum NodeMaterialBlockTargets {
  8799. /** Vertex shader */
  8800. Vertex = 1,
  8801. /** Fragment shader */
  8802. Fragment = 2,
  8803. /** Neutral */
  8804. Neutral = 4,
  8805. /** Vertex and Fragment */
  8806. VertexAndFragment = 3
  8807. }
  8808. }
  8809. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8810. /**
  8811. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8812. */
  8813. export enum NodeMaterialBlockConnectionPointMode {
  8814. /** Value is an uniform */
  8815. Uniform = 0,
  8816. /** Value is a mesh attribute */
  8817. Attribute = 1,
  8818. /** Value is a varying between vertex and fragment shaders */
  8819. Varying = 2,
  8820. /** Mode is undefined */
  8821. Undefined = 3
  8822. }
  8823. }
  8824. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8825. /**
  8826. * Enum used to define system values e.g. values automatically provided by the system
  8827. */
  8828. export enum NodeMaterialSystemValues {
  8829. /** World */
  8830. World = 1,
  8831. /** View */
  8832. View = 2,
  8833. /** Projection */
  8834. Projection = 3,
  8835. /** ViewProjection */
  8836. ViewProjection = 4,
  8837. /** WorldView */
  8838. WorldView = 5,
  8839. /** WorldViewProjection */
  8840. WorldViewProjection = 6,
  8841. /** CameraPosition */
  8842. CameraPosition = 7,
  8843. /** Fog Color */
  8844. FogColor = 8,
  8845. /** Delta time */
  8846. DeltaTime = 9
  8847. }
  8848. }
  8849. declare module "babylonjs/Maths/math.axis" {
  8850. import { Vector3 } from "babylonjs/Maths/math.vector";
  8851. /** Defines supported spaces */
  8852. export enum Space {
  8853. /** Local (object) space */
  8854. LOCAL = 0,
  8855. /** World space */
  8856. WORLD = 1,
  8857. /** Bone space */
  8858. BONE = 2
  8859. }
  8860. /** Defines the 3 main axes */
  8861. export class Axis {
  8862. /** X axis */
  8863. static X: Vector3;
  8864. /** Y axis */
  8865. static Y: Vector3;
  8866. /** Z axis */
  8867. static Z: Vector3;
  8868. }
  8869. }
  8870. declare module "babylonjs/Maths/math.frustum" {
  8871. import { Matrix } from "babylonjs/Maths/math.vector";
  8872. import { DeepImmutable } from "babylonjs/types";
  8873. import { Plane } from "babylonjs/Maths/math.plane";
  8874. /**
  8875. * Represents a camera frustum
  8876. */
  8877. export class Frustum {
  8878. /**
  8879. * Gets the planes representing the frustum
  8880. * @param transform matrix to be applied to the returned planes
  8881. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8882. */
  8883. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8884. /**
  8885. * Gets the near frustum plane transformed by the transform matrix
  8886. * @param transform transformation matrix to be applied to the resulting frustum plane
  8887. * @param frustumPlane the resuling frustum plane
  8888. */
  8889. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8890. /**
  8891. * Gets the far frustum plane transformed by the transform matrix
  8892. * @param transform transformation matrix to be applied to the resulting frustum plane
  8893. * @param frustumPlane the resuling frustum plane
  8894. */
  8895. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8896. /**
  8897. * Gets the left frustum plane transformed by the transform matrix
  8898. * @param transform transformation matrix to be applied to the resulting frustum plane
  8899. * @param frustumPlane the resuling frustum plane
  8900. */
  8901. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8902. /**
  8903. * Gets the right frustum plane transformed by the transform matrix
  8904. * @param transform transformation matrix to be applied to the resulting frustum plane
  8905. * @param frustumPlane the resuling frustum plane
  8906. */
  8907. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8908. /**
  8909. * Gets the top frustum plane transformed by the transform matrix
  8910. * @param transform transformation matrix to be applied to the resulting frustum plane
  8911. * @param frustumPlane the resuling frustum plane
  8912. */
  8913. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8914. /**
  8915. * Gets the bottom frustum plane transformed by the transform matrix
  8916. * @param transform transformation matrix to be applied to the resulting frustum plane
  8917. * @param frustumPlane the resuling frustum plane
  8918. */
  8919. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8920. /**
  8921. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8922. * @param transform transformation matrix to be applied to the resulting frustum planes
  8923. * @param frustumPlanes the resuling frustum planes
  8924. */
  8925. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8926. }
  8927. }
  8928. declare module "babylonjs/Maths/math.size" {
  8929. /**
  8930. * Interface for the size containing width and height
  8931. */
  8932. export interface ISize {
  8933. /**
  8934. * Width
  8935. */
  8936. width: number;
  8937. /**
  8938. * Heighht
  8939. */
  8940. height: number;
  8941. }
  8942. /**
  8943. * Size containing widht and height
  8944. */
  8945. export class Size implements ISize {
  8946. /**
  8947. * Width
  8948. */
  8949. width: number;
  8950. /**
  8951. * Height
  8952. */
  8953. height: number;
  8954. /**
  8955. * Creates a Size object from the given width and height (floats).
  8956. * @param width width of the new size
  8957. * @param height height of the new size
  8958. */
  8959. constructor(width: number, height: number);
  8960. /**
  8961. * Returns a string with the Size width and height
  8962. * @returns a string with the Size width and height
  8963. */
  8964. toString(): string;
  8965. /**
  8966. * "Size"
  8967. * @returns the string "Size"
  8968. */
  8969. getClassName(): string;
  8970. /**
  8971. * Returns the Size hash code.
  8972. * @returns a hash code for a unique width and height
  8973. */
  8974. getHashCode(): number;
  8975. /**
  8976. * Updates the current size from the given one.
  8977. * @param src the given size
  8978. */
  8979. copyFrom(src: Size): void;
  8980. /**
  8981. * Updates in place the current Size from the given floats.
  8982. * @param width width of the new size
  8983. * @param height height of the new size
  8984. * @returns the updated Size.
  8985. */
  8986. copyFromFloats(width: number, height: number): Size;
  8987. /**
  8988. * Updates in place the current Size from the given floats.
  8989. * @param width width to set
  8990. * @param height height to set
  8991. * @returns the updated Size.
  8992. */
  8993. set(width: number, height: number): Size;
  8994. /**
  8995. * Multiplies the width and height by numbers
  8996. * @param w factor to multiple the width by
  8997. * @param h factor to multiple the height by
  8998. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8999. */
  9000. multiplyByFloats(w: number, h: number): Size;
  9001. /**
  9002. * Clones the size
  9003. * @returns a new Size copied from the given one.
  9004. */
  9005. clone(): Size;
  9006. /**
  9007. * True if the current Size and the given one width and height are strictly equal.
  9008. * @param other the other size to compare against
  9009. * @returns True if the current Size and the given one width and height are strictly equal.
  9010. */
  9011. equals(other: Size): boolean;
  9012. /**
  9013. * The surface of the Size : width * height (float).
  9014. */
  9015. get surface(): number;
  9016. /**
  9017. * Create a new size of zero
  9018. * @returns a new Size set to (0.0, 0.0)
  9019. */
  9020. static Zero(): Size;
  9021. /**
  9022. * Sums the width and height of two sizes
  9023. * @param otherSize size to add to this size
  9024. * @returns a new Size set as the addition result of the current Size and the given one.
  9025. */
  9026. add(otherSize: Size): Size;
  9027. /**
  9028. * Subtracts the width and height of two
  9029. * @param otherSize size to subtract to this size
  9030. * @returns a new Size set as the subtraction result of the given one from the current Size.
  9031. */
  9032. subtract(otherSize: Size): Size;
  9033. /**
  9034. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  9035. * @param start starting size to lerp between
  9036. * @param end end size to lerp between
  9037. * @param amount amount to lerp between the start and end values
  9038. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  9039. */
  9040. static Lerp(start: Size, end: Size, amount: number): Size;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math.vertexFormat" {
  9044. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  9045. /**
  9046. * Contains position and normal vectors for a vertex
  9047. */
  9048. export class PositionNormalVertex {
  9049. /** the position of the vertex (defaut: 0,0,0) */
  9050. position: Vector3;
  9051. /** the normal of the vertex (defaut: 0,1,0) */
  9052. normal: Vector3;
  9053. /**
  9054. * Creates a PositionNormalVertex
  9055. * @param position the position of the vertex (defaut: 0,0,0)
  9056. * @param normal the normal of the vertex (defaut: 0,1,0)
  9057. */
  9058. constructor(
  9059. /** the position of the vertex (defaut: 0,0,0) */
  9060. position?: Vector3,
  9061. /** the normal of the vertex (defaut: 0,1,0) */
  9062. normal?: Vector3);
  9063. /**
  9064. * Clones the PositionNormalVertex
  9065. * @returns the cloned PositionNormalVertex
  9066. */
  9067. clone(): PositionNormalVertex;
  9068. }
  9069. /**
  9070. * Contains position, normal and uv vectors for a vertex
  9071. */
  9072. export class PositionNormalTextureVertex {
  9073. /** the position of the vertex (defaut: 0,0,0) */
  9074. position: Vector3;
  9075. /** the normal of the vertex (defaut: 0,1,0) */
  9076. normal: Vector3;
  9077. /** the uv of the vertex (default: 0,0) */
  9078. uv: Vector2;
  9079. /**
  9080. * Creates a PositionNormalTextureVertex
  9081. * @param position the position of the vertex (defaut: 0,0,0)
  9082. * @param normal the normal of the vertex (defaut: 0,1,0)
  9083. * @param uv the uv of the vertex (default: 0,0)
  9084. */
  9085. constructor(
  9086. /** the position of the vertex (defaut: 0,0,0) */
  9087. position?: Vector3,
  9088. /** the normal of the vertex (defaut: 0,1,0) */
  9089. normal?: Vector3,
  9090. /** the uv of the vertex (default: 0,0) */
  9091. uv?: Vector2);
  9092. /**
  9093. * Clones the PositionNormalTextureVertex
  9094. * @returns the cloned PositionNormalTextureVertex
  9095. */
  9096. clone(): PositionNormalTextureVertex;
  9097. }
  9098. }
  9099. declare module "babylonjs/Maths/math" {
  9100. export * from "babylonjs/Maths/math.axis";
  9101. export * from "babylonjs/Maths/math.color";
  9102. export * from "babylonjs/Maths/math.constants";
  9103. export * from "babylonjs/Maths/math.frustum";
  9104. export * from "babylonjs/Maths/math.path";
  9105. export * from "babylonjs/Maths/math.plane";
  9106. export * from "babylonjs/Maths/math.size";
  9107. export * from "babylonjs/Maths/math.vector";
  9108. export * from "babylonjs/Maths/math.vertexFormat";
  9109. export * from "babylonjs/Maths/math.viewport";
  9110. }
  9111. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9112. /**
  9113. * Enum defining the type of animations supported by InputBlock
  9114. */
  9115. export enum AnimatedInputBlockTypes {
  9116. /** No animation */
  9117. None = 0,
  9118. /** Time based animation. Will only work for floats */
  9119. Time = 1
  9120. }
  9121. }
  9122. declare module "babylonjs/Lights/shadowLight" {
  9123. import { Camera } from "babylonjs/Cameras/camera";
  9124. import { Scene } from "babylonjs/scene";
  9125. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9127. import { Light } from "babylonjs/Lights/light";
  9128. /**
  9129. * Interface describing all the common properties and methods a shadow light needs to implement.
  9130. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9131. * as well as binding the different shadow properties to the effects.
  9132. */
  9133. export interface IShadowLight extends Light {
  9134. /**
  9135. * The light id in the scene (used in scene.findLighById for instance)
  9136. */
  9137. id: string;
  9138. /**
  9139. * The position the shdow will be casted from.
  9140. */
  9141. position: Vector3;
  9142. /**
  9143. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9144. */
  9145. direction: Vector3;
  9146. /**
  9147. * The transformed position. Position of the light in world space taking parenting in account.
  9148. */
  9149. transformedPosition: Vector3;
  9150. /**
  9151. * The transformed direction. Direction of the light in world space taking parenting in account.
  9152. */
  9153. transformedDirection: Vector3;
  9154. /**
  9155. * The friendly name of the light in the scene.
  9156. */
  9157. name: string;
  9158. /**
  9159. * Defines the shadow projection clipping minimum z value.
  9160. */
  9161. shadowMinZ: number;
  9162. /**
  9163. * Defines the shadow projection clipping maximum z value.
  9164. */
  9165. shadowMaxZ: number;
  9166. /**
  9167. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9168. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9169. */
  9170. computeTransformedInformation(): boolean;
  9171. /**
  9172. * Gets the scene the light belongs to.
  9173. * @returns The scene
  9174. */
  9175. getScene(): Scene;
  9176. /**
  9177. * Callback defining a custom Projection Matrix Builder.
  9178. * This can be used to override the default projection matrix computation.
  9179. */
  9180. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9181. /**
  9182. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9183. * @param matrix The materix to updated with the projection information
  9184. * @param viewMatrix The transform matrix of the light
  9185. * @param renderList The list of mesh to render in the map
  9186. * @returns The current light
  9187. */
  9188. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9189. /**
  9190. * Gets the current depth scale used in ESM.
  9191. * @returns The scale
  9192. */
  9193. getDepthScale(): number;
  9194. /**
  9195. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9196. * @returns true if a cube texture needs to be use
  9197. */
  9198. needCube(): boolean;
  9199. /**
  9200. * Detects if the projection matrix requires to be recomputed this frame.
  9201. * @returns true if it requires to be recomputed otherwise, false.
  9202. */
  9203. needProjectionMatrixCompute(): boolean;
  9204. /**
  9205. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9206. */
  9207. forceProjectionMatrixCompute(): void;
  9208. /**
  9209. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9210. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9211. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9212. */
  9213. getShadowDirection(faceIndex?: number): Vector3;
  9214. /**
  9215. * Gets the minZ used for shadow according to both the scene and the light.
  9216. * @param activeCamera The camera we are returning the min for
  9217. * @returns the depth min z
  9218. */
  9219. getDepthMinZ(activeCamera: Camera): number;
  9220. /**
  9221. * Gets the maxZ used for shadow according to both the scene and the light.
  9222. * @param activeCamera The camera we are returning the max for
  9223. * @returns the depth max z
  9224. */
  9225. getDepthMaxZ(activeCamera: Camera): number;
  9226. }
  9227. /**
  9228. * Base implementation IShadowLight
  9229. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9230. */
  9231. export abstract class ShadowLight extends Light implements IShadowLight {
  9232. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9233. protected _position: Vector3;
  9234. protected _setPosition(value: Vector3): void;
  9235. /**
  9236. * Sets the position the shadow will be casted from. Also use as the light position for both
  9237. * point and spot lights.
  9238. */
  9239. get position(): Vector3;
  9240. /**
  9241. * Sets the position the shadow will be casted from. Also use as the light position for both
  9242. * point and spot lights.
  9243. */
  9244. set position(value: Vector3);
  9245. protected _direction: Vector3;
  9246. protected _setDirection(value: Vector3): void;
  9247. /**
  9248. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9249. * Also use as the light direction on spot and directional lights.
  9250. */
  9251. get direction(): Vector3;
  9252. /**
  9253. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9254. * Also use as the light direction on spot and directional lights.
  9255. */
  9256. set direction(value: Vector3);
  9257. protected _shadowMinZ: number;
  9258. /**
  9259. * Gets the shadow projection clipping minimum z value.
  9260. */
  9261. get shadowMinZ(): number;
  9262. /**
  9263. * Sets the shadow projection clipping minimum z value.
  9264. */
  9265. set shadowMinZ(value: number);
  9266. protected _shadowMaxZ: number;
  9267. /**
  9268. * Sets the shadow projection clipping maximum z value.
  9269. */
  9270. get shadowMaxZ(): number;
  9271. /**
  9272. * Gets the shadow projection clipping maximum z value.
  9273. */
  9274. set shadowMaxZ(value: number);
  9275. /**
  9276. * Callback defining a custom Projection Matrix Builder.
  9277. * This can be used to override the default projection matrix computation.
  9278. */
  9279. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9280. /**
  9281. * The transformed position. Position of the light in world space taking parenting in account.
  9282. */
  9283. transformedPosition: Vector3;
  9284. /**
  9285. * The transformed direction. Direction of the light in world space taking parenting in account.
  9286. */
  9287. transformedDirection: Vector3;
  9288. private _needProjectionMatrixCompute;
  9289. /**
  9290. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9291. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9292. */
  9293. computeTransformedInformation(): boolean;
  9294. /**
  9295. * Return the depth scale used for the shadow map.
  9296. * @returns the depth scale.
  9297. */
  9298. getDepthScale(): number;
  9299. /**
  9300. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9301. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9302. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9303. */
  9304. getShadowDirection(faceIndex?: number): Vector3;
  9305. /**
  9306. * Returns the ShadowLight absolute position in the World.
  9307. * @returns the position vector in world space
  9308. */
  9309. getAbsolutePosition(): Vector3;
  9310. /**
  9311. * Sets the ShadowLight direction toward the passed target.
  9312. * @param target The point to target in local space
  9313. * @returns the updated ShadowLight direction
  9314. */
  9315. setDirectionToTarget(target: Vector3): Vector3;
  9316. /**
  9317. * Returns the light rotation in euler definition.
  9318. * @returns the x y z rotation in local space.
  9319. */
  9320. getRotation(): Vector3;
  9321. /**
  9322. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9323. * @returns true if a cube texture needs to be use
  9324. */
  9325. needCube(): boolean;
  9326. /**
  9327. * Detects if the projection matrix requires to be recomputed this frame.
  9328. * @returns true if it requires to be recomputed otherwise, false.
  9329. */
  9330. needProjectionMatrixCompute(): boolean;
  9331. /**
  9332. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9333. */
  9334. forceProjectionMatrixCompute(): void;
  9335. /** @hidden */
  9336. _initCache(): void;
  9337. /** @hidden */
  9338. _isSynchronized(): boolean;
  9339. /**
  9340. * Computes the world matrix of the node
  9341. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9342. * @returns the world matrix
  9343. */
  9344. computeWorldMatrix(force?: boolean): Matrix;
  9345. /**
  9346. * Gets the minZ used for shadow according to both the scene and the light.
  9347. * @param activeCamera The camera we are returning the min for
  9348. * @returns the depth min z
  9349. */
  9350. getDepthMinZ(activeCamera: Camera): number;
  9351. /**
  9352. * Gets the maxZ used for shadow according to both the scene and the light.
  9353. * @param activeCamera The camera we are returning the max for
  9354. * @returns the depth max z
  9355. */
  9356. getDepthMaxZ(activeCamera: Camera): number;
  9357. /**
  9358. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9359. * @param matrix The materix to updated with the projection information
  9360. * @param viewMatrix The transform matrix of the light
  9361. * @param renderList The list of mesh to render in the map
  9362. * @returns The current light
  9363. */
  9364. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9365. }
  9366. }
  9367. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9368. /** @hidden */
  9369. export var packingFunctions: {
  9370. name: string;
  9371. shader: string;
  9372. };
  9373. }
  9374. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9375. /** @hidden */
  9376. export var bayerDitherFunctions: {
  9377. name: string;
  9378. shader: string;
  9379. };
  9380. }
  9381. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9382. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9383. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9384. /** @hidden */
  9385. export var shadowMapFragmentDeclaration: {
  9386. name: string;
  9387. shader: string;
  9388. };
  9389. }
  9390. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9391. /** @hidden */
  9392. export var clipPlaneFragmentDeclaration: {
  9393. name: string;
  9394. shader: string;
  9395. };
  9396. }
  9397. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9398. /** @hidden */
  9399. export var clipPlaneFragment: {
  9400. name: string;
  9401. shader: string;
  9402. };
  9403. }
  9404. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9405. /** @hidden */
  9406. export var shadowMapFragment: {
  9407. name: string;
  9408. shader: string;
  9409. };
  9410. }
  9411. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9412. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9413. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9414. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9415. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9416. /** @hidden */
  9417. export var shadowMapPixelShader: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9423. /** @hidden */
  9424. export var bonesDeclaration: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9430. /** @hidden */
  9431. export var morphTargetsVertexGlobalDeclaration: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9437. /** @hidden */
  9438. export var morphTargetsVertexDeclaration: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9444. /** @hidden */
  9445. export var instancesDeclaration: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9451. /** @hidden */
  9452. export var helperFunctions: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9458. /** @hidden */
  9459. export var shadowMapVertexDeclaration: {
  9460. name: string;
  9461. shader: string;
  9462. };
  9463. }
  9464. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9465. /** @hidden */
  9466. export var clipPlaneVertexDeclaration: {
  9467. name: string;
  9468. shader: string;
  9469. };
  9470. }
  9471. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9472. /** @hidden */
  9473. export var morphTargetsVertex: {
  9474. name: string;
  9475. shader: string;
  9476. };
  9477. }
  9478. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9479. /** @hidden */
  9480. export var instancesVertex: {
  9481. name: string;
  9482. shader: string;
  9483. };
  9484. }
  9485. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9486. /** @hidden */
  9487. export var bonesVertex: {
  9488. name: string;
  9489. shader: string;
  9490. };
  9491. }
  9492. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9493. /** @hidden */
  9494. export var shadowMapVertexNormalBias: {
  9495. name: string;
  9496. shader: string;
  9497. };
  9498. }
  9499. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9500. /** @hidden */
  9501. export var shadowMapVertexMetric: {
  9502. name: string;
  9503. shader: string;
  9504. };
  9505. }
  9506. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9507. /** @hidden */
  9508. export var clipPlaneVertex: {
  9509. name: string;
  9510. shader: string;
  9511. };
  9512. }
  9513. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9514. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9515. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9516. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9517. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9518. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9519. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9520. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9521. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9522. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9523. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9524. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9525. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9526. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9527. /** @hidden */
  9528. export var shadowMapVertexShader: {
  9529. name: string;
  9530. shader: string;
  9531. };
  9532. }
  9533. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9534. /** @hidden */
  9535. export var depthBoxBlurPixelShader: {
  9536. name: string;
  9537. shader: string;
  9538. };
  9539. }
  9540. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9541. /** @hidden */
  9542. export var shadowMapFragmentSoftTransparentShadow: {
  9543. name: string;
  9544. shader: string;
  9545. };
  9546. }
  9547. declare module "babylonjs/Materials/effectFallbacks" {
  9548. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9549. import { Effect } from "babylonjs/Materials/effect";
  9550. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9551. /**
  9552. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9553. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9554. */
  9555. export class EffectFallbacks implements IEffectFallbacks {
  9556. private _defines;
  9557. private _currentRank;
  9558. private _maxRank;
  9559. private _mesh;
  9560. /**
  9561. * Removes the fallback from the bound mesh.
  9562. */
  9563. unBindMesh(): void;
  9564. /**
  9565. * Adds a fallback on the specified property.
  9566. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9567. * @param define The name of the define in the shader
  9568. */
  9569. addFallback(rank: number, define: string): void;
  9570. /**
  9571. * Sets the mesh to use CPU skinning when needing to fallback.
  9572. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9573. * @param mesh The mesh to use the fallbacks.
  9574. */
  9575. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9576. /**
  9577. * Checks to see if more fallbacks are still availible.
  9578. */
  9579. get hasMoreFallbacks(): boolean;
  9580. /**
  9581. * Removes the defines that should be removed when falling back.
  9582. * @param currentDefines defines the current define statements for the shader.
  9583. * @param effect defines the current effect we try to compile
  9584. * @returns The resulting defines with defines of the current rank removed.
  9585. */
  9586. reduce(currentDefines: string, effect: Effect): string;
  9587. }
  9588. }
  9589. declare module "babylonjs/Actions/action" {
  9590. import { Observable } from "babylonjs/Misc/observable";
  9591. import { Condition } from "babylonjs/Actions/condition";
  9592. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9593. import { Nullable } from "babylonjs/types";
  9594. import { Scene } from "babylonjs/scene";
  9595. import { ActionManager } from "babylonjs/Actions/actionManager";
  9596. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9597. import { Node } from "babylonjs/node";
  9598. /**
  9599. * Interface used to define Action
  9600. */
  9601. export interface IAction {
  9602. /**
  9603. * Trigger for the action
  9604. */
  9605. trigger: number;
  9606. /** Options of the trigger */
  9607. triggerOptions: any;
  9608. /**
  9609. * Gets the trigger parameters
  9610. * @returns the trigger parameters
  9611. */
  9612. getTriggerParameter(): any;
  9613. /**
  9614. * Internal only - executes current action event
  9615. * @hidden
  9616. */
  9617. _executeCurrent(evt?: ActionEvent): void;
  9618. /**
  9619. * Serialize placeholder for child classes
  9620. * @param parent of child
  9621. * @returns the serialized object
  9622. */
  9623. serialize(parent: any): any;
  9624. /**
  9625. * Internal only
  9626. * @hidden
  9627. */
  9628. _prepare(): void;
  9629. /**
  9630. * Internal only - manager for action
  9631. * @hidden
  9632. */
  9633. _actionManager: Nullable<AbstractActionManager>;
  9634. /**
  9635. * Adds action to chain of actions, may be a DoNothingAction
  9636. * @param action defines the next action to execute
  9637. * @returns The action passed in
  9638. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9639. */
  9640. then(action: IAction): IAction;
  9641. }
  9642. /**
  9643. * The action to be carried out following a trigger
  9644. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9645. */
  9646. export class Action implements IAction {
  9647. /** the trigger, with or without parameters, for the action */
  9648. triggerOptions: any;
  9649. /**
  9650. * Trigger for the action
  9651. */
  9652. trigger: number;
  9653. /**
  9654. * Internal only - manager for action
  9655. * @hidden
  9656. */
  9657. _actionManager: ActionManager;
  9658. private _nextActiveAction;
  9659. private _child;
  9660. private _condition?;
  9661. private _triggerParameter;
  9662. /**
  9663. * An event triggered prior to action being executed.
  9664. */
  9665. onBeforeExecuteObservable: Observable<Action>;
  9666. /**
  9667. * Creates a new Action
  9668. * @param triggerOptions the trigger, with or without parameters, for the action
  9669. * @param condition an optional determinant of action
  9670. */
  9671. constructor(
  9672. /** the trigger, with or without parameters, for the action */
  9673. triggerOptions: any, condition?: Condition);
  9674. /**
  9675. * Internal only
  9676. * @hidden
  9677. */
  9678. _prepare(): void;
  9679. /**
  9680. * Gets the trigger parameters
  9681. * @returns the trigger parameters
  9682. */
  9683. getTriggerParameter(): any;
  9684. /**
  9685. * Internal only - executes current action event
  9686. * @hidden
  9687. */
  9688. _executeCurrent(evt?: ActionEvent): void;
  9689. /**
  9690. * Execute placeholder for child classes
  9691. * @param evt optional action event
  9692. */
  9693. execute(evt?: ActionEvent): void;
  9694. /**
  9695. * Skips to next active action
  9696. */
  9697. skipToNextActiveAction(): void;
  9698. /**
  9699. * Adds action to chain of actions, may be a DoNothingAction
  9700. * @param action defines the next action to execute
  9701. * @returns The action passed in
  9702. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9703. */
  9704. then(action: Action): Action;
  9705. /**
  9706. * Internal only
  9707. * @hidden
  9708. */
  9709. _getProperty(propertyPath: string): string;
  9710. /**
  9711. * Internal only
  9712. * @hidden
  9713. */
  9714. _getEffectiveTarget(target: any, propertyPath: string): any;
  9715. /**
  9716. * Serialize placeholder for child classes
  9717. * @param parent of child
  9718. * @returns the serialized object
  9719. */
  9720. serialize(parent: any): any;
  9721. /**
  9722. * Internal only called by serialize
  9723. * @hidden
  9724. */
  9725. protected _serialize(serializedAction: any, parent?: any): any;
  9726. /**
  9727. * Internal only
  9728. * @hidden
  9729. */
  9730. static _SerializeValueAsString: (value: any) => string;
  9731. /**
  9732. * Internal only
  9733. * @hidden
  9734. */
  9735. static _GetTargetProperty: (target: Scene | Node) => {
  9736. name: string;
  9737. targetType: string;
  9738. value: string;
  9739. };
  9740. }
  9741. }
  9742. declare module "babylonjs/Actions/condition" {
  9743. import { ActionManager } from "babylonjs/Actions/actionManager";
  9744. /**
  9745. * A Condition applied to an Action
  9746. */
  9747. export class Condition {
  9748. /**
  9749. * Internal only - manager for action
  9750. * @hidden
  9751. */
  9752. _actionManager: ActionManager;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. _evaluationId: number;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. _currentResult: boolean;
  9763. /**
  9764. * Creates a new Condition
  9765. * @param actionManager the manager of the action the condition is applied to
  9766. */
  9767. constructor(actionManager: ActionManager);
  9768. /**
  9769. * Check if the current condition is valid
  9770. * @returns a boolean
  9771. */
  9772. isValid(): boolean;
  9773. /**
  9774. * Internal only
  9775. * @hidden
  9776. */
  9777. _getProperty(propertyPath: string): string;
  9778. /**
  9779. * Internal only
  9780. * @hidden
  9781. */
  9782. _getEffectiveTarget(target: any, propertyPath: string): any;
  9783. /**
  9784. * Serialize placeholder for child classes
  9785. * @returns the serialized object
  9786. */
  9787. serialize(): any;
  9788. /**
  9789. * Internal only
  9790. * @hidden
  9791. */
  9792. protected _serialize(serializedCondition: any): any;
  9793. }
  9794. /**
  9795. * Defines specific conditional operators as extensions of Condition
  9796. */
  9797. export class ValueCondition extends Condition {
  9798. /** path to specify the property of the target the conditional operator uses */
  9799. propertyPath: string;
  9800. /** the value compared by the conditional operator against the current value of the property */
  9801. value: any;
  9802. /** the conditional operator, default ValueCondition.IsEqual */
  9803. operator: number;
  9804. /**
  9805. * Internal only
  9806. * @hidden
  9807. */
  9808. private static _IsEqual;
  9809. /**
  9810. * Internal only
  9811. * @hidden
  9812. */
  9813. private static _IsDifferent;
  9814. /**
  9815. * Internal only
  9816. * @hidden
  9817. */
  9818. private static _IsGreater;
  9819. /**
  9820. * Internal only
  9821. * @hidden
  9822. */
  9823. private static _IsLesser;
  9824. /**
  9825. * returns the number for IsEqual
  9826. */
  9827. static get IsEqual(): number;
  9828. /**
  9829. * Returns the number for IsDifferent
  9830. */
  9831. static get IsDifferent(): number;
  9832. /**
  9833. * Returns the number for IsGreater
  9834. */
  9835. static get IsGreater(): number;
  9836. /**
  9837. * Returns the number for IsLesser
  9838. */
  9839. static get IsLesser(): number;
  9840. /**
  9841. * Internal only The action manager for the condition
  9842. * @hidden
  9843. */
  9844. _actionManager: ActionManager;
  9845. /**
  9846. * Internal only
  9847. * @hidden
  9848. */
  9849. private _target;
  9850. /**
  9851. * Internal only
  9852. * @hidden
  9853. */
  9854. private _effectiveTarget;
  9855. /**
  9856. * Internal only
  9857. * @hidden
  9858. */
  9859. private _property;
  9860. /**
  9861. * Creates a new ValueCondition
  9862. * @param actionManager manager for the action the condition applies to
  9863. * @param target for the action
  9864. * @param propertyPath path to specify the property of the target the conditional operator uses
  9865. * @param value the value compared by the conditional operator against the current value of the property
  9866. * @param operator the conditional operator, default ValueCondition.IsEqual
  9867. */
  9868. constructor(actionManager: ActionManager, target: any,
  9869. /** path to specify the property of the target the conditional operator uses */
  9870. propertyPath: string,
  9871. /** the value compared by the conditional operator against the current value of the property */
  9872. value: any,
  9873. /** the conditional operator, default ValueCondition.IsEqual */
  9874. operator?: number);
  9875. /**
  9876. * Compares the given value with the property value for the specified conditional operator
  9877. * @returns the result of the comparison
  9878. */
  9879. isValid(): boolean;
  9880. /**
  9881. * Serialize the ValueCondition into a JSON compatible object
  9882. * @returns serialization object
  9883. */
  9884. serialize(): any;
  9885. /**
  9886. * Gets the name of the conditional operator for the ValueCondition
  9887. * @param operator the conditional operator
  9888. * @returns the name
  9889. */
  9890. static GetOperatorName(operator: number): string;
  9891. }
  9892. /**
  9893. * Defines a predicate condition as an extension of Condition
  9894. */
  9895. export class PredicateCondition extends Condition {
  9896. /** defines the predicate function used to validate the condition */
  9897. predicate: () => boolean;
  9898. /**
  9899. * Internal only - manager for action
  9900. * @hidden
  9901. */
  9902. _actionManager: ActionManager;
  9903. /**
  9904. * Creates a new PredicateCondition
  9905. * @param actionManager manager for the action the condition applies to
  9906. * @param predicate defines the predicate function used to validate the condition
  9907. */
  9908. constructor(actionManager: ActionManager,
  9909. /** defines the predicate function used to validate the condition */
  9910. predicate: () => boolean);
  9911. /**
  9912. * @returns the validity of the predicate condition
  9913. */
  9914. isValid(): boolean;
  9915. }
  9916. /**
  9917. * Defines a state condition as an extension of Condition
  9918. */
  9919. export class StateCondition extends Condition {
  9920. /** Value to compare with target state */
  9921. value: string;
  9922. /**
  9923. * Internal only - manager for action
  9924. * @hidden
  9925. */
  9926. _actionManager: ActionManager;
  9927. /**
  9928. * Internal only
  9929. * @hidden
  9930. */
  9931. private _target;
  9932. /**
  9933. * Creates a new StateCondition
  9934. * @param actionManager manager for the action the condition applies to
  9935. * @param target of the condition
  9936. * @param value to compare with target state
  9937. */
  9938. constructor(actionManager: ActionManager, target: any,
  9939. /** Value to compare with target state */
  9940. value: string);
  9941. /**
  9942. * Gets a boolean indicating if the current condition is met
  9943. * @returns the validity of the state
  9944. */
  9945. isValid(): boolean;
  9946. /**
  9947. * Serialize the StateCondition into a JSON compatible object
  9948. * @returns serialization object
  9949. */
  9950. serialize(): any;
  9951. }
  9952. }
  9953. declare module "babylonjs/Actions/directActions" {
  9954. import { Action } from "babylonjs/Actions/action";
  9955. import { Condition } from "babylonjs/Actions/condition";
  9956. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9957. /**
  9958. * This defines an action responsible to toggle a boolean once triggered.
  9959. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9960. */
  9961. export class SwitchBooleanAction extends Action {
  9962. /**
  9963. * The path to the boolean property in the target object
  9964. */
  9965. propertyPath: string;
  9966. private _target;
  9967. private _effectiveTarget;
  9968. private _property;
  9969. /**
  9970. * Instantiate the action
  9971. * @param triggerOptions defines the trigger options
  9972. * @param target defines the object containing the boolean
  9973. * @param propertyPath defines the path to the boolean property in the target object
  9974. * @param condition defines the trigger related conditions
  9975. */
  9976. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9977. /** @hidden */
  9978. _prepare(): void;
  9979. /**
  9980. * Execute the action toggle the boolean value.
  9981. */
  9982. execute(): void;
  9983. /**
  9984. * Serializes the actions and its related information.
  9985. * @param parent defines the object to serialize in
  9986. * @returns the serialized object
  9987. */
  9988. serialize(parent: any): any;
  9989. }
  9990. /**
  9991. * This defines an action responsible to set a the state field of the target
  9992. * to a desired value once triggered.
  9993. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9994. */
  9995. export class SetStateAction extends Action {
  9996. /**
  9997. * The value to store in the state field.
  9998. */
  9999. value: string;
  10000. private _target;
  10001. /**
  10002. * Instantiate the action
  10003. * @param triggerOptions defines the trigger options
  10004. * @param target defines the object containing the state property
  10005. * @param value defines the value to store in the state field
  10006. * @param condition defines the trigger related conditions
  10007. */
  10008. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10009. /**
  10010. * Execute the action and store the value on the target state property.
  10011. */
  10012. execute(): void;
  10013. /**
  10014. * Serializes the actions and its related information.
  10015. * @param parent defines the object to serialize in
  10016. * @returns the serialized object
  10017. */
  10018. serialize(parent: any): any;
  10019. }
  10020. /**
  10021. * This defines an action responsible to set a property of the target
  10022. * to a desired value once triggered.
  10023. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10024. */
  10025. export class SetValueAction extends Action {
  10026. /**
  10027. * The path of the property to set in the target.
  10028. */
  10029. propertyPath: string;
  10030. /**
  10031. * The value to set in the property
  10032. */
  10033. value: any;
  10034. private _target;
  10035. private _effectiveTarget;
  10036. private _property;
  10037. /**
  10038. * Instantiate the action
  10039. * @param triggerOptions defines the trigger options
  10040. * @param target defines the object containing the property
  10041. * @param propertyPath defines the path of the property to set in the target
  10042. * @param value defines the value to set in the property
  10043. * @param condition defines the trigger related conditions
  10044. */
  10045. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10046. /** @hidden */
  10047. _prepare(): void;
  10048. /**
  10049. * Execute the action and set the targetted property to the desired value.
  10050. */
  10051. execute(): void;
  10052. /**
  10053. * Serializes the actions and its related information.
  10054. * @param parent defines the object to serialize in
  10055. * @returns the serialized object
  10056. */
  10057. serialize(parent: any): any;
  10058. }
  10059. /**
  10060. * This defines an action responsible to increment the target value
  10061. * to a desired value once triggered.
  10062. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10063. */
  10064. export class IncrementValueAction extends Action {
  10065. /**
  10066. * The path of the property to increment in the target.
  10067. */
  10068. propertyPath: string;
  10069. /**
  10070. * The value we should increment the property by.
  10071. */
  10072. value: any;
  10073. private _target;
  10074. private _effectiveTarget;
  10075. private _property;
  10076. /**
  10077. * Instantiate the action
  10078. * @param triggerOptions defines the trigger options
  10079. * @param target defines the object containing the property
  10080. * @param propertyPath defines the path of the property to increment in the target
  10081. * @param value defines the value value we should increment the property by
  10082. * @param condition defines the trigger related conditions
  10083. */
  10084. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10085. /** @hidden */
  10086. _prepare(): void;
  10087. /**
  10088. * Execute the action and increment the target of the value amount.
  10089. */
  10090. execute(): void;
  10091. /**
  10092. * Serializes the actions and its related information.
  10093. * @param parent defines the object to serialize in
  10094. * @returns the serialized object
  10095. */
  10096. serialize(parent: any): any;
  10097. }
  10098. /**
  10099. * This defines an action responsible to start an animation once triggered.
  10100. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10101. */
  10102. export class PlayAnimationAction extends Action {
  10103. /**
  10104. * Where the animation should start (animation frame)
  10105. */
  10106. from: number;
  10107. /**
  10108. * Where the animation should stop (animation frame)
  10109. */
  10110. to: number;
  10111. /**
  10112. * Define if the animation should loop or stop after the first play.
  10113. */
  10114. loop?: boolean;
  10115. private _target;
  10116. /**
  10117. * Instantiate the action
  10118. * @param triggerOptions defines the trigger options
  10119. * @param target defines the target animation or animation name
  10120. * @param from defines from where the animation should start (animation frame)
  10121. * @param end defines where the animation should stop (animation frame)
  10122. * @param loop defines if the animation should loop or stop after the first play
  10123. * @param condition defines the trigger related conditions
  10124. */
  10125. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10126. /** @hidden */
  10127. _prepare(): void;
  10128. /**
  10129. * Execute the action and play the animation.
  10130. */
  10131. execute(): void;
  10132. /**
  10133. * Serializes the actions and its related information.
  10134. * @param parent defines the object to serialize in
  10135. * @returns the serialized object
  10136. */
  10137. serialize(parent: any): any;
  10138. }
  10139. /**
  10140. * This defines an action responsible to stop an animation once triggered.
  10141. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10142. */
  10143. export class StopAnimationAction extends Action {
  10144. private _target;
  10145. /**
  10146. * Instantiate the action
  10147. * @param triggerOptions defines the trigger options
  10148. * @param target defines the target animation or animation name
  10149. * @param condition defines the trigger related conditions
  10150. */
  10151. constructor(triggerOptions: any, target: any, condition?: Condition);
  10152. /** @hidden */
  10153. _prepare(): void;
  10154. /**
  10155. * Execute the action and stop the animation.
  10156. */
  10157. execute(): void;
  10158. /**
  10159. * Serializes the actions and its related information.
  10160. * @param parent defines the object to serialize in
  10161. * @returns the serialized object
  10162. */
  10163. serialize(parent: any): any;
  10164. }
  10165. /**
  10166. * This defines an action responsible that does nothing once triggered.
  10167. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10168. */
  10169. export class DoNothingAction extends Action {
  10170. /**
  10171. * Instantiate the action
  10172. * @param triggerOptions defines the trigger options
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions?: any, condition?: Condition);
  10176. /**
  10177. * Execute the action and do nothing.
  10178. */
  10179. execute(): void;
  10180. /**
  10181. * Serializes the actions and its related information.
  10182. * @param parent defines the object to serialize in
  10183. * @returns the serialized object
  10184. */
  10185. serialize(parent: any): any;
  10186. }
  10187. /**
  10188. * This defines an action responsible to trigger several actions once triggered.
  10189. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10190. */
  10191. export class CombineAction extends Action {
  10192. /**
  10193. * The list of aggregated animations to run.
  10194. */
  10195. children: Action[];
  10196. /**
  10197. * Instantiate the action
  10198. * @param triggerOptions defines the trigger options
  10199. * @param children defines the list of aggregated animations to run
  10200. * @param condition defines the trigger related conditions
  10201. */
  10202. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10203. /** @hidden */
  10204. _prepare(): void;
  10205. /**
  10206. * Execute the action and executes all the aggregated actions.
  10207. */
  10208. execute(evt: ActionEvent): void;
  10209. /**
  10210. * Serializes the actions and its related information.
  10211. * @param parent defines the object to serialize in
  10212. * @returns the serialized object
  10213. */
  10214. serialize(parent: any): any;
  10215. }
  10216. /**
  10217. * This defines an action responsible to run code (external event) once triggered.
  10218. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10219. */
  10220. export class ExecuteCodeAction extends Action {
  10221. /**
  10222. * The callback function to run.
  10223. */
  10224. func: (evt: ActionEvent) => void;
  10225. /**
  10226. * Instantiate the action
  10227. * @param triggerOptions defines the trigger options
  10228. * @param func defines the callback function to run
  10229. * @param condition defines the trigger related conditions
  10230. */
  10231. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10232. /**
  10233. * Execute the action and run the attached code.
  10234. */
  10235. execute(evt: ActionEvent): void;
  10236. }
  10237. /**
  10238. * This defines an action responsible to set the parent property of the target once triggered.
  10239. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10240. */
  10241. export class SetParentAction extends Action {
  10242. private _parent;
  10243. private _target;
  10244. /**
  10245. * Instantiate the action
  10246. * @param triggerOptions defines the trigger options
  10247. * @param target defines the target containing the parent property
  10248. * @param parent defines from where the animation should start (animation frame)
  10249. * @param condition defines the trigger related conditions
  10250. */
  10251. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10252. /** @hidden */
  10253. _prepare(): void;
  10254. /**
  10255. * Execute the action and set the parent property.
  10256. */
  10257. execute(): void;
  10258. /**
  10259. * Serializes the actions and its related information.
  10260. * @param parent defines the object to serialize in
  10261. * @returns the serialized object
  10262. */
  10263. serialize(parent: any): any;
  10264. }
  10265. }
  10266. declare module "babylonjs/Actions/actionManager" {
  10267. import { Nullable } from "babylonjs/types";
  10268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10269. import { Scene } from "babylonjs/scene";
  10270. import { IAction } from "babylonjs/Actions/action";
  10271. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10272. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10273. /**
  10274. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10275. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10277. */
  10278. export class ActionManager extends AbstractActionManager {
  10279. /**
  10280. * Nothing
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly NothingTrigger: number;
  10284. /**
  10285. * On pick
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnPickTrigger: number;
  10289. /**
  10290. * On left pick
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnLeftPickTrigger: number;
  10294. /**
  10295. * On right pick
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnRightPickTrigger: number;
  10299. /**
  10300. * On center pick
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnCenterPickTrigger: number;
  10304. /**
  10305. * On pick down
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnPickDownTrigger: number;
  10309. /**
  10310. * On double pick
  10311. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10312. */
  10313. static readonly OnDoublePickTrigger: number;
  10314. /**
  10315. * On pick up
  10316. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10317. */
  10318. static readonly OnPickUpTrigger: number;
  10319. /**
  10320. * On pick out.
  10321. * This trigger will only be raised if you also declared a OnPickDown
  10322. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10323. */
  10324. static readonly OnPickOutTrigger: number;
  10325. /**
  10326. * On long press
  10327. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10328. */
  10329. static readonly OnLongPressTrigger: number;
  10330. /**
  10331. * On pointer over
  10332. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10333. */
  10334. static readonly OnPointerOverTrigger: number;
  10335. /**
  10336. * On pointer out
  10337. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10338. */
  10339. static readonly OnPointerOutTrigger: number;
  10340. /**
  10341. * On every frame
  10342. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10343. */
  10344. static readonly OnEveryFrameTrigger: number;
  10345. /**
  10346. * On intersection enter
  10347. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10348. */
  10349. static readonly OnIntersectionEnterTrigger: number;
  10350. /**
  10351. * On intersection exit
  10352. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10353. */
  10354. static readonly OnIntersectionExitTrigger: number;
  10355. /**
  10356. * On key down
  10357. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10358. */
  10359. static readonly OnKeyDownTrigger: number;
  10360. /**
  10361. * On key up
  10362. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10363. */
  10364. static readonly OnKeyUpTrigger: number;
  10365. private _scene;
  10366. /**
  10367. * Creates a new action manager
  10368. * @param scene defines the hosting scene
  10369. */
  10370. constructor(scene: Scene);
  10371. /**
  10372. * Releases all associated resources
  10373. */
  10374. dispose(): void;
  10375. /**
  10376. * Gets hosting scene
  10377. * @returns the hosting scene
  10378. */
  10379. getScene(): Scene;
  10380. /**
  10381. * Does this action manager handles actions of any of the given triggers
  10382. * @param triggers defines the triggers to be tested
  10383. * @return a boolean indicating whether one (or more) of the triggers is handled
  10384. */
  10385. hasSpecificTriggers(triggers: number[]): boolean;
  10386. /**
  10387. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10388. * speed.
  10389. * @param triggerA defines the trigger to be tested
  10390. * @param triggerB defines the trigger to be tested
  10391. * @return a boolean indicating whether one (or more) of the triggers is handled
  10392. */
  10393. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10394. /**
  10395. * Does this action manager handles actions of a given trigger
  10396. * @param trigger defines the trigger to be tested
  10397. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10398. * @return whether the trigger is handled
  10399. */
  10400. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10401. /**
  10402. * Does this action manager has pointer triggers
  10403. */
  10404. get hasPointerTriggers(): boolean;
  10405. /**
  10406. * Does this action manager has pick triggers
  10407. */
  10408. get hasPickTriggers(): boolean;
  10409. /**
  10410. * Registers an action to this action manager
  10411. * @param action defines the action to be registered
  10412. * @return the action amended (prepared) after registration
  10413. */
  10414. registerAction(action: IAction): Nullable<IAction>;
  10415. /**
  10416. * Unregisters an action to this action manager
  10417. * @param action defines the action to be unregistered
  10418. * @return a boolean indicating whether the action has been unregistered
  10419. */
  10420. unregisterAction(action: IAction): Boolean;
  10421. /**
  10422. * Process a specific trigger
  10423. * @param trigger defines the trigger to process
  10424. * @param evt defines the event details to be processed
  10425. */
  10426. processTrigger(trigger: number, evt?: IActionEvent): void;
  10427. /** @hidden */
  10428. _getEffectiveTarget(target: any, propertyPath: string): any;
  10429. /** @hidden */
  10430. _getProperty(propertyPath: string): string;
  10431. /**
  10432. * Serialize this manager to a JSON object
  10433. * @param name defines the property name to store this manager
  10434. * @returns a JSON representation of this manager
  10435. */
  10436. serialize(name: string): any;
  10437. /**
  10438. * Creates a new ActionManager from a JSON data
  10439. * @param parsedActions defines the JSON data to read from
  10440. * @param object defines the hosting mesh
  10441. * @param scene defines the hosting scene
  10442. */
  10443. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10444. /**
  10445. * Get a trigger name by index
  10446. * @param trigger defines the trigger index
  10447. * @returns a trigger name
  10448. */
  10449. static GetTriggerName(trigger: number): string;
  10450. }
  10451. }
  10452. declare module "babylonjs/Sprites/sprite" {
  10453. import { Vector3 } from "babylonjs/Maths/math.vector";
  10454. import { Nullable } from "babylonjs/types";
  10455. import { ActionManager } from "babylonjs/Actions/actionManager";
  10456. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10457. import { Color4 } from "babylonjs/Maths/math.color";
  10458. import { Observable } from "babylonjs/Misc/observable";
  10459. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10460. import { Animation } from "babylonjs/Animations/animation";
  10461. /**
  10462. * Class used to represent a sprite
  10463. * @see https://doc.babylonjs.com/babylon101/sprites
  10464. */
  10465. export class Sprite implements IAnimatable {
  10466. /** defines the name */
  10467. name: string;
  10468. /** Gets or sets the current world position */
  10469. position: Vector3;
  10470. /** Gets or sets the main color */
  10471. color: Color4;
  10472. /** Gets or sets the width */
  10473. width: number;
  10474. /** Gets or sets the height */
  10475. height: number;
  10476. /** Gets or sets rotation angle */
  10477. angle: number;
  10478. /** Gets or sets the cell index in the sprite sheet */
  10479. cellIndex: number;
  10480. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10481. cellRef: string;
  10482. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10483. invertU: boolean;
  10484. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10485. invertV: boolean;
  10486. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10487. disposeWhenFinishedAnimating: boolean;
  10488. /** Gets the list of attached animations */
  10489. animations: Nullable<Array<Animation>>;
  10490. /** Gets or sets a boolean indicating if the sprite can be picked */
  10491. isPickable: boolean;
  10492. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10493. useAlphaForPicking: boolean;
  10494. /** @hidden */
  10495. _xOffset: number;
  10496. /** @hidden */
  10497. _yOffset: number;
  10498. /** @hidden */
  10499. _xSize: number;
  10500. /** @hidden */
  10501. _ySize: number;
  10502. /**
  10503. * Gets or sets the associated action manager
  10504. */
  10505. actionManager: Nullable<ActionManager>;
  10506. /**
  10507. * An event triggered when the control has been disposed
  10508. */
  10509. onDisposeObservable: Observable<Sprite>;
  10510. private _animationStarted;
  10511. private _loopAnimation;
  10512. private _fromIndex;
  10513. private _toIndex;
  10514. private _delay;
  10515. private _direction;
  10516. private _manager;
  10517. private _time;
  10518. private _onAnimationEnd;
  10519. /**
  10520. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10521. */
  10522. isVisible: boolean;
  10523. /**
  10524. * Gets or sets the sprite size
  10525. */
  10526. get size(): number;
  10527. set size(value: number);
  10528. /**
  10529. * Returns a boolean indicating if the animation is started
  10530. */
  10531. get animationStarted(): boolean;
  10532. /**
  10533. * Gets or sets the unique id of the sprite
  10534. */
  10535. uniqueId: number;
  10536. /**
  10537. * Gets the manager of this sprite
  10538. */
  10539. get manager(): ISpriteManager;
  10540. /**
  10541. * Creates a new Sprite
  10542. * @param name defines the name
  10543. * @param manager defines the manager
  10544. */
  10545. constructor(
  10546. /** defines the name */
  10547. name: string, manager: ISpriteManager);
  10548. /**
  10549. * Returns the string "Sprite"
  10550. * @returns "Sprite"
  10551. */
  10552. getClassName(): string;
  10553. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10554. get fromIndex(): number;
  10555. set fromIndex(value: number);
  10556. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10557. get toIndex(): number;
  10558. set toIndex(value: number);
  10559. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10560. get loopAnimation(): boolean;
  10561. set loopAnimation(value: boolean);
  10562. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10563. get delay(): number;
  10564. set delay(value: number);
  10565. /**
  10566. * Starts an animation
  10567. * @param from defines the initial key
  10568. * @param to defines the end key
  10569. * @param loop defines if the animation must loop
  10570. * @param delay defines the start delay (in ms)
  10571. * @param onAnimationEnd defines a callback to call when animation ends
  10572. */
  10573. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10574. /** Stops current animation (if any) */
  10575. stopAnimation(): void;
  10576. /** @hidden */
  10577. _animate(deltaTime: number): void;
  10578. /** Release associated resources */
  10579. dispose(): void;
  10580. /**
  10581. * Serializes the sprite to a JSON object
  10582. * @returns the JSON object
  10583. */
  10584. serialize(): any;
  10585. /**
  10586. * Parses a JSON object to create a new sprite
  10587. * @param parsedSprite The JSON object to parse
  10588. * @param manager defines the hosting manager
  10589. * @returns the new sprite
  10590. */
  10591. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10592. }
  10593. }
  10594. declare module "babylonjs/Collisions/pickingInfo" {
  10595. import { Nullable } from "babylonjs/types";
  10596. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10597. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10598. import { Sprite } from "babylonjs/Sprites/sprite";
  10599. import { Ray } from "babylonjs/Culling/ray";
  10600. /**
  10601. * Information about the result of picking within a scene
  10602. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10603. */
  10604. export class PickingInfo {
  10605. /** @hidden */
  10606. _pickingUnavailable: boolean;
  10607. /**
  10608. * If the pick collided with an object
  10609. */
  10610. hit: boolean;
  10611. /**
  10612. * Distance away where the pick collided
  10613. */
  10614. distance: number;
  10615. /**
  10616. * The location of pick collision
  10617. */
  10618. pickedPoint: Nullable<Vector3>;
  10619. /**
  10620. * The mesh corresponding the the pick collision
  10621. */
  10622. pickedMesh: Nullable<AbstractMesh>;
  10623. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10624. bu: number;
  10625. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10626. bv: number;
  10627. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10628. faceId: number;
  10629. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10630. subMeshFaceId: number;
  10631. /** Id of the the submesh that was picked */
  10632. subMeshId: number;
  10633. /** If a sprite was picked, this will be the sprite the pick collided with */
  10634. pickedSprite: Nullable<Sprite>;
  10635. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10636. thinInstanceIndex: number;
  10637. /**
  10638. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10639. */
  10640. originMesh: Nullable<AbstractMesh>;
  10641. /**
  10642. * The ray that was used to perform the picking.
  10643. */
  10644. ray: Nullable<Ray>;
  10645. /**
  10646. * Gets the normal correspodning to the face the pick collided with
  10647. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10648. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10649. * @returns The normal correspodning to the face the pick collided with
  10650. */
  10651. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10652. /**
  10653. * Gets the texture coordinates of where the pick occured
  10654. * @returns the vector containing the coordnates of the texture
  10655. */
  10656. getTextureCoordinates(): Nullable<Vector2>;
  10657. }
  10658. }
  10659. declare module "babylonjs/Culling/ray" {
  10660. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10661. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10662. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10663. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10664. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10665. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10666. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10667. import { Plane } from "babylonjs/Maths/math.plane";
  10668. /**
  10669. * Class representing a ray with position and direction
  10670. */
  10671. export class Ray {
  10672. /** origin point */
  10673. origin: Vector3;
  10674. /** direction */
  10675. direction: Vector3;
  10676. /** length of the ray */
  10677. length: number;
  10678. private static readonly _TmpVector3;
  10679. private _tmpRay;
  10680. /**
  10681. * Creates a new ray
  10682. * @param origin origin point
  10683. * @param direction direction
  10684. * @param length length of the ray
  10685. */
  10686. constructor(
  10687. /** origin point */
  10688. origin: Vector3,
  10689. /** direction */
  10690. direction: Vector3,
  10691. /** length of the ray */
  10692. length?: number);
  10693. /**
  10694. * Checks if the ray intersects a box
  10695. * This does not account for the ray lenght by design to improve perfs.
  10696. * @param minimum bound of the box
  10697. * @param maximum bound of the box
  10698. * @param intersectionTreshold extra extend to be added to the box in all direction
  10699. * @returns if the box was hit
  10700. */
  10701. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10702. /**
  10703. * Checks if the ray intersects a box
  10704. * This does not account for the ray lenght by design to improve perfs.
  10705. * @param box the bounding box to check
  10706. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10707. * @returns if the box was hit
  10708. */
  10709. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10710. /**
  10711. * If the ray hits a sphere
  10712. * @param sphere the bounding sphere to check
  10713. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10714. * @returns true if it hits the sphere
  10715. */
  10716. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10717. /**
  10718. * If the ray hits a triange
  10719. * @param vertex0 triangle vertex
  10720. * @param vertex1 triangle vertex
  10721. * @param vertex2 triangle vertex
  10722. * @returns intersection information if hit
  10723. */
  10724. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10725. /**
  10726. * Checks if ray intersects a plane
  10727. * @param plane the plane to check
  10728. * @returns the distance away it was hit
  10729. */
  10730. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10731. /**
  10732. * Calculate the intercept of a ray on a given axis
  10733. * @param axis to check 'x' | 'y' | 'z'
  10734. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10735. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10736. */
  10737. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10738. /**
  10739. * Checks if ray intersects a mesh
  10740. * @param mesh the mesh to check
  10741. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10742. * @returns picking info of the intersecton
  10743. */
  10744. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10745. /**
  10746. * Checks if ray intersects a mesh
  10747. * @param meshes the meshes to check
  10748. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10749. * @param results array to store result in
  10750. * @returns Array of picking infos
  10751. */
  10752. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10753. private _comparePickingInfo;
  10754. private static smallnum;
  10755. private static rayl;
  10756. /**
  10757. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10758. * @param sega the first point of the segment to test the intersection against
  10759. * @param segb the second point of the segment to test the intersection against
  10760. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10761. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10762. */
  10763. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10764. /**
  10765. * Update the ray from viewport position
  10766. * @param x position
  10767. * @param y y position
  10768. * @param viewportWidth viewport width
  10769. * @param viewportHeight viewport height
  10770. * @param world world matrix
  10771. * @param view view matrix
  10772. * @param projection projection matrix
  10773. * @returns this ray updated
  10774. */
  10775. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10776. /**
  10777. * Creates a ray with origin and direction of 0,0,0
  10778. * @returns the new ray
  10779. */
  10780. static Zero(): Ray;
  10781. /**
  10782. * Creates a new ray from screen space and viewport
  10783. * @param x position
  10784. * @param y y position
  10785. * @param viewportWidth viewport width
  10786. * @param viewportHeight viewport height
  10787. * @param world world matrix
  10788. * @param view view matrix
  10789. * @param projection projection matrix
  10790. * @returns new ray
  10791. */
  10792. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10793. /**
  10794. * 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
  10795. * transformed to the given world matrix.
  10796. * @param origin The origin point
  10797. * @param end The end point
  10798. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10799. * @returns the new ray
  10800. */
  10801. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10802. /**
  10803. * Transforms a ray by a matrix
  10804. * @param ray ray to transform
  10805. * @param matrix matrix to apply
  10806. * @returns the resulting new ray
  10807. */
  10808. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10809. /**
  10810. * Transforms a ray by a matrix
  10811. * @param ray ray to transform
  10812. * @param matrix matrix to apply
  10813. * @param result ray to store result in
  10814. */
  10815. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10816. /**
  10817. * Unproject a ray from screen space to object space
  10818. * @param sourceX defines the screen space x coordinate to use
  10819. * @param sourceY defines the screen space y coordinate to use
  10820. * @param viewportWidth defines the current width of the viewport
  10821. * @param viewportHeight defines the current height of the viewport
  10822. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10823. * @param view defines the view matrix to use
  10824. * @param projection defines the projection matrix to use
  10825. */
  10826. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10827. }
  10828. /**
  10829. * Type used to define predicate used to select faces when a mesh intersection is detected
  10830. */
  10831. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10832. module "babylonjs/scene" {
  10833. interface Scene {
  10834. /** @hidden */
  10835. _tempPickingRay: Nullable<Ray>;
  10836. /** @hidden */
  10837. _cachedRayForTransform: Ray;
  10838. /** @hidden */
  10839. _pickWithRayInverseMatrix: Matrix;
  10840. /** @hidden */
  10841. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10842. /** @hidden */
  10843. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10844. /** @hidden */
  10845. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10846. }
  10847. }
  10848. }
  10849. declare module "babylonjs/sceneComponent" {
  10850. import { Scene } from "babylonjs/scene";
  10851. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10852. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10853. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10854. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10855. import { Nullable } from "babylonjs/types";
  10856. import { Camera } from "babylonjs/Cameras/camera";
  10857. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10858. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10859. import { AbstractScene } from "babylonjs/abstractScene";
  10860. import { Mesh } from "babylonjs/Meshes/mesh";
  10861. /**
  10862. * Groups all the scene component constants in one place to ease maintenance.
  10863. * @hidden
  10864. */
  10865. export class SceneComponentConstants {
  10866. static readonly NAME_EFFECTLAYER: string;
  10867. static readonly NAME_LAYER: string;
  10868. static readonly NAME_LENSFLARESYSTEM: string;
  10869. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10870. static readonly NAME_PARTICLESYSTEM: string;
  10871. static readonly NAME_GAMEPAD: string;
  10872. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10873. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10874. static readonly NAME_PREPASSRENDERER: string;
  10875. static readonly NAME_DEPTHRENDERER: string;
  10876. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10877. static readonly NAME_SPRITE: string;
  10878. static readonly NAME_SUBSURFACE: string;
  10879. static readonly NAME_OUTLINERENDERER: string;
  10880. static readonly NAME_PROCEDURALTEXTURE: string;
  10881. static readonly NAME_SHADOWGENERATOR: string;
  10882. static readonly NAME_OCTREE: string;
  10883. static readonly NAME_PHYSICSENGINE: string;
  10884. static readonly NAME_AUDIO: string;
  10885. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10886. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10887. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10888. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10889. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10890. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10891. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10892. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10893. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10894. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10895. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10896. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10897. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10898. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10899. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10900. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10901. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10902. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10903. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10904. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10905. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10906. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10907. static readonly STEP_AFTERRENDER_AUDIO: number;
  10908. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10909. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10910. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10911. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10912. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10913. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10914. static readonly STEP_POINTERMOVE_SPRITE: number;
  10915. static readonly STEP_POINTERDOWN_SPRITE: number;
  10916. static readonly STEP_POINTERUP_SPRITE: number;
  10917. }
  10918. /**
  10919. * This represents a scene component.
  10920. *
  10921. * This is used to decouple the dependency the scene is having on the different workloads like
  10922. * layers, post processes...
  10923. */
  10924. export interface ISceneComponent {
  10925. /**
  10926. * The name of the component. Each component must have a unique name.
  10927. */
  10928. name: string;
  10929. /**
  10930. * The scene the component belongs to.
  10931. */
  10932. scene: Scene;
  10933. /**
  10934. * Register the component to one instance of a scene.
  10935. */
  10936. register(): void;
  10937. /**
  10938. * Rebuilds the elements related to this component in case of
  10939. * context lost for instance.
  10940. */
  10941. rebuild(): void;
  10942. /**
  10943. * Disposes the component and the associated ressources.
  10944. */
  10945. dispose(): void;
  10946. }
  10947. /**
  10948. * This represents a SERIALIZABLE scene component.
  10949. *
  10950. * This extends Scene Component to add Serialization methods on top.
  10951. */
  10952. export interface ISceneSerializableComponent extends ISceneComponent {
  10953. /**
  10954. * Adds all the elements from the container to the scene
  10955. * @param container the container holding the elements
  10956. */
  10957. addFromContainer(container: AbstractScene): void;
  10958. /**
  10959. * Removes all the elements in the container from the scene
  10960. * @param container contains the elements to remove
  10961. * @param dispose if the removed element should be disposed (default: false)
  10962. */
  10963. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10964. /**
  10965. * Serializes the component data to the specified json object
  10966. * @param serializationObject The object to serialize to
  10967. */
  10968. serialize(serializationObject: any): void;
  10969. }
  10970. /**
  10971. * Strong typing of a Mesh related stage step action
  10972. */
  10973. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10974. /**
  10975. * Strong typing of a Evaluate Sub Mesh related stage step action
  10976. */
  10977. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10978. /**
  10979. * Strong typing of a Active Mesh related stage step action
  10980. */
  10981. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10982. /**
  10983. * Strong typing of a Camera related stage step action
  10984. */
  10985. export type CameraStageAction = (camera: Camera) => void;
  10986. /**
  10987. * Strong typing of a Camera Frame buffer related stage step action
  10988. */
  10989. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10990. /**
  10991. * Strong typing of a Render Target related stage step action
  10992. */
  10993. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10994. /**
  10995. * Strong typing of a RenderingGroup related stage step action
  10996. */
  10997. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10998. /**
  10999. * Strong typing of a Mesh Render related stage step action
  11000. */
  11001. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11002. /**
  11003. * Strong typing of a simple stage step action
  11004. */
  11005. export type SimpleStageAction = () => void;
  11006. /**
  11007. * Strong typing of a render target action.
  11008. */
  11009. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11010. /**
  11011. * Strong typing of a pointer move action.
  11012. */
  11013. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  11014. /**
  11015. * Strong typing of a pointer up/down action.
  11016. */
  11017. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11018. /**
  11019. * Representation of a stage in the scene (Basically a list of ordered steps)
  11020. * @hidden
  11021. */
  11022. export class Stage<T extends Function> extends Array<{
  11023. index: number;
  11024. component: ISceneComponent;
  11025. action: T;
  11026. }> {
  11027. /**
  11028. * Hide ctor from the rest of the world.
  11029. * @param items The items to add.
  11030. */
  11031. private constructor();
  11032. /**
  11033. * Creates a new Stage.
  11034. * @returns A new instance of a Stage
  11035. */
  11036. static Create<T extends Function>(): Stage<T>;
  11037. /**
  11038. * Registers a step in an ordered way in the targeted stage.
  11039. * @param index Defines the position to register the step in
  11040. * @param component Defines the component attached to the step
  11041. * @param action Defines the action to launch during the step
  11042. */
  11043. registerStep(index: number, component: ISceneComponent, action: T): void;
  11044. /**
  11045. * Clears all the steps from the stage.
  11046. */
  11047. clear(): void;
  11048. }
  11049. }
  11050. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11051. import { Nullable } from "babylonjs/types";
  11052. import { Observable } from "babylonjs/Misc/observable";
  11053. import { Scene } from "babylonjs/scene";
  11054. import { Sprite } from "babylonjs/Sprites/sprite";
  11055. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11056. import { Ray } from "babylonjs/Culling/ray";
  11057. import { Camera } from "babylonjs/Cameras/camera";
  11058. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11059. import { ISceneComponent } from "babylonjs/sceneComponent";
  11060. module "babylonjs/scene" {
  11061. interface Scene {
  11062. /** @hidden */
  11063. _pointerOverSprite: Nullable<Sprite>;
  11064. /** @hidden */
  11065. _pickedDownSprite: Nullable<Sprite>;
  11066. /** @hidden */
  11067. _tempSpritePickingRay: Nullable<Ray>;
  11068. /**
  11069. * All of the sprite managers added to this scene
  11070. * @see https://doc.babylonjs.com/babylon101/sprites
  11071. */
  11072. spriteManagers: Array<ISpriteManager>;
  11073. /**
  11074. * An event triggered when sprites rendering is about to start
  11075. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11076. */
  11077. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11078. /**
  11079. * An event triggered when sprites rendering is done
  11080. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11081. */
  11082. onAfterSpritesRenderingObservable: Observable<Scene>;
  11083. /** @hidden */
  11084. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11085. /** Launch a ray to try to pick a sprite in the scene
  11086. * @param x position on screen
  11087. * @param y position on screen
  11088. * @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
  11089. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11090. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11091. * @returns a PickingInfo
  11092. */
  11093. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11094. /** Use the given ray to pick a sprite in the scene
  11095. * @param ray The ray (in world space) to use to pick meshes
  11096. * @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
  11097. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11098. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11099. * @returns a PickingInfo
  11100. */
  11101. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11102. /** @hidden */
  11103. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11104. /** Launch a ray to try to pick sprites in the scene
  11105. * @param x position on screen
  11106. * @param y position on screen
  11107. * @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
  11108. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11109. * @returns a PickingInfo array
  11110. */
  11111. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11112. /** Use the given ray to pick sprites in the scene
  11113. * @param ray The ray (in world space) to use to pick meshes
  11114. * @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
  11115. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11116. * @returns a PickingInfo array
  11117. */
  11118. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11119. /**
  11120. * Force the sprite under the pointer
  11121. * @param sprite defines the sprite to use
  11122. */
  11123. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11124. /**
  11125. * Gets the sprite under the pointer
  11126. * @returns a Sprite or null if no sprite is under the pointer
  11127. */
  11128. getPointerOverSprite(): Nullable<Sprite>;
  11129. }
  11130. }
  11131. /**
  11132. * Defines the sprite scene component responsible to manage sprites
  11133. * in a given scene.
  11134. */
  11135. export class SpriteSceneComponent implements ISceneComponent {
  11136. /**
  11137. * The component name helpfull to identify the component in the list of scene components.
  11138. */
  11139. readonly name: string;
  11140. /**
  11141. * The scene the component belongs to.
  11142. */
  11143. scene: Scene;
  11144. /** @hidden */
  11145. private _spritePredicate;
  11146. /**
  11147. * Creates a new instance of the component for the given scene
  11148. * @param scene Defines the scene to register the component in
  11149. */
  11150. constructor(scene: Scene);
  11151. /**
  11152. * Registers the component in a given scene
  11153. */
  11154. register(): void;
  11155. /**
  11156. * Rebuilds the elements related to this component in case of
  11157. * context lost for instance.
  11158. */
  11159. rebuild(): void;
  11160. /**
  11161. * Disposes the component and the associated ressources.
  11162. */
  11163. dispose(): void;
  11164. private _pickSpriteButKeepRay;
  11165. private _pointerMove;
  11166. private _pointerDown;
  11167. private _pointerUp;
  11168. }
  11169. }
  11170. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11171. /** @hidden */
  11172. export var fogFragmentDeclaration: {
  11173. name: string;
  11174. shader: string;
  11175. };
  11176. }
  11177. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11178. /** @hidden */
  11179. export var fogFragment: {
  11180. name: string;
  11181. shader: string;
  11182. };
  11183. }
  11184. declare module "babylonjs/Shaders/sprites.fragment" {
  11185. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11186. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11187. /** @hidden */
  11188. export var spritesPixelShader: {
  11189. name: string;
  11190. shader: string;
  11191. };
  11192. }
  11193. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11194. /** @hidden */
  11195. export var fogVertexDeclaration: {
  11196. name: string;
  11197. shader: string;
  11198. };
  11199. }
  11200. declare module "babylonjs/Shaders/sprites.vertex" {
  11201. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11202. /** @hidden */
  11203. export var spritesVertexShader: {
  11204. name: string;
  11205. shader: string;
  11206. };
  11207. }
  11208. declare module "babylonjs/Sprites/spriteManager" {
  11209. import { IDisposable, Scene } from "babylonjs/scene";
  11210. import { Nullable } from "babylonjs/types";
  11211. import { Observable } from "babylonjs/Misc/observable";
  11212. import { Sprite } from "babylonjs/Sprites/sprite";
  11213. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11214. import { Camera } from "babylonjs/Cameras/camera";
  11215. import { Texture } from "babylonjs/Materials/Textures/texture";
  11216. import "babylonjs/Shaders/sprites.fragment";
  11217. import "babylonjs/Shaders/sprites.vertex";
  11218. import { Ray } from "babylonjs/Culling/ray";
  11219. /**
  11220. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11221. */
  11222. export interface ISpriteManager extends IDisposable {
  11223. /**
  11224. * Gets manager's name
  11225. */
  11226. name: string;
  11227. /**
  11228. * Restricts the camera to viewing objects with the same layerMask.
  11229. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11230. */
  11231. layerMask: number;
  11232. /**
  11233. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11234. */
  11235. isPickable: boolean;
  11236. /**
  11237. * Gets the hosting scene
  11238. */
  11239. scene: Scene;
  11240. /**
  11241. * Specifies the rendering group id for this mesh (0 by default)
  11242. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11243. */
  11244. renderingGroupId: number;
  11245. /**
  11246. * Defines the list of sprites managed by the manager.
  11247. */
  11248. sprites: Array<Sprite>;
  11249. /**
  11250. * Gets or sets the spritesheet texture
  11251. */
  11252. texture: Texture;
  11253. /** Defines the default width of a cell in the spritesheet */
  11254. cellWidth: number;
  11255. /** Defines the default height of a cell in the spritesheet */
  11256. cellHeight: number;
  11257. /**
  11258. * Tests the intersection of a sprite with a specific ray.
  11259. * @param ray The ray we are sending to test the collision
  11260. * @param camera The camera space we are sending rays in
  11261. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11262. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11263. * @returns picking info or null.
  11264. */
  11265. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11266. /**
  11267. * Intersects the sprites with a ray
  11268. * @param ray defines the ray to intersect with
  11269. * @param camera defines the current active camera
  11270. * @param predicate defines a predicate used to select candidate sprites
  11271. * @returns null if no hit or a PickingInfo array
  11272. */
  11273. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11274. /**
  11275. * Renders the list of sprites on screen.
  11276. */
  11277. render(): void;
  11278. }
  11279. /**
  11280. * Class used to manage multiple sprites on the same spritesheet
  11281. * @see https://doc.babylonjs.com/babylon101/sprites
  11282. */
  11283. export class SpriteManager implements ISpriteManager {
  11284. /** defines the manager's name */
  11285. name: string;
  11286. /** Define the Url to load snippets */
  11287. static SnippetUrl: string;
  11288. /** Snippet ID if the manager was created from the snippet server */
  11289. snippetId: string;
  11290. /** Gets the list of sprites */
  11291. sprites: Sprite[];
  11292. /** Gets or sets the rendering group id (0 by default) */
  11293. renderingGroupId: number;
  11294. /** Gets or sets camera layer mask */
  11295. layerMask: number;
  11296. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11297. fogEnabled: boolean;
  11298. /** Gets or sets a boolean indicating if the sprites are pickable */
  11299. isPickable: boolean;
  11300. /** Defines the default width of a cell in the spritesheet */
  11301. cellWidth: number;
  11302. /** Defines the default height of a cell in the spritesheet */
  11303. cellHeight: number;
  11304. /** Associative array from JSON sprite data file */
  11305. private _cellData;
  11306. /** Array of sprite names from JSON sprite data file */
  11307. private _spriteMap;
  11308. /** True when packed cell data from JSON file is ready*/
  11309. private _packedAndReady;
  11310. private _textureContent;
  11311. private _useInstancing;
  11312. /**
  11313. * An event triggered when the manager is disposed.
  11314. */
  11315. onDisposeObservable: Observable<SpriteManager>;
  11316. private _onDisposeObserver;
  11317. /**
  11318. * Callback called when the manager is disposed
  11319. */
  11320. set onDispose(callback: () => void);
  11321. private _capacity;
  11322. private _fromPacked;
  11323. private _spriteTexture;
  11324. private _epsilon;
  11325. private _scene;
  11326. private _vertexData;
  11327. private _buffer;
  11328. private _vertexBuffers;
  11329. private _spriteBuffer;
  11330. private _indexBuffer;
  11331. private _effectBase;
  11332. private _effectFog;
  11333. private _vertexBufferSize;
  11334. /**
  11335. * Gets or sets the unique id of the sprite
  11336. */
  11337. uniqueId: number;
  11338. /**
  11339. * Gets the array of sprites
  11340. */
  11341. get children(): Sprite[];
  11342. /**
  11343. * Gets the hosting scene
  11344. */
  11345. get scene(): Scene;
  11346. /**
  11347. * Gets the capacity of the manager
  11348. */
  11349. get capacity(): number;
  11350. /**
  11351. * Gets or sets the spritesheet texture
  11352. */
  11353. get texture(): Texture;
  11354. set texture(value: Texture);
  11355. private _blendMode;
  11356. /**
  11357. * Blend mode use to render the particle, it can be any of
  11358. * the static Constants.ALPHA_x properties provided in this class.
  11359. * Default value is Constants.ALPHA_COMBINE
  11360. */
  11361. get blendMode(): number;
  11362. set blendMode(blendMode: number);
  11363. /** Disables writing to the depth buffer when rendering the sprites.
  11364. * It can be handy to disable depth writing when using textures without alpha channel
  11365. * and setting some specific blend modes.
  11366. */
  11367. disableDepthWrite: boolean;
  11368. /**
  11369. * Creates a new sprite manager
  11370. * @param name defines the manager's name
  11371. * @param imgUrl defines the sprite sheet url
  11372. * @param capacity defines the maximum allowed number of sprites
  11373. * @param cellSize defines the size of a sprite cell
  11374. * @param scene defines the hosting scene
  11375. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11376. * @param samplingMode defines the smapling mode to use with spritesheet
  11377. * @param fromPacked set to false; do not alter
  11378. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11379. */
  11380. constructor(
  11381. /** defines the manager's name */
  11382. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11383. /**
  11384. * Returns the string "SpriteManager"
  11385. * @returns "SpriteManager"
  11386. */
  11387. getClassName(): string;
  11388. private _makePacked;
  11389. private _appendSpriteVertex;
  11390. private _checkTextureAlpha;
  11391. /**
  11392. * Intersects the sprites with a ray
  11393. * @param ray defines the ray to intersect with
  11394. * @param camera defines the current active camera
  11395. * @param predicate defines a predicate used to select candidate sprites
  11396. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11397. * @returns null if no hit or a PickingInfo
  11398. */
  11399. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11400. /**
  11401. * Intersects the sprites with a ray
  11402. * @param ray defines the ray to intersect with
  11403. * @param camera defines the current active camera
  11404. * @param predicate defines a predicate used to select candidate sprites
  11405. * @returns null if no hit or a PickingInfo array
  11406. */
  11407. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11408. /**
  11409. * Render all child sprites
  11410. */
  11411. render(): void;
  11412. /**
  11413. * Release associated resources
  11414. */
  11415. dispose(): void;
  11416. /**
  11417. * Serializes the sprite manager to a JSON object
  11418. * @param serializeTexture defines if the texture must be serialized as well
  11419. * @returns the JSON object
  11420. */
  11421. serialize(serializeTexture?: boolean): any;
  11422. /**
  11423. * Parses a JSON object to create a new sprite manager.
  11424. * @param parsedManager The JSON object to parse
  11425. * @param scene The scene to create the sprite managerin
  11426. * @param rootUrl The root url to use to load external dependencies like texture
  11427. * @returns the new sprite manager
  11428. */
  11429. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11430. /**
  11431. * Creates a sprite manager from a snippet saved in a remote file
  11432. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11433. * @param url defines the url to load from
  11434. * @param scene defines the hosting scene
  11435. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11436. * @returns a promise that will resolve to the new sprite manager
  11437. */
  11438. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11439. /**
  11440. * Creates a sprite manager from a snippet saved by the sprite editor
  11441. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11442. * @param scene defines the hosting scene
  11443. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11444. * @returns a promise that will resolve to the new sprite manager
  11445. */
  11446. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11447. }
  11448. }
  11449. declare module "babylonjs/Misc/gradients" {
  11450. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11451. /** Interface used by value gradients (color, factor, ...) */
  11452. export interface IValueGradient {
  11453. /**
  11454. * Gets or sets the gradient value (between 0 and 1)
  11455. */
  11456. gradient: number;
  11457. }
  11458. /** Class used to store color4 gradient */
  11459. export class ColorGradient implements IValueGradient {
  11460. /**
  11461. * Gets or sets the gradient value (between 0 and 1)
  11462. */
  11463. gradient: number;
  11464. /**
  11465. * Gets or sets first associated color
  11466. */
  11467. color1: Color4;
  11468. /**
  11469. * Gets or sets second associated color
  11470. */
  11471. color2?: Color4 | undefined;
  11472. /**
  11473. * Creates a new color4 gradient
  11474. * @param gradient gets or sets the gradient value (between 0 and 1)
  11475. * @param color1 gets or sets first associated color
  11476. * @param color2 gets or sets first second color
  11477. */
  11478. constructor(
  11479. /**
  11480. * Gets or sets the gradient value (between 0 and 1)
  11481. */
  11482. gradient: number,
  11483. /**
  11484. * Gets or sets first associated color
  11485. */
  11486. color1: Color4,
  11487. /**
  11488. * Gets or sets second associated color
  11489. */
  11490. color2?: Color4 | undefined);
  11491. /**
  11492. * Will get a color picked randomly between color1 and color2.
  11493. * If color2 is undefined then color1 will be used
  11494. * @param result defines the target Color4 to store the result in
  11495. */
  11496. getColorToRef(result: Color4): void;
  11497. }
  11498. /** Class used to store color 3 gradient */
  11499. export class Color3Gradient implements IValueGradient {
  11500. /**
  11501. * Gets or sets the gradient value (between 0 and 1)
  11502. */
  11503. gradient: number;
  11504. /**
  11505. * Gets or sets the associated color
  11506. */
  11507. color: Color3;
  11508. /**
  11509. * Creates a new color3 gradient
  11510. * @param gradient gets or sets the gradient value (between 0 and 1)
  11511. * @param color gets or sets associated color
  11512. */
  11513. constructor(
  11514. /**
  11515. * Gets or sets the gradient value (between 0 and 1)
  11516. */
  11517. gradient: number,
  11518. /**
  11519. * Gets or sets the associated color
  11520. */
  11521. color: Color3);
  11522. }
  11523. /** Class used to store factor gradient */
  11524. export class FactorGradient implements IValueGradient {
  11525. /**
  11526. * Gets or sets the gradient value (between 0 and 1)
  11527. */
  11528. gradient: number;
  11529. /**
  11530. * Gets or sets first associated factor
  11531. */
  11532. factor1: number;
  11533. /**
  11534. * Gets or sets second associated factor
  11535. */
  11536. factor2?: number | undefined;
  11537. /**
  11538. * Creates a new factor gradient
  11539. * @param gradient gets or sets the gradient value (between 0 and 1)
  11540. * @param factor1 gets or sets first associated factor
  11541. * @param factor2 gets or sets second associated factor
  11542. */
  11543. constructor(
  11544. /**
  11545. * Gets or sets the gradient value (between 0 and 1)
  11546. */
  11547. gradient: number,
  11548. /**
  11549. * Gets or sets first associated factor
  11550. */
  11551. factor1: number,
  11552. /**
  11553. * Gets or sets second associated factor
  11554. */
  11555. factor2?: number | undefined);
  11556. /**
  11557. * Will get a number picked randomly between factor1 and factor2.
  11558. * If factor2 is undefined then factor1 will be used
  11559. * @returns the picked number
  11560. */
  11561. getFactor(): number;
  11562. }
  11563. /**
  11564. * Helper used to simplify some generic gradient tasks
  11565. */
  11566. export class GradientHelper {
  11567. /**
  11568. * Gets the current gradient from an array of IValueGradient
  11569. * @param ratio defines the current ratio to get
  11570. * @param gradients defines the array of IValueGradient
  11571. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11572. */
  11573. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11574. }
  11575. }
  11576. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11577. import { Nullable } from "babylonjs/types";
  11578. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11579. import { Scene } from "babylonjs/scene";
  11580. module "babylonjs/Engines/thinEngine" {
  11581. interface ThinEngine {
  11582. /**
  11583. * Creates a raw texture
  11584. * @param data defines the data to store in the texture
  11585. * @param width defines the width of the texture
  11586. * @param height defines the height of the texture
  11587. * @param format defines the format of the data
  11588. * @param generateMipMaps defines if the engine should generate the mip levels
  11589. * @param invertY defines if data must be stored with Y axis inverted
  11590. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11591. * @param compression defines the compression used (null by default)
  11592. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11593. * @returns the raw texture inside an InternalTexture
  11594. */
  11595. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11596. /**
  11597. * Update a raw texture
  11598. * @param texture defines the texture to update
  11599. * @param data defines the data to store in the texture
  11600. * @param format defines the format of the data
  11601. * @param invertY defines if data must be stored with Y axis inverted
  11602. */
  11603. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11604. /**
  11605. * Update a raw texture
  11606. * @param texture defines the texture to update
  11607. * @param data defines the data to store in the texture
  11608. * @param format defines the format of the data
  11609. * @param invertY defines if data must be stored with Y axis inverted
  11610. * @param compression defines the compression used (null by default)
  11611. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11612. */
  11613. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11614. /**
  11615. * Creates a new raw cube texture
  11616. * @param data defines the array of data to use to create each face
  11617. * @param size defines the size of the textures
  11618. * @param format defines the format of the data
  11619. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11620. * @param generateMipMaps defines if the engine should generate the mip levels
  11621. * @param invertY defines if data must be stored with Y axis inverted
  11622. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11623. * @param compression defines the compression used (null by default)
  11624. * @returns the cube texture as an InternalTexture
  11625. */
  11626. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11627. /**
  11628. * Update a raw cube texture
  11629. * @param texture defines the texture to udpdate
  11630. * @param data defines the data to store
  11631. * @param format defines the data format
  11632. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11633. * @param invertY defines if data must be stored with Y axis inverted
  11634. */
  11635. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11636. /**
  11637. * Update a raw cube texture
  11638. * @param texture defines the texture to udpdate
  11639. * @param data defines the data to store
  11640. * @param format defines the data format
  11641. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11642. * @param invertY defines if data must be stored with Y axis inverted
  11643. * @param compression defines the compression used (null by default)
  11644. */
  11645. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11646. /**
  11647. * Update a raw cube texture
  11648. * @param texture defines the texture to udpdate
  11649. * @param data defines the data to store
  11650. * @param format defines the data format
  11651. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. * @param compression defines the compression used (null by default)
  11654. * @param level defines which level of the texture to update
  11655. */
  11656. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11657. /**
  11658. * Creates a new raw cube texture from a specified url
  11659. * @param url defines the url where the data is located
  11660. * @param scene defines the current scene
  11661. * @param size defines the size of the textures
  11662. * @param format defines the format of the data
  11663. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11664. * @param noMipmap defines if the engine should avoid generating the mip levels
  11665. * @param callback defines a callback used to extract texture data from loaded data
  11666. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11667. * @param onLoad defines a callback called when texture is loaded
  11668. * @param onError defines a callback called if there is an error
  11669. * @returns the cube texture as an InternalTexture
  11670. */
  11671. 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;
  11672. /**
  11673. * Creates a new raw cube texture from a specified url
  11674. * @param url defines the url where the data is located
  11675. * @param scene defines the current scene
  11676. * @param size defines the size of the textures
  11677. * @param format defines the format of the data
  11678. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11679. * @param noMipmap defines if the engine should avoid generating the mip levels
  11680. * @param callback defines a callback used to extract texture data from loaded data
  11681. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11682. * @param onLoad defines a callback called when texture is loaded
  11683. * @param onError defines a callback called if there is an error
  11684. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. * @returns the cube texture as an InternalTexture
  11687. */
  11688. 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;
  11689. /**
  11690. * Creates a new raw 3D texture
  11691. * @param data defines the data used to create the texture
  11692. * @param width defines the width of the texture
  11693. * @param height defines the height of the texture
  11694. * @param depth defines the depth of the texture
  11695. * @param format defines the format of the texture
  11696. * @param generateMipMaps defines if the engine must generate mip levels
  11697. * @param invertY defines if data must be stored with Y axis inverted
  11698. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11699. * @param compression defines the compressed used (can be null)
  11700. * @param textureType defines the compressed used (can be null)
  11701. * @returns a new raw 3D texture (stored in an InternalTexture)
  11702. */
  11703. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11704. /**
  11705. * Update a raw 3D texture
  11706. * @param texture defines the texture to update
  11707. * @param data defines the data to store
  11708. * @param format defines the data format
  11709. * @param invertY defines if data must be stored with Y axis inverted
  11710. */
  11711. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11712. /**
  11713. * Update a raw 3D texture
  11714. * @param texture defines the texture to update
  11715. * @param data defines the data to store
  11716. * @param format defines the data format
  11717. * @param invertY defines if data must be stored with Y axis inverted
  11718. * @param compression defines the used compression (can be null)
  11719. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11720. */
  11721. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11722. /**
  11723. * Creates a new raw 2D array texture
  11724. * @param data defines the data used to create the texture
  11725. * @param width defines the width of the texture
  11726. * @param height defines the height of the texture
  11727. * @param depth defines the number of layers of the texture
  11728. * @param format defines the format of the texture
  11729. * @param generateMipMaps defines if the engine must generate mip levels
  11730. * @param invertY defines if data must be stored with Y axis inverted
  11731. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11732. * @param compression defines the compressed used (can be null)
  11733. * @param textureType defines the compressed used (can be null)
  11734. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11735. */
  11736. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11737. /**
  11738. * Update a raw 2D array texture
  11739. * @param texture defines the texture to update
  11740. * @param data defines the data to store
  11741. * @param format defines the data format
  11742. * @param invertY defines if data must be stored with Y axis inverted
  11743. */
  11744. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11745. /**
  11746. * Update a raw 2D array texture
  11747. * @param texture defines the texture to update
  11748. * @param data defines the data to store
  11749. * @param format defines the data format
  11750. * @param invertY defines if data must be stored with Y axis inverted
  11751. * @param compression defines the used compression (can be null)
  11752. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11753. */
  11754. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11755. }
  11756. }
  11757. }
  11758. declare module "babylonjs/Materials/Textures/rawTexture" {
  11759. import { Texture } from "babylonjs/Materials/Textures/texture";
  11760. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11761. import { Nullable } from "babylonjs/types";
  11762. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11763. import { Scene } from "babylonjs/scene";
  11764. /**
  11765. * Raw texture can help creating a texture directly from an array of data.
  11766. * This can be super useful if you either get the data from an uncompressed source or
  11767. * if you wish to create your texture pixel by pixel.
  11768. */
  11769. export class RawTexture extends Texture {
  11770. /**
  11771. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11772. */
  11773. format: number;
  11774. /**
  11775. * Instantiates a new RawTexture.
  11776. * Raw texture can help creating a texture directly from an array of data.
  11777. * This can be super useful if you either get the data from an uncompressed source or
  11778. * if you wish to create your texture pixel by pixel.
  11779. * @param data define the array of data to use to create the texture
  11780. * @param width define the width of the texture
  11781. * @param height define the height of the texture
  11782. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps define whether mip maps should be generated or not
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. */
  11789. constructor(data: ArrayBufferView, width: number, height: number,
  11790. /**
  11791. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11792. */
  11793. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11794. /**
  11795. * Updates the texture underlying data.
  11796. * @param data Define the new data of the texture
  11797. */
  11798. update(data: ArrayBufferView): void;
  11799. /**
  11800. * Creates a luminance texture from some data.
  11801. * @param data Define the texture data
  11802. * @param width Define the width of the texture
  11803. * @param height Define the height of the texture
  11804. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11805. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11806. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11807. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11808. * @returns the luminance texture
  11809. */
  11810. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11811. /**
  11812. * Creates a luminance alpha texture from some data.
  11813. * @param data Define the texture data
  11814. * @param width Define the width of the texture
  11815. * @param height Define the height of the texture
  11816. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11817. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11818. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11819. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11820. * @returns the luminance alpha texture
  11821. */
  11822. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11823. /**
  11824. * Creates an alpha texture from some data.
  11825. * @param data Define the texture data
  11826. * @param width Define the width of the texture
  11827. * @param height Define the height of the texture
  11828. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11829. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11830. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11831. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11832. * @returns the alpha texture
  11833. */
  11834. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11835. /**
  11836. * Creates a RGB texture from some data.
  11837. * @param data Define the texture data
  11838. * @param width Define the width of the texture
  11839. * @param height Define the height of the texture
  11840. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11841. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11842. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11843. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11844. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11845. * @returns the RGB alpha texture
  11846. */
  11847. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11848. /**
  11849. * Creates a RGBA texture from some data.
  11850. * @param data Define the texture data
  11851. * @param width Define the width of the texture
  11852. * @param height Define the height of the texture
  11853. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11854. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11855. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11856. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11857. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11858. * @returns the RGBA texture
  11859. */
  11860. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11861. /**
  11862. * Creates a R texture from some data.
  11863. * @param data Define the texture data
  11864. * @param width Define the width of the texture
  11865. * @param height Define the height of the texture
  11866. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11867. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11868. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11869. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11870. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11871. * @returns the R texture
  11872. */
  11873. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11874. }
  11875. }
  11876. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11877. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11878. import { IndicesArray, DataArray } from "babylonjs/types";
  11879. module "babylonjs/Engines/thinEngine" {
  11880. interface ThinEngine {
  11881. /**
  11882. * Update a dynamic index buffer
  11883. * @param indexBuffer defines the target index buffer
  11884. * @param indices defines the data to update
  11885. * @param offset defines the offset in the target index buffer where update should start
  11886. */
  11887. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11888. /**
  11889. * Updates a dynamic vertex buffer.
  11890. * @param vertexBuffer the vertex buffer to update
  11891. * @param data the data used to update the vertex buffer
  11892. * @param byteOffset the byte offset of the data
  11893. * @param byteLength the byte length of the data
  11894. */
  11895. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11896. }
  11897. }
  11898. }
  11899. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11900. import { Scene } from "babylonjs/scene";
  11901. import { ISceneComponent } from "babylonjs/sceneComponent";
  11902. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11903. module "babylonjs/abstractScene" {
  11904. interface AbstractScene {
  11905. /**
  11906. * The list of procedural textures added to the scene
  11907. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11908. */
  11909. proceduralTextures: Array<ProceduralTexture>;
  11910. }
  11911. }
  11912. /**
  11913. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11914. * in a given scene.
  11915. */
  11916. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11917. /**
  11918. * The component name helpfull to identify the component in the list of scene components.
  11919. */
  11920. readonly name: string;
  11921. /**
  11922. * The scene the component belongs to.
  11923. */
  11924. scene: Scene;
  11925. /**
  11926. * Creates a new instance of the component for the given scene
  11927. * @param scene Defines the scene to register the component in
  11928. */
  11929. constructor(scene: Scene);
  11930. /**
  11931. * Registers the component in a given scene
  11932. */
  11933. register(): void;
  11934. /**
  11935. * Rebuilds the elements related to this component in case of
  11936. * context lost for instance.
  11937. */
  11938. rebuild(): void;
  11939. /**
  11940. * Disposes the component and the associated ressources.
  11941. */
  11942. dispose(): void;
  11943. private _beforeClear;
  11944. }
  11945. }
  11946. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11947. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11948. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11949. module "babylonjs/Engines/thinEngine" {
  11950. interface ThinEngine {
  11951. /**
  11952. * Creates a new render target cube texture
  11953. * @param size defines the size of the texture
  11954. * @param options defines the options used to create the texture
  11955. * @returns a new render target cube texture stored in an InternalTexture
  11956. */
  11957. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11958. }
  11959. }
  11960. }
  11961. declare module "babylonjs/Shaders/procedural.vertex" {
  11962. /** @hidden */
  11963. export var proceduralVertexShader: {
  11964. name: string;
  11965. shader: string;
  11966. };
  11967. }
  11968. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11969. import { Observable } from "babylonjs/Misc/observable";
  11970. import { Nullable } from "babylonjs/types";
  11971. import { Scene } from "babylonjs/scene";
  11972. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11973. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11974. import { Effect } from "babylonjs/Materials/effect";
  11975. import { Texture } from "babylonjs/Materials/Textures/texture";
  11976. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11977. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11978. import "babylonjs/Shaders/procedural.vertex";
  11979. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  11980. import { RenderTargetTextureSize } from "babylonjs/Engines/Extensions/engine.renderTarget";
  11981. /**
  11982. * 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.
  11983. * This is the base class of any Procedural texture and contains most of the shareable code.
  11984. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11985. */
  11986. export class ProceduralTexture extends Texture {
  11987. /**
  11988. * Define if the texture is enabled or not (disabled texture will not render)
  11989. */
  11990. isEnabled: boolean;
  11991. /**
  11992. * Define if the texture must be cleared before rendering (default is true)
  11993. */
  11994. autoClear: boolean;
  11995. /**
  11996. * Callback called when the texture is generated
  11997. */
  11998. onGenerated: () => void;
  11999. /**
  12000. * Event raised when the texture is generated
  12001. */
  12002. onGeneratedObservable: Observable<ProceduralTexture>;
  12003. /**
  12004. * Event raised before the texture is generated
  12005. */
  12006. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  12007. /**
  12008. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  12009. */
  12010. nodeMaterialSource: Nullable<NodeMaterial>;
  12011. /** @hidden */
  12012. _generateMipMaps: boolean;
  12013. /** @hidden **/
  12014. _effect: Effect;
  12015. /** @hidden */
  12016. _textures: {
  12017. [key: string]: Texture;
  12018. };
  12019. /** @hidden */
  12020. protected _fallbackTexture: Nullable<Texture>;
  12021. private _size;
  12022. private _currentRefreshId;
  12023. private _frameId;
  12024. private _refreshRate;
  12025. private _vertexBuffers;
  12026. private _indexBuffer;
  12027. private _uniforms;
  12028. private _samplers;
  12029. private _fragment;
  12030. private _floats;
  12031. private _ints;
  12032. private _floatsArrays;
  12033. private _colors3;
  12034. private _colors4;
  12035. private _vectors2;
  12036. private _vectors3;
  12037. private _matrices;
  12038. private _fallbackTextureUsed;
  12039. private _fullEngine;
  12040. private _cachedDefines;
  12041. private _contentUpdateId;
  12042. private _contentData;
  12043. /**
  12044. * Instantiates a new procedural texture.
  12045. * 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.
  12046. * This is the base class of any Procedural texture and contains most of the shareable code.
  12047. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  12048. * @param name Define the name of the texture
  12049. * @param size Define the size of the texture to create
  12050. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  12051. * @param scene Define the scene the texture belongs to
  12052. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  12053. * @param generateMipMaps Define if the texture should creates mip maps or not
  12054. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  12055. */
  12056. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  12057. /**
  12058. * The effect that is created when initializing the post process.
  12059. * @returns The created effect corresponding the the postprocess.
  12060. */
  12061. getEffect(): Effect;
  12062. /**
  12063. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  12064. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  12065. */
  12066. getContent(): Nullable<ArrayBufferView>;
  12067. private _createIndexBuffer;
  12068. /** @hidden */
  12069. _rebuild(): void;
  12070. /**
  12071. * Resets the texture in order to recreate its associated resources.
  12072. * This can be called in case of context loss
  12073. */
  12074. reset(): void;
  12075. protected _getDefines(): string;
  12076. /**
  12077. * Is the texture ready to be used ? (rendered at least once)
  12078. * @returns true if ready, otherwise, false.
  12079. */
  12080. isReady(): boolean;
  12081. /**
  12082. * Resets the refresh counter of the texture and start bak from scratch.
  12083. * Could be useful to regenerate the texture if it is setup to render only once.
  12084. */
  12085. resetRefreshCounter(): void;
  12086. /**
  12087. * Set the fragment shader to use in order to render the texture.
  12088. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12089. */
  12090. setFragment(fragment: any): void;
  12091. /**
  12092. * Define the refresh rate of the texture or the rendering frequency.
  12093. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12094. */
  12095. get refreshRate(): number;
  12096. set refreshRate(value: number);
  12097. /** @hidden */
  12098. _shouldRender(): boolean;
  12099. /**
  12100. * Get the size the texture is rendering at.
  12101. * @returns the size (on cube texture it is always squared)
  12102. */
  12103. getRenderSize(): RenderTargetTextureSize;
  12104. /**
  12105. * Resize the texture to new value.
  12106. * @param size Define the new size the texture should have
  12107. * @param generateMipMaps Define whether the new texture should create mip maps
  12108. */
  12109. resize(size: number, generateMipMaps: boolean): void;
  12110. private _checkUniform;
  12111. /**
  12112. * Set a texture in the shader program used to render.
  12113. * @param name Define the name of the uniform samplers as defined in the shader
  12114. * @param texture Define the texture to bind to this sampler
  12115. * @return the texture itself allowing "fluent" like uniform updates
  12116. */
  12117. setTexture(name: string, texture: Texture): ProceduralTexture;
  12118. /**
  12119. * Set a float in the shader.
  12120. * @param name Define the name of the uniform as defined in the shader
  12121. * @param value Define the value to give to the uniform
  12122. * @return the texture itself allowing "fluent" like uniform updates
  12123. */
  12124. setFloat(name: string, value: number): ProceduralTexture;
  12125. /**
  12126. * Set a int in the shader.
  12127. * @param name Define the name of the uniform as defined in the shader
  12128. * @param value Define the value to give to the uniform
  12129. * @return the texture itself allowing "fluent" like uniform updates
  12130. */
  12131. setInt(name: string, value: number): ProceduralTexture;
  12132. /**
  12133. * Set an array of floats in the shader.
  12134. * @param name Define the name of the uniform as defined in the shader
  12135. * @param value Define the value to give to the uniform
  12136. * @return the texture itself allowing "fluent" like uniform updates
  12137. */
  12138. setFloats(name: string, value: number[]): ProceduralTexture;
  12139. /**
  12140. * Set a vec3 in the shader from a Color3.
  12141. * @param name Define the name of the uniform as defined in the shader
  12142. * @param value Define the value to give to the uniform
  12143. * @return the texture itself allowing "fluent" like uniform updates
  12144. */
  12145. setColor3(name: string, value: Color3): ProceduralTexture;
  12146. /**
  12147. * Set a vec4 in the shader from a Color4.
  12148. * @param name Define the name of the uniform as defined in the shader
  12149. * @param value Define the value to give to the uniform
  12150. * @return the texture itself allowing "fluent" like uniform updates
  12151. */
  12152. setColor4(name: string, value: Color4): ProceduralTexture;
  12153. /**
  12154. * Set a vec2 in the shader from a Vector2.
  12155. * @param name Define the name of the uniform as defined in the shader
  12156. * @param value Define the value to give to the uniform
  12157. * @return the texture itself allowing "fluent" like uniform updates
  12158. */
  12159. setVector2(name: string, value: Vector2): ProceduralTexture;
  12160. /**
  12161. * Set a vec3 in the shader from a Vector3.
  12162. * @param name Define the name of the uniform as defined in the shader
  12163. * @param value Define the value to give to the uniform
  12164. * @return the texture itself allowing "fluent" like uniform updates
  12165. */
  12166. setVector3(name: string, value: Vector3): ProceduralTexture;
  12167. /**
  12168. * Set a mat4 in the shader from a MAtrix.
  12169. * @param name Define the name of the uniform as defined in the shader
  12170. * @param value Define the value to give to the uniform
  12171. * @return the texture itself allowing "fluent" like uniform updates
  12172. */
  12173. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12174. /**
  12175. * Render the texture to its associated render target.
  12176. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12177. */
  12178. render(useCameraPostProcess?: boolean): void;
  12179. /**
  12180. * Clone the texture.
  12181. * @returns the cloned texture
  12182. */
  12183. clone(): ProceduralTexture;
  12184. /**
  12185. * Dispose the texture and release its asoociated resources.
  12186. */
  12187. dispose(): void;
  12188. }
  12189. }
  12190. declare module "babylonjs/Particles/baseParticleSystem" {
  12191. import { Nullable } from "babylonjs/types";
  12192. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12193. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12194. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12195. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12196. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12197. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12198. import { Color4 } from "babylonjs/Maths/math.color";
  12199. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12200. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12201. import { Animation } from "babylonjs/Animations/animation";
  12202. import { Scene } from "babylonjs/scene";
  12203. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12204. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12205. /**
  12206. * This represents the base class for particle system in Babylon.
  12207. * 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.
  12208. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12209. * @example https://doc.babylonjs.com/babylon101/particles
  12210. */
  12211. export class BaseParticleSystem {
  12212. /**
  12213. * Source color is added to the destination color without alpha affecting the result
  12214. */
  12215. static BLENDMODE_ONEONE: number;
  12216. /**
  12217. * Blend current color and particle color using particle’s alpha
  12218. */
  12219. static BLENDMODE_STANDARD: number;
  12220. /**
  12221. * Add current color and particle color multiplied by particle’s alpha
  12222. */
  12223. static BLENDMODE_ADD: number;
  12224. /**
  12225. * Multiply current color with particle color
  12226. */
  12227. static BLENDMODE_MULTIPLY: number;
  12228. /**
  12229. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12230. */
  12231. static BLENDMODE_MULTIPLYADD: number;
  12232. /**
  12233. * List of animations used by the particle system.
  12234. */
  12235. animations: Animation[];
  12236. /**
  12237. * Gets or sets the unique id of the particle system
  12238. */
  12239. uniqueId: number;
  12240. /**
  12241. * The id of the Particle system.
  12242. */
  12243. id: string;
  12244. /**
  12245. * The friendly name of the Particle system.
  12246. */
  12247. name: string;
  12248. /**
  12249. * Snippet ID if the particle system was created from the snippet server
  12250. */
  12251. snippetId: string;
  12252. /**
  12253. * The rendering group used by the Particle system to chose when to render.
  12254. */
  12255. renderingGroupId: number;
  12256. /**
  12257. * The emitter represents the Mesh or position we are attaching the particle system to.
  12258. */
  12259. emitter: Nullable<AbstractMesh | Vector3>;
  12260. /**
  12261. * The maximum number of particles to emit per frame
  12262. */
  12263. emitRate: number;
  12264. /**
  12265. * If you want to launch only a few particles at once, that can be done, as well.
  12266. */
  12267. manualEmitCount: number;
  12268. /**
  12269. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12270. */
  12271. updateSpeed: number;
  12272. /**
  12273. * The amount of time the particle system is running (depends of the overall update speed).
  12274. */
  12275. targetStopDuration: number;
  12276. /**
  12277. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12278. */
  12279. disposeOnStop: boolean;
  12280. /**
  12281. * Minimum power of emitting particles.
  12282. */
  12283. minEmitPower: number;
  12284. /**
  12285. * Maximum power of emitting particles.
  12286. */
  12287. maxEmitPower: number;
  12288. /**
  12289. * Minimum life time of emitting particles.
  12290. */
  12291. minLifeTime: number;
  12292. /**
  12293. * Maximum life time of emitting particles.
  12294. */
  12295. maxLifeTime: number;
  12296. /**
  12297. * Minimum Size of emitting particles.
  12298. */
  12299. minSize: number;
  12300. /**
  12301. * Maximum Size of emitting particles.
  12302. */
  12303. maxSize: number;
  12304. /**
  12305. * Minimum scale of emitting particles on X axis.
  12306. */
  12307. minScaleX: number;
  12308. /**
  12309. * Maximum scale of emitting particles on X axis.
  12310. */
  12311. maxScaleX: number;
  12312. /**
  12313. * Minimum scale of emitting particles on Y axis.
  12314. */
  12315. minScaleY: number;
  12316. /**
  12317. * Maximum scale of emitting particles on Y axis.
  12318. */
  12319. maxScaleY: number;
  12320. /**
  12321. * Gets or sets the minimal initial rotation in radians.
  12322. */
  12323. minInitialRotation: number;
  12324. /**
  12325. * Gets or sets the maximal initial rotation in radians.
  12326. */
  12327. maxInitialRotation: number;
  12328. /**
  12329. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12330. */
  12331. minAngularSpeed: number;
  12332. /**
  12333. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12334. */
  12335. maxAngularSpeed: number;
  12336. /**
  12337. * The texture used to render each particle. (this can be a spritesheet)
  12338. */
  12339. particleTexture: Nullable<BaseTexture>;
  12340. /**
  12341. * The layer mask we are rendering the particles through.
  12342. */
  12343. layerMask: number;
  12344. /**
  12345. * This can help using your own shader to render the particle system.
  12346. * The according effect will be created
  12347. */
  12348. customShader: any;
  12349. /**
  12350. * By default particle system starts as soon as they are created. This prevents the
  12351. * automatic start to happen and let you decide when to start emitting particles.
  12352. */
  12353. preventAutoStart: boolean;
  12354. private _noiseTexture;
  12355. /**
  12356. * Gets or sets a texture used to add random noise to particle positions
  12357. */
  12358. get noiseTexture(): Nullable<ProceduralTexture>;
  12359. set noiseTexture(value: Nullable<ProceduralTexture>);
  12360. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12361. noiseStrength: Vector3;
  12362. /**
  12363. * Callback triggered when the particle animation is ending.
  12364. */
  12365. onAnimationEnd: Nullable<() => void>;
  12366. /**
  12367. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12368. */
  12369. blendMode: number;
  12370. /**
  12371. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12372. * to override the particles.
  12373. */
  12374. forceDepthWrite: boolean;
  12375. /** 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 */
  12376. preWarmCycles: number;
  12377. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12378. preWarmStepOffset: number;
  12379. /**
  12380. * 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)
  12381. */
  12382. spriteCellChangeSpeed: number;
  12383. /**
  12384. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12385. */
  12386. startSpriteCellID: number;
  12387. /**
  12388. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12389. */
  12390. endSpriteCellID: number;
  12391. /**
  12392. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12393. */
  12394. spriteCellWidth: number;
  12395. /**
  12396. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12397. */
  12398. spriteCellHeight: number;
  12399. /**
  12400. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12401. */
  12402. spriteRandomStartCell: boolean;
  12403. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12404. translationPivot: Vector2;
  12405. /** @hidden */
  12406. protected _isAnimationSheetEnabled: boolean;
  12407. /**
  12408. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12409. */
  12410. beginAnimationOnStart: boolean;
  12411. /**
  12412. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12413. */
  12414. beginAnimationFrom: number;
  12415. /**
  12416. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12417. */
  12418. beginAnimationTo: number;
  12419. /**
  12420. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12421. */
  12422. beginAnimationLoop: boolean;
  12423. /**
  12424. * Gets or sets a world offset applied to all particles
  12425. */
  12426. worldOffset: Vector3;
  12427. /**
  12428. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12429. */
  12430. get isAnimationSheetEnabled(): boolean;
  12431. set isAnimationSheetEnabled(value: boolean);
  12432. /**
  12433. * Get hosting scene
  12434. * @returns the scene
  12435. */
  12436. getScene(): Nullable<Scene>;
  12437. /**
  12438. * You can use gravity if you want to give an orientation to your particles.
  12439. */
  12440. gravity: Vector3;
  12441. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12442. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12443. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12444. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12445. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12446. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12447. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12448. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12449. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12450. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12451. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12452. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12453. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12454. /**
  12455. * Defines the delay in milliseconds before starting the system (0 by default)
  12456. */
  12457. startDelay: number;
  12458. /**
  12459. * Gets the current list of drag gradients.
  12460. * You must use addDragGradient and removeDragGradient to udpate this list
  12461. * @returns the list of drag gradients
  12462. */
  12463. getDragGradients(): Nullable<Array<FactorGradient>>;
  12464. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12465. limitVelocityDamping: number;
  12466. /**
  12467. * Gets the current list of limit velocity gradients.
  12468. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12469. * @returns the list of limit velocity gradients
  12470. */
  12471. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12472. /**
  12473. * Gets the current list of color gradients.
  12474. * You must use addColorGradient and removeColorGradient to udpate this list
  12475. * @returns the list of color gradients
  12476. */
  12477. getColorGradients(): Nullable<Array<ColorGradient>>;
  12478. /**
  12479. * Gets the current list of size gradients.
  12480. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12481. * @returns the list of size gradients
  12482. */
  12483. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12484. /**
  12485. * Gets the current list of color remap gradients.
  12486. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12487. * @returns the list of color remap gradients
  12488. */
  12489. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12490. /**
  12491. * Gets the current list of alpha remap gradients.
  12492. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12493. * @returns the list of alpha remap gradients
  12494. */
  12495. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12496. /**
  12497. * Gets the current list of life time gradients.
  12498. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12499. * @returns the list of life time gradients
  12500. */
  12501. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12502. /**
  12503. * Gets the current list of angular speed gradients.
  12504. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12505. * @returns the list of angular speed gradients
  12506. */
  12507. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12508. /**
  12509. * Gets the current list of velocity gradients.
  12510. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12511. * @returns the list of velocity gradients
  12512. */
  12513. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12514. /**
  12515. * Gets the current list of start size gradients.
  12516. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12517. * @returns the list of start size gradients
  12518. */
  12519. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12520. /**
  12521. * Gets the current list of emit rate gradients.
  12522. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12523. * @returns the list of emit rate gradients
  12524. */
  12525. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12526. /**
  12527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12528. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12529. */
  12530. get direction1(): Vector3;
  12531. set direction1(value: Vector3);
  12532. /**
  12533. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12534. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12535. */
  12536. get direction2(): Vector3;
  12537. set direction2(value: Vector3);
  12538. /**
  12539. * 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.
  12540. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12541. */
  12542. get minEmitBox(): Vector3;
  12543. set minEmitBox(value: Vector3);
  12544. /**
  12545. * 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.
  12546. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12547. */
  12548. get maxEmitBox(): Vector3;
  12549. set maxEmitBox(value: Vector3);
  12550. /**
  12551. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12552. */
  12553. color1: Color4;
  12554. /**
  12555. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12556. */
  12557. color2: Color4;
  12558. /**
  12559. * Color the particle will have at the end of its lifetime
  12560. */
  12561. colorDead: Color4;
  12562. /**
  12563. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12564. */
  12565. textureMask: Color4;
  12566. /**
  12567. * The particle emitter type defines the emitter used by the particle system.
  12568. * It can be for example box, sphere, or cone...
  12569. */
  12570. particleEmitterType: IParticleEmitterType;
  12571. /** @hidden */
  12572. _isSubEmitter: boolean;
  12573. /**
  12574. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12575. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12576. */
  12577. billboardMode: number;
  12578. protected _isBillboardBased: boolean;
  12579. /**
  12580. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12581. */
  12582. get isBillboardBased(): boolean;
  12583. set isBillboardBased(value: boolean);
  12584. /**
  12585. * The scene the particle system belongs to.
  12586. */
  12587. protected _scene: Nullable<Scene>;
  12588. /**
  12589. * The engine the particle system belongs to.
  12590. */
  12591. protected _engine: ThinEngine;
  12592. /**
  12593. * Local cache of defines for image processing.
  12594. */
  12595. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12596. /**
  12597. * Default configuration related to image processing available in the standard Material.
  12598. */
  12599. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12600. /**
  12601. * Gets the image processing configuration used either in this material.
  12602. */
  12603. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12604. /**
  12605. * Sets the Default image processing configuration used either in the this material.
  12606. *
  12607. * If sets to null, the scene one is in use.
  12608. */
  12609. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12610. /**
  12611. * Attaches a new image processing configuration to the Standard Material.
  12612. * @param configuration
  12613. */
  12614. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12615. /** @hidden */
  12616. protected _reset(): void;
  12617. /** @hidden */
  12618. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12619. /**
  12620. * Instantiates a particle system.
  12621. * 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.
  12622. * @param name The name of the particle system
  12623. */
  12624. constructor(name: string);
  12625. /**
  12626. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12627. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12628. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12629. * @returns the emitter
  12630. */
  12631. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12632. /**
  12633. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12634. * @param radius The radius of the hemisphere to emit from
  12635. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12636. * @returns the emitter
  12637. */
  12638. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12639. /**
  12640. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12641. * @param radius The radius of the sphere to emit from
  12642. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12643. * @returns the emitter
  12644. */
  12645. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12646. /**
  12647. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12648. * @param radius The radius of the sphere to emit from
  12649. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12650. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12651. * @returns the emitter
  12652. */
  12653. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12654. /**
  12655. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12656. * @param radius The radius of the emission cylinder
  12657. * @param height The height of the emission cylinder
  12658. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12659. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12660. * @returns the emitter
  12661. */
  12662. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12663. /**
  12664. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12665. * @param radius The radius of the cylinder to emit from
  12666. * @param height The height of the emission cylinder
  12667. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12668. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12669. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12670. * @returns the emitter
  12671. */
  12672. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12673. /**
  12674. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12675. * @param radius The radius of the cone to emit from
  12676. * @param angle The base angle of the cone
  12677. * @returns the emitter
  12678. */
  12679. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12680. /**
  12681. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12682. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12683. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12684. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12685. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12686. * @returns the emitter
  12687. */
  12688. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12689. }
  12690. }
  12691. declare module "babylonjs/Particles/subEmitter" {
  12692. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12693. import { Scene } from "babylonjs/scene";
  12694. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12695. /**
  12696. * Type of sub emitter
  12697. */
  12698. export enum SubEmitterType {
  12699. /**
  12700. * Attached to the particle over it's lifetime
  12701. */
  12702. ATTACHED = 0,
  12703. /**
  12704. * Created when the particle dies
  12705. */
  12706. END = 1
  12707. }
  12708. /**
  12709. * Sub emitter class used to emit particles from an existing particle
  12710. */
  12711. export class SubEmitter {
  12712. /**
  12713. * the particle system to be used by the sub emitter
  12714. */
  12715. particleSystem: ParticleSystem;
  12716. /**
  12717. * Type of the submitter (Default: END)
  12718. */
  12719. type: SubEmitterType;
  12720. /**
  12721. * 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)
  12722. * Note: This only is supported when using an emitter of type Mesh
  12723. */
  12724. inheritDirection: boolean;
  12725. /**
  12726. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12727. */
  12728. inheritedVelocityAmount: number;
  12729. /**
  12730. * Creates a sub emitter
  12731. * @param particleSystem the particle system to be used by the sub emitter
  12732. */
  12733. constructor(
  12734. /**
  12735. * the particle system to be used by the sub emitter
  12736. */
  12737. particleSystem: ParticleSystem);
  12738. /**
  12739. * Clones the sub emitter
  12740. * @returns the cloned sub emitter
  12741. */
  12742. clone(): SubEmitter;
  12743. /**
  12744. * Serialize current object to a JSON object
  12745. * @returns the serialized object
  12746. */
  12747. serialize(): any;
  12748. /** @hidden */
  12749. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12750. /**
  12751. * Creates a new SubEmitter from a serialized JSON version
  12752. * @param serializationObject defines the JSON object to read from
  12753. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12754. * @param rootUrl defines the rootUrl for data loading
  12755. * @returns a new SubEmitter
  12756. */
  12757. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12758. /** Release associated resources */
  12759. dispose(): void;
  12760. }
  12761. }
  12762. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12763. /** @hidden */
  12764. export var imageProcessingDeclaration: {
  12765. name: string;
  12766. shader: string;
  12767. };
  12768. }
  12769. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12770. /** @hidden */
  12771. export var imageProcessingFunctions: {
  12772. name: string;
  12773. shader: string;
  12774. };
  12775. }
  12776. declare module "babylonjs/Shaders/particles.fragment" {
  12777. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12778. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12779. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12780. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12781. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12782. /** @hidden */
  12783. export var particlesPixelShader: {
  12784. name: string;
  12785. shader: string;
  12786. };
  12787. }
  12788. declare module "babylonjs/Shaders/particles.vertex" {
  12789. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12790. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12791. /** @hidden */
  12792. export var particlesVertexShader: {
  12793. name: string;
  12794. shader: string;
  12795. };
  12796. }
  12797. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12798. import { Nullable } from "babylonjs/types";
  12799. import { Plane } from "babylonjs/Maths/math";
  12800. /**
  12801. * Interface used to define entities containing multiple clip planes
  12802. */
  12803. export interface IClipPlanesHolder {
  12804. /**
  12805. * Gets or sets the active clipplane 1
  12806. */
  12807. clipPlane: Nullable<Plane>;
  12808. /**
  12809. * Gets or sets the active clipplane 2
  12810. */
  12811. clipPlane2: Nullable<Plane>;
  12812. /**
  12813. * Gets or sets the active clipplane 3
  12814. */
  12815. clipPlane3: Nullable<Plane>;
  12816. /**
  12817. * Gets or sets the active clipplane 4
  12818. */
  12819. clipPlane4: Nullable<Plane>;
  12820. /**
  12821. * Gets or sets the active clipplane 5
  12822. */
  12823. clipPlane5: Nullable<Plane>;
  12824. /**
  12825. * Gets or sets the active clipplane 6
  12826. */
  12827. clipPlane6: Nullable<Plane>;
  12828. }
  12829. }
  12830. declare module "babylonjs/Materials/thinMaterialHelper" {
  12831. import { Effect } from "babylonjs/Materials/effect";
  12832. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12833. /**
  12834. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12835. *
  12836. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12837. *
  12838. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12839. */
  12840. export class ThinMaterialHelper {
  12841. /**
  12842. * Binds the clip plane information from the holder to the effect.
  12843. * @param effect The effect we are binding the data to
  12844. * @param holder The entity containing the clip plane information
  12845. */
  12846. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12847. }
  12848. }
  12849. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12850. module "babylonjs/Engines/thinEngine" {
  12851. interface ThinEngine {
  12852. /**
  12853. * Sets alpha constants used by some alpha blending modes
  12854. * @param r defines the red component
  12855. * @param g defines the green component
  12856. * @param b defines the blue component
  12857. * @param a defines the alpha component
  12858. */
  12859. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12860. /**
  12861. * Sets the current alpha mode
  12862. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12863. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12864. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12865. */
  12866. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12867. /**
  12868. * Gets the current alpha mode
  12869. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12870. * @returns the current alpha mode
  12871. */
  12872. getAlphaMode(): number;
  12873. /**
  12874. * Sets the current alpha equation
  12875. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12876. */
  12877. setAlphaEquation(equation: number): void;
  12878. /**
  12879. * Gets the current alpha equation.
  12880. * @returns the current alpha equation
  12881. */
  12882. getAlphaEquation(): number;
  12883. }
  12884. }
  12885. }
  12886. declare module "babylonjs/Particles/particleSystem" {
  12887. import { Nullable } from "babylonjs/types";
  12888. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12889. import { Observable } from "babylonjs/Misc/observable";
  12890. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12891. import { Effect } from "babylonjs/Materials/effect";
  12892. import { IDisposable } from "babylonjs/scene";
  12893. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12894. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12895. import { Particle } from "babylonjs/Particles/particle";
  12896. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12897. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12898. import "babylonjs/Shaders/particles.fragment";
  12899. import "babylonjs/Shaders/particles.vertex";
  12900. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12901. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12902. import "babylonjs/Engines/Extensions/engine.alpha";
  12903. import { Scene } from "babylonjs/scene";
  12904. /**
  12905. * This represents a particle system in Babylon.
  12906. * 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.
  12907. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12908. * @example https://doc.babylonjs.com/babylon101/particles
  12909. */
  12910. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12911. /**
  12912. * Billboard mode will only apply to Y axis
  12913. */
  12914. static readonly BILLBOARDMODE_Y: number;
  12915. /**
  12916. * Billboard mode will apply to all axes
  12917. */
  12918. static readonly BILLBOARDMODE_ALL: number;
  12919. /**
  12920. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12921. */
  12922. static readonly BILLBOARDMODE_STRETCHED: number;
  12923. /**
  12924. * This function can be defined to provide custom update for active particles.
  12925. * This function will be called instead of regular update (age, position, color, etc.).
  12926. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12927. */
  12928. updateFunction: (particles: Particle[]) => void;
  12929. private _emitterWorldMatrix;
  12930. /**
  12931. * This function can be defined to specify initial direction for every new particle.
  12932. * It by default use the emitterType defined function
  12933. */
  12934. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12935. /**
  12936. * This function can be defined to specify initial position for every new particle.
  12937. * It by default use the emitterType defined function
  12938. */
  12939. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12940. /**
  12941. * @hidden
  12942. */
  12943. _inheritedVelocityOffset: Vector3;
  12944. /**
  12945. * An event triggered when the system is disposed
  12946. */
  12947. onDisposeObservable: Observable<IParticleSystem>;
  12948. private _onDisposeObserver;
  12949. /**
  12950. * Sets a callback that will be triggered when the system is disposed
  12951. */
  12952. set onDispose(callback: () => void);
  12953. private _particles;
  12954. private _epsilon;
  12955. private _capacity;
  12956. private _stockParticles;
  12957. private _newPartsExcess;
  12958. private _vertexData;
  12959. private _vertexBuffer;
  12960. private _vertexBuffers;
  12961. private _spriteBuffer;
  12962. private _indexBuffer;
  12963. private _effect;
  12964. private _customEffect;
  12965. private _cachedDefines;
  12966. private _scaledColorStep;
  12967. private _colorDiff;
  12968. private _scaledDirection;
  12969. private _scaledGravity;
  12970. private _currentRenderId;
  12971. private _alive;
  12972. private _useInstancing;
  12973. private _started;
  12974. private _stopped;
  12975. private _actualFrame;
  12976. private _scaledUpdateSpeed;
  12977. private _vertexBufferSize;
  12978. /** @hidden */
  12979. _currentEmitRateGradient: Nullable<FactorGradient>;
  12980. /** @hidden */
  12981. _currentEmitRate1: number;
  12982. /** @hidden */
  12983. _currentEmitRate2: number;
  12984. /** @hidden */
  12985. _currentStartSizeGradient: Nullable<FactorGradient>;
  12986. /** @hidden */
  12987. _currentStartSize1: number;
  12988. /** @hidden */
  12989. _currentStartSize2: number;
  12990. private readonly _rawTextureWidth;
  12991. private _rampGradientsTexture;
  12992. private _useRampGradients;
  12993. /** Gets or sets a matrix to use to compute projection */
  12994. defaultProjectionMatrix: Matrix;
  12995. /** Gets or sets a matrix to use to compute view */
  12996. defaultViewMatrix: Matrix;
  12997. /** Gets or sets a boolean indicating that ramp gradients must be used
  12998. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12999. */
  13000. get useRampGradients(): boolean;
  13001. set useRampGradients(value: boolean);
  13002. /**
  13003. * 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.
  13004. * 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: [])
  13005. */
  13006. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  13007. private _subEmitters;
  13008. /**
  13009. * @hidden
  13010. * If the particle systems emitter should be disposed when the particle system is disposed
  13011. */
  13012. _disposeEmitterOnDispose: boolean;
  13013. /**
  13014. * The current active Sub-systems, this property is used by the root particle system only.
  13015. */
  13016. activeSubSystems: Array<ParticleSystem>;
  13017. /**
  13018. * Specifies if the particles are updated in emitter local space or world space
  13019. */
  13020. isLocal: boolean;
  13021. private _rootParticleSystem;
  13022. /**
  13023. * Gets the current list of active particles
  13024. */
  13025. get particles(): Particle[];
  13026. /**
  13027. * Gets the number of particles active at the same time.
  13028. * @returns The number of active particles.
  13029. */
  13030. getActiveCount(): number;
  13031. /**
  13032. * Returns the string "ParticleSystem"
  13033. * @returns a string containing the class name
  13034. */
  13035. getClassName(): string;
  13036. /**
  13037. * Gets a boolean indicating that the system is stopping
  13038. * @returns true if the system is currently stopping
  13039. */
  13040. isStopping(): boolean;
  13041. /**
  13042. * Gets the custom effect used to render the particles
  13043. * @param blendMode Blend mode for which the effect should be retrieved
  13044. * @returns The effect
  13045. */
  13046. getCustomEffect(blendMode?: number): Nullable<Effect>;
  13047. /**
  13048. * Sets the custom effect used to render the particles
  13049. * @param effect The effect to set
  13050. * @param blendMode Blend mode for which the effect should be set
  13051. */
  13052. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  13053. /** @hidden */
  13054. private _onBeforeDrawParticlesObservable;
  13055. /**
  13056. * Observable that will be called just before the particles are drawn
  13057. */
  13058. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  13059. /**
  13060. * Gets the name of the particle vertex shader
  13061. */
  13062. get vertexShaderName(): string;
  13063. /**
  13064. * Instantiates a particle system.
  13065. * 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.
  13066. * @param name The name of the particle system
  13067. * @param capacity The max number of particles alive at the same time
  13068. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13069. * @param customEffect a custom effect used to change the way particles are rendered by default
  13070. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13071. * @param epsilon Offset used to render the particles
  13072. */
  13073. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13074. private _addFactorGradient;
  13075. private _removeFactorGradient;
  13076. /**
  13077. * Adds a new life time gradient
  13078. * @param gradient defines the gradient to use (between 0 and 1)
  13079. * @param factor defines the life time factor to affect to the specified gradient
  13080. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13081. * @returns the current particle system
  13082. */
  13083. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13084. /**
  13085. * Remove a specific life time gradient
  13086. * @param gradient defines the gradient to remove
  13087. * @returns the current particle system
  13088. */
  13089. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13090. /**
  13091. * Adds a new size gradient
  13092. * @param gradient defines the gradient to use (between 0 and 1)
  13093. * @param factor defines the size factor to affect to the specified gradient
  13094. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13095. * @returns the current particle system
  13096. */
  13097. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13098. /**
  13099. * Remove a specific size gradient
  13100. * @param gradient defines the gradient to remove
  13101. * @returns the current particle system
  13102. */
  13103. removeSizeGradient(gradient: number): IParticleSystem;
  13104. /**
  13105. * Adds a new color remap gradient
  13106. * @param gradient defines the gradient to use (between 0 and 1)
  13107. * @param min defines the color remap minimal range
  13108. * @param max defines the color remap maximal range
  13109. * @returns the current particle system
  13110. */
  13111. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13112. /**
  13113. * Remove a specific color remap gradient
  13114. * @param gradient defines the gradient to remove
  13115. * @returns the current particle system
  13116. */
  13117. removeColorRemapGradient(gradient: number): IParticleSystem;
  13118. /**
  13119. * Adds a new alpha remap gradient
  13120. * @param gradient defines the gradient to use (between 0 and 1)
  13121. * @param min defines the alpha remap minimal range
  13122. * @param max defines the alpha remap maximal range
  13123. * @returns the current particle system
  13124. */
  13125. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13126. /**
  13127. * Remove a specific alpha remap gradient
  13128. * @param gradient defines the gradient to remove
  13129. * @returns the current particle system
  13130. */
  13131. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13132. /**
  13133. * Adds a new angular speed gradient
  13134. * @param gradient defines the gradient to use (between 0 and 1)
  13135. * @param factor defines the angular speed to affect to the specified gradient
  13136. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13137. * @returns the current particle system
  13138. */
  13139. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13140. /**
  13141. * Remove a specific angular speed gradient
  13142. * @param gradient defines the gradient to remove
  13143. * @returns the current particle system
  13144. */
  13145. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13146. /**
  13147. * Adds a new velocity gradient
  13148. * @param gradient defines the gradient to use (between 0 and 1)
  13149. * @param factor defines the velocity to affect to the specified gradient
  13150. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13151. * @returns the current particle system
  13152. */
  13153. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13154. /**
  13155. * Remove a specific velocity gradient
  13156. * @param gradient defines the gradient to remove
  13157. * @returns the current particle system
  13158. */
  13159. removeVelocityGradient(gradient: number): IParticleSystem;
  13160. /**
  13161. * Adds a new limit velocity gradient
  13162. * @param gradient defines the gradient to use (between 0 and 1)
  13163. * @param factor defines the limit velocity value to affect to the specified gradient
  13164. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13165. * @returns the current particle system
  13166. */
  13167. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13168. /**
  13169. * Remove a specific limit velocity gradient
  13170. * @param gradient defines the gradient to remove
  13171. * @returns the current particle system
  13172. */
  13173. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13174. /**
  13175. * Adds a new drag gradient
  13176. * @param gradient defines the gradient to use (between 0 and 1)
  13177. * @param factor defines the drag value to affect to the specified gradient
  13178. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13179. * @returns the current particle system
  13180. */
  13181. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13182. /**
  13183. * Remove a specific drag gradient
  13184. * @param gradient defines the gradient to remove
  13185. * @returns the current particle system
  13186. */
  13187. removeDragGradient(gradient: number): IParticleSystem;
  13188. /**
  13189. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13190. * @param gradient defines the gradient to use (between 0 and 1)
  13191. * @param factor defines the emit rate value to affect to the specified gradient
  13192. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13193. * @returns the current particle system
  13194. */
  13195. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13196. /**
  13197. * Remove a specific emit rate gradient
  13198. * @param gradient defines the gradient to remove
  13199. * @returns the current particle system
  13200. */
  13201. removeEmitRateGradient(gradient: number): IParticleSystem;
  13202. /**
  13203. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13204. * @param gradient defines the gradient to use (between 0 and 1)
  13205. * @param factor defines the start size value to affect to the specified gradient
  13206. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13207. * @returns the current particle system
  13208. */
  13209. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13210. /**
  13211. * Remove a specific start size gradient
  13212. * @param gradient defines the gradient to remove
  13213. * @returns the current particle system
  13214. */
  13215. removeStartSizeGradient(gradient: number): IParticleSystem;
  13216. private _createRampGradientTexture;
  13217. /**
  13218. * Gets the current list of ramp gradients.
  13219. * You must use addRampGradient and removeRampGradient to udpate this list
  13220. * @returns the list of ramp gradients
  13221. */
  13222. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13223. /** Force the system to rebuild all gradients that need to be resync */
  13224. forceRefreshGradients(): void;
  13225. private _syncRampGradientTexture;
  13226. /**
  13227. * Adds a new ramp gradient used to remap particle colors
  13228. * @param gradient defines the gradient to use (between 0 and 1)
  13229. * @param color defines the color to affect to the specified gradient
  13230. * @returns the current particle system
  13231. */
  13232. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13233. /**
  13234. * Remove a specific ramp gradient
  13235. * @param gradient defines the gradient to remove
  13236. * @returns the current particle system
  13237. */
  13238. removeRampGradient(gradient: number): ParticleSystem;
  13239. /**
  13240. * Adds a new color gradient
  13241. * @param gradient defines the gradient to use (between 0 and 1)
  13242. * @param color1 defines the color to affect to the specified gradient
  13243. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13244. * @returns this particle system
  13245. */
  13246. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13247. /**
  13248. * Remove a specific color gradient
  13249. * @param gradient defines the gradient to remove
  13250. * @returns this particle system
  13251. */
  13252. removeColorGradient(gradient: number): IParticleSystem;
  13253. private _fetchR;
  13254. protected _reset(): void;
  13255. private _resetEffect;
  13256. private _createVertexBuffers;
  13257. private _createIndexBuffer;
  13258. /**
  13259. * Gets the maximum number of particles active at the same time.
  13260. * @returns The max number of active particles.
  13261. */
  13262. getCapacity(): number;
  13263. /**
  13264. * Gets whether there are still active particles in the system.
  13265. * @returns True if it is alive, otherwise false.
  13266. */
  13267. isAlive(): boolean;
  13268. /**
  13269. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13270. * @returns True if it has been started, otherwise false.
  13271. */
  13272. isStarted(): boolean;
  13273. private _prepareSubEmitterInternalArray;
  13274. /**
  13275. * Starts the particle system and begins to emit
  13276. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13277. */
  13278. start(delay?: number): void;
  13279. /**
  13280. * Stops the particle system.
  13281. * @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.
  13282. */
  13283. stop(stopSubEmitters?: boolean): void;
  13284. /**
  13285. * Remove all active particles
  13286. */
  13287. reset(): void;
  13288. /**
  13289. * @hidden (for internal use only)
  13290. */
  13291. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13292. /**
  13293. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13294. * Its lifetime will start back at 0.
  13295. */
  13296. recycleParticle: (particle: Particle) => void;
  13297. private _stopSubEmitters;
  13298. private _createParticle;
  13299. private _removeFromRoot;
  13300. private _emitFromParticle;
  13301. private _update;
  13302. /** @hidden */
  13303. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13304. /** @hidden */
  13305. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13306. /**
  13307. * Fill the defines array according to the current settings of the particle system
  13308. * @param defines Array to be updated
  13309. * @param blendMode blend mode to take into account when updating the array
  13310. */
  13311. fillDefines(defines: Array<string>, blendMode: number): void;
  13312. /**
  13313. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13314. * @param uniforms Uniforms array to fill
  13315. * @param attributes Attributes array to fill
  13316. * @param samplers Samplers array to fill
  13317. */
  13318. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13319. /** @hidden */
  13320. private _getEffect;
  13321. /**
  13322. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13323. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13324. */
  13325. animate(preWarmOnly?: boolean): void;
  13326. private _appendParticleVertices;
  13327. /**
  13328. * Rebuilds the particle system.
  13329. */
  13330. rebuild(): void;
  13331. /**
  13332. * Is this system ready to be used/rendered
  13333. * @return true if the system is ready
  13334. */
  13335. isReady(): boolean;
  13336. private _render;
  13337. /**
  13338. * Renders the particle system in its current state.
  13339. * @returns the current number of particles
  13340. */
  13341. render(): number;
  13342. /**
  13343. * Disposes the particle system and free the associated resources
  13344. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13345. */
  13346. dispose(disposeTexture?: boolean): void;
  13347. /**
  13348. * Clones the particle system.
  13349. * @param name The name of the cloned object
  13350. * @param newEmitter The new emitter to use
  13351. * @returns the cloned particle system
  13352. */
  13353. clone(name: string, newEmitter: any): ParticleSystem;
  13354. /**
  13355. * Serializes the particle system to a JSON object
  13356. * @param serializeTexture defines if the texture must be serialized as well
  13357. * @returns the JSON object
  13358. */
  13359. serialize(serializeTexture?: boolean): any;
  13360. /** @hidden */
  13361. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13362. /** @hidden */
  13363. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13364. /**
  13365. * Parses a JSON object to create a particle system.
  13366. * @param parsedParticleSystem The JSON object to parse
  13367. * @param sceneOrEngine The scene or the engine to create the particle system in
  13368. * @param rootUrl The root url to use to load external dependencies like texture
  13369. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13370. * @returns the Parsed particle system
  13371. */
  13372. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13373. }
  13374. }
  13375. declare module "babylonjs/Particles/particle" {
  13376. import { Nullable } from "babylonjs/types";
  13377. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13378. import { Color4 } from "babylonjs/Maths/math.color";
  13379. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13380. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13381. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13382. /**
  13383. * A particle represents one of the element emitted by a particle system.
  13384. * This is mainly define by its coordinates, direction, velocity and age.
  13385. */
  13386. export class Particle {
  13387. /**
  13388. * The particle system the particle belongs to.
  13389. */
  13390. particleSystem: ParticleSystem;
  13391. private static _Count;
  13392. /**
  13393. * Unique ID of the particle
  13394. */
  13395. id: number;
  13396. /**
  13397. * The world position of the particle in the scene.
  13398. */
  13399. position: Vector3;
  13400. /**
  13401. * The world direction of the particle in the scene.
  13402. */
  13403. direction: Vector3;
  13404. /**
  13405. * The color of the particle.
  13406. */
  13407. color: Color4;
  13408. /**
  13409. * The color change of the particle per step.
  13410. */
  13411. colorStep: Color4;
  13412. /**
  13413. * Defines how long will the life of the particle be.
  13414. */
  13415. lifeTime: number;
  13416. /**
  13417. * The current age of the particle.
  13418. */
  13419. age: number;
  13420. /**
  13421. * The current size of the particle.
  13422. */
  13423. size: number;
  13424. /**
  13425. * The current scale of the particle.
  13426. */
  13427. scale: Vector2;
  13428. /**
  13429. * The current angle of the particle.
  13430. */
  13431. angle: number;
  13432. /**
  13433. * Defines how fast is the angle changing.
  13434. */
  13435. angularSpeed: number;
  13436. /**
  13437. * Defines the cell index used by the particle to be rendered from a sprite.
  13438. */
  13439. cellIndex: number;
  13440. /**
  13441. * The information required to support color remapping
  13442. */
  13443. remapData: Vector4;
  13444. /** @hidden */
  13445. _randomCellOffset?: number;
  13446. /** @hidden */
  13447. _initialDirection: Nullable<Vector3>;
  13448. /** @hidden */
  13449. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13450. /** @hidden */
  13451. _initialStartSpriteCellID: number;
  13452. /** @hidden */
  13453. _initialEndSpriteCellID: number;
  13454. /** @hidden */
  13455. _currentColorGradient: Nullable<ColorGradient>;
  13456. /** @hidden */
  13457. _currentColor1: Color4;
  13458. /** @hidden */
  13459. _currentColor2: Color4;
  13460. /** @hidden */
  13461. _currentSizeGradient: Nullable<FactorGradient>;
  13462. /** @hidden */
  13463. _currentSize1: number;
  13464. /** @hidden */
  13465. _currentSize2: number;
  13466. /** @hidden */
  13467. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13468. /** @hidden */
  13469. _currentAngularSpeed1: number;
  13470. /** @hidden */
  13471. _currentAngularSpeed2: number;
  13472. /** @hidden */
  13473. _currentVelocityGradient: Nullable<FactorGradient>;
  13474. /** @hidden */
  13475. _currentVelocity1: number;
  13476. /** @hidden */
  13477. _currentVelocity2: number;
  13478. /** @hidden */
  13479. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13480. /** @hidden */
  13481. _currentLimitVelocity1: number;
  13482. /** @hidden */
  13483. _currentLimitVelocity2: number;
  13484. /** @hidden */
  13485. _currentDragGradient: Nullable<FactorGradient>;
  13486. /** @hidden */
  13487. _currentDrag1: number;
  13488. /** @hidden */
  13489. _currentDrag2: number;
  13490. /** @hidden */
  13491. _randomNoiseCoordinates1: Vector3;
  13492. /** @hidden */
  13493. _randomNoiseCoordinates2: Vector3;
  13494. /** @hidden */
  13495. _localPosition?: Vector3;
  13496. /**
  13497. * Creates a new instance Particle
  13498. * @param particleSystem the particle system the particle belongs to
  13499. */
  13500. constructor(
  13501. /**
  13502. * The particle system the particle belongs to.
  13503. */
  13504. particleSystem: ParticleSystem);
  13505. private updateCellInfoFromSystem;
  13506. /**
  13507. * Defines how the sprite cell index is updated for the particle
  13508. */
  13509. updateCellIndex(): void;
  13510. /** @hidden */
  13511. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13512. /** @hidden */
  13513. _inheritParticleInfoToSubEmitters(): void;
  13514. /** @hidden */
  13515. _reset(): void;
  13516. /**
  13517. * Copy the properties of particle to another one.
  13518. * @param other the particle to copy the information to.
  13519. */
  13520. copyTo(other: Particle): void;
  13521. }
  13522. }
  13523. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13524. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13525. import { Effect } from "babylonjs/Materials/effect";
  13526. import { Particle } from "babylonjs/Particles/particle";
  13527. import { Nullable } from "babylonjs/types";
  13528. import { Scene } from "babylonjs/scene";
  13529. /**
  13530. * Particle emitter represents a volume emitting particles.
  13531. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13532. */
  13533. export interface IParticleEmitterType {
  13534. /**
  13535. * Called by the particle System when the direction is computed for the created particle.
  13536. * @param worldMatrix is the world matrix of the particle system
  13537. * @param directionToUpdate is the direction vector to update with the result
  13538. * @param particle is the particle we are computed the direction for
  13539. * @param isLocal defines if the direction should be set in local space
  13540. */
  13541. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13542. /**
  13543. * Called by the particle System when the position is computed for the created particle.
  13544. * @param worldMatrix is the world matrix of the particle system
  13545. * @param positionToUpdate is the position vector to update with the result
  13546. * @param particle is the particle we are computed the position for
  13547. * @param isLocal defines if the position should be set in local space
  13548. */
  13549. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13550. /**
  13551. * Clones the current emitter and returns a copy of it
  13552. * @returns the new emitter
  13553. */
  13554. clone(): IParticleEmitterType;
  13555. /**
  13556. * Called by the GPUParticleSystem to setup the update shader
  13557. * @param effect defines the update shader
  13558. */
  13559. applyToShader(effect: Effect): void;
  13560. /**
  13561. * Returns a string to use to update the GPU particles update shader
  13562. * @returns the effect defines string
  13563. */
  13564. getEffectDefines(): string;
  13565. /**
  13566. * Returns a string representing the class name
  13567. * @returns a string containing the class name
  13568. */
  13569. getClassName(): string;
  13570. /**
  13571. * Serializes the particle system to a JSON object.
  13572. * @returns the JSON object
  13573. */
  13574. serialize(): any;
  13575. /**
  13576. * Parse properties from a JSON object
  13577. * @param serializationObject defines the JSON object
  13578. * @param scene defines the hosting scene
  13579. */
  13580. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13581. }
  13582. }
  13583. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13584. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13585. import { Effect } from "babylonjs/Materials/effect";
  13586. import { Particle } from "babylonjs/Particles/particle";
  13587. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13588. /**
  13589. * Particle emitter emitting particles from the inside of a box.
  13590. * It emits the particles randomly between 2 given directions.
  13591. */
  13592. export class BoxParticleEmitter implements IParticleEmitterType {
  13593. /**
  13594. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13595. */
  13596. direction1: Vector3;
  13597. /**
  13598. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13599. */
  13600. direction2: Vector3;
  13601. /**
  13602. * 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.
  13603. */
  13604. minEmitBox: Vector3;
  13605. /**
  13606. * 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.
  13607. */
  13608. maxEmitBox: Vector3;
  13609. /**
  13610. * Creates a new instance BoxParticleEmitter
  13611. */
  13612. constructor();
  13613. /**
  13614. * Called by the particle System when the direction is computed for the created particle.
  13615. * @param worldMatrix is the world matrix of the particle system
  13616. * @param directionToUpdate is the direction vector to update with the result
  13617. * @param particle is the particle we are computed the direction for
  13618. * @param isLocal defines if the direction should be set in local space
  13619. */
  13620. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13621. /**
  13622. * Called by the particle System when the position is computed for the created particle.
  13623. * @param worldMatrix is the world matrix of the particle system
  13624. * @param positionToUpdate is the position vector to update with the result
  13625. * @param particle is the particle we are computed the position for
  13626. * @param isLocal defines if the position should be set in local space
  13627. */
  13628. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13629. /**
  13630. * Clones the current emitter and returns a copy of it
  13631. * @returns the new emitter
  13632. */
  13633. clone(): BoxParticleEmitter;
  13634. /**
  13635. * Called by the GPUParticleSystem to setup the update shader
  13636. * @param effect defines the update shader
  13637. */
  13638. applyToShader(effect: Effect): void;
  13639. /**
  13640. * Returns a string to use to update the GPU particles update shader
  13641. * @returns a string containng the defines string
  13642. */
  13643. getEffectDefines(): string;
  13644. /**
  13645. * Returns the string "BoxParticleEmitter"
  13646. * @returns a string containing the class name
  13647. */
  13648. getClassName(): string;
  13649. /**
  13650. * Serializes the particle system to a JSON object.
  13651. * @returns the JSON object
  13652. */
  13653. serialize(): any;
  13654. /**
  13655. * Parse properties from a JSON object
  13656. * @param serializationObject defines the JSON object
  13657. */
  13658. parse(serializationObject: any): void;
  13659. }
  13660. }
  13661. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13662. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13663. import { Effect } from "babylonjs/Materials/effect";
  13664. import { Particle } from "babylonjs/Particles/particle";
  13665. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13666. /**
  13667. * Particle emitter emitting particles from the inside of a cone.
  13668. * It emits the particles alongside the cone volume from the base to the particle.
  13669. * The emission direction might be randomized.
  13670. */
  13671. export class ConeParticleEmitter implements IParticleEmitterType {
  13672. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13673. directionRandomizer: number;
  13674. private _radius;
  13675. private _angle;
  13676. private _height;
  13677. /**
  13678. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13679. */
  13680. radiusRange: number;
  13681. /**
  13682. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13683. */
  13684. heightRange: number;
  13685. /**
  13686. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13687. */
  13688. emitFromSpawnPointOnly: boolean;
  13689. /**
  13690. * Gets or sets the radius of the emission cone
  13691. */
  13692. get radius(): number;
  13693. set radius(value: number);
  13694. /**
  13695. * Gets or sets the angle of the emission cone
  13696. */
  13697. get angle(): number;
  13698. set angle(value: number);
  13699. private _buildHeight;
  13700. /**
  13701. * Creates a new instance ConeParticleEmitter
  13702. * @param radius the radius of the emission cone (1 by default)
  13703. * @param angle the cone base angle (PI by default)
  13704. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13705. */
  13706. constructor(radius?: number, angle?: number,
  13707. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13708. directionRandomizer?: number);
  13709. /**
  13710. * Called by the particle System when the direction is computed for the created particle.
  13711. * @param worldMatrix is the world matrix of the particle system
  13712. * @param directionToUpdate is the direction vector to update with the result
  13713. * @param particle is the particle we are computed the direction for
  13714. * @param isLocal defines if the direction should be set in local space
  13715. */
  13716. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13717. /**
  13718. * Called by the particle System when the position is computed for the created particle.
  13719. * @param worldMatrix is the world matrix of the particle system
  13720. * @param positionToUpdate is the position vector to update with the result
  13721. * @param particle is the particle we are computed the position for
  13722. * @param isLocal defines if the position should be set in local space
  13723. */
  13724. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13725. /**
  13726. * Clones the current emitter and returns a copy of it
  13727. * @returns the new emitter
  13728. */
  13729. clone(): ConeParticleEmitter;
  13730. /**
  13731. * Called by the GPUParticleSystem to setup the update shader
  13732. * @param effect defines the update shader
  13733. */
  13734. applyToShader(effect: Effect): void;
  13735. /**
  13736. * Returns a string to use to update the GPU particles update shader
  13737. * @returns a string containng the defines string
  13738. */
  13739. getEffectDefines(): string;
  13740. /**
  13741. * Returns the string "ConeParticleEmitter"
  13742. * @returns a string containing the class name
  13743. */
  13744. getClassName(): string;
  13745. /**
  13746. * Serializes the particle system to a JSON object.
  13747. * @returns the JSON object
  13748. */
  13749. serialize(): any;
  13750. /**
  13751. * Parse properties from a JSON object
  13752. * @param serializationObject defines the JSON object
  13753. */
  13754. parse(serializationObject: any): void;
  13755. }
  13756. }
  13757. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13758. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13759. import { Effect } from "babylonjs/Materials/effect";
  13760. import { Particle } from "babylonjs/Particles/particle";
  13761. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13762. /**
  13763. * Particle emitter emitting particles from the inside of a cylinder.
  13764. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13765. */
  13766. export class CylinderParticleEmitter implements IParticleEmitterType {
  13767. /**
  13768. * The radius of the emission cylinder.
  13769. */
  13770. radius: number;
  13771. /**
  13772. * The height of the emission cylinder.
  13773. */
  13774. height: number;
  13775. /**
  13776. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13777. */
  13778. radiusRange: number;
  13779. /**
  13780. * How much to randomize the particle direction [0-1].
  13781. */
  13782. directionRandomizer: number;
  13783. /**
  13784. * Creates a new instance CylinderParticleEmitter
  13785. * @param radius the radius of the emission cylinder (1 by default)
  13786. * @param height the height of the emission cylinder (1 by default)
  13787. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13788. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13789. */
  13790. constructor(
  13791. /**
  13792. * The radius of the emission cylinder.
  13793. */
  13794. radius?: number,
  13795. /**
  13796. * The height of the emission cylinder.
  13797. */
  13798. height?: number,
  13799. /**
  13800. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13801. */
  13802. radiusRange?: number,
  13803. /**
  13804. * How much to randomize the particle direction [0-1].
  13805. */
  13806. directionRandomizer?: number);
  13807. /**
  13808. * Called by the particle System when the direction is computed for the created particle.
  13809. * @param worldMatrix is the world matrix of the particle system
  13810. * @param directionToUpdate is the direction vector to update with the result
  13811. * @param particle is the particle we are computed the direction for
  13812. * @param isLocal defines if the direction should be set in local space
  13813. */
  13814. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13815. /**
  13816. * Called by the particle System when the position is computed for the created particle.
  13817. * @param worldMatrix is the world matrix of the particle system
  13818. * @param positionToUpdate is the position vector to update with the result
  13819. * @param particle is the particle we are computed the position for
  13820. * @param isLocal defines if the position should be set in local space
  13821. */
  13822. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13823. /**
  13824. * Clones the current emitter and returns a copy of it
  13825. * @returns the new emitter
  13826. */
  13827. clone(): CylinderParticleEmitter;
  13828. /**
  13829. * Called by the GPUParticleSystem to setup the update shader
  13830. * @param effect defines the update shader
  13831. */
  13832. applyToShader(effect: Effect): void;
  13833. /**
  13834. * Returns a string to use to update the GPU particles update shader
  13835. * @returns a string containng the defines string
  13836. */
  13837. getEffectDefines(): string;
  13838. /**
  13839. * Returns the string "CylinderParticleEmitter"
  13840. * @returns a string containing the class name
  13841. */
  13842. getClassName(): string;
  13843. /**
  13844. * Serializes the particle system to a JSON object.
  13845. * @returns the JSON object
  13846. */
  13847. serialize(): any;
  13848. /**
  13849. * Parse properties from a JSON object
  13850. * @param serializationObject defines the JSON object
  13851. */
  13852. parse(serializationObject: any): void;
  13853. }
  13854. /**
  13855. * Particle emitter emitting particles from the inside of a cylinder.
  13856. * It emits the particles randomly between two vectors.
  13857. */
  13858. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13859. /**
  13860. * The min limit of the emission direction.
  13861. */
  13862. direction1: Vector3;
  13863. /**
  13864. * The max limit of the emission direction.
  13865. */
  13866. direction2: Vector3;
  13867. /**
  13868. * Creates a new instance CylinderDirectedParticleEmitter
  13869. * @param radius the radius of the emission cylinder (1 by default)
  13870. * @param height the height of the emission cylinder (1 by default)
  13871. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13872. * @param direction1 the min limit of the emission direction (up vector by default)
  13873. * @param direction2 the max limit of the emission direction (up vector by default)
  13874. */
  13875. constructor(radius?: number, height?: number, radiusRange?: number,
  13876. /**
  13877. * The min limit of the emission direction.
  13878. */
  13879. direction1?: Vector3,
  13880. /**
  13881. * The max limit of the emission direction.
  13882. */
  13883. direction2?: Vector3);
  13884. /**
  13885. * Called by the particle System when the direction is computed for the created particle.
  13886. * @param worldMatrix is the world matrix of the particle system
  13887. * @param directionToUpdate is the direction vector to update with the result
  13888. * @param particle is the particle we are computed the direction for
  13889. */
  13890. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13891. /**
  13892. * Clones the current emitter and returns a copy of it
  13893. * @returns the new emitter
  13894. */
  13895. clone(): CylinderDirectedParticleEmitter;
  13896. /**
  13897. * Called by the GPUParticleSystem to setup the update shader
  13898. * @param effect defines the update shader
  13899. */
  13900. applyToShader(effect: Effect): void;
  13901. /**
  13902. * Returns a string to use to update the GPU particles update shader
  13903. * @returns a string containng the defines string
  13904. */
  13905. getEffectDefines(): string;
  13906. /**
  13907. * Returns the string "CylinderDirectedParticleEmitter"
  13908. * @returns a string containing the class name
  13909. */
  13910. getClassName(): string;
  13911. /**
  13912. * Serializes the particle system to a JSON object.
  13913. * @returns the JSON object
  13914. */
  13915. serialize(): any;
  13916. /**
  13917. * Parse properties from a JSON object
  13918. * @param serializationObject defines the JSON object
  13919. */
  13920. parse(serializationObject: any): void;
  13921. }
  13922. }
  13923. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13924. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13925. import { Effect } from "babylonjs/Materials/effect";
  13926. import { Particle } from "babylonjs/Particles/particle";
  13927. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13928. /**
  13929. * Particle emitter emitting particles from the inside of a hemisphere.
  13930. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13931. */
  13932. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13933. /**
  13934. * The radius of the emission hemisphere.
  13935. */
  13936. radius: number;
  13937. /**
  13938. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13939. */
  13940. radiusRange: number;
  13941. /**
  13942. * How much to randomize the particle direction [0-1].
  13943. */
  13944. directionRandomizer: number;
  13945. /**
  13946. * Creates a new instance HemisphericParticleEmitter
  13947. * @param radius the radius of the emission hemisphere (1 by default)
  13948. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13949. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13950. */
  13951. constructor(
  13952. /**
  13953. * The radius of the emission hemisphere.
  13954. */
  13955. radius?: number,
  13956. /**
  13957. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13958. */
  13959. radiusRange?: number,
  13960. /**
  13961. * How much to randomize the particle direction [0-1].
  13962. */
  13963. directionRandomizer?: number);
  13964. /**
  13965. * Called by the particle System when the direction is computed for the created particle.
  13966. * @param worldMatrix is the world matrix of the particle system
  13967. * @param directionToUpdate is the direction vector to update with the result
  13968. * @param particle is the particle we are computed the direction for
  13969. * @param isLocal defines if the direction should be set in local space
  13970. */
  13971. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13972. /**
  13973. * Called by the particle System when the position is computed for the created particle.
  13974. * @param worldMatrix is the world matrix of the particle system
  13975. * @param positionToUpdate is the position vector to update with the result
  13976. * @param particle is the particle we are computed the position for
  13977. * @param isLocal defines if the position should be set in local space
  13978. */
  13979. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13980. /**
  13981. * Clones the current emitter and returns a copy of it
  13982. * @returns the new emitter
  13983. */
  13984. clone(): HemisphericParticleEmitter;
  13985. /**
  13986. * Called by the GPUParticleSystem to setup the update shader
  13987. * @param effect defines the update shader
  13988. */
  13989. applyToShader(effect: Effect): void;
  13990. /**
  13991. * Returns a string to use to update the GPU particles update shader
  13992. * @returns a string containng the defines string
  13993. */
  13994. getEffectDefines(): string;
  13995. /**
  13996. * Returns the string "HemisphericParticleEmitter"
  13997. * @returns a string containing the class name
  13998. */
  13999. getClassName(): string;
  14000. /**
  14001. * Serializes the particle system to a JSON object.
  14002. * @returns the JSON object
  14003. */
  14004. serialize(): any;
  14005. /**
  14006. * Parse properties from a JSON object
  14007. * @param serializationObject defines the JSON object
  14008. */
  14009. parse(serializationObject: any): void;
  14010. }
  14011. }
  14012. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  14013. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14014. import { Effect } from "babylonjs/Materials/effect";
  14015. import { Particle } from "babylonjs/Particles/particle";
  14016. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14017. /**
  14018. * Particle emitter emitting particles from a point.
  14019. * It emits the particles randomly between 2 given directions.
  14020. */
  14021. export class PointParticleEmitter implements IParticleEmitterType {
  14022. /**
  14023. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14024. */
  14025. direction1: Vector3;
  14026. /**
  14027. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14028. */
  14029. direction2: Vector3;
  14030. /**
  14031. * Creates a new instance PointParticleEmitter
  14032. */
  14033. constructor();
  14034. /**
  14035. * Called by the particle System when the direction is computed for the created particle.
  14036. * @param worldMatrix is the world matrix of the particle system
  14037. * @param directionToUpdate is the direction vector to update with the result
  14038. * @param particle is the particle we are computed the direction for
  14039. * @param isLocal defines if the direction should be set in local space
  14040. */
  14041. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14042. /**
  14043. * Called by the particle System when the position is computed for the created particle.
  14044. * @param worldMatrix is the world matrix of the particle system
  14045. * @param positionToUpdate is the position vector to update with the result
  14046. * @param particle is the particle we are computed the position for
  14047. * @param isLocal defines if the position should be set in local space
  14048. */
  14049. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14050. /**
  14051. * Clones the current emitter and returns a copy of it
  14052. * @returns the new emitter
  14053. */
  14054. clone(): PointParticleEmitter;
  14055. /**
  14056. * Called by the GPUParticleSystem to setup the update shader
  14057. * @param effect defines the update shader
  14058. */
  14059. applyToShader(effect: Effect): void;
  14060. /**
  14061. * Returns a string to use to update the GPU particles update shader
  14062. * @returns a string containng the defines string
  14063. */
  14064. getEffectDefines(): string;
  14065. /**
  14066. * Returns the string "PointParticleEmitter"
  14067. * @returns a string containing the class name
  14068. */
  14069. getClassName(): string;
  14070. /**
  14071. * Serializes the particle system to a JSON object.
  14072. * @returns the JSON object
  14073. */
  14074. serialize(): any;
  14075. /**
  14076. * Parse properties from a JSON object
  14077. * @param serializationObject defines the JSON object
  14078. */
  14079. parse(serializationObject: any): void;
  14080. }
  14081. }
  14082. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14083. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14084. import { Effect } from "babylonjs/Materials/effect";
  14085. import { Particle } from "babylonjs/Particles/particle";
  14086. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14087. /**
  14088. * Particle emitter emitting particles from the inside of a sphere.
  14089. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14090. */
  14091. export class SphereParticleEmitter implements IParticleEmitterType {
  14092. /**
  14093. * The radius of the emission sphere.
  14094. */
  14095. radius: number;
  14096. /**
  14097. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14098. */
  14099. radiusRange: number;
  14100. /**
  14101. * How much to randomize the particle direction [0-1].
  14102. */
  14103. directionRandomizer: number;
  14104. /**
  14105. * Creates a new instance SphereParticleEmitter
  14106. * @param radius the radius of the emission sphere (1 by default)
  14107. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14108. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14109. */
  14110. constructor(
  14111. /**
  14112. * The radius of the emission sphere.
  14113. */
  14114. radius?: number,
  14115. /**
  14116. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14117. */
  14118. radiusRange?: number,
  14119. /**
  14120. * How much to randomize the particle direction [0-1].
  14121. */
  14122. directionRandomizer?: number);
  14123. /**
  14124. * Called by the particle System when the direction is computed for the created particle.
  14125. * @param worldMatrix is the world matrix of the particle system
  14126. * @param directionToUpdate is the direction vector to update with the result
  14127. * @param particle is the particle we are computed the direction for
  14128. * @param isLocal defines if the direction should be set in local space
  14129. */
  14130. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14131. /**
  14132. * Called by the particle System when the position is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param positionToUpdate is the position vector to update with the result
  14135. * @param particle is the particle we are computed the position for
  14136. * @param isLocal defines if the position should be set in local space
  14137. */
  14138. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14139. /**
  14140. * Clones the current emitter and returns a copy of it
  14141. * @returns the new emitter
  14142. */
  14143. clone(): SphereParticleEmitter;
  14144. /**
  14145. * Called by the GPUParticleSystem to setup the update shader
  14146. * @param effect defines the update shader
  14147. */
  14148. applyToShader(effect: Effect): void;
  14149. /**
  14150. * Returns a string to use to update the GPU particles update shader
  14151. * @returns a string containng the defines string
  14152. */
  14153. getEffectDefines(): string;
  14154. /**
  14155. * Returns the string "SphereParticleEmitter"
  14156. * @returns a string containing the class name
  14157. */
  14158. getClassName(): string;
  14159. /**
  14160. * Serializes the particle system to a JSON object.
  14161. * @returns the JSON object
  14162. */
  14163. serialize(): any;
  14164. /**
  14165. * Parse properties from a JSON object
  14166. * @param serializationObject defines the JSON object
  14167. */
  14168. parse(serializationObject: any): void;
  14169. }
  14170. /**
  14171. * Particle emitter emitting particles from the inside of a sphere.
  14172. * It emits the particles randomly between two vectors.
  14173. */
  14174. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14175. /**
  14176. * The min limit of the emission direction.
  14177. */
  14178. direction1: Vector3;
  14179. /**
  14180. * The max limit of the emission direction.
  14181. */
  14182. direction2: Vector3;
  14183. /**
  14184. * Creates a new instance SphereDirectedParticleEmitter
  14185. * @param radius the radius of the emission sphere (1 by default)
  14186. * @param direction1 the min limit of the emission direction (up vector by default)
  14187. * @param direction2 the max limit of the emission direction (up vector by default)
  14188. */
  14189. constructor(radius?: number,
  14190. /**
  14191. * The min limit of the emission direction.
  14192. */
  14193. direction1?: Vector3,
  14194. /**
  14195. * The max limit of the emission direction.
  14196. */
  14197. direction2?: Vector3);
  14198. /**
  14199. * Called by the particle System when the direction is computed for the created particle.
  14200. * @param worldMatrix is the world matrix of the particle system
  14201. * @param directionToUpdate is the direction vector to update with the result
  14202. * @param particle is the particle we are computed the direction for
  14203. */
  14204. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14205. /**
  14206. * Clones the current emitter and returns a copy of it
  14207. * @returns the new emitter
  14208. */
  14209. clone(): SphereDirectedParticleEmitter;
  14210. /**
  14211. * Called by the GPUParticleSystem to setup the update shader
  14212. * @param effect defines the update shader
  14213. */
  14214. applyToShader(effect: Effect): void;
  14215. /**
  14216. * Returns a string to use to update the GPU particles update shader
  14217. * @returns a string containng the defines string
  14218. */
  14219. getEffectDefines(): string;
  14220. /**
  14221. * Returns the string "SphereDirectedParticleEmitter"
  14222. * @returns a string containing the class name
  14223. */
  14224. getClassName(): string;
  14225. /**
  14226. * Serializes the particle system to a JSON object.
  14227. * @returns the JSON object
  14228. */
  14229. serialize(): any;
  14230. /**
  14231. * Parse properties from a JSON object
  14232. * @param serializationObject defines the JSON object
  14233. */
  14234. parse(serializationObject: any): void;
  14235. }
  14236. }
  14237. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14238. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14239. import { Effect } from "babylonjs/Materials/effect";
  14240. import { Particle } from "babylonjs/Particles/particle";
  14241. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14242. import { Nullable } from "babylonjs/types";
  14243. /**
  14244. * Particle emitter emitting particles from a custom list of positions.
  14245. */
  14246. export class CustomParticleEmitter implements IParticleEmitterType {
  14247. /**
  14248. * Gets or sets the position generator that will create the inital position of each particle.
  14249. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14250. */
  14251. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14252. /**
  14253. * Gets or sets the destination generator that will create the final destination of each particle.
  14254. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14255. */
  14256. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14257. /**
  14258. * Creates a new instance CustomParticleEmitter
  14259. */
  14260. constructor();
  14261. /**
  14262. * Called by the particle System when the direction is computed for the created particle.
  14263. * @param worldMatrix is the world matrix of the particle system
  14264. * @param directionToUpdate is the direction vector to update with the result
  14265. * @param particle is the particle we are computed the direction for
  14266. * @param isLocal defines if the direction should be set in local space
  14267. */
  14268. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14269. /**
  14270. * Called by the particle System when the position is computed for the created particle.
  14271. * @param worldMatrix is the world matrix of the particle system
  14272. * @param positionToUpdate is the position vector to update with the result
  14273. * @param particle is the particle we are computed the position for
  14274. * @param isLocal defines if the position should be set in local space
  14275. */
  14276. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14277. /**
  14278. * Clones the current emitter and returns a copy of it
  14279. * @returns the new emitter
  14280. */
  14281. clone(): CustomParticleEmitter;
  14282. /**
  14283. * Called by the GPUParticleSystem to setup the update shader
  14284. * @param effect defines the update shader
  14285. */
  14286. applyToShader(effect: Effect): void;
  14287. /**
  14288. * Returns a string to use to update the GPU particles update shader
  14289. * @returns a string containng the defines string
  14290. */
  14291. getEffectDefines(): string;
  14292. /**
  14293. * Returns the string "PointParticleEmitter"
  14294. * @returns a string containing the class name
  14295. */
  14296. getClassName(): string;
  14297. /**
  14298. * Serializes the particle system to a JSON object.
  14299. * @returns the JSON object
  14300. */
  14301. serialize(): any;
  14302. /**
  14303. * Parse properties from a JSON object
  14304. * @param serializationObject defines the JSON object
  14305. */
  14306. parse(serializationObject: any): void;
  14307. }
  14308. }
  14309. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14310. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14311. import { Effect } from "babylonjs/Materials/effect";
  14312. import { Particle } from "babylonjs/Particles/particle";
  14313. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14314. import { Nullable } from "babylonjs/types";
  14315. import { Scene } from "babylonjs/scene";
  14316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14317. /**
  14318. * Particle emitter emitting particles from the inside of a box.
  14319. * It emits the particles randomly between 2 given directions.
  14320. */
  14321. export class MeshParticleEmitter implements IParticleEmitterType {
  14322. private _indices;
  14323. private _positions;
  14324. private _normals;
  14325. private _storedNormal;
  14326. private _mesh;
  14327. /**
  14328. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14329. */
  14330. direction1: Vector3;
  14331. /**
  14332. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14333. */
  14334. direction2: Vector3;
  14335. /**
  14336. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14337. */
  14338. useMeshNormalsForDirection: boolean;
  14339. /** Defines the mesh to use as source */
  14340. get mesh(): Nullable<AbstractMesh>;
  14341. set mesh(value: Nullable<AbstractMesh>);
  14342. /**
  14343. * Creates a new instance MeshParticleEmitter
  14344. * @param mesh defines the mesh to use as source
  14345. */
  14346. constructor(mesh?: Nullable<AbstractMesh>);
  14347. /**
  14348. * Called by the particle System when the direction is computed for the created particle.
  14349. * @param worldMatrix is the world matrix of the particle system
  14350. * @param directionToUpdate is the direction vector to update with the result
  14351. * @param particle is the particle we are computed the direction for
  14352. * @param isLocal defines if the direction should be set in local space
  14353. */
  14354. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14355. /**
  14356. * Called by the particle System when the position is computed for the created particle.
  14357. * @param worldMatrix is the world matrix of the particle system
  14358. * @param positionToUpdate is the position vector to update with the result
  14359. * @param particle is the particle we are computed the position for
  14360. * @param isLocal defines if the position should be set in local space
  14361. */
  14362. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14363. /**
  14364. * Clones the current emitter and returns a copy of it
  14365. * @returns the new emitter
  14366. */
  14367. clone(): MeshParticleEmitter;
  14368. /**
  14369. * Called by the GPUParticleSystem to setup the update shader
  14370. * @param effect defines the update shader
  14371. */
  14372. applyToShader(effect: Effect): void;
  14373. /**
  14374. * Returns a string to use to update the GPU particles update shader
  14375. * @returns a string containng the defines string
  14376. */
  14377. getEffectDefines(): string;
  14378. /**
  14379. * Returns the string "BoxParticleEmitter"
  14380. * @returns a string containing the class name
  14381. */
  14382. getClassName(): string;
  14383. /**
  14384. * Serializes the particle system to a JSON object.
  14385. * @returns the JSON object
  14386. */
  14387. serialize(): any;
  14388. /**
  14389. * Parse properties from a JSON object
  14390. * @param serializationObject defines the JSON object
  14391. * @param scene defines the hosting scene
  14392. */
  14393. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14394. }
  14395. }
  14396. declare module "babylonjs/Particles/EmitterTypes/index" {
  14397. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14398. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14399. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14400. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14401. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14402. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14403. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14404. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14405. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14406. }
  14407. declare module "babylonjs/Particles/IParticleSystem" {
  14408. import { Nullable } from "babylonjs/types";
  14409. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14410. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14411. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14412. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14413. import { Scene } from "babylonjs/scene";
  14414. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14415. import { Effect } from "babylonjs/Materials/effect";
  14416. import { Observable } from "babylonjs/Misc/observable";
  14417. import { Animation } from "babylonjs/Animations/animation";
  14418. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14419. /**
  14420. * Interface representing a particle system in Babylon.js.
  14421. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14422. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14423. */
  14424. export interface IParticleSystem {
  14425. /**
  14426. * List of animations used by the particle system.
  14427. */
  14428. animations: Animation[];
  14429. /**
  14430. * The id of the Particle system.
  14431. */
  14432. id: string;
  14433. /**
  14434. * The name of the Particle system.
  14435. */
  14436. name: string;
  14437. /**
  14438. * The emitter represents the Mesh or position we are attaching the particle system to.
  14439. */
  14440. emitter: Nullable<AbstractMesh | Vector3>;
  14441. /**
  14442. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14443. */
  14444. isBillboardBased: boolean;
  14445. /**
  14446. * The rendering group used by the Particle system to chose when to render.
  14447. */
  14448. renderingGroupId: number;
  14449. /**
  14450. * The layer mask we are rendering the particles through.
  14451. */
  14452. layerMask: number;
  14453. /**
  14454. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14455. */
  14456. updateSpeed: number;
  14457. /**
  14458. * The amount of time the particle system is running (depends of the overall update speed).
  14459. */
  14460. targetStopDuration: number;
  14461. /**
  14462. * The texture used to render each particle. (this can be a spritesheet)
  14463. */
  14464. particleTexture: Nullable<BaseTexture>;
  14465. /**
  14466. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14467. */
  14468. blendMode: number;
  14469. /**
  14470. * Minimum life time of emitting particles.
  14471. */
  14472. minLifeTime: number;
  14473. /**
  14474. * Maximum life time of emitting particles.
  14475. */
  14476. maxLifeTime: number;
  14477. /**
  14478. * Minimum Size of emitting particles.
  14479. */
  14480. minSize: number;
  14481. /**
  14482. * Maximum Size of emitting particles.
  14483. */
  14484. maxSize: number;
  14485. /**
  14486. * Minimum scale of emitting particles on X axis.
  14487. */
  14488. minScaleX: number;
  14489. /**
  14490. * Maximum scale of emitting particles on X axis.
  14491. */
  14492. maxScaleX: number;
  14493. /**
  14494. * Minimum scale of emitting particles on Y axis.
  14495. */
  14496. minScaleY: number;
  14497. /**
  14498. * Maximum scale of emitting particles on Y axis.
  14499. */
  14500. maxScaleY: number;
  14501. /**
  14502. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14503. */
  14504. color1: Color4;
  14505. /**
  14506. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14507. */
  14508. color2: Color4;
  14509. /**
  14510. * Color the particle will have at the end of its lifetime.
  14511. */
  14512. colorDead: Color4;
  14513. /**
  14514. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14515. */
  14516. emitRate: number;
  14517. /**
  14518. * You can use gravity if you want to give an orientation to your particles.
  14519. */
  14520. gravity: Vector3;
  14521. /**
  14522. * Minimum power of emitting particles.
  14523. */
  14524. minEmitPower: number;
  14525. /**
  14526. * Maximum power of emitting particles.
  14527. */
  14528. maxEmitPower: number;
  14529. /**
  14530. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14531. */
  14532. minAngularSpeed: number;
  14533. /**
  14534. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14535. */
  14536. maxAngularSpeed: number;
  14537. /**
  14538. * Gets or sets the minimal initial rotation in radians.
  14539. */
  14540. minInitialRotation: number;
  14541. /**
  14542. * Gets or sets the maximal initial rotation in radians.
  14543. */
  14544. maxInitialRotation: number;
  14545. /**
  14546. * The particle emitter type defines the emitter used by the particle system.
  14547. * It can be for example box, sphere, or cone...
  14548. */
  14549. particleEmitterType: Nullable<IParticleEmitterType>;
  14550. /**
  14551. * Defines the delay in milliseconds before starting the system (0 by default)
  14552. */
  14553. startDelay: number;
  14554. /**
  14555. * 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
  14556. */
  14557. preWarmCycles: number;
  14558. /**
  14559. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14560. */
  14561. preWarmStepOffset: number;
  14562. /**
  14563. * 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)
  14564. */
  14565. spriteCellChangeSpeed: number;
  14566. /**
  14567. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14568. */
  14569. startSpriteCellID: number;
  14570. /**
  14571. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14572. */
  14573. endSpriteCellID: number;
  14574. /**
  14575. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14576. */
  14577. spriteCellWidth: number;
  14578. /**
  14579. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14580. */
  14581. spriteCellHeight: number;
  14582. /**
  14583. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14584. */
  14585. spriteRandomStartCell: boolean;
  14586. /**
  14587. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14588. */
  14589. isAnimationSheetEnabled: boolean;
  14590. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14591. translationPivot: Vector2;
  14592. /**
  14593. * Gets or sets a texture used to add random noise to particle positions
  14594. */
  14595. noiseTexture: Nullable<BaseTexture>;
  14596. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14597. noiseStrength: Vector3;
  14598. /**
  14599. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14600. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14601. */
  14602. billboardMode: number;
  14603. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14604. limitVelocityDamping: number;
  14605. /**
  14606. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14607. */
  14608. beginAnimationOnStart: boolean;
  14609. /**
  14610. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14611. */
  14612. beginAnimationFrom: number;
  14613. /**
  14614. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14615. */
  14616. beginAnimationTo: number;
  14617. /**
  14618. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14619. */
  14620. beginAnimationLoop: boolean;
  14621. /**
  14622. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14623. */
  14624. disposeOnStop: boolean;
  14625. /**
  14626. * Specifies if the particles are updated in emitter local space or world space
  14627. */
  14628. isLocal: boolean;
  14629. /** Snippet ID if the particle system was created from the snippet server */
  14630. snippetId: string;
  14631. /** Gets or sets a matrix to use to compute projection */
  14632. defaultProjectionMatrix: Matrix;
  14633. /**
  14634. * Gets the maximum number of particles active at the same time.
  14635. * @returns The max number of active particles.
  14636. */
  14637. getCapacity(): number;
  14638. /**
  14639. * Gets the number of particles active at the same time.
  14640. * @returns The number of active particles.
  14641. */
  14642. getActiveCount(): number;
  14643. /**
  14644. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14645. * @returns True if it has been started, otherwise false.
  14646. */
  14647. isStarted(): boolean;
  14648. /**
  14649. * Animates the particle system for this frame.
  14650. */
  14651. animate(): void;
  14652. /**
  14653. * Renders the particle system in its current state.
  14654. * @returns the current number of particles
  14655. */
  14656. render(): number;
  14657. /**
  14658. * Dispose the particle system and frees its associated resources.
  14659. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14660. */
  14661. dispose(disposeTexture?: boolean): void;
  14662. /**
  14663. * An event triggered when the system is disposed
  14664. */
  14665. onDisposeObservable: Observable<IParticleSystem>;
  14666. /**
  14667. * Clones the particle system.
  14668. * @param name The name of the cloned object
  14669. * @param newEmitter The new emitter to use
  14670. * @returns the cloned particle system
  14671. */
  14672. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14673. /**
  14674. * Serializes the particle system to a JSON object
  14675. * @param serializeTexture defines if the texture must be serialized as well
  14676. * @returns the JSON object
  14677. */
  14678. serialize(serializeTexture: boolean): any;
  14679. /**
  14680. * Rebuild the particle system
  14681. */
  14682. rebuild(): void;
  14683. /** Force the system to rebuild all gradients that need to be resync */
  14684. forceRefreshGradients(): void;
  14685. /**
  14686. * Starts the particle system and begins to emit
  14687. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14688. */
  14689. start(delay?: number): void;
  14690. /**
  14691. * Stops the particle system.
  14692. */
  14693. stop(): void;
  14694. /**
  14695. * Remove all active particles
  14696. */
  14697. reset(): void;
  14698. /**
  14699. * Gets a boolean indicating that the system is stopping
  14700. * @returns true if the system is currently stopping
  14701. */
  14702. isStopping(): boolean;
  14703. /**
  14704. * Is this system ready to be used/rendered
  14705. * @return true if the system is ready
  14706. */
  14707. isReady(): boolean;
  14708. /**
  14709. * Returns the string "ParticleSystem"
  14710. * @returns a string containing the class name
  14711. */
  14712. getClassName(): string;
  14713. /**
  14714. * Gets the custom effect used to render the particles
  14715. * @param blendMode Blend mode for which the effect should be retrieved
  14716. * @returns The effect
  14717. */
  14718. getCustomEffect(blendMode: number): Nullable<Effect>;
  14719. /**
  14720. * Sets the custom effect used to render the particles
  14721. * @param effect The effect to set
  14722. * @param blendMode Blend mode for which the effect should be set
  14723. */
  14724. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14725. /**
  14726. * Fill the defines array according to the current settings of the particle system
  14727. * @param defines Array to be updated
  14728. * @param blendMode blend mode to take into account when updating the array
  14729. */
  14730. fillDefines(defines: Array<string>, blendMode: number): void;
  14731. /**
  14732. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14733. * @param uniforms Uniforms array to fill
  14734. * @param attributes Attributes array to fill
  14735. * @param samplers Samplers array to fill
  14736. */
  14737. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14738. /**
  14739. * Observable that will be called just before the particles are drawn
  14740. */
  14741. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14742. /**
  14743. * Gets the name of the particle vertex shader
  14744. */
  14745. vertexShaderName: string;
  14746. /**
  14747. * Adds a new color gradient
  14748. * @param gradient defines the gradient to use (between 0 and 1)
  14749. * @param color1 defines the color to affect to the specified gradient
  14750. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14751. * @returns the current particle system
  14752. */
  14753. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14754. /**
  14755. * Remove a specific color gradient
  14756. * @param gradient defines the gradient to remove
  14757. * @returns the current particle system
  14758. */
  14759. removeColorGradient(gradient: number): IParticleSystem;
  14760. /**
  14761. * Adds a new size gradient
  14762. * @param gradient defines the gradient to use (between 0 and 1)
  14763. * @param factor defines the size factor to affect to the specified gradient
  14764. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14765. * @returns the current particle system
  14766. */
  14767. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14768. /**
  14769. * Remove a specific size gradient
  14770. * @param gradient defines the gradient to remove
  14771. * @returns the current particle system
  14772. */
  14773. removeSizeGradient(gradient: number): IParticleSystem;
  14774. /**
  14775. * Gets the current list of color gradients.
  14776. * You must use addColorGradient and removeColorGradient to udpate this list
  14777. * @returns the list of color gradients
  14778. */
  14779. getColorGradients(): Nullable<Array<ColorGradient>>;
  14780. /**
  14781. * Gets the current list of size gradients.
  14782. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14783. * @returns the list of size gradients
  14784. */
  14785. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14786. /**
  14787. * Gets the current list of angular speed gradients.
  14788. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14789. * @returns the list of angular speed gradients
  14790. */
  14791. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14792. /**
  14793. * Adds a new angular speed gradient
  14794. * @param gradient defines the gradient to use (between 0 and 1)
  14795. * @param factor defines the angular speed to affect to the specified gradient
  14796. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14797. * @returns the current particle system
  14798. */
  14799. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14800. /**
  14801. * Remove a specific angular speed gradient
  14802. * @param gradient defines the gradient to remove
  14803. * @returns the current particle system
  14804. */
  14805. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14806. /**
  14807. * Gets the current list of velocity gradients.
  14808. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14809. * @returns the list of velocity gradients
  14810. */
  14811. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14812. /**
  14813. * Adds a new velocity gradient
  14814. * @param gradient defines the gradient to use (between 0 and 1)
  14815. * @param factor defines the velocity to affect to the specified gradient
  14816. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14817. * @returns the current particle system
  14818. */
  14819. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14820. /**
  14821. * Remove a specific velocity gradient
  14822. * @param gradient defines the gradient to remove
  14823. * @returns the current particle system
  14824. */
  14825. removeVelocityGradient(gradient: number): IParticleSystem;
  14826. /**
  14827. * Gets the current list of limit velocity gradients.
  14828. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14829. * @returns the list of limit velocity gradients
  14830. */
  14831. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14832. /**
  14833. * Adds a new limit velocity gradient
  14834. * @param gradient defines the gradient to use (between 0 and 1)
  14835. * @param factor defines the limit velocity to affect to the specified gradient
  14836. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14837. * @returns the current particle system
  14838. */
  14839. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14840. /**
  14841. * Remove a specific limit velocity gradient
  14842. * @param gradient defines the gradient to remove
  14843. * @returns the current particle system
  14844. */
  14845. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14846. /**
  14847. * Adds a new drag gradient
  14848. * @param gradient defines the gradient to use (between 0 and 1)
  14849. * @param factor defines the drag to affect to the specified gradient
  14850. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14851. * @returns the current particle system
  14852. */
  14853. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14854. /**
  14855. * Remove a specific drag gradient
  14856. * @param gradient defines the gradient to remove
  14857. * @returns the current particle system
  14858. */
  14859. removeDragGradient(gradient: number): IParticleSystem;
  14860. /**
  14861. * Gets the current list of drag gradients.
  14862. * You must use addDragGradient and removeDragGradient to udpate this list
  14863. * @returns the list of drag gradients
  14864. */
  14865. getDragGradients(): Nullable<Array<FactorGradient>>;
  14866. /**
  14867. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14868. * @param gradient defines the gradient to use (between 0 and 1)
  14869. * @param factor defines the emit rate to affect to the specified gradient
  14870. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14871. * @returns the current particle system
  14872. */
  14873. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14874. /**
  14875. * Remove a specific emit rate gradient
  14876. * @param gradient defines the gradient to remove
  14877. * @returns the current particle system
  14878. */
  14879. removeEmitRateGradient(gradient: number): IParticleSystem;
  14880. /**
  14881. * Gets the current list of emit rate gradients.
  14882. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14883. * @returns the list of emit rate gradients
  14884. */
  14885. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14886. /**
  14887. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14888. * @param gradient defines the gradient to use (between 0 and 1)
  14889. * @param factor defines the start size to affect to the specified gradient
  14890. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14891. * @returns the current particle system
  14892. */
  14893. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14894. /**
  14895. * Remove a specific start size gradient
  14896. * @param gradient defines the gradient to remove
  14897. * @returns the current particle system
  14898. */
  14899. removeStartSizeGradient(gradient: number): IParticleSystem;
  14900. /**
  14901. * Gets the current list of start size gradients.
  14902. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14903. * @returns the list of start size gradients
  14904. */
  14905. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14906. /**
  14907. * Adds a new life time gradient
  14908. * @param gradient defines the gradient to use (between 0 and 1)
  14909. * @param factor defines the life time factor to affect to the specified gradient
  14910. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14911. * @returns the current particle system
  14912. */
  14913. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14914. /**
  14915. * Remove a specific life time gradient
  14916. * @param gradient defines the gradient to remove
  14917. * @returns the current particle system
  14918. */
  14919. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14920. /**
  14921. * Gets the current list of life time gradients.
  14922. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14923. * @returns the list of life time gradients
  14924. */
  14925. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14926. /**
  14927. * Gets the current list of color gradients.
  14928. * You must use addColorGradient and removeColorGradient to udpate this list
  14929. * @returns the list of color gradients
  14930. */
  14931. getColorGradients(): Nullable<Array<ColorGradient>>;
  14932. /**
  14933. * Adds a new ramp gradient used to remap particle colors
  14934. * @param gradient defines the gradient to use (between 0 and 1)
  14935. * @param color defines the color to affect to the specified gradient
  14936. * @returns the current particle system
  14937. */
  14938. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14939. /**
  14940. * Gets the current list of ramp gradients.
  14941. * You must use addRampGradient and removeRampGradient to udpate this list
  14942. * @returns the list of ramp gradients
  14943. */
  14944. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14945. /** Gets or sets a boolean indicating that ramp gradients must be used
  14946. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14947. */
  14948. useRampGradients: boolean;
  14949. /**
  14950. * Adds a new color remap gradient
  14951. * @param gradient defines the gradient to use (between 0 and 1)
  14952. * @param min defines the color remap minimal range
  14953. * @param max defines the color remap maximal range
  14954. * @returns the current particle system
  14955. */
  14956. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14957. /**
  14958. * Gets the current list of color remap gradients.
  14959. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14960. * @returns the list of color remap gradients
  14961. */
  14962. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14963. /**
  14964. * Adds a new alpha remap gradient
  14965. * @param gradient defines the gradient to use (between 0 and 1)
  14966. * @param min defines the alpha remap minimal range
  14967. * @param max defines the alpha remap maximal range
  14968. * @returns the current particle system
  14969. */
  14970. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14971. /**
  14972. * Gets the current list of alpha remap gradients.
  14973. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14974. * @returns the list of alpha remap gradients
  14975. */
  14976. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14977. /**
  14978. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14979. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14980. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14981. * @returns the emitter
  14982. */
  14983. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14984. /**
  14985. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14986. * @param radius The radius of the hemisphere to emit from
  14987. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14988. * @returns the emitter
  14989. */
  14990. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14991. /**
  14992. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14993. * @param radius The radius of the sphere to emit from
  14994. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14995. * @returns the emitter
  14996. */
  14997. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14998. /**
  14999. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  15000. * @param radius The radius of the sphere to emit from
  15001. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  15002. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  15003. * @returns the emitter
  15004. */
  15005. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  15006. /**
  15007. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  15008. * @param radius The radius of the emission cylinder
  15009. * @param height The height of the emission cylinder
  15010. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  15011. * @param directionRandomizer How much to randomize the particle direction [0-1]
  15012. * @returns the emitter
  15013. */
  15014. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  15015. /**
  15016. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  15017. * @param radius The radius of the cylinder to emit from
  15018. * @param height The height of the emission cylinder
  15019. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  15020. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  15021. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  15022. * @returns the emitter
  15023. */
  15024. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  15025. /**
  15026. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  15027. * @param radius The radius of the cone to emit from
  15028. * @param angle The base angle of the cone
  15029. * @returns the emitter
  15030. */
  15031. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  15032. /**
  15033. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  15034. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  15035. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  15036. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  15037. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  15038. * @returns the emitter
  15039. */
  15040. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  15041. /**
  15042. * Get hosting scene
  15043. * @returns the scene
  15044. */
  15045. getScene(): Nullable<Scene>;
  15046. }
  15047. }
  15048. declare module "babylonjs/Meshes/transformNode" {
  15049. import { DeepImmutable } from "babylonjs/types";
  15050. import { Observable } from "babylonjs/Misc/observable";
  15051. import { Nullable } from "babylonjs/types";
  15052. import { Camera } from "babylonjs/Cameras/camera";
  15053. import { Scene } from "babylonjs/scene";
  15054. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15055. import { Node } from "babylonjs/node";
  15056. import { Bone } from "babylonjs/Bones/bone";
  15057. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15058. import { Space } from "babylonjs/Maths/math.axis";
  15059. /**
  15060. * 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.
  15061. * @see https://doc.babylonjs.com/how_to/transformnode
  15062. */
  15063. export class TransformNode extends Node {
  15064. /**
  15065. * Object will not rotate to face the camera
  15066. */
  15067. static BILLBOARDMODE_NONE: number;
  15068. /**
  15069. * Object will rotate to face the camera but only on the x axis
  15070. */
  15071. static BILLBOARDMODE_X: number;
  15072. /**
  15073. * Object will rotate to face the camera but only on the y axis
  15074. */
  15075. static BILLBOARDMODE_Y: number;
  15076. /**
  15077. * Object will rotate to face the camera but only on the z axis
  15078. */
  15079. static BILLBOARDMODE_Z: number;
  15080. /**
  15081. * Object will rotate to face the camera
  15082. */
  15083. static BILLBOARDMODE_ALL: number;
  15084. /**
  15085. * Object will rotate to face the camera's position instead of orientation
  15086. */
  15087. static BILLBOARDMODE_USE_POSITION: number;
  15088. private static _TmpRotation;
  15089. private static _TmpScaling;
  15090. private static _TmpTranslation;
  15091. private _forward;
  15092. private _forwardInverted;
  15093. private _up;
  15094. private _right;
  15095. private _rightInverted;
  15096. private _position;
  15097. private _rotation;
  15098. private _rotationQuaternion;
  15099. protected _scaling: Vector3;
  15100. protected _isDirty: boolean;
  15101. private _transformToBoneReferal;
  15102. private _isAbsoluteSynced;
  15103. private _billboardMode;
  15104. /**
  15105. * Gets or sets the billboard mode. Default is 0.
  15106. *
  15107. * | Value | Type | Description |
  15108. * | --- | --- | --- |
  15109. * | 0 | BILLBOARDMODE_NONE | |
  15110. * | 1 | BILLBOARDMODE_X | |
  15111. * | 2 | BILLBOARDMODE_Y | |
  15112. * | 4 | BILLBOARDMODE_Z | |
  15113. * | 7 | BILLBOARDMODE_ALL | |
  15114. *
  15115. */
  15116. get billboardMode(): number;
  15117. set billboardMode(value: number);
  15118. private _preserveParentRotationForBillboard;
  15119. /**
  15120. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15121. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15122. */
  15123. get preserveParentRotationForBillboard(): boolean;
  15124. set preserveParentRotationForBillboard(value: boolean);
  15125. /**
  15126. * 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
  15127. */
  15128. scalingDeterminant: number;
  15129. private _infiniteDistance;
  15130. /**
  15131. * Gets or sets the distance of the object to max, often used by skybox
  15132. */
  15133. get infiniteDistance(): boolean;
  15134. set infiniteDistance(value: boolean);
  15135. /**
  15136. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15137. * By default the system will update normals to compensate
  15138. */
  15139. ignoreNonUniformScaling: boolean;
  15140. /**
  15141. * 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
  15142. */
  15143. reIntegrateRotationIntoRotationQuaternion: boolean;
  15144. /** @hidden */
  15145. _poseMatrix: Nullable<Matrix>;
  15146. /** @hidden */
  15147. _localMatrix: Matrix;
  15148. private _usePivotMatrix;
  15149. private _absolutePosition;
  15150. private _absoluteScaling;
  15151. private _absoluteRotationQuaternion;
  15152. private _pivotMatrix;
  15153. private _pivotMatrixInverse;
  15154. /** @hidden */
  15155. _postMultiplyPivotMatrix: boolean;
  15156. protected _isWorldMatrixFrozen: boolean;
  15157. /** @hidden */
  15158. _indexInSceneTransformNodesArray: number;
  15159. /**
  15160. * An event triggered after the world matrix is updated
  15161. */
  15162. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15163. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15164. /**
  15165. * Gets a string identifying the name of the class
  15166. * @returns "TransformNode" string
  15167. */
  15168. getClassName(): string;
  15169. /**
  15170. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15171. */
  15172. get position(): Vector3;
  15173. set position(newPosition: Vector3);
  15174. /**
  15175. * 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)).
  15176. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15177. */
  15178. get rotation(): Vector3;
  15179. set rotation(newRotation: Vector3);
  15180. /**
  15181. * 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)).
  15182. */
  15183. get scaling(): Vector3;
  15184. set scaling(newScaling: Vector3);
  15185. /**
  15186. * 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).
  15187. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15188. */
  15189. get rotationQuaternion(): Nullable<Quaternion>;
  15190. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15191. /**
  15192. * The forward direction of that transform in world space.
  15193. */
  15194. get forward(): Vector3;
  15195. /**
  15196. * The up direction of that transform in world space.
  15197. */
  15198. get up(): Vector3;
  15199. /**
  15200. * The right direction of that transform in world space.
  15201. */
  15202. get right(): Vector3;
  15203. /**
  15204. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15205. * @param matrix the matrix to copy the pose from
  15206. * @returns this TransformNode.
  15207. */
  15208. updatePoseMatrix(matrix: Matrix): TransformNode;
  15209. /**
  15210. * Returns the mesh Pose matrix.
  15211. * @returns the pose matrix
  15212. */
  15213. getPoseMatrix(): Matrix;
  15214. /** @hidden */
  15215. _isSynchronized(): boolean;
  15216. /** @hidden */
  15217. _initCache(): void;
  15218. /**
  15219. * Flag the transform node as dirty (Forcing it to update everything)
  15220. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15221. * @returns this transform node
  15222. */
  15223. markAsDirty(property: string): TransformNode;
  15224. /**
  15225. * Returns the current mesh absolute position.
  15226. * Returns a Vector3.
  15227. */
  15228. get absolutePosition(): Vector3;
  15229. /**
  15230. * Returns the current mesh absolute scaling.
  15231. * Returns a Vector3.
  15232. */
  15233. get absoluteScaling(): Vector3;
  15234. /**
  15235. * Returns the current mesh absolute rotation.
  15236. * Returns a Quaternion.
  15237. */
  15238. get absoluteRotationQuaternion(): Quaternion;
  15239. /**
  15240. * Sets a new matrix to apply before all other transformation
  15241. * @param matrix defines the transform matrix
  15242. * @returns the current TransformNode
  15243. */
  15244. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15245. /**
  15246. * Sets a new pivot matrix to the current node
  15247. * @param matrix defines the new pivot matrix to use
  15248. * @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
  15249. * @returns the current TransformNode
  15250. */
  15251. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15252. /**
  15253. * Returns the mesh pivot matrix.
  15254. * Default : Identity.
  15255. * @returns the matrix
  15256. */
  15257. getPivotMatrix(): Matrix;
  15258. /**
  15259. * Instantiate (when possible) or clone that node with its hierarchy
  15260. * @param newParent defines the new parent to use for the instance (or clone)
  15261. * @param options defines options to configure how copy is done
  15262. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15263. * @returns an instance (or a clone) of the current node with its hiearchy
  15264. */
  15265. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15266. doNotInstantiate: boolean;
  15267. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15268. /**
  15269. * Prevents the World matrix to be computed any longer
  15270. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15271. * @returns the TransformNode.
  15272. */
  15273. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15274. /**
  15275. * Allows back the World matrix computation.
  15276. * @returns the TransformNode.
  15277. */
  15278. unfreezeWorldMatrix(): this;
  15279. /**
  15280. * True if the World matrix has been frozen.
  15281. */
  15282. get isWorldMatrixFrozen(): boolean;
  15283. /**
  15284. * Retuns the mesh absolute position in the World.
  15285. * @returns a Vector3.
  15286. */
  15287. getAbsolutePosition(): Vector3;
  15288. /**
  15289. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15290. * @param absolutePosition the absolute position to set
  15291. * @returns the TransformNode.
  15292. */
  15293. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15294. /**
  15295. * Sets the mesh position in its local space.
  15296. * @param vector3 the position to set in localspace
  15297. * @returns the TransformNode.
  15298. */
  15299. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15300. /**
  15301. * Returns the mesh position in the local space from the current World matrix values.
  15302. * @returns a new Vector3.
  15303. */
  15304. getPositionExpressedInLocalSpace(): Vector3;
  15305. /**
  15306. * Translates the mesh along the passed Vector3 in its local space.
  15307. * @param vector3 the distance to translate in localspace
  15308. * @returns the TransformNode.
  15309. */
  15310. locallyTranslate(vector3: Vector3): TransformNode;
  15311. private static _lookAtVectorCache;
  15312. /**
  15313. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15314. * @param targetPoint the position (must be in same space as current mesh) to look at
  15315. * @param yawCor optional yaw (y-axis) correction in radians
  15316. * @param pitchCor optional pitch (x-axis) correction in radians
  15317. * @param rollCor optional roll (z-axis) correction in radians
  15318. * @param space the choosen space of the target
  15319. * @returns the TransformNode.
  15320. */
  15321. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15322. /**
  15323. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15324. * This Vector3 is expressed in the World space.
  15325. * @param localAxis axis to rotate
  15326. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15327. */
  15328. getDirection(localAxis: Vector3): Vector3;
  15329. /**
  15330. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15331. * localAxis is expressed in the mesh local space.
  15332. * result is computed in the Wordl space from the mesh World matrix.
  15333. * @param localAxis axis to rotate
  15334. * @param result the resulting transformnode
  15335. * @returns this TransformNode.
  15336. */
  15337. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15338. /**
  15339. * Sets this transform node rotation to the given local axis.
  15340. * @param localAxis the axis in local space
  15341. * @param yawCor optional yaw (y-axis) correction in radians
  15342. * @param pitchCor optional pitch (x-axis) correction in radians
  15343. * @param rollCor optional roll (z-axis) correction in radians
  15344. * @returns this TransformNode
  15345. */
  15346. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15347. /**
  15348. * Sets a new pivot point to the current node
  15349. * @param point defines the new pivot point to use
  15350. * @param space defines if the point is in world or local space (local by default)
  15351. * @returns the current TransformNode
  15352. */
  15353. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15354. /**
  15355. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15356. * @returns the pivot point
  15357. */
  15358. getPivotPoint(): Vector3;
  15359. /**
  15360. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15361. * @param result the vector3 to store the result
  15362. * @returns this TransformNode.
  15363. */
  15364. getPivotPointToRef(result: Vector3): TransformNode;
  15365. /**
  15366. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15367. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15368. */
  15369. getAbsolutePivotPoint(): Vector3;
  15370. /**
  15371. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15372. * @param result vector3 to store the result
  15373. * @returns this TransformNode.
  15374. */
  15375. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15376. /**
  15377. * Defines the passed node as the parent of the current node.
  15378. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15379. * @see https://doc.babylonjs.com/how_to/parenting
  15380. * @param node the node ot set as the parent
  15381. * @returns this TransformNode.
  15382. */
  15383. setParent(node: Nullable<Node>): TransformNode;
  15384. private _nonUniformScaling;
  15385. /**
  15386. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15387. */
  15388. get nonUniformScaling(): boolean;
  15389. /** @hidden */
  15390. _updateNonUniformScalingState(value: boolean): boolean;
  15391. /**
  15392. * Attach the current TransformNode to another TransformNode associated with a bone
  15393. * @param bone Bone affecting the TransformNode
  15394. * @param affectedTransformNode TransformNode associated with the bone
  15395. * @returns this object
  15396. */
  15397. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15398. /**
  15399. * Detach the transform node if its associated with a bone
  15400. * @returns this object
  15401. */
  15402. detachFromBone(): TransformNode;
  15403. private static _rotationAxisCache;
  15404. /**
  15405. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15406. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15407. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15408. * The passed axis is also normalized.
  15409. * @param axis the axis to rotate around
  15410. * @param amount the amount to rotate in radians
  15411. * @param space Space to rotate in (Default: local)
  15412. * @returns the TransformNode.
  15413. */
  15414. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15415. /**
  15416. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15417. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15418. * The passed axis is also normalized. .
  15419. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15420. * @param point the point to rotate around
  15421. * @param axis the axis to rotate around
  15422. * @param amount the amount to rotate in radians
  15423. * @returns the TransformNode
  15424. */
  15425. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15426. /**
  15427. * Translates the mesh along the axis vector for the passed distance in the given space.
  15428. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15429. * @param axis the axis to translate in
  15430. * @param distance the distance to translate
  15431. * @param space Space to rotate in (Default: local)
  15432. * @returns the TransformNode.
  15433. */
  15434. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15435. /**
  15436. * Adds a rotation step to the mesh current rotation.
  15437. * x, y, z are Euler angles expressed in radians.
  15438. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15439. * This means this rotation is made in the mesh local space only.
  15440. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15441. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15442. * ```javascript
  15443. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15444. * ```
  15445. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15446. * 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.
  15447. * @param x Rotation to add
  15448. * @param y Rotation to add
  15449. * @param z Rotation to add
  15450. * @returns the TransformNode.
  15451. */
  15452. addRotation(x: number, y: number, z: number): TransformNode;
  15453. /**
  15454. * @hidden
  15455. */
  15456. protected _getEffectiveParent(): Nullable<Node>;
  15457. /**
  15458. * Computes the world matrix of the node
  15459. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15460. * @returns the world matrix
  15461. */
  15462. computeWorldMatrix(force?: boolean): Matrix;
  15463. /**
  15464. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15465. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15466. */
  15467. resetLocalMatrix(independentOfChildren?: boolean): void;
  15468. protected _afterComputeWorldMatrix(): void;
  15469. /**
  15470. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15471. * @param func callback function to add
  15472. *
  15473. * @returns the TransformNode.
  15474. */
  15475. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15476. /**
  15477. * Removes a registered callback function.
  15478. * @param func callback function to remove
  15479. * @returns the TransformNode.
  15480. */
  15481. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15482. /**
  15483. * Gets the position of the current mesh in camera space
  15484. * @param camera defines the camera to use
  15485. * @returns a position
  15486. */
  15487. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15488. /**
  15489. * Returns the distance from the mesh to the active camera
  15490. * @param camera defines the camera to use
  15491. * @returns the distance
  15492. */
  15493. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15494. /**
  15495. * Clone the current transform node
  15496. * @param name Name of the new clone
  15497. * @param newParent New parent for the clone
  15498. * @param doNotCloneChildren Do not clone children hierarchy
  15499. * @returns the new transform node
  15500. */
  15501. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15502. /**
  15503. * Serializes the objects information.
  15504. * @param currentSerializationObject defines the object to serialize in
  15505. * @returns the serialized object
  15506. */
  15507. serialize(currentSerializationObject?: any): any;
  15508. /**
  15509. * Returns a new TransformNode object parsed from the source provided.
  15510. * @param parsedTransformNode is the source.
  15511. * @param scene the scne the object belongs to
  15512. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15513. * @returns a new TransformNode object parsed from the source provided.
  15514. */
  15515. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15516. /**
  15517. * Get all child-transformNodes of this node
  15518. * @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
  15519. * @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
  15520. * @returns an array of TransformNode
  15521. */
  15522. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15523. /**
  15524. * Releases resources associated with this transform node.
  15525. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15526. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15527. */
  15528. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15529. /**
  15530. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15531. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15532. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15533. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15534. * @returns the current mesh
  15535. */
  15536. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15537. private _syncAbsoluteScalingAndRotation;
  15538. }
  15539. }
  15540. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15541. /**
  15542. * Class used to override all child animations of a given target
  15543. */
  15544. export class AnimationPropertiesOverride {
  15545. /**
  15546. * Gets or sets a value indicating if animation blending must be used
  15547. */
  15548. enableBlending: boolean;
  15549. /**
  15550. * Gets or sets the blending speed to use when enableBlending is true
  15551. */
  15552. blendingSpeed: number;
  15553. /**
  15554. * Gets or sets the default loop mode to use
  15555. */
  15556. loopMode: number;
  15557. }
  15558. }
  15559. declare module "babylonjs/Bones/bone" {
  15560. import { Skeleton } from "babylonjs/Bones/skeleton";
  15561. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15562. import { Nullable } from "babylonjs/types";
  15563. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15564. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15565. import { Node } from "babylonjs/node";
  15566. import { Space } from "babylonjs/Maths/math.axis";
  15567. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15568. /**
  15569. * Class used to store bone information
  15570. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15571. */
  15572. export class Bone extends Node {
  15573. /**
  15574. * defines the bone name
  15575. */
  15576. name: string;
  15577. private static _tmpVecs;
  15578. private static _tmpQuat;
  15579. private static _tmpMats;
  15580. /**
  15581. * Gets the list of child bones
  15582. */
  15583. children: Bone[];
  15584. /** Gets the animations associated with this bone */
  15585. animations: import("babylonjs/Animations/animation").Animation[];
  15586. /**
  15587. * Gets or sets bone length
  15588. */
  15589. length: number;
  15590. /**
  15591. * @hidden Internal only
  15592. * Set this value to map this bone to a different index in the transform matrices
  15593. * Set this value to -1 to exclude the bone from the transform matrices
  15594. */
  15595. _index: Nullable<number>;
  15596. private _skeleton;
  15597. private _localMatrix;
  15598. private _restPose;
  15599. private _bindPose;
  15600. private _baseMatrix;
  15601. private _absoluteTransform;
  15602. private _invertedAbsoluteTransform;
  15603. private _parent;
  15604. private _scalingDeterminant;
  15605. private _worldTransform;
  15606. private _localScaling;
  15607. private _localRotation;
  15608. private _localPosition;
  15609. private _needToDecompose;
  15610. private _needToCompose;
  15611. /** @hidden */
  15612. _linkedTransformNode: Nullable<TransformNode>;
  15613. /** @hidden */
  15614. _waitingTransformNodeId: Nullable<string>;
  15615. /** @hidden */
  15616. get _matrix(): Matrix;
  15617. /** @hidden */
  15618. set _matrix(value: Matrix);
  15619. /**
  15620. * Create a new bone
  15621. * @param name defines the bone name
  15622. * @param skeleton defines the parent skeleton
  15623. * @param parentBone defines the parent (can be null if the bone is the root)
  15624. * @param localMatrix defines the local matrix
  15625. * @param restPose defines the rest pose matrix
  15626. * @param baseMatrix defines the base matrix
  15627. * @param index defines index of the bone in the hiearchy
  15628. */
  15629. constructor(
  15630. /**
  15631. * defines the bone name
  15632. */
  15633. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15634. /**
  15635. * Gets the current object class name.
  15636. * @return the class name
  15637. */
  15638. getClassName(): string;
  15639. /**
  15640. * Gets the parent skeleton
  15641. * @returns a skeleton
  15642. */
  15643. getSkeleton(): Skeleton;
  15644. /**
  15645. * Gets parent bone
  15646. * @returns a bone or null if the bone is the root of the bone hierarchy
  15647. */
  15648. getParent(): Nullable<Bone>;
  15649. /**
  15650. * Returns an array containing the root bones
  15651. * @returns an array containing the root bones
  15652. */
  15653. getChildren(): Array<Bone>;
  15654. /**
  15655. * Gets the node index in matrix array generated for rendering
  15656. * @returns the node index
  15657. */
  15658. getIndex(): number;
  15659. /**
  15660. * Sets the parent bone
  15661. * @param parent defines the parent (can be null if the bone is the root)
  15662. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15663. */
  15664. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15665. /**
  15666. * Gets the local matrix
  15667. * @returns a matrix
  15668. */
  15669. getLocalMatrix(): Matrix;
  15670. /**
  15671. * Gets the base matrix (initial matrix which remains unchanged)
  15672. * @returns a matrix
  15673. */
  15674. getBaseMatrix(): Matrix;
  15675. /**
  15676. * Gets the rest pose matrix
  15677. * @returns a matrix
  15678. */
  15679. getRestPose(): Matrix;
  15680. /**
  15681. * Sets the rest pose matrix
  15682. * @param matrix the local-space rest pose to set for this bone
  15683. */
  15684. setRestPose(matrix: Matrix): void;
  15685. /**
  15686. * Gets the bind pose matrix
  15687. * @returns the bind pose matrix
  15688. */
  15689. getBindPose(): Matrix;
  15690. /**
  15691. * Sets the bind pose matrix
  15692. * @param matrix the local-space bind pose to set for this bone
  15693. */
  15694. setBindPose(matrix: Matrix): void;
  15695. /**
  15696. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15697. */
  15698. getWorldMatrix(): Matrix;
  15699. /**
  15700. * Sets the local matrix to rest pose matrix
  15701. */
  15702. returnToRest(): void;
  15703. /**
  15704. * Gets the inverse of the absolute transform matrix.
  15705. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15706. * @returns a matrix
  15707. */
  15708. getInvertedAbsoluteTransform(): Matrix;
  15709. /**
  15710. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15711. * @returns a matrix
  15712. */
  15713. getAbsoluteTransform(): Matrix;
  15714. /**
  15715. * Links with the given transform node.
  15716. * The local matrix of this bone is copied from the transform node every frame.
  15717. * @param transformNode defines the transform node to link to
  15718. */
  15719. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15720. /**
  15721. * Gets the node used to drive the bone's transformation
  15722. * @returns a transform node or null
  15723. */
  15724. getTransformNode(): Nullable<TransformNode>;
  15725. /** Gets or sets current position (in local space) */
  15726. get position(): Vector3;
  15727. set position(newPosition: Vector3);
  15728. /** Gets or sets current rotation (in local space) */
  15729. get rotation(): Vector3;
  15730. set rotation(newRotation: Vector3);
  15731. /** Gets or sets current rotation quaternion (in local space) */
  15732. get rotationQuaternion(): Quaternion;
  15733. set rotationQuaternion(newRotation: Quaternion);
  15734. /** Gets or sets current scaling (in local space) */
  15735. get scaling(): Vector3;
  15736. set scaling(newScaling: Vector3);
  15737. /**
  15738. * Gets the animation properties override
  15739. */
  15740. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15741. private _decompose;
  15742. private _compose;
  15743. /**
  15744. * Update the base and local matrices
  15745. * @param matrix defines the new base or local matrix
  15746. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15747. * @param updateLocalMatrix defines if the local matrix should be updated
  15748. */
  15749. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15750. /** @hidden */
  15751. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15752. /**
  15753. * Flag the bone as dirty (Forcing it to update everything)
  15754. */
  15755. markAsDirty(): void;
  15756. /** @hidden */
  15757. _markAsDirtyAndCompose(): void;
  15758. private _markAsDirtyAndDecompose;
  15759. /**
  15760. * Translate the bone in local or world space
  15761. * @param vec The amount to translate the bone
  15762. * @param space The space that the translation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the postion of the bone in local or world space
  15768. * @param position The position to set the bone
  15769. * @param space The space that the position is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the absolute position of the bone (world space)
  15775. * @param position The position to set the bone
  15776. * @param mesh The mesh that this bone is attached to
  15777. */
  15778. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15779. /**
  15780. * Scale the bone on the x, y and z axes (in local space)
  15781. * @param x The amount to scale the bone on the x axis
  15782. * @param y The amount to scale the bone on the y axis
  15783. * @param z The amount to scale the bone on the z axis
  15784. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15785. */
  15786. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15787. /**
  15788. * Set the bone scaling in local space
  15789. * @param scale defines the scaling vector
  15790. */
  15791. setScale(scale: Vector3): void;
  15792. /**
  15793. * Gets the current scaling in local space
  15794. * @returns the current scaling vector
  15795. */
  15796. getScale(): Vector3;
  15797. /**
  15798. * Gets the current scaling in local space and stores it in a target vector
  15799. * @param result defines the target vector
  15800. */
  15801. getScaleToRef(result: Vector3): void;
  15802. /**
  15803. * Set the yaw, pitch, and roll of the bone in local or world space
  15804. * @param yaw The rotation of the bone on the y axis
  15805. * @param pitch The rotation of the bone on the x axis
  15806. * @param roll The rotation of the bone on the z axis
  15807. * @param space The space that the axes of rotation are in
  15808. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15809. */
  15810. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15811. /**
  15812. * Add a rotation to the bone on an axis in local or world space
  15813. * @param axis The axis to rotate the bone on
  15814. * @param amount The amount to rotate the bone
  15815. * @param space The space that the axis is in
  15816. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15817. */
  15818. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15819. /**
  15820. * Set the rotation of the bone to a particular axis angle in local or world space
  15821. * @param axis The axis to rotate the bone on
  15822. * @param angle The angle that the bone should be rotated to
  15823. * @param space The space that the axis is in
  15824. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15825. */
  15826. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15827. /**
  15828. * Set the euler rotation of the bone in local or world space
  15829. * @param rotation The euler rotation that the bone should be set to
  15830. * @param space The space that the rotation is in
  15831. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15832. */
  15833. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15834. /**
  15835. * Set the quaternion rotation of the bone in local or world space
  15836. * @param quat The quaternion rotation that the bone should be set to
  15837. * @param space The space that the rotation is in
  15838. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15839. */
  15840. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15841. /**
  15842. * Set the rotation matrix of the bone in local or world space
  15843. * @param rotMat The rotation matrix that the bone should be set to
  15844. * @param space The space that the rotation is in
  15845. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15846. */
  15847. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15848. private _rotateWithMatrix;
  15849. private _getNegativeRotationToRef;
  15850. /**
  15851. * Get the position of the bone in local or world space
  15852. * @param space The space that the returned position is in
  15853. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15854. * @returns The position of the bone
  15855. */
  15856. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15857. /**
  15858. * Copy the position of the bone to a vector3 in local or world space
  15859. * @param space The space that the returned position is in
  15860. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15861. * @param result The vector3 to copy the position to
  15862. */
  15863. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15864. /**
  15865. * Get the absolute position of the bone (world space)
  15866. * @param mesh The mesh that this bone is attached to
  15867. * @returns The absolute position of the bone
  15868. */
  15869. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15870. /**
  15871. * Copy the absolute position of the bone (world space) to the result param
  15872. * @param mesh The mesh that this bone is attached to
  15873. * @param result The vector3 to copy the absolute position to
  15874. */
  15875. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15876. /**
  15877. * Compute the absolute transforms of this bone and its children
  15878. */
  15879. computeAbsoluteTransforms(): void;
  15880. /**
  15881. * Get the world direction from an axis that is in the local space of the bone
  15882. * @param localAxis The local direction that is used to compute the world direction
  15883. * @param mesh The mesh that this bone is attached to
  15884. * @returns The world direction
  15885. */
  15886. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15887. /**
  15888. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15889. * @param localAxis The local direction that is used to compute the world direction
  15890. * @param mesh The mesh that this bone is attached to
  15891. * @param result The vector3 that the world direction will be copied to
  15892. */
  15893. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15894. /**
  15895. * Get the euler rotation of the bone in local or world space
  15896. * @param space The space that the rotation should be in
  15897. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15898. * @returns The euler rotation
  15899. */
  15900. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15901. /**
  15902. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15903. * @param space The space that the rotation should be in
  15904. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15905. * @param result The vector3 that the rotation should be copied to
  15906. */
  15907. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15908. /**
  15909. * Get the quaternion rotation of the bone in either local or world space
  15910. * @param space The space that the rotation should be in
  15911. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15912. * @returns The quaternion rotation
  15913. */
  15914. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15915. /**
  15916. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15917. * @param space The space that the rotation should be in
  15918. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15919. * @param result The quaternion that the rotation should be copied to
  15920. */
  15921. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15922. /**
  15923. * Get the rotation matrix of the bone in local or world space
  15924. * @param space The space that the rotation should be in
  15925. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15926. * @returns The rotation matrix
  15927. */
  15928. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15929. /**
  15930. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15931. * @param space The space that the rotation should be in
  15932. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15933. * @param result The quaternion that the rotation should be copied to
  15934. */
  15935. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15936. /**
  15937. * Get the world position of a point that is in the local space of the bone
  15938. * @param position The local position
  15939. * @param mesh The mesh that this bone is attached to
  15940. * @returns The world position
  15941. */
  15942. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15943. /**
  15944. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15945. * @param position The local position
  15946. * @param mesh The mesh that this bone is attached to
  15947. * @param result The vector3 that the world position should be copied to
  15948. */
  15949. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15950. /**
  15951. * Get the local position of a point that is in world space
  15952. * @param position The world position
  15953. * @param mesh The mesh that this bone is attached to
  15954. * @returns The local position
  15955. */
  15956. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15957. /**
  15958. * Get the local position of a point that is in world space and copy it to the result param
  15959. * @param position The world position
  15960. * @param mesh The mesh that this bone is attached to
  15961. * @param result The vector3 that the local position should be copied to
  15962. */
  15963. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15964. /**
  15965. * Set the current local matrix as the restPose for this bone.
  15966. */
  15967. setCurrentPoseAsRest(): void;
  15968. }
  15969. }
  15970. declare module "babylonjs/Animations/runtimeAnimation" {
  15971. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15972. import { Animatable } from "babylonjs/Animations/animatable";
  15973. import { Scene } from "babylonjs/scene";
  15974. /**
  15975. * Defines a runtime animation
  15976. */
  15977. export class RuntimeAnimation {
  15978. private _events;
  15979. /**
  15980. * The current frame of the runtime animation
  15981. */
  15982. private _currentFrame;
  15983. /**
  15984. * The animation used by the runtime animation
  15985. */
  15986. private _animation;
  15987. /**
  15988. * The target of the runtime animation
  15989. */
  15990. private _target;
  15991. /**
  15992. * The initiating animatable
  15993. */
  15994. private _host;
  15995. /**
  15996. * The original value of the runtime animation
  15997. */
  15998. private _originalValue;
  15999. /**
  16000. * The original blend value of the runtime animation
  16001. */
  16002. private _originalBlendValue;
  16003. /**
  16004. * The offsets cache of the runtime animation
  16005. */
  16006. private _offsetsCache;
  16007. /**
  16008. * The high limits cache of the runtime animation
  16009. */
  16010. private _highLimitsCache;
  16011. /**
  16012. * Specifies if the runtime animation has been stopped
  16013. */
  16014. private _stopped;
  16015. /**
  16016. * The blending factor of the runtime animation
  16017. */
  16018. private _blendingFactor;
  16019. /**
  16020. * The BabylonJS scene
  16021. */
  16022. private _scene;
  16023. /**
  16024. * The current value of the runtime animation
  16025. */
  16026. private _currentValue;
  16027. /** @hidden */
  16028. _animationState: _IAnimationState;
  16029. /**
  16030. * The active target of the runtime animation
  16031. */
  16032. private _activeTargets;
  16033. private _currentActiveTarget;
  16034. private _directTarget;
  16035. /**
  16036. * The target path of the runtime animation
  16037. */
  16038. private _targetPath;
  16039. /**
  16040. * The weight of the runtime animation
  16041. */
  16042. private _weight;
  16043. /**
  16044. * The ratio offset of the runtime animation
  16045. */
  16046. private _ratioOffset;
  16047. /**
  16048. * The previous delay of the runtime animation
  16049. */
  16050. private _previousDelay;
  16051. /**
  16052. * The previous ratio of the runtime animation
  16053. */
  16054. private _previousRatio;
  16055. private _enableBlending;
  16056. private _keys;
  16057. private _minFrame;
  16058. private _maxFrame;
  16059. private _minValue;
  16060. private _maxValue;
  16061. private _targetIsArray;
  16062. /**
  16063. * Gets the current frame of the runtime animation
  16064. */
  16065. get currentFrame(): number;
  16066. /**
  16067. * Gets the weight of the runtime animation
  16068. */
  16069. get weight(): number;
  16070. /**
  16071. * Gets the current value of the runtime animation
  16072. */
  16073. get currentValue(): any;
  16074. /**
  16075. * Gets the target path of the runtime animation
  16076. */
  16077. get targetPath(): string;
  16078. /**
  16079. * Gets the actual target of the runtime animation
  16080. */
  16081. get target(): any;
  16082. /**
  16083. * Gets the additive state of the runtime animation
  16084. */
  16085. get isAdditive(): boolean;
  16086. /** @hidden */
  16087. _onLoop: () => void;
  16088. /**
  16089. * Create a new RuntimeAnimation object
  16090. * @param target defines the target of the animation
  16091. * @param animation defines the source animation object
  16092. * @param scene defines the hosting scene
  16093. * @param host defines the initiating Animatable
  16094. */
  16095. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16096. private _preparePath;
  16097. /**
  16098. * Gets the animation from the runtime animation
  16099. */
  16100. get animation(): Animation;
  16101. /**
  16102. * Resets the runtime animation to the beginning
  16103. * @param restoreOriginal defines whether to restore the target property to the original value
  16104. */
  16105. reset(restoreOriginal?: boolean): void;
  16106. /**
  16107. * Specifies if the runtime animation is stopped
  16108. * @returns Boolean specifying if the runtime animation is stopped
  16109. */
  16110. isStopped(): boolean;
  16111. /**
  16112. * Disposes of the runtime animation
  16113. */
  16114. dispose(): void;
  16115. /**
  16116. * Apply the interpolated value to the target
  16117. * @param currentValue defines the value computed by the animation
  16118. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16119. */
  16120. setValue(currentValue: any, weight: number): void;
  16121. private _getOriginalValues;
  16122. private _setValue;
  16123. /**
  16124. * Gets the loop pmode of the runtime animation
  16125. * @returns Loop Mode
  16126. */
  16127. private _getCorrectLoopMode;
  16128. /**
  16129. * Move the current animation to a given frame
  16130. * @param frame defines the frame to move to
  16131. */
  16132. goToFrame(frame: number): void;
  16133. /**
  16134. * @hidden Internal use only
  16135. */
  16136. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16137. /**
  16138. * Execute the current animation
  16139. * @param delay defines the delay to add to the current frame
  16140. * @param from defines the lower bound of the animation range
  16141. * @param to defines the upper bound of the animation range
  16142. * @param loop defines if the current animation must loop
  16143. * @param speedRatio defines the current speed ratio
  16144. * @param weight defines the weight of the animation (default is -1 so no weight)
  16145. * @param onLoop optional callback called when animation loops
  16146. * @returns a boolean indicating if the animation is running
  16147. */
  16148. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16149. }
  16150. }
  16151. declare module "babylonjs/Animations/animatable" {
  16152. import { Animation } from "babylonjs/Animations/animation";
  16153. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16154. import { Nullable } from "babylonjs/types";
  16155. import { Observable } from "babylonjs/Misc/observable";
  16156. import { Scene } from "babylonjs/scene";
  16157. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16158. import { Node } from "babylonjs/node";
  16159. /**
  16160. * Class used to store an actual running animation
  16161. */
  16162. export class Animatable {
  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;
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined;
  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. private _localDelayOffset;
  16178. private _pausedDelay;
  16179. private _runtimeAnimations;
  16180. private _paused;
  16181. private _scene;
  16182. private _speedRatio;
  16183. private _weight;
  16184. private _syncRoot;
  16185. /**
  16186. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16187. * This will only apply for non looping animation (default is true)
  16188. */
  16189. disposeOnEnd: boolean;
  16190. /**
  16191. * Gets a boolean indicating if the animation has started
  16192. */
  16193. animationStarted: boolean;
  16194. /**
  16195. * Observer raised when the animation ends
  16196. */
  16197. onAnimationEndObservable: Observable<Animatable>;
  16198. /**
  16199. * Observer raised when the animation loops
  16200. */
  16201. onAnimationLoopObservable: Observable<Animatable>;
  16202. /**
  16203. * Gets the root Animatable used to synchronize and normalize animations
  16204. */
  16205. get syncRoot(): Nullable<Animatable>;
  16206. /**
  16207. * Gets the current frame of the first RuntimeAnimation
  16208. * Used to synchronize Animatables
  16209. */
  16210. get masterFrame(): number;
  16211. /**
  16212. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16213. */
  16214. get weight(): number;
  16215. set weight(value: number);
  16216. /**
  16217. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16218. */
  16219. get speedRatio(): number;
  16220. set speedRatio(value: number);
  16221. /**
  16222. * Creates a new Animatable
  16223. * @param scene defines the hosting scene
  16224. * @param target defines the target object
  16225. * @param fromFrame defines the starting frame number (default is 0)
  16226. * @param toFrame defines the ending frame number (default is 100)
  16227. * @param loopAnimation defines if the animation must loop (default is false)
  16228. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16229. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16230. * @param animations defines a group of animation to add to the new Animatable
  16231. * @param onAnimationLoop defines a callback to call when animation loops
  16232. * @param isAdditive defines whether the animation should be evaluated additively
  16233. */
  16234. constructor(scene: Scene,
  16235. /** defines the target object */
  16236. target: any,
  16237. /** defines the starting frame number (default is 0) */
  16238. fromFrame?: number,
  16239. /** defines the ending frame number (default is 100) */
  16240. toFrame?: number,
  16241. /** defines if the animation must loop (default is false) */
  16242. loopAnimation?: boolean, speedRatio?: number,
  16243. /** defines a callback to call when animation ends if it is not looping */
  16244. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16245. /** defines a callback to call when animation loops */
  16246. onAnimationLoop?: (() => void) | null | undefined,
  16247. /** defines whether the animation should be evaluated additively */
  16248. isAdditive?: boolean);
  16249. /**
  16250. * Synchronize and normalize current Animatable with a source Animatable
  16251. * This is useful when using animation weights and when animations are not of the same length
  16252. * @param root defines the root Animatable to synchronize with
  16253. * @returns the current Animatable
  16254. */
  16255. syncWith(root: Animatable): Animatable;
  16256. /**
  16257. * Gets the list of runtime animations
  16258. * @returns an array of RuntimeAnimation
  16259. */
  16260. getAnimations(): RuntimeAnimation[];
  16261. /**
  16262. * Adds more animations to the current animatable
  16263. * @param target defines the target of the animations
  16264. * @param animations defines the new animations to add
  16265. */
  16266. appendAnimations(target: any, animations: Animation[]): void;
  16267. /**
  16268. * Gets the source animation for a specific property
  16269. * @param property defines the propertyu to look for
  16270. * @returns null or the source animation for the given property
  16271. */
  16272. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16273. /**
  16274. * Gets the runtime animation for a specific property
  16275. * @param property defines the propertyu to look for
  16276. * @returns null or the runtime animation for the given property
  16277. */
  16278. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16279. /**
  16280. * Resets the animatable to its original state
  16281. */
  16282. reset(): void;
  16283. /**
  16284. * Allows the animatable to blend with current running animations
  16285. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16286. * @param blendingSpeed defines the blending speed to use
  16287. */
  16288. enableBlending(blendingSpeed: number): void;
  16289. /**
  16290. * Disable animation blending
  16291. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16292. */
  16293. disableBlending(): void;
  16294. /**
  16295. * Jump directly to a given frame
  16296. * @param frame defines the frame to jump to
  16297. */
  16298. goToFrame(frame: number): void;
  16299. /**
  16300. * Pause the animation
  16301. */
  16302. pause(): void;
  16303. /**
  16304. * Restart the animation
  16305. */
  16306. restart(): void;
  16307. private _raiseOnAnimationEnd;
  16308. /**
  16309. * Stop and delete the current animation
  16310. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16311. * @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)
  16312. */
  16313. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16314. /**
  16315. * Wait asynchronously for the animation to end
  16316. * @returns a promise which will be fullfilled when the animation ends
  16317. */
  16318. waitAsync(): Promise<Animatable>;
  16319. /** @hidden */
  16320. _animate(delay: number): boolean;
  16321. }
  16322. module "babylonjs/scene" {
  16323. interface Scene {
  16324. /** @hidden */
  16325. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16326. /** @hidden */
  16327. _processLateAnimationBindingsForMatrices(holder: {
  16328. totalWeight: number;
  16329. totalAdditiveWeight: number;
  16330. animations: RuntimeAnimation[];
  16331. additiveAnimations: RuntimeAnimation[];
  16332. originalValue: Matrix;
  16333. }): any;
  16334. /** @hidden */
  16335. _processLateAnimationBindingsForQuaternions(holder: {
  16336. totalWeight: number;
  16337. totalAdditiveWeight: number;
  16338. animations: RuntimeAnimation[];
  16339. additiveAnimations: RuntimeAnimation[];
  16340. originalValue: Quaternion;
  16341. }, refQuaternion: Quaternion): Quaternion;
  16342. /** @hidden */
  16343. _processLateAnimationBindings(): void;
  16344. /**
  16345. * Will start the animation sequence of a given target
  16346. * @param target defines the target
  16347. * @param from defines from which frame should animation start
  16348. * @param to defines until which frame should animation run.
  16349. * @param weight defines the weight to apply to the animation (1.0 by default)
  16350. * @param loop defines if the animation loops
  16351. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16352. * @param onAnimationEnd defines the function to be executed when the animation ends
  16353. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16354. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16355. * @param onAnimationLoop defines the callback to call when an animation loops
  16356. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16357. * @returns the animatable object created for this animation
  16358. */
  16359. 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;
  16360. /**
  16361. * Will start the animation sequence of a given target
  16362. * @param target defines the target
  16363. * @param from defines from which frame should animation start
  16364. * @param to defines until which frame should animation run.
  16365. * @param loop defines if the animation loops
  16366. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16367. * @param onAnimationEnd defines the function to be executed when the animation ends
  16368. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16369. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16370. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16371. * @param onAnimationLoop defines the callback to call when an animation loops
  16372. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16373. * @returns the animatable object created for this animation
  16374. */
  16375. 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;
  16376. /**
  16377. * Will start the animation sequence of a given target and its hierarchy
  16378. * @param target defines the target
  16379. * @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.
  16380. * @param from defines from which frame should animation start
  16381. * @param to defines until which frame should animation run.
  16382. * @param loop defines if the animation loops
  16383. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16384. * @param onAnimationEnd defines the function to be executed when the animation ends
  16385. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16386. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16387. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16388. * @param onAnimationLoop defines the callback to call when an animation loops
  16389. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16390. * @returns the list of created animatables
  16391. */
  16392. 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[];
  16393. /**
  16394. * Begin a new animation on a given node
  16395. * @param target defines the target where the animation will take place
  16396. * @param animations defines the list of animations to start
  16397. * @param from defines the initial value
  16398. * @param to defines the final value
  16399. * @param loop defines if you want animation to loop (off by default)
  16400. * @param speedRatio defines the speed ratio to apply to all animations
  16401. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16402. * @param onAnimationLoop defines the callback to call when an animation loops
  16403. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16404. * @returns the list of created animatables
  16405. */
  16406. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16407. /**
  16408. * Begin a new animation on a given node and its hierarchy
  16409. * @param target defines the root node where the animation will take place
  16410. * @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.
  16411. * @param animations defines the list of animations to start
  16412. * @param from defines the initial value
  16413. * @param to defines the final value
  16414. * @param loop defines if you want animation to loop (off by default)
  16415. * @param speedRatio defines the speed ratio to apply to all animations
  16416. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16417. * @param onAnimationLoop defines the callback to call when an animation loops
  16418. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16419. * @returns the list of animatables created for all nodes
  16420. */
  16421. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16422. /**
  16423. * Gets the animatable associated with a specific target
  16424. * @param target defines the target of the animatable
  16425. * @returns the required animatable if found
  16426. */
  16427. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16428. /**
  16429. * Gets all animatables associated with a given target
  16430. * @param target defines the target to look animatables for
  16431. * @returns an array of Animatables
  16432. */
  16433. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16434. /**
  16435. * Stops and removes all animations that have been applied to the scene
  16436. */
  16437. stopAllAnimations(): void;
  16438. /**
  16439. * Gets the current delta time used by animation engine
  16440. */
  16441. deltaTime: number;
  16442. }
  16443. }
  16444. module "babylonjs/Bones/bone" {
  16445. interface Bone {
  16446. /**
  16447. * Copy an animation range from another bone
  16448. * @param source defines the source bone
  16449. * @param rangeName defines the range name to copy
  16450. * @param frameOffset defines the frame offset
  16451. * @param rescaleAsRequired defines if rescaling must be applied if required
  16452. * @param skelDimensionsRatio defines the scaling ratio
  16453. * @returns true if operation was successful
  16454. */
  16455. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16456. }
  16457. }
  16458. }
  16459. declare module "babylonjs/Bones/skeleton" {
  16460. import { Bone } from "babylonjs/Bones/bone";
  16461. import { Observable } from "babylonjs/Misc/observable";
  16462. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16463. import { Scene } from "babylonjs/scene";
  16464. import { Nullable } from "babylonjs/types";
  16465. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16466. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16467. import { Animatable } from "babylonjs/Animations/animatable";
  16468. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16469. import { Animation } from "babylonjs/Animations/animation";
  16470. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16471. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16472. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16473. /**
  16474. * Class used to handle skinning animations
  16475. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16476. */
  16477. export class Skeleton implements IAnimatable {
  16478. /** defines the skeleton name */
  16479. name: string;
  16480. /** defines the skeleton Id */
  16481. id: string;
  16482. /**
  16483. * Defines the list of child bones
  16484. */
  16485. bones: Bone[];
  16486. /**
  16487. * Defines an estimate of the dimension of the skeleton at rest
  16488. */
  16489. dimensionsAtRest: Vector3;
  16490. /**
  16491. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16492. */
  16493. needInitialSkinMatrix: boolean;
  16494. /**
  16495. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16496. */
  16497. overrideMesh: Nullable<AbstractMesh>;
  16498. /**
  16499. * Gets the list of animations attached to this skeleton
  16500. */
  16501. animations: Array<Animation>;
  16502. private _scene;
  16503. private _isDirty;
  16504. private _transformMatrices;
  16505. private _transformMatrixTexture;
  16506. private _meshesWithPoseMatrix;
  16507. private _animatables;
  16508. private _identity;
  16509. private _synchronizedWithMesh;
  16510. private _ranges;
  16511. private _lastAbsoluteTransformsUpdateId;
  16512. private _canUseTextureForBones;
  16513. private _uniqueId;
  16514. /** @hidden */
  16515. _numBonesWithLinkedTransformNode: number;
  16516. /** @hidden */
  16517. _hasWaitingData: Nullable<boolean>;
  16518. /** @hidden */
  16519. _waitingOverrideMeshId: Nullable<string>;
  16520. /**
  16521. * Specifies if the skeleton should be serialized
  16522. */
  16523. doNotSerialize: boolean;
  16524. private _useTextureToStoreBoneMatrices;
  16525. /**
  16526. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16527. * Please note that this option is not available if the hardware does not support it
  16528. */
  16529. get useTextureToStoreBoneMatrices(): boolean;
  16530. set useTextureToStoreBoneMatrices(value: boolean);
  16531. private _animationPropertiesOverride;
  16532. /**
  16533. * Gets or sets the animation properties override
  16534. */
  16535. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16536. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16537. /**
  16538. * List of inspectable custom properties (used by the Inspector)
  16539. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16540. */
  16541. inspectableCustomProperties: IInspectable[];
  16542. /**
  16543. * An observable triggered before computing the skeleton's matrices
  16544. */
  16545. onBeforeComputeObservable: Observable<Skeleton>;
  16546. /**
  16547. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16548. */
  16549. get isUsingTextureForMatrices(): boolean;
  16550. /**
  16551. * Gets the unique ID of this skeleton
  16552. */
  16553. get uniqueId(): number;
  16554. /**
  16555. * Creates a new skeleton
  16556. * @param name defines the skeleton name
  16557. * @param id defines the skeleton Id
  16558. * @param scene defines the hosting scene
  16559. */
  16560. constructor(
  16561. /** defines the skeleton name */
  16562. name: string,
  16563. /** defines the skeleton Id */
  16564. id: string, scene: Scene);
  16565. /**
  16566. * Gets the current object class name.
  16567. * @return the class name
  16568. */
  16569. getClassName(): string;
  16570. /**
  16571. * Returns an array containing the root bones
  16572. * @returns an array containing the root bones
  16573. */
  16574. getChildren(): Array<Bone>;
  16575. /**
  16576. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16577. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16578. * @returns a Float32Array containing matrices data
  16579. */
  16580. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16581. /**
  16582. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16583. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16584. * @returns a raw texture containing the data
  16585. */
  16586. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16587. /**
  16588. * Gets the current hosting scene
  16589. * @returns a scene object
  16590. */
  16591. getScene(): Scene;
  16592. /**
  16593. * Gets a string representing the current skeleton data
  16594. * @param fullDetails defines a boolean indicating if we want a verbose version
  16595. * @returns a string representing the current skeleton data
  16596. */
  16597. toString(fullDetails?: boolean): string;
  16598. /**
  16599. * Get bone's index searching by name
  16600. * @param name defines bone's name to search for
  16601. * @return the indice of the bone. Returns -1 if not found
  16602. */
  16603. getBoneIndexByName(name: string): number;
  16604. /**
  16605. * Creater a new animation range
  16606. * @param name defines the name of the range
  16607. * @param from defines the start key
  16608. * @param to defines the end key
  16609. */
  16610. createAnimationRange(name: string, from: number, to: number): void;
  16611. /**
  16612. * Delete a specific animation range
  16613. * @param name defines the name of the range
  16614. * @param deleteFrames defines if frames must be removed as well
  16615. */
  16616. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16617. /**
  16618. * Gets a specific animation range
  16619. * @param name defines the name of the range to look for
  16620. * @returns the requested animation range or null if not found
  16621. */
  16622. getAnimationRange(name: string): Nullable<AnimationRange>;
  16623. /**
  16624. * Gets the list of all animation ranges defined on this skeleton
  16625. * @returns an array
  16626. */
  16627. getAnimationRanges(): Nullable<AnimationRange>[];
  16628. /**
  16629. * Copy animation range from a source skeleton.
  16630. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16631. * @param source defines the source skeleton
  16632. * @param name defines the name of the range to copy
  16633. * @param rescaleAsRequired defines if rescaling must be applied if required
  16634. * @returns true if operation was successful
  16635. */
  16636. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16637. /**
  16638. * Forces the skeleton to go to rest pose
  16639. */
  16640. returnToRest(): void;
  16641. private _getHighestAnimationFrame;
  16642. /**
  16643. * Begin a specific animation range
  16644. * @param name defines the name of the range to start
  16645. * @param loop defines if looping must be turned on (false by default)
  16646. * @param speedRatio defines the speed ratio to apply (1 by default)
  16647. * @param onAnimationEnd defines a callback which will be called when animation will end
  16648. * @returns a new animatable
  16649. */
  16650. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16651. /**
  16652. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16653. * @param skeleton defines the Skeleton containing the animation range to convert
  16654. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16655. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16656. * @returns the original skeleton
  16657. */
  16658. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16659. /** @hidden */
  16660. _markAsDirty(): void;
  16661. /** @hidden */
  16662. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16663. /** @hidden */
  16664. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16665. private _computeTransformMatrices;
  16666. /**
  16667. * Build all resources required to render a skeleton
  16668. */
  16669. prepare(): void;
  16670. /**
  16671. * Gets the list of animatables currently running for this skeleton
  16672. * @returns an array of animatables
  16673. */
  16674. getAnimatables(): IAnimatable[];
  16675. /**
  16676. * Clone the current skeleton
  16677. * @param name defines the name of the new skeleton
  16678. * @param id defines the id of the new skeleton
  16679. * @returns the new skeleton
  16680. */
  16681. clone(name: string, id?: string): Skeleton;
  16682. /**
  16683. * Enable animation blending for this skeleton
  16684. * @param blendingSpeed defines the blending speed to apply
  16685. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16686. */
  16687. enableBlending(blendingSpeed?: number): void;
  16688. /**
  16689. * Releases all resources associated with the current skeleton
  16690. */
  16691. dispose(): void;
  16692. /**
  16693. * Serialize the skeleton in a JSON object
  16694. * @returns a JSON object
  16695. */
  16696. serialize(): any;
  16697. /**
  16698. * Creates a new skeleton from serialized data
  16699. * @param parsedSkeleton defines the serialized data
  16700. * @param scene defines the hosting scene
  16701. * @returns a new skeleton
  16702. */
  16703. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16704. /**
  16705. * Compute all node absolute transforms
  16706. * @param forceUpdate defines if computation must be done even if cache is up to date
  16707. */
  16708. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16709. /**
  16710. * Gets the root pose matrix
  16711. * @returns a matrix
  16712. */
  16713. getPoseMatrix(): Nullable<Matrix>;
  16714. /**
  16715. * Sorts bones per internal index
  16716. */
  16717. sortBones(): void;
  16718. private _sortBones;
  16719. /**
  16720. * Set the current local matrix as the restPose for all bones in the skeleton.
  16721. */
  16722. setCurrentPoseAsRest(): void;
  16723. }
  16724. }
  16725. declare module "babylonjs/Meshes/instancedMesh" {
  16726. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16727. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16728. import { Camera } from "babylonjs/Cameras/camera";
  16729. import { Node } from "babylonjs/node";
  16730. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16731. import { Mesh } from "babylonjs/Meshes/mesh";
  16732. import { Material } from "babylonjs/Materials/material";
  16733. import { Skeleton } from "babylonjs/Bones/skeleton";
  16734. import { Light } from "babylonjs/Lights/light";
  16735. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16736. /**
  16737. * Creates an instance based on a source mesh.
  16738. */
  16739. export class InstancedMesh extends AbstractMesh {
  16740. private _sourceMesh;
  16741. private _currentLOD;
  16742. /** @hidden */
  16743. _indexInSourceMeshInstanceArray: number;
  16744. constructor(name: string, source: Mesh);
  16745. /**
  16746. * Returns the string "InstancedMesh".
  16747. */
  16748. getClassName(): string;
  16749. /** Gets the list of lights affecting that mesh */
  16750. get lightSources(): Light[];
  16751. _resyncLightSources(): void;
  16752. _resyncLightSource(light: Light): void;
  16753. _removeLightSource(light: Light, dispose: boolean): void;
  16754. /**
  16755. * If the source mesh receives shadows
  16756. */
  16757. get receiveShadows(): boolean;
  16758. /**
  16759. * The material of the source mesh
  16760. */
  16761. get material(): Nullable<Material>;
  16762. /**
  16763. * Visibility of the source mesh
  16764. */
  16765. get visibility(): number;
  16766. /**
  16767. * Skeleton of the source mesh
  16768. */
  16769. get skeleton(): Nullable<Skeleton>;
  16770. /**
  16771. * Rendering ground id of the source mesh
  16772. */
  16773. get renderingGroupId(): number;
  16774. set renderingGroupId(value: number);
  16775. /**
  16776. * Returns the total number of vertices (integer).
  16777. */
  16778. getTotalVertices(): number;
  16779. /**
  16780. * Returns a positive integer : the total number of indices in this mesh geometry.
  16781. * @returns the numner of indices or zero if the mesh has no geometry.
  16782. */
  16783. getTotalIndices(): number;
  16784. /**
  16785. * The source mesh of the instance
  16786. */
  16787. get sourceMesh(): Mesh;
  16788. /**
  16789. * Creates a new InstancedMesh object from the mesh model.
  16790. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16791. * @param name defines the name of the new instance
  16792. * @returns a new InstancedMesh
  16793. */
  16794. createInstance(name: string): InstancedMesh;
  16795. /**
  16796. * Is this node ready to be used/rendered
  16797. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16798. * @return {boolean} is it ready
  16799. */
  16800. isReady(completeCheck?: boolean): boolean;
  16801. /**
  16802. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16803. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16804. * @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.
  16805. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16806. */
  16807. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16808. /**
  16809. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16810. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16811. * The `data` are either a numeric array either a Float32Array.
  16812. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16813. * 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).
  16814. * Note that a new underlying VertexBuffer object is created each call.
  16815. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16816. *
  16817. * Possible `kind` values :
  16818. * - VertexBuffer.PositionKind
  16819. * - VertexBuffer.UVKind
  16820. * - VertexBuffer.UV2Kind
  16821. * - VertexBuffer.UV3Kind
  16822. * - VertexBuffer.UV4Kind
  16823. * - VertexBuffer.UV5Kind
  16824. * - VertexBuffer.UV6Kind
  16825. * - VertexBuffer.ColorKind
  16826. * - VertexBuffer.MatricesIndicesKind
  16827. * - VertexBuffer.MatricesIndicesExtraKind
  16828. * - VertexBuffer.MatricesWeightsKind
  16829. * - VertexBuffer.MatricesWeightsExtraKind
  16830. *
  16831. * Returns the Mesh.
  16832. */
  16833. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16834. /**
  16835. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16836. * If the mesh has no geometry, it is simply returned as it is.
  16837. * The `data` are either a numeric array either a Float32Array.
  16838. * No new underlying VertexBuffer object is created.
  16839. * 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.
  16840. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16841. *
  16842. * Possible `kind` values :
  16843. * - VertexBuffer.PositionKind
  16844. * - VertexBuffer.UVKind
  16845. * - VertexBuffer.UV2Kind
  16846. * - VertexBuffer.UV3Kind
  16847. * - VertexBuffer.UV4Kind
  16848. * - VertexBuffer.UV5Kind
  16849. * - VertexBuffer.UV6Kind
  16850. * - VertexBuffer.ColorKind
  16851. * - VertexBuffer.MatricesIndicesKind
  16852. * - VertexBuffer.MatricesIndicesExtraKind
  16853. * - VertexBuffer.MatricesWeightsKind
  16854. * - VertexBuffer.MatricesWeightsExtraKind
  16855. *
  16856. * Returns the Mesh.
  16857. */
  16858. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16859. /**
  16860. * Sets the mesh indices.
  16861. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16862. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16863. * This method creates a new index buffer each call.
  16864. * Returns the Mesh.
  16865. */
  16866. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16867. /**
  16868. * Boolean : True if the mesh owns the requested kind of data.
  16869. */
  16870. isVerticesDataPresent(kind: string): boolean;
  16871. /**
  16872. * Returns an array of indices (IndicesArray).
  16873. */
  16874. getIndices(): Nullable<IndicesArray>;
  16875. get _positions(): Nullable<Vector3[]>;
  16876. /**
  16877. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16878. * This means the mesh underlying bounding box and sphere are recomputed.
  16879. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16880. * @returns the current mesh
  16881. */
  16882. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16883. /** @hidden */
  16884. _preActivate(): InstancedMesh;
  16885. /** @hidden */
  16886. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16887. /** @hidden */
  16888. _postActivate(): void;
  16889. getWorldMatrix(): Matrix;
  16890. get isAnInstance(): boolean;
  16891. /**
  16892. * Returns the current associated LOD AbstractMesh.
  16893. */
  16894. getLOD(camera: Camera): AbstractMesh;
  16895. /** @hidden */
  16896. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16897. /** @hidden */
  16898. _syncSubMeshes(): InstancedMesh;
  16899. /** @hidden */
  16900. _generatePointsArray(): boolean;
  16901. /** @hidden */
  16902. _updateBoundingInfo(): AbstractMesh;
  16903. /**
  16904. * Creates a new InstancedMesh from the current mesh.
  16905. * - name (string) : the cloned mesh name
  16906. * - newParent (optional Node) : the optional Node to parent the clone to.
  16907. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16908. *
  16909. * Returns the clone.
  16910. */
  16911. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16912. /**
  16913. * Disposes the InstancedMesh.
  16914. * Returns nothing.
  16915. */
  16916. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16917. }
  16918. module "babylonjs/Meshes/mesh" {
  16919. interface Mesh {
  16920. /**
  16921. * Register a custom buffer that will be instanced
  16922. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16923. * @param kind defines the buffer kind
  16924. * @param stride defines the stride in floats
  16925. */
  16926. registerInstancedBuffer(kind: string, stride: number): void;
  16927. /**
  16928. * true to use the edge renderer for all instances of this mesh
  16929. */
  16930. edgesShareWithInstances: boolean;
  16931. /** @hidden */
  16932. _userInstancedBuffersStorage: {
  16933. data: {
  16934. [key: string]: Float32Array;
  16935. };
  16936. sizes: {
  16937. [key: string]: number;
  16938. };
  16939. vertexBuffers: {
  16940. [key: string]: Nullable<VertexBuffer>;
  16941. };
  16942. strides: {
  16943. [key: string]: number;
  16944. };
  16945. };
  16946. }
  16947. }
  16948. module "babylonjs/Meshes/abstractMesh" {
  16949. interface AbstractMesh {
  16950. /**
  16951. * Object used to store instanced buffers defined by user
  16952. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16953. */
  16954. instancedBuffers: {
  16955. [key: string]: any;
  16956. };
  16957. }
  16958. }
  16959. }
  16960. declare module "babylonjs/Materials/shaderMaterial" {
  16961. import { Nullable } from "babylonjs/types";
  16962. import { Scene } from "babylonjs/scene";
  16963. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16964. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16965. import { Mesh } from "babylonjs/Meshes/mesh";
  16966. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16967. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16968. import { Effect } from "babylonjs/Materials/effect";
  16969. import { Material } from "babylonjs/Materials/material";
  16970. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16971. /**
  16972. * Defines the options associated with the creation of a shader material.
  16973. */
  16974. export interface IShaderMaterialOptions {
  16975. /**
  16976. * Does the material work in alpha blend mode
  16977. */
  16978. needAlphaBlending: boolean;
  16979. /**
  16980. * Does the material work in alpha test mode
  16981. */
  16982. needAlphaTesting: boolean;
  16983. /**
  16984. * The list of attribute names used in the shader
  16985. */
  16986. attributes: string[];
  16987. /**
  16988. * The list of unifrom names used in the shader
  16989. */
  16990. uniforms: string[];
  16991. /**
  16992. * The list of UBO names used in the shader
  16993. */
  16994. uniformBuffers: string[];
  16995. /**
  16996. * The list of sampler names used in the shader
  16997. */
  16998. samplers: string[];
  16999. /**
  17000. * The list of defines used in the shader
  17001. */
  17002. defines: string[];
  17003. }
  17004. /**
  17005. * 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.
  17006. *
  17007. * This returned material effects how the mesh will look based on the code in the shaders.
  17008. *
  17009. * @see https://doc.babylonjs.com/how_to/shader_material
  17010. */
  17011. export class ShaderMaterial extends Material {
  17012. private _shaderPath;
  17013. private _options;
  17014. private _textures;
  17015. private _textureArrays;
  17016. private _floats;
  17017. private _ints;
  17018. private _floatsArrays;
  17019. private _colors3;
  17020. private _colors3Arrays;
  17021. private _colors4;
  17022. private _colors4Arrays;
  17023. private _vectors2;
  17024. private _vectors3;
  17025. private _vectors4;
  17026. private _matrices;
  17027. private _matrixArrays;
  17028. private _matrices3x3;
  17029. private _matrices2x2;
  17030. private _vectors2Arrays;
  17031. private _vectors3Arrays;
  17032. private _vectors4Arrays;
  17033. private _cachedWorldViewMatrix;
  17034. private _cachedWorldViewProjectionMatrix;
  17035. private _renderId;
  17036. private _multiview;
  17037. private _cachedDefines;
  17038. /** Define the Url to load snippets */
  17039. static SnippetUrl: string;
  17040. /** Snippet ID if the material was created from the snippet server */
  17041. snippetId: string;
  17042. /**
  17043. * Instantiate a new shader material.
  17044. * 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.
  17045. * This returned material effects how the mesh will look based on the code in the shaders.
  17046. * @see https://doc.babylonjs.com/how_to/shader_material
  17047. * @param name Define the name of the material in the scene
  17048. * @param scene Define the scene the material belongs to
  17049. * @param shaderPath Defines the route to the shader code in one of three ways:
  17050. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  17051. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  17052. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  17053. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  17054. * @param options Define the options used to create the shader
  17055. */
  17056. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  17057. /**
  17058. * Gets the shader path used to define the shader code
  17059. * It can be modified to trigger a new compilation
  17060. */
  17061. get shaderPath(): any;
  17062. /**
  17063. * Sets the shader path used to define the shader code
  17064. * It can be modified to trigger a new compilation
  17065. */
  17066. set shaderPath(shaderPath: any);
  17067. /**
  17068. * Gets the options used to compile the shader.
  17069. * They can be modified to trigger a new compilation
  17070. */
  17071. get options(): IShaderMaterialOptions;
  17072. /**
  17073. * Gets the current class name of the material e.g. "ShaderMaterial"
  17074. * Mainly use in serialization.
  17075. * @returns the class name
  17076. */
  17077. getClassName(): string;
  17078. /**
  17079. * Specifies if the material will require alpha blending
  17080. * @returns a boolean specifying if alpha blending is needed
  17081. */
  17082. needAlphaBlending(): boolean;
  17083. /**
  17084. * Specifies if this material should be rendered in alpha test mode
  17085. * @returns a boolean specifying if an alpha test is needed.
  17086. */
  17087. needAlphaTesting(): boolean;
  17088. private _checkUniform;
  17089. /**
  17090. * Set a texture in the shader.
  17091. * @param name Define the name of the uniform samplers as defined in the shader
  17092. * @param texture Define the texture to bind to this sampler
  17093. * @return the material itself allowing "fluent" like uniform updates
  17094. */
  17095. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17096. /**
  17097. * Set a texture array in the shader.
  17098. * @param name Define the name of the uniform sampler array as defined in the shader
  17099. * @param textures Define the list of textures to bind to this sampler
  17100. * @return the material itself allowing "fluent" like uniform updates
  17101. */
  17102. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17103. /**
  17104. * Set a float in the shader.
  17105. * @param name Define the name of the uniform as defined in the shader
  17106. * @param value Define the value to give to the uniform
  17107. * @return the material itself allowing "fluent" like uniform updates
  17108. */
  17109. setFloat(name: string, value: number): ShaderMaterial;
  17110. /**
  17111. * Set a int in the shader.
  17112. * @param name Define the name of the uniform as defined in the shader
  17113. * @param value Define the value to give to the uniform
  17114. * @return the material itself allowing "fluent" like uniform updates
  17115. */
  17116. setInt(name: string, value: number): ShaderMaterial;
  17117. /**
  17118. * Set an array of floats in the shader.
  17119. * @param name Define the name of the uniform as defined in the shader
  17120. * @param value Define the value to give to the uniform
  17121. * @return the material itself allowing "fluent" like uniform updates
  17122. */
  17123. setFloats(name: string, value: number[]): ShaderMaterial;
  17124. /**
  17125. * Set a vec3 in the shader from a Color3.
  17126. * @param name Define the name of the uniform as defined in the shader
  17127. * @param value Define the value to give to the uniform
  17128. * @return the material itself allowing "fluent" like uniform updates
  17129. */
  17130. setColor3(name: string, value: Color3): ShaderMaterial;
  17131. /**
  17132. * Set a vec3 array in the shader from a Color3 array.
  17133. * @param name Define the name of the uniform as defined in the shader
  17134. * @param value Define the value to give to the uniform
  17135. * @return the material itself allowing "fluent" like uniform updates
  17136. */
  17137. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17138. /**
  17139. * Set a vec4 in the shader from a Color4.
  17140. * @param name Define the name of the uniform as defined in the shader
  17141. * @param value Define the value to give to the uniform
  17142. * @return the material itself allowing "fluent" like uniform updates
  17143. */
  17144. setColor4(name: string, value: Color4): ShaderMaterial;
  17145. /**
  17146. * Set a vec4 array in the shader from a Color4 array.
  17147. * @param name Define the name of the uniform as defined in the shader
  17148. * @param value Define the value to give to the uniform
  17149. * @return the material itself allowing "fluent" like uniform updates
  17150. */
  17151. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17152. /**
  17153. * Set a vec2 in the shader from a Vector2.
  17154. * @param name Define the name of the uniform as defined in the shader
  17155. * @param value Define the value to give to the uniform
  17156. * @return the material itself allowing "fluent" like uniform updates
  17157. */
  17158. setVector2(name: string, value: Vector2): ShaderMaterial;
  17159. /**
  17160. * Set a vec3 in the shader from a Vector3.
  17161. * @param name Define the name of the uniform as defined in the shader
  17162. * @param value Define the value to give to the uniform
  17163. * @return the material itself allowing "fluent" like uniform updates
  17164. */
  17165. setVector3(name: string, value: Vector3): ShaderMaterial;
  17166. /**
  17167. * Set a vec4 in the shader from a Vector4.
  17168. * @param name Define the name of the uniform as defined in the shader
  17169. * @param value Define the value to give to the uniform
  17170. * @return the material itself allowing "fluent" like uniform updates
  17171. */
  17172. setVector4(name: string, value: Vector4): ShaderMaterial;
  17173. /**
  17174. * Set a mat4 in the shader from a Matrix.
  17175. * @param name Define the name of the uniform as defined in the shader
  17176. * @param value Define the value to give to the uniform
  17177. * @return the material itself allowing "fluent" like uniform updates
  17178. */
  17179. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17180. /**
  17181. * Set a float32Array in the shader from a matrix array.
  17182. * @param name Define the name of the uniform as defined in the shader
  17183. * @param value Define the value to give to the uniform
  17184. * @return the material itself allowing "fluent" like uniform updates
  17185. */
  17186. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17187. /**
  17188. * Set a mat3 in the shader from a Float32Array.
  17189. * @param name Define the name of the uniform as defined in the shader
  17190. * @param value Define the value to give to the uniform
  17191. * @return the material itself allowing "fluent" like uniform updates
  17192. */
  17193. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17194. /**
  17195. * Set a mat2 in the shader from a Float32Array.
  17196. * @param name Define the name of the uniform as defined in the shader
  17197. * @param value Define the value to give to the uniform
  17198. * @return the material itself allowing "fluent" like uniform updates
  17199. */
  17200. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17201. /**
  17202. * Set a vec2 array in the shader from a number array.
  17203. * @param name Define the name of the uniform as defined in the shader
  17204. * @param value Define the value to give to the uniform
  17205. * @return the material itself allowing "fluent" like uniform updates
  17206. */
  17207. setArray2(name: string, value: number[]): ShaderMaterial;
  17208. /**
  17209. * Set a vec3 array in the shader from a number array.
  17210. * @param name Define the name of the uniform as defined in the shader
  17211. * @param value Define the value to give to the uniform
  17212. * @return the material itself allowing "fluent" like uniform updates
  17213. */
  17214. setArray3(name: string, value: number[]): ShaderMaterial;
  17215. /**
  17216. * Set a vec4 array in the shader from a number array.
  17217. * @param name Define the name of the uniform as defined in the shader
  17218. * @param value Define the value to give to the uniform
  17219. * @return the material itself allowing "fluent" like uniform updates
  17220. */
  17221. setArray4(name: string, value: number[]): ShaderMaterial;
  17222. private _checkCache;
  17223. /**
  17224. * Specifies that the submesh is ready to be used
  17225. * @param mesh defines the mesh to check
  17226. * @param subMesh defines which submesh to check
  17227. * @param useInstances specifies that instances should be used
  17228. * @returns a boolean indicating that the submesh is ready or not
  17229. */
  17230. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17231. /**
  17232. * Checks if the material is ready to render the requested mesh
  17233. * @param mesh Define the mesh to render
  17234. * @param useInstances Define whether or not the material is used with instances
  17235. * @returns true if ready, otherwise false
  17236. */
  17237. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17238. /**
  17239. * Binds the world matrix to the material
  17240. * @param world defines the world transformation matrix
  17241. * @param effectOverride - If provided, use this effect instead of internal effect
  17242. */
  17243. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17244. /**
  17245. * Binds the submesh to this material by preparing the effect and shader to draw
  17246. * @param world defines the world transformation matrix
  17247. * @param mesh defines the mesh containing the submesh
  17248. * @param subMesh defines the submesh to bind the material to
  17249. */
  17250. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17251. /**
  17252. * Binds the material to the mesh
  17253. * @param world defines the world transformation matrix
  17254. * @param mesh defines the mesh to bind the material to
  17255. * @param effectOverride - If provided, use this effect instead of internal effect
  17256. */
  17257. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17258. protected _afterBind(mesh?: Mesh): void;
  17259. /**
  17260. * Gets the active textures from the material
  17261. * @returns an array of textures
  17262. */
  17263. getActiveTextures(): BaseTexture[];
  17264. /**
  17265. * Specifies if the material uses a texture
  17266. * @param texture defines the texture to check against the material
  17267. * @returns a boolean specifying if the material uses the texture
  17268. */
  17269. hasTexture(texture: BaseTexture): boolean;
  17270. /**
  17271. * Makes a duplicate of the material, and gives it a new name
  17272. * @param name defines the new name for the duplicated material
  17273. * @returns the cloned material
  17274. */
  17275. clone(name: string): ShaderMaterial;
  17276. /**
  17277. * Disposes the material
  17278. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17279. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17280. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17281. */
  17282. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17283. /**
  17284. * Serializes this material in a JSON representation
  17285. * @returns the serialized material object
  17286. */
  17287. serialize(): any;
  17288. /**
  17289. * Creates a shader material from parsed shader material data
  17290. * @param source defines the JSON represnetation of the material
  17291. * @param scene defines the hosting scene
  17292. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17293. * @returns a new material
  17294. */
  17295. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17296. /**
  17297. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17298. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17299. * @param url defines the url to load from
  17300. * @param scene defines the hosting scene
  17301. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17302. * @returns a promise that will resolve to the new ShaderMaterial
  17303. */
  17304. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17305. /**
  17306. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17307. * @param snippetId defines the snippet to load
  17308. * @param scene defines the hosting scene
  17309. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17310. * @returns a promise that will resolve to the new ShaderMaterial
  17311. */
  17312. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17313. }
  17314. }
  17315. declare module "babylonjs/Shaders/color.fragment" {
  17316. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17317. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17318. /** @hidden */
  17319. export var colorPixelShader: {
  17320. name: string;
  17321. shader: string;
  17322. };
  17323. }
  17324. declare module "babylonjs/Shaders/color.vertex" {
  17325. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17326. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17327. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17328. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17329. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17330. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17331. /** @hidden */
  17332. export var colorVertexShader: {
  17333. name: string;
  17334. shader: string;
  17335. };
  17336. }
  17337. declare module "babylonjs/Meshes/linesMesh" {
  17338. import { Nullable } from "babylonjs/types";
  17339. import { Scene } from "babylonjs/scene";
  17340. import { Color3 } from "babylonjs/Maths/math.color";
  17341. import { Node } from "babylonjs/node";
  17342. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17343. import { Mesh } from "babylonjs/Meshes/mesh";
  17344. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17345. import { Effect } from "babylonjs/Materials/effect";
  17346. import { Material } from "babylonjs/Materials/material";
  17347. import "babylonjs/Shaders/color.fragment";
  17348. import "babylonjs/Shaders/color.vertex";
  17349. /**
  17350. * Line mesh
  17351. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17352. */
  17353. export class LinesMesh extends Mesh {
  17354. /**
  17355. * If vertex color should be applied to the mesh
  17356. */
  17357. readonly useVertexColor?: boolean | undefined;
  17358. /**
  17359. * If vertex alpha should be applied to the mesh
  17360. */
  17361. readonly useVertexAlpha?: boolean | undefined;
  17362. /**
  17363. * Color of the line (Default: White)
  17364. */
  17365. color: Color3;
  17366. /**
  17367. * Alpha of the line (Default: 1)
  17368. */
  17369. alpha: number;
  17370. /**
  17371. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17372. * This margin is expressed in world space coordinates, so its value may vary.
  17373. * Default value is 0.1
  17374. */
  17375. intersectionThreshold: number;
  17376. private _colorShader;
  17377. private color4;
  17378. /**
  17379. * Creates a new LinesMesh
  17380. * @param name defines the name
  17381. * @param scene defines the hosting scene
  17382. * @param parent defines the parent mesh if any
  17383. * @param source defines the optional source LinesMesh used to clone data from
  17384. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17385. * When false, achieved by calling a clone(), also passing False.
  17386. * This will make creation of children, recursive.
  17387. * @param useVertexColor defines if this LinesMesh supports vertex color
  17388. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17389. */
  17390. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17391. /**
  17392. * If vertex color should be applied to the mesh
  17393. */
  17394. useVertexColor?: boolean | undefined,
  17395. /**
  17396. * If vertex alpha should be applied to the mesh
  17397. */
  17398. useVertexAlpha?: boolean | undefined);
  17399. private _addClipPlaneDefine;
  17400. private _removeClipPlaneDefine;
  17401. isReady(): boolean;
  17402. /**
  17403. * Returns the string "LineMesh"
  17404. */
  17405. getClassName(): string;
  17406. /**
  17407. * @hidden
  17408. */
  17409. get material(): Material;
  17410. /**
  17411. * @hidden
  17412. */
  17413. set material(value: Material);
  17414. /**
  17415. * @hidden
  17416. */
  17417. get checkCollisions(): boolean;
  17418. /** @hidden */
  17419. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17420. /** @hidden */
  17421. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17422. /**
  17423. * Disposes of the line mesh
  17424. * @param doNotRecurse If children should be disposed
  17425. */
  17426. dispose(doNotRecurse?: boolean): void;
  17427. /**
  17428. * Returns a new LineMesh object cloned from the current one.
  17429. */
  17430. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17431. /**
  17432. * Creates a new InstancedLinesMesh object from the mesh model.
  17433. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17434. * @param name defines the name of the new instance
  17435. * @returns a new InstancedLinesMesh
  17436. */
  17437. createInstance(name: string): InstancedLinesMesh;
  17438. }
  17439. /**
  17440. * Creates an instance based on a source LinesMesh
  17441. */
  17442. export class InstancedLinesMesh extends InstancedMesh {
  17443. /**
  17444. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17445. * This margin is expressed in world space coordinates, so its value may vary.
  17446. * Initilized with the intersectionThreshold value of the source LinesMesh
  17447. */
  17448. intersectionThreshold: number;
  17449. constructor(name: string, source: LinesMesh);
  17450. /**
  17451. * Returns the string "InstancedLinesMesh".
  17452. */
  17453. getClassName(): string;
  17454. }
  17455. }
  17456. declare module "babylonjs/Shaders/line.fragment" {
  17457. /** @hidden */
  17458. export var linePixelShader: {
  17459. name: string;
  17460. shader: string;
  17461. };
  17462. }
  17463. declare module "babylonjs/Shaders/line.vertex" {
  17464. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17465. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17466. /** @hidden */
  17467. export var lineVertexShader: {
  17468. name: string;
  17469. shader: string;
  17470. };
  17471. }
  17472. declare module "babylonjs/Rendering/edgesRenderer" {
  17473. import { Nullable } from "babylonjs/types";
  17474. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17475. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17476. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17477. import { IDisposable } from "babylonjs/scene";
  17478. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17479. import "babylonjs/Shaders/line.fragment";
  17480. import "babylonjs/Shaders/line.vertex";
  17481. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17482. import { SmartArray } from "babylonjs/Misc/smartArray";
  17483. module "babylonjs/scene" {
  17484. interface Scene {
  17485. /** @hidden */
  17486. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17487. }
  17488. }
  17489. module "babylonjs/Meshes/abstractMesh" {
  17490. interface AbstractMesh {
  17491. /**
  17492. * Gets the edgesRenderer associated with the mesh
  17493. */
  17494. edgesRenderer: Nullable<EdgesRenderer>;
  17495. }
  17496. }
  17497. module "babylonjs/Meshes/linesMesh" {
  17498. interface LinesMesh {
  17499. /**
  17500. * Enables the edge rendering mode on the mesh.
  17501. * This mode makes the mesh edges visible
  17502. * @param epsilon defines the maximal distance between two angles to detect a face
  17503. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17504. * @returns the currentAbstractMesh
  17505. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17506. */
  17507. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17508. }
  17509. }
  17510. module "babylonjs/Meshes/linesMesh" {
  17511. interface InstancedLinesMesh {
  17512. /**
  17513. * Enables the edge rendering mode on the mesh.
  17514. * This mode makes the mesh edges visible
  17515. * @param epsilon defines the maximal distance between two angles to detect a face
  17516. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17517. * @returns the current InstancedLinesMesh
  17518. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17519. */
  17520. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17521. }
  17522. }
  17523. /**
  17524. * Defines the minimum contract an Edges renderer should follow.
  17525. */
  17526. export interface IEdgesRenderer extends IDisposable {
  17527. /**
  17528. * Gets or sets a boolean indicating if the edgesRenderer is active
  17529. */
  17530. isEnabled: boolean;
  17531. /**
  17532. * Renders the edges of the attached mesh,
  17533. */
  17534. render(): void;
  17535. /**
  17536. * Checks wether or not the edges renderer is ready to render.
  17537. * @return true if ready, otherwise false.
  17538. */
  17539. isReady(): boolean;
  17540. /**
  17541. * List of instances to render in case the source mesh has instances
  17542. */
  17543. customInstances: SmartArray<Matrix>;
  17544. }
  17545. /**
  17546. * Defines the additional options of the edges renderer
  17547. */
  17548. export interface IEdgesRendererOptions {
  17549. /**
  17550. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17551. * If not defined, the default value is true
  17552. */
  17553. useAlternateEdgeFinder?: boolean;
  17554. /**
  17555. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17556. * If not defined, the default value is true.
  17557. * 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)
  17558. * This option is used only if useAlternateEdgeFinder = true
  17559. */
  17560. useFastVertexMerger?: boolean;
  17561. /**
  17562. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17563. * The default value is 1e-6
  17564. * This option is used only if useAlternateEdgeFinder = true
  17565. */
  17566. epsilonVertexMerge?: number;
  17567. /**
  17568. * 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
  17569. * 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.
  17570. * This option is used only if useAlternateEdgeFinder = true
  17571. */
  17572. applyTessellation?: boolean;
  17573. /**
  17574. * 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
  17575. * The default value is 1e-6
  17576. * This option is used only if useAlternateEdgeFinder = true
  17577. */
  17578. epsilonVertexAligned?: number;
  17579. }
  17580. /**
  17581. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17582. */
  17583. export class EdgesRenderer implements IEdgesRenderer {
  17584. /**
  17585. * Define the size of the edges with an orthographic camera
  17586. */
  17587. edgesWidthScalerForOrthographic: number;
  17588. /**
  17589. * Define the size of the edges with a perspective camera
  17590. */
  17591. edgesWidthScalerForPerspective: number;
  17592. protected _source: AbstractMesh;
  17593. protected _linesPositions: number[];
  17594. protected _linesNormals: number[];
  17595. protected _linesIndices: number[];
  17596. protected _epsilon: number;
  17597. protected _indicesCount: number;
  17598. protected _lineShader: ShaderMaterial;
  17599. protected _ib: DataBuffer;
  17600. protected _buffers: {
  17601. [key: string]: Nullable<VertexBuffer>;
  17602. };
  17603. protected _buffersForInstances: {
  17604. [key: string]: Nullable<VertexBuffer>;
  17605. };
  17606. protected _checkVerticesInsteadOfIndices: boolean;
  17607. protected _options: Nullable<IEdgesRendererOptions>;
  17608. private _meshRebuildObserver;
  17609. private _meshDisposeObserver;
  17610. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17611. isEnabled: boolean;
  17612. /**
  17613. * List of instances to render in case the source mesh has instances
  17614. */
  17615. customInstances: SmartArray<Matrix>;
  17616. private static GetShader;
  17617. /**
  17618. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17619. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17620. * @param source Mesh used to create edges
  17621. * @param epsilon sum of angles in adjacency to check for edge
  17622. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17623. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17624. * @param options The options to apply when generating the edges
  17625. */
  17626. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17627. protected _prepareRessources(): void;
  17628. /** @hidden */
  17629. _rebuild(): void;
  17630. /**
  17631. * Releases the required resources for the edges renderer
  17632. */
  17633. dispose(): void;
  17634. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17635. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17636. /**
  17637. * Checks if the pair of p0 and p1 is en edge
  17638. * @param faceIndex
  17639. * @param edge
  17640. * @param faceNormals
  17641. * @param p0
  17642. * @param p1
  17643. * @private
  17644. */
  17645. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17646. /**
  17647. * push line into the position, normal and index buffer
  17648. * @protected
  17649. */
  17650. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17651. /**
  17652. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17653. */
  17654. private _tessellateTriangle;
  17655. private _generateEdgesLinesAlternate;
  17656. /**
  17657. * Generates lines edges from adjacencjes
  17658. * @private
  17659. */
  17660. _generateEdgesLines(): void;
  17661. /**
  17662. * Checks wether or not the edges renderer is ready to render.
  17663. * @return true if ready, otherwise false.
  17664. */
  17665. isReady(): boolean;
  17666. /**
  17667. * Renders the edges of the attached mesh,
  17668. */
  17669. render(): void;
  17670. }
  17671. /**
  17672. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17673. */
  17674. export class LineEdgesRenderer extends EdgesRenderer {
  17675. /**
  17676. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17677. * @param source LineMesh used to generate edges
  17678. * @param epsilon not important (specified angle for edge detection)
  17679. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17680. */
  17681. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17682. /**
  17683. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17684. */
  17685. _generateEdgesLines(): void;
  17686. }
  17687. }
  17688. declare module "babylonjs/Rendering/renderingGroup" {
  17689. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17692. import { Nullable } from "babylonjs/types";
  17693. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17694. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17695. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17696. import { Material } from "babylonjs/Materials/material";
  17697. import { Scene } from "babylonjs/scene";
  17698. /**
  17699. * This represents the object necessary to create a rendering group.
  17700. * This is exclusively used and created by the rendering manager.
  17701. * To modify the behavior, you use the available helpers in your scene or meshes.
  17702. * @hidden
  17703. */
  17704. export class RenderingGroup {
  17705. index: number;
  17706. private static _zeroVector;
  17707. private _scene;
  17708. private _opaqueSubMeshes;
  17709. private _transparentSubMeshes;
  17710. private _alphaTestSubMeshes;
  17711. private _depthOnlySubMeshes;
  17712. private _particleSystems;
  17713. private _spriteManagers;
  17714. private _opaqueSortCompareFn;
  17715. private _alphaTestSortCompareFn;
  17716. private _transparentSortCompareFn;
  17717. private _renderOpaque;
  17718. private _renderAlphaTest;
  17719. private _renderTransparent;
  17720. /** @hidden */
  17721. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17722. onBeforeTransparentRendering: () => void;
  17723. /**
  17724. * Set the opaque sort comparison function.
  17725. * If null the sub meshes will be render in the order they were created
  17726. */
  17727. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17728. /**
  17729. * Set the alpha test sort comparison function.
  17730. * If null the sub meshes will be render in the order they were created
  17731. */
  17732. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17733. /**
  17734. * Set the transparent sort comparison function.
  17735. * If null the sub meshes will be render in the order they were created
  17736. */
  17737. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17738. /**
  17739. * Creates a new rendering group.
  17740. * @param index The rendering group index
  17741. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17742. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17743. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17744. */
  17745. 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>);
  17746. /**
  17747. * Render all the sub meshes contained in the group.
  17748. * @param customRenderFunction Used to override the default render behaviour of the group.
  17749. * @returns true if rendered some submeshes.
  17750. */
  17751. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17752. /**
  17753. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17754. * @param subMeshes The submeshes to render
  17755. */
  17756. private renderOpaqueSorted;
  17757. /**
  17758. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17759. * @param subMeshes The submeshes to render
  17760. */
  17761. private renderAlphaTestSorted;
  17762. /**
  17763. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17764. * @param subMeshes The submeshes to render
  17765. */
  17766. private renderTransparentSorted;
  17767. /**
  17768. * Renders the submeshes in a specified order.
  17769. * @param subMeshes The submeshes to sort before render
  17770. * @param sortCompareFn The comparison function use to sort
  17771. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17772. * @param transparent Specifies to activate blending if true
  17773. */
  17774. private static renderSorted;
  17775. /**
  17776. * Renders the submeshes in the order they were dispatched (no sort applied).
  17777. * @param subMeshes The submeshes to render
  17778. */
  17779. private static renderUnsorted;
  17780. /**
  17781. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17782. * are rendered back to front if in the same alpha index.
  17783. *
  17784. * @param a The first submesh
  17785. * @param b The second submesh
  17786. * @returns The result of the comparison
  17787. */
  17788. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17789. /**
  17790. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17791. * are rendered back to front.
  17792. *
  17793. * @param a The first submesh
  17794. * @param b The second submesh
  17795. * @returns The result of the comparison
  17796. */
  17797. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17798. /**
  17799. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17800. * are rendered front to back (prevent overdraw).
  17801. *
  17802. * @param a The first submesh
  17803. * @param b The second submesh
  17804. * @returns The result of the comparison
  17805. */
  17806. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17807. /**
  17808. * Resets the different lists of submeshes to prepare a new frame.
  17809. */
  17810. prepare(): void;
  17811. dispose(): void;
  17812. /**
  17813. * Inserts the submesh in its correct queue depending on its material.
  17814. * @param subMesh The submesh to dispatch
  17815. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17816. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17817. */
  17818. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17819. dispatchSprites(spriteManager: ISpriteManager): void;
  17820. dispatchParticles(particleSystem: IParticleSystem): void;
  17821. private _renderParticles;
  17822. private _renderSprites;
  17823. }
  17824. }
  17825. declare module "babylonjs/Rendering/renderingManager" {
  17826. import { Nullable } from "babylonjs/types";
  17827. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17828. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17829. import { SmartArray } from "babylonjs/Misc/smartArray";
  17830. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17831. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17832. import { Material } from "babylonjs/Materials/material";
  17833. import { Scene } from "babylonjs/scene";
  17834. import { Camera } from "babylonjs/Cameras/camera";
  17835. /**
  17836. * Interface describing the different options available in the rendering manager
  17837. * regarding Auto Clear between groups.
  17838. */
  17839. export interface IRenderingManagerAutoClearSetup {
  17840. /**
  17841. * Defines whether or not autoclear is enable.
  17842. */
  17843. autoClear: boolean;
  17844. /**
  17845. * Defines whether or not to autoclear the depth buffer.
  17846. */
  17847. depth: boolean;
  17848. /**
  17849. * Defines whether or not to autoclear the stencil buffer.
  17850. */
  17851. stencil: boolean;
  17852. }
  17853. /**
  17854. * This class is used by the onRenderingGroupObservable
  17855. */
  17856. export class RenderingGroupInfo {
  17857. /**
  17858. * The Scene that being rendered
  17859. */
  17860. scene: Scene;
  17861. /**
  17862. * The camera currently used for the rendering pass
  17863. */
  17864. camera: Nullable<Camera>;
  17865. /**
  17866. * The ID of the renderingGroup being processed
  17867. */
  17868. renderingGroupId: number;
  17869. }
  17870. /**
  17871. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17872. * It is enable to manage the different groups as well as the different necessary sort functions.
  17873. * This should not be used directly aside of the few static configurations
  17874. */
  17875. export class RenderingManager {
  17876. /**
  17877. * The max id used for rendering groups (not included)
  17878. */
  17879. static MAX_RENDERINGGROUPS: number;
  17880. /**
  17881. * The min id used for rendering groups (included)
  17882. */
  17883. static MIN_RENDERINGGROUPS: number;
  17884. /**
  17885. * Used to globally prevent autoclearing scenes.
  17886. */
  17887. static AUTOCLEAR: boolean;
  17888. /**
  17889. * @hidden
  17890. */
  17891. _useSceneAutoClearSetup: boolean;
  17892. private _scene;
  17893. private _renderingGroups;
  17894. private _depthStencilBufferAlreadyCleaned;
  17895. private _autoClearDepthStencil;
  17896. private _customOpaqueSortCompareFn;
  17897. private _customAlphaTestSortCompareFn;
  17898. private _customTransparentSortCompareFn;
  17899. private _renderingGroupInfo;
  17900. /**
  17901. * Instantiates a new rendering group for a particular scene
  17902. * @param scene Defines the scene the groups belongs to
  17903. */
  17904. constructor(scene: Scene);
  17905. private _clearDepthStencilBuffer;
  17906. /**
  17907. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17908. * @hidden
  17909. */
  17910. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17911. /**
  17912. * Resets the different information of the group to prepare a new frame
  17913. * @hidden
  17914. */
  17915. reset(): void;
  17916. /**
  17917. * Dispose and release the group and its associated resources.
  17918. * @hidden
  17919. */
  17920. dispose(): void;
  17921. /**
  17922. * Clear the info related to rendering groups preventing retention points during dispose.
  17923. */
  17924. freeRenderingGroups(): void;
  17925. private _prepareRenderingGroup;
  17926. /**
  17927. * Add a sprite manager to the rendering manager in order to render it this frame.
  17928. * @param spriteManager Define the sprite manager to render
  17929. */
  17930. dispatchSprites(spriteManager: ISpriteManager): void;
  17931. /**
  17932. * Add a particle system to the rendering manager in order to render it this frame.
  17933. * @param particleSystem Define the particle system to render
  17934. */
  17935. dispatchParticles(particleSystem: IParticleSystem): void;
  17936. /**
  17937. * Add a submesh to the manager in order to render it this frame
  17938. * @param subMesh The submesh to dispatch
  17939. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17940. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17941. */
  17942. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17943. /**
  17944. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17945. * This allowed control for front to back rendering or reversly depending of the special needs.
  17946. *
  17947. * @param renderingGroupId The rendering group id corresponding to its index
  17948. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17949. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17950. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17951. */
  17952. 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;
  17953. /**
  17954. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17955. *
  17956. * @param renderingGroupId The rendering group id corresponding to its index
  17957. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17958. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17959. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17960. */
  17961. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17962. /**
  17963. * Gets the current auto clear configuration for one rendering group of the rendering
  17964. * manager.
  17965. * @param index the rendering group index to get the information for
  17966. * @returns The auto clear setup for the requested rendering group
  17967. */
  17968. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17969. }
  17970. }
  17971. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17972. import { SmartArray } from "babylonjs/Misc/smartArray";
  17973. import { Nullable } from "babylonjs/types";
  17974. import { Scene } from "babylonjs/scene";
  17975. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17976. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17978. import { Mesh } from "babylonjs/Meshes/mesh";
  17979. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17980. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17981. import { Effect } from "babylonjs/Materials/effect";
  17982. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17983. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17984. import "babylonjs/Shaders/shadowMap.fragment";
  17985. import "babylonjs/Shaders/shadowMap.vertex";
  17986. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17987. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17988. import { Observable } from "babylonjs/Misc/observable";
  17989. /**
  17990. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17991. */
  17992. export interface ICustomShaderOptions {
  17993. /**
  17994. * Gets or sets the custom shader name to use
  17995. */
  17996. shaderName: string;
  17997. /**
  17998. * The list of attribute names used in the shader
  17999. */
  18000. attributes?: string[];
  18001. /**
  18002. * The list of unifrom names used in the shader
  18003. */
  18004. uniforms?: string[];
  18005. /**
  18006. * The list of sampler names used in the shader
  18007. */
  18008. samplers?: string[];
  18009. /**
  18010. * The list of defines used in the shader
  18011. */
  18012. defines?: string[];
  18013. }
  18014. /**
  18015. * Interface to implement to create a shadow generator compatible with BJS.
  18016. */
  18017. export interface IShadowGenerator {
  18018. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18019. id: string;
  18020. /**
  18021. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18022. * @returns The render target texture if present otherwise, null
  18023. */
  18024. getShadowMap(): Nullable<RenderTargetTexture>;
  18025. /**
  18026. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18027. * @param subMesh The submesh we want to render in the shadow map
  18028. * @param useInstances Defines wether will draw in the map using instances
  18029. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18030. * @returns true if ready otherwise, false
  18031. */
  18032. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18033. /**
  18034. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18035. * @param defines Defines of the material we want to update
  18036. * @param lightIndex Index of the light in the enabled light list of the material
  18037. */
  18038. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  18039. /**
  18040. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18041. * defined in the generator but impacting the effect).
  18042. * It implies the unifroms available on the materials are the standard BJS ones.
  18043. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18044. * @param effect The effect we are binfing the information for
  18045. */
  18046. bindShadowLight(lightIndex: string, effect: Effect): void;
  18047. /**
  18048. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18049. * (eq to shadow prjection matrix * light transform matrix)
  18050. * @returns The transform matrix used to create the shadow map
  18051. */
  18052. getTransformMatrix(): Matrix;
  18053. /**
  18054. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18055. * Cube and 2D textures for instance.
  18056. */
  18057. recreateShadowMap(): void;
  18058. /**
  18059. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18060. * @param onCompiled Callback triggered at the and of the effects compilation
  18061. * @param options Sets of optional options forcing the compilation with different modes
  18062. */
  18063. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18064. useInstances: boolean;
  18065. }>): void;
  18066. /**
  18067. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18068. * @param options Sets of optional options forcing the compilation with different modes
  18069. * @returns A promise that resolves when the compilation completes
  18070. */
  18071. forceCompilationAsync(options?: Partial<{
  18072. useInstances: boolean;
  18073. }>): Promise<void>;
  18074. /**
  18075. * Serializes the shadow generator setup to a json object.
  18076. * @returns The serialized JSON object
  18077. */
  18078. serialize(): any;
  18079. /**
  18080. * Disposes the Shadow map and related Textures and effects.
  18081. */
  18082. dispose(): void;
  18083. }
  18084. /**
  18085. * Default implementation IShadowGenerator.
  18086. * This is the main object responsible of generating shadows in the framework.
  18087. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18088. */
  18089. export class ShadowGenerator implements IShadowGenerator {
  18090. /**
  18091. * Name of the shadow generator class
  18092. */
  18093. static CLASSNAME: string;
  18094. /**
  18095. * Shadow generator mode None: no filtering applied.
  18096. */
  18097. static readonly FILTER_NONE: number;
  18098. /**
  18099. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18100. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18101. */
  18102. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18103. /**
  18104. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18105. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18106. */
  18107. static readonly FILTER_POISSONSAMPLING: number;
  18108. /**
  18109. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18110. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18111. */
  18112. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18113. /**
  18114. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18115. * edge artifacts on steep falloff.
  18116. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18117. */
  18118. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18119. /**
  18120. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18121. * edge artifacts on steep falloff.
  18122. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18123. */
  18124. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18125. /**
  18126. * Shadow generator mode PCF: Percentage Closer Filtering
  18127. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18128. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18129. */
  18130. static readonly FILTER_PCF: number;
  18131. /**
  18132. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18133. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18134. * Contact Hardening
  18135. */
  18136. static readonly FILTER_PCSS: number;
  18137. /**
  18138. * Reserved for PCF and PCSS
  18139. * Highest Quality.
  18140. *
  18141. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18142. *
  18143. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18144. */
  18145. static readonly QUALITY_HIGH: number;
  18146. /**
  18147. * Reserved for PCF and PCSS
  18148. * Good tradeoff for quality/perf cross devices
  18149. *
  18150. * Execute PCF on a 3*3 kernel.
  18151. *
  18152. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18153. */
  18154. static readonly QUALITY_MEDIUM: number;
  18155. /**
  18156. * Reserved for PCF and PCSS
  18157. * The lowest quality but the fastest.
  18158. *
  18159. * Execute PCF on a 1*1 kernel.
  18160. *
  18161. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18162. */
  18163. static readonly QUALITY_LOW: number;
  18164. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18165. id: string;
  18166. /** Gets or sets the custom shader name to use */
  18167. customShaderOptions: ICustomShaderOptions;
  18168. /**
  18169. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18170. */
  18171. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18172. /**
  18173. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18174. */
  18175. onAfterShadowMapRenderObservable: Observable<Effect>;
  18176. /**
  18177. * Observable triggered before a mesh is rendered in the shadow map.
  18178. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18179. */
  18180. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18181. /**
  18182. * Observable triggered after a mesh is rendered in the shadow map.
  18183. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18184. */
  18185. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18186. protected _bias: number;
  18187. /**
  18188. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18189. */
  18190. get bias(): number;
  18191. /**
  18192. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18193. */
  18194. set bias(bias: number);
  18195. protected _normalBias: number;
  18196. /**
  18197. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18198. */
  18199. get normalBias(): number;
  18200. /**
  18201. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18202. */
  18203. set normalBias(normalBias: number);
  18204. protected _blurBoxOffset: number;
  18205. /**
  18206. * Gets the blur box offset: offset applied during the blur pass.
  18207. * Only useful if useKernelBlur = false
  18208. */
  18209. get blurBoxOffset(): number;
  18210. /**
  18211. * Sets the blur box offset: offset applied during the blur pass.
  18212. * Only useful if useKernelBlur = false
  18213. */
  18214. set blurBoxOffset(value: number);
  18215. protected _blurScale: number;
  18216. /**
  18217. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18218. * 2 means half of the size.
  18219. */
  18220. get blurScale(): number;
  18221. /**
  18222. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18223. * 2 means half of the size.
  18224. */
  18225. set blurScale(value: number);
  18226. protected _blurKernel: number;
  18227. /**
  18228. * Gets the blur kernel: kernel size of the blur pass.
  18229. * Only useful if useKernelBlur = true
  18230. */
  18231. get blurKernel(): number;
  18232. /**
  18233. * Sets the blur kernel: kernel size of the blur pass.
  18234. * Only useful if useKernelBlur = true
  18235. */
  18236. set blurKernel(value: number);
  18237. protected _useKernelBlur: boolean;
  18238. /**
  18239. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18240. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18241. */
  18242. get useKernelBlur(): boolean;
  18243. /**
  18244. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18245. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18246. */
  18247. set useKernelBlur(value: boolean);
  18248. protected _depthScale: number;
  18249. /**
  18250. * Gets the depth scale used in ESM mode.
  18251. */
  18252. get depthScale(): number;
  18253. /**
  18254. * Sets the depth scale used in ESM mode.
  18255. * This can override the scale stored on the light.
  18256. */
  18257. set depthScale(value: number);
  18258. protected _validateFilter(filter: number): number;
  18259. protected _filter: number;
  18260. /**
  18261. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18262. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18263. */
  18264. get filter(): number;
  18265. /**
  18266. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18267. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18268. */
  18269. set filter(value: number);
  18270. /**
  18271. * Gets if the current filter is set to Poisson Sampling.
  18272. */
  18273. get usePoissonSampling(): boolean;
  18274. /**
  18275. * Sets the current filter to Poisson Sampling.
  18276. */
  18277. set usePoissonSampling(value: boolean);
  18278. /**
  18279. * Gets if the current filter is set to ESM.
  18280. */
  18281. get useExponentialShadowMap(): boolean;
  18282. /**
  18283. * Sets the current filter is to ESM.
  18284. */
  18285. set useExponentialShadowMap(value: boolean);
  18286. /**
  18287. * Gets if the current filter is set to filtered ESM.
  18288. */
  18289. get useBlurExponentialShadowMap(): boolean;
  18290. /**
  18291. * Gets if the current filter is set to filtered ESM.
  18292. */
  18293. set useBlurExponentialShadowMap(value: boolean);
  18294. /**
  18295. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18296. * exponential to prevent steep falloff artifacts).
  18297. */
  18298. get useCloseExponentialShadowMap(): boolean;
  18299. /**
  18300. * Sets the current filter to "close ESM" (using the inverse of the
  18301. * exponential to prevent steep falloff artifacts).
  18302. */
  18303. set useCloseExponentialShadowMap(value: boolean);
  18304. /**
  18305. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18306. * exponential to prevent steep falloff artifacts).
  18307. */
  18308. get useBlurCloseExponentialShadowMap(): boolean;
  18309. /**
  18310. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18311. * exponential to prevent steep falloff artifacts).
  18312. */
  18313. set useBlurCloseExponentialShadowMap(value: boolean);
  18314. /**
  18315. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18316. */
  18317. get usePercentageCloserFiltering(): boolean;
  18318. /**
  18319. * Sets the current filter to "PCF" (percentage closer filtering).
  18320. */
  18321. set usePercentageCloserFiltering(value: boolean);
  18322. protected _filteringQuality: number;
  18323. /**
  18324. * Gets the PCF or PCSS Quality.
  18325. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18326. */
  18327. get filteringQuality(): number;
  18328. /**
  18329. * Sets the PCF or PCSS Quality.
  18330. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18331. */
  18332. set filteringQuality(filteringQuality: number);
  18333. /**
  18334. * Gets if the current filter is set to "PCSS" (contact hardening).
  18335. */
  18336. get useContactHardeningShadow(): boolean;
  18337. /**
  18338. * Sets the current filter to "PCSS" (contact hardening).
  18339. */
  18340. set useContactHardeningShadow(value: boolean);
  18341. protected _contactHardeningLightSizeUVRatio: number;
  18342. /**
  18343. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18344. * Using a ratio helps keeping shape stability independently of the map size.
  18345. *
  18346. * It does not account for the light projection as it was having too much
  18347. * instability during the light setup or during light position changes.
  18348. *
  18349. * Only valid if useContactHardeningShadow is true.
  18350. */
  18351. get contactHardeningLightSizeUVRatio(): number;
  18352. /**
  18353. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18354. * Using a ratio helps keeping shape stability independently of the map size.
  18355. *
  18356. * It does not account for the light projection as it was having too much
  18357. * instability during the light setup or during light position changes.
  18358. *
  18359. * Only valid if useContactHardeningShadow is true.
  18360. */
  18361. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18362. protected _darkness: number;
  18363. /** Gets or sets the actual darkness of a shadow */
  18364. get darkness(): number;
  18365. set darkness(value: number);
  18366. /**
  18367. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18368. * 0 means strongest and 1 would means no shadow.
  18369. * @returns the darkness.
  18370. */
  18371. getDarkness(): number;
  18372. /**
  18373. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18374. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18375. * @returns the shadow generator allowing fluent coding.
  18376. */
  18377. setDarkness(darkness: number): ShadowGenerator;
  18378. protected _transparencyShadow: boolean;
  18379. /** Gets or sets the ability to have transparent shadow */
  18380. get transparencyShadow(): boolean;
  18381. set transparencyShadow(value: boolean);
  18382. /**
  18383. * Sets the ability to have transparent shadow (boolean).
  18384. * @param transparent True if transparent else False
  18385. * @returns the shadow generator allowing fluent coding
  18386. */
  18387. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18388. /**
  18389. * Enables or disables shadows with varying strength based on the transparency
  18390. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18391. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18392. * mesh.visibility * alphaTexture.a
  18393. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18394. */
  18395. enableSoftTransparentShadow: boolean;
  18396. protected _shadowMap: Nullable<RenderTargetTexture>;
  18397. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18398. /**
  18399. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18400. * @returns The render target texture if present otherwise, null
  18401. */
  18402. getShadowMap(): Nullable<RenderTargetTexture>;
  18403. /**
  18404. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18405. * @returns The render target texture if the shadow map is present otherwise, null
  18406. */
  18407. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18408. /**
  18409. * Gets the class name of that object
  18410. * @returns "ShadowGenerator"
  18411. */
  18412. getClassName(): string;
  18413. /**
  18414. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18415. * @param mesh Mesh to add
  18416. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18417. * @returns the Shadow Generator itself
  18418. */
  18419. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18420. /**
  18421. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18422. * @param mesh Mesh to remove
  18423. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18424. * @returns the Shadow Generator itself
  18425. */
  18426. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18427. /**
  18428. * Controls the extent to which the shadows fade out at the edge of the frustum
  18429. */
  18430. frustumEdgeFalloff: number;
  18431. protected _light: IShadowLight;
  18432. /**
  18433. * Returns the associated light object.
  18434. * @returns the light generating the shadow
  18435. */
  18436. getLight(): IShadowLight;
  18437. /**
  18438. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18439. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18440. * It might on the other hand introduce peter panning.
  18441. */
  18442. forceBackFacesOnly: boolean;
  18443. protected _scene: Scene;
  18444. protected _lightDirection: Vector3;
  18445. protected _effect: Effect;
  18446. protected _viewMatrix: Matrix;
  18447. protected _projectionMatrix: Matrix;
  18448. protected _transformMatrix: Matrix;
  18449. protected _cachedPosition: Vector3;
  18450. protected _cachedDirection: Vector3;
  18451. protected _cachedDefines: string;
  18452. protected _currentRenderID: number;
  18453. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18454. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18455. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18456. protected _blurPostProcesses: PostProcess[];
  18457. protected _mapSize: number;
  18458. protected _currentFaceIndex: number;
  18459. protected _currentFaceIndexCache: number;
  18460. protected _textureType: number;
  18461. protected _defaultTextureMatrix: Matrix;
  18462. protected _storedUniqueId: Nullable<number>;
  18463. /** @hidden */
  18464. static _SceneComponentInitialization: (scene: Scene) => void;
  18465. /**
  18466. * Creates a ShadowGenerator object.
  18467. * A ShadowGenerator is the required tool to use the shadows.
  18468. * Each light casting shadows needs to use its own ShadowGenerator.
  18469. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18470. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18471. * @param light The light object generating the shadows.
  18472. * @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.
  18473. */
  18474. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18475. protected _initializeGenerator(): void;
  18476. protected _createTargetRenderTexture(): void;
  18477. protected _initializeShadowMap(): void;
  18478. protected _initializeBlurRTTAndPostProcesses(): void;
  18479. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18480. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18481. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18482. protected _applyFilterValues(): void;
  18483. /**
  18484. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18485. * @param onCompiled Callback triggered at the and of the effects compilation
  18486. * @param options Sets of optional options forcing the compilation with different modes
  18487. */
  18488. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18489. useInstances: boolean;
  18490. }>): void;
  18491. /**
  18492. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18493. * @param options Sets of optional options forcing the compilation with different modes
  18494. * @returns A promise that resolves when the compilation completes
  18495. */
  18496. forceCompilationAsync(options?: Partial<{
  18497. useInstances: boolean;
  18498. }>): Promise<void>;
  18499. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18500. private _prepareShadowDefines;
  18501. /**
  18502. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18503. * @param subMesh The submesh we want to render in the shadow map
  18504. * @param useInstances Defines wether will draw in the map using instances
  18505. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18506. * @returns true if ready otherwise, false
  18507. */
  18508. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18509. /**
  18510. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18511. * @param defines Defines of the material we want to update
  18512. * @param lightIndex Index of the light in the enabled light list of the material
  18513. */
  18514. prepareDefines(defines: any, lightIndex: number): void;
  18515. /**
  18516. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18517. * defined in the generator but impacting the effect).
  18518. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18519. * @param effect The effect we are binfing the information for
  18520. */
  18521. bindShadowLight(lightIndex: string, effect: Effect): void;
  18522. /**
  18523. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18524. * (eq to shadow prjection matrix * light transform matrix)
  18525. * @returns The transform matrix used to create the shadow map
  18526. */
  18527. getTransformMatrix(): Matrix;
  18528. /**
  18529. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18530. * Cube and 2D textures for instance.
  18531. */
  18532. recreateShadowMap(): void;
  18533. protected _disposeBlurPostProcesses(): void;
  18534. protected _disposeRTTandPostProcesses(): void;
  18535. /**
  18536. * Disposes the ShadowGenerator.
  18537. * Returns nothing.
  18538. */
  18539. dispose(): void;
  18540. /**
  18541. * Serializes the shadow generator setup to a json object.
  18542. * @returns The serialized JSON object
  18543. */
  18544. serialize(): any;
  18545. /**
  18546. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18547. * @param parsedShadowGenerator The JSON object to parse
  18548. * @param scene The scene to create the shadow map for
  18549. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18550. * @returns The parsed shadow generator
  18551. */
  18552. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18553. }
  18554. }
  18555. declare module "babylonjs/Lights/light" {
  18556. import { Nullable } from "babylonjs/types";
  18557. import { Scene } from "babylonjs/scene";
  18558. import { Vector3 } from "babylonjs/Maths/math.vector";
  18559. import { Color3 } from "babylonjs/Maths/math.color";
  18560. import { Node } from "babylonjs/node";
  18561. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18562. import { Effect } from "babylonjs/Materials/effect";
  18563. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18564. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18565. /**
  18566. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18567. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18568. * 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.
  18569. */
  18570. export abstract class Light extends Node {
  18571. /**
  18572. * Falloff Default: light is falling off following the material specification:
  18573. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18574. */
  18575. static readonly FALLOFF_DEFAULT: number;
  18576. /**
  18577. * Falloff Physical: light is falling off following the inverse squared distance law.
  18578. */
  18579. static readonly FALLOFF_PHYSICAL: number;
  18580. /**
  18581. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18582. * to enhance interoperability with other engines.
  18583. */
  18584. static readonly FALLOFF_GLTF: number;
  18585. /**
  18586. * Falloff Standard: light is falling off like in the standard material
  18587. * to enhance interoperability with other materials.
  18588. */
  18589. static readonly FALLOFF_STANDARD: number;
  18590. /**
  18591. * If every light affecting the material is in this lightmapMode,
  18592. * material.lightmapTexture adds or multiplies
  18593. * (depends on material.useLightmapAsShadowmap)
  18594. * after every other light calculations.
  18595. */
  18596. static readonly LIGHTMAP_DEFAULT: number;
  18597. /**
  18598. * material.lightmapTexture as only diffuse lighting from this light
  18599. * adds only specular lighting from this light
  18600. * adds dynamic shadows
  18601. */
  18602. static readonly LIGHTMAP_SPECULAR: number;
  18603. /**
  18604. * material.lightmapTexture as only lighting
  18605. * no light calculation from this light
  18606. * only adds dynamic shadows from this light
  18607. */
  18608. static readonly LIGHTMAP_SHADOWSONLY: number;
  18609. /**
  18610. * Each light type uses the default quantity according to its type:
  18611. * point/spot lights use luminous intensity
  18612. * directional lights use illuminance
  18613. */
  18614. static readonly INTENSITYMODE_AUTOMATIC: number;
  18615. /**
  18616. * lumen (lm)
  18617. */
  18618. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18619. /**
  18620. * candela (lm/sr)
  18621. */
  18622. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18623. /**
  18624. * lux (lm/m^2)
  18625. */
  18626. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18627. /**
  18628. * nit (cd/m^2)
  18629. */
  18630. static readonly INTENSITYMODE_LUMINANCE: number;
  18631. /**
  18632. * Light type const id of the point light.
  18633. */
  18634. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18635. /**
  18636. * Light type const id of the directional light.
  18637. */
  18638. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18639. /**
  18640. * Light type const id of the spot light.
  18641. */
  18642. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18643. /**
  18644. * Light type const id of the hemispheric light.
  18645. */
  18646. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18647. /**
  18648. * Diffuse gives the basic color to an object.
  18649. */
  18650. diffuse: Color3;
  18651. /**
  18652. * Specular produces a highlight color on an object.
  18653. * Note: This is note affecting PBR materials.
  18654. */
  18655. specular: Color3;
  18656. /**
  18657. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18658. * falling off base on range or angle.
  18659. * This can be set to any values in Light.FALLOFF_x.
  18660. *
  18661. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18662. * other types of materials.
  18663. */
  18664. falloffType: number;
  18665. /**
  18666. * Strength of the light.
  18667. * Note: By default it is define in the framework own unit.
  18668. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18669. */
  18670. intensity: number;
  18671. private _range;
  18672. protected _inverseSquaredRange: number;
  18673. /**
  18674. * Defines how far from the source the light is impacting in scene units.
  18675. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18676. */
  18677. get range(): number;
  18678. /**
  18679. * Defines how far from the source the light is impacting in scene units.
  18680. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18681. */
  18682. set range(value: number);
  18683. /**
  18684. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18685. * of light.
  18686. */
  18687. private _photometricScale;
  18688. private _intensityMode;
  18689. /**
  18690. * Gets the photometric scale used to interpret the intensity.
  18691. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18692. */
  18693. get intensityMode(): number;
  18694. /**
  18695. * Sets the photometric scale used to interpret the intensity.
  18696. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18697. */
  18698. set intensityMode(value: number);
  18699. private _radius;
  18700. /**
  18701. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18702. */
  18703. get radius(): number;
  18704. /**
  18705. * sets the light radius used by PBR Materials to simulate soft area lights.
  18706. */
  18707. set radius(value: number);
  18708. private _renderPriority;
  18709. /**
  18710. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18711. * exceeding the number allowed of the materials.
  18712. */
  18713. renderPriority: number;
  18714. private _shadowEnabled;
  18715. /**
  18716. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18717. * the current shadow generator.
  18718. */
  18719. get shadowEnabled(): boolean;
  18720. /**
  18721. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18722. * the current shadow generator.
  18723. */
  18724. set shadowEnabled(value: boolean);
  18725. private _includedOnlyMeshes;
  18726. /**
  18727. * Gets the only meshes impacted by this light.
  18728. */
  18729. get includedOnlyMeshes(): AbstractMesh[];
  18730. /**
  18731. * Sets the only meshes impacted by this light.
  18732. */
  18733. set includedOnlyMeshes(value: AbstractMesh[]);
  18734. private _excludedMeshes;
  18735. /**
  18736. * Gets the meshes not impacted by this light.
  18737. */
  18738. get excludedMeshes(): AbstractMesh[];
  18739. /**
  18740. * Sets the meshes not impacted by this light.
  18741. */
  18742. set excludedMeshes(value: AbstractMesh[]);
  18743. private _excludeWithLayerMask;
  18744. /**
  18745. * Gets the layer id use to find what meshes are not impacted by the light.
  18746. * Inactive if 0
  18747. */
  18748. get excludeWithLayerMask(): number;
  18749. /**
  18750. * Sets the layer id use to find what meshes are not impacted by the light.
  18751. * Inactive if 0
  18752. */
  18753. set excludeWithLayerMask(value: number);
  18754. private _includeOnlyWithLayerMask;
  18755. /**
  18756. * Gets the layer id use to find what meshes are impacted by the light.
  18757. * Inactive if 0
  18758. */
  18759. get includeOnlyWithLayerMask(): number;
  18760. /**
  18761. * Sets the layer id use to find what meshes are impacted by the light.
  18762. * Inactive if 0
  18763. */
  18764. set includeOnlyWithLayerMask(value: number);
  18765. private _lightmapMode;
  18766. /**
  18767. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18768. */
  18769. get lightmapMode(): number;
  18770. /**
  18771. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18772. */
  18773. set lightmapMode(value: number);
  18774. /**
  18775. * Shadow generator associted to the light.
  18776. * @hidden Internal use only.
  18777. */
  18778. _shadowGenerator: Nullable<IShadowGenerator>;
  18779. /**
  18780. * @hidden Internal use only.
  18781. */
  18782. _excludedMeshesIds: string[];
  18783. /**
  18784. * @hidden Internal use only.
  18785. */
  18786. _includedOnlyMeshesIds: string[];
  18787. /**
  18788. * The current light unifom buffer.
  18789. * @hidden Internal use only.
  18790. */
  18791. _uniformBuffer: UniformBuffer;
  18792. /** @hidden */
  18793. _renderId: number;
  18794. /**
  18795. * Creates a Light object in the scene.
  18796. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18797. * @param name The firendly name of the light
  18798. * @param scene The scene the light belongs too
  18799. */
  18800. constructor(name: string, scene: Scene);
  18801. protected abstract _buildUniformLayout(): void;
  18802. /**
  18803. * Sets the passed Effect "effect" with the Light information.
  18804. * @param effect The effect to update
  18805. * @param lightIndex The index of the light in the effect to update
  18806. * @returns The light
  18807. */
  18808. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18809. /**
  18810. * Sets the passed Effect "effect" with the Light textures.
  18811. * @param effect The effect to update
  18812. * @param lightIndex The index of the light in the effect to update
  18813. * @returns The light
  18814. */
  18815. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18816. /**
  18817. * Binds the lights information from the scene to the effect for the given mesh.
  18818. * @param lightIndex Light index
  18819. * @param scene The scene where the light belongs to
  18820. * @param effect The effect we are binding the data to
  18821. * @param useSpecular Defines if specular is supported
  18822. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18823. */
  18824. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18825. /**
  18826. * Sets the passed Effect "effect" with the Light information.
  18827. * @param effect The effect to update
  18828. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18829. * @returns The light
  18830. */
  18831. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18832. /**
  18833. * Returns the string "Light".
  18834. * @returns the class name
  18835. */
  18836. getClassName(): string;
  18837. /** @hidden */
  18838. readonly _isLight: boolean;
  18839. /**
  18840. * Converts the light information to a readable string for debug purpose.
  18841. * @param fullDetails Supports for multiple levels of logging within scene loading
  18842. * @returns the human readable light info
  18843. */
  18844. toString(fullDetails?: boolean): string;
  18845. /** @hidden */
  18846. protected _syncParentEnabledState(): void;
  18847. /**
  18848. * Set the enabled state of this node.
  18849. * @param value - the new enabled state
  18850. */
  18851. setEnabled(value: boolean): void;
  18852. /**
  18853. * Returns the Light associated shadow generator if any.
  18854. * @return the associated shadow generator.
  18855. */
  18856. getShadowGenerator(): Nullable<IShadowGenerator>;
  18857. /**
  18858. * Returns a Vector3, the absolute light position in the World.
  18859. * @returns the world space position of the light
  18860. */
  18861. getAbsolutePosition(): Vector3;
  18862. /**
  18863. * Specifies if the light will affect the passed mesh.
  18864. * @param mesh The mesh to test against the light
  18865. * @return true the mesh is affected otherwise, false.
  18866. */
  18867. canAffectMesh(mesh: AbstractMesh): boolean;
  18868. /**
  18869. * Sort function to order lights for rendering.
  18870. * @param a First Light object to compare to second.
  18871. * @param b Second Light object to compare first.
  18872. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18873. */
  18874. static CompareLightsPriority(a: Light, b: Light): number;
  18875. /**
  18876. * Releases resources associated with this node.
  18877. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18878. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18879. */
  18880. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18881. /**
  18882. * Returns the light type ID (integer).
  18883. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18884. */
  18885. getTypeID(): number;
  18886. /**
  18887. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18888. * @returns the scaled intensity in intensity mode unit
  18889. */
  18890. getScaledIntensity(): number;
  18891. /**
  18892. * Returns a new Light object, named "name", from the current one.
  18893. * @param name The name of the cloned light
  18894. * @param newParent The parent of this light, if it has one
  18895. * @returns the new created light
  18896. */
  18897. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18898. /**
  18899. * Serializes the current light into a Serialization object.
  18900. * @returns the serialized object.
  18901. */
  18902. serialize(): any;
  18903. /**
  18904. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18905. * This new light is named "name" and added to the passed scene.
  18906. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18907. * @param name The friendly name of the light
  18908. * @param scene The scene the new light will belong to
  18909. * @returns the constructor function
  18910. */
  18911. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18912. /**
  18913. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18914. * @param parsedLight The JSON representation of the light
  18915. * @param scene The scene to create the parsed light in
  18916. * @returns the created light after parsing
  18917. */
  18918. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18919. private _hookArrayForExcluded;
  18920. private _hookArrayForIncludedOnly;
  18921. private _resyncMeshes;
  18922. /**
  18923. * Forces the meshes to update their light related information in their rendering used effects
  18924. * @hidden Internal Use Only
  18925. */
  18926. _markMeshesAsLightDirty(): void;
  18927. /**
  18928. * Recomputes the cached photometric scale if needed.
  18929. */
  18930. private _computePhotometricScale;
  18931. /**
  18932. * Returns the Photometric Scale according to the light type and intensity mode.
  18933. */
  18934. private _getPhotometricScale;
  18935. /**
  18936. * Reorder the light in the scene according to their defined priority.
  18937. * @hidden Internal Use Only
  18938. */
  18939. _reorderLightsInScene(): void;
  18940. /**
  18941. * Prepares the list of defines specific to the light type.
  18942. * @param defines the list of defines
  18943. * @param lightIndex defines the index of the light for the effect
  18944. */
  18945. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18946. }
  18947. }
  18948. declare module "babylonjs/Cameras/targetCamera" {
  18949. import { Nullable } from "babylonjs/types";
  18950. import { Camera } from "babylonjs/Cameras/camera";
  18951. import { Scene } from "babylonjs/scene";
  18952. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18953. /**
  18954. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18955. * This is the base of the follow, arc rotate cameras and Free camera
  18956. * @see https://doc.babylonjs.com/features/cameras
  18957. */
  18958. export class TargetCamera extends Camera {
  18959. private static _RigCamTransformMatrix;
  18960. private static _TargetTransformMatrix;
  18961. private static _TargetFocalPoint;
  18962. private _tmpUpVector;
  18963. private _tmpTargetVector;
  18964. /**
  18965. * Define the current direction the camera is moving to
  18966. */
  18967. cameraDirection: Vector3;
  18968. /**
  18969. * Define the current rotation the camera is rotating to
  18970. */
  18971. cameraRotation: Vector2;
  18972. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18973. ignoreParentScaling: boolean;
  18974. /**
  18975. * When set, the up vector of the camera will be updated by the rotation of the camera
  18976. */
  18977. updateUpVectorFromRotation: boolean;
  18978. private _tmpQuaternion;
  18979. /**
  18980. * Define the current rotation of the camera
  18981. */
  18982. rotation: Vector3;
  18983. /**
  18984. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18985. */
  18986. rotationQuaternion: Quaternion;
  18987. /**
  18988. * Define the current speed of the camera
  18989. */
  18990. speed: number;
  18991. /**
  18992. * Add constraint to the camera to prevent it to move freely in all directions and
  18993. * around all axis.
  18994. */
  18995. noRotationConstraint: boolean;
  18996. /**
  18997. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18998. * panning
  18999. */
  19000. invertRotation: boolean;
  19001. /**
  19002. * Speed multiplier for inverse camera panning
  19003. */
  19004. inverseRotationSpeed: number;
  19005. /**
  19006. * Define the current target of the camera as an object or a position.
  19007. */
  19008. lockedTarget: any;
  19009. /** @hidden */
  19010. _currentTarget: Vector3;
  19011. /** @hidden */
  19012. _initialFocalDistance: number;
  19013. /** @hidden */
  19014. _viewMatrix: Matrix;
  19015. /** @hidden */
  19016. _camMatrix: Matrix;
  19017. /** @hidden */
  19018. _cameraTransformMatrix: Matrix;
  19019. /** @hidden */
  19020. _cameraRotationMatrix: Matrix;
  19021. /** @hidden */
  19022. _referencePoint: Vector3;
  19023. /** @hidden */
  19024. _transformedReferencePoint: Vector3;
  19025. /** @hidden */
  19026. _reset: () => void;
  19027. private _defaultUp;
  19028. /**
  19029. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  19030. * This is the base of the follow, arc rotate cameras and Free camera
  19031. * @see https://doc.babylonjs.com/features/cameras
  19032. * @param name Defines the name of the camera in the scene
  19033. * @param position Defines the start position of the camera in the scene
  19034. * @param scene Defines the scene the camera belongs to
  19035. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19036. */
  19037. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19038. /**
  19039. * Gets the position in front of the camera at a given distance.
  19040. * @param distance The distance from the camera we want the position to be
  19041. * @returns the position
  19042. */
  19043. getFrontPosition(distance: number): Vector3;
  19044. /** @hidden */
  19045. _getLockedTargetPosition(): Nullable<Vector3>;
  19046. private _storedPosition;
  19047. private _storedRotation;
  19048. private _storedRotationQuaternion;
  19049. /**
  19050. * Store current camera state of the camera (fov, position, rotation, etc..)
  19051. * @returns the camera
  19052. */
  19053. storeState(): Camera;
  19054. /**
  19055. * Restored camera state. You must call storeState() first
  19056. * @returns whether it was successful or not
  19057. * @hidden
  19058. */
  19059. _restoreStateValues(): boolean;
  19060. /** @hidden */
  19061. _initCache(): void;
  19062. /** @hidden */
  19063. _updateCache(ignoreParentClass?: boolean): void;
  19064. /** @hidden */
  19065. _isSynchronizedViewMatrix(): boolean;
  19066. /** @hidden */
  19067. _computeLocalCameraSpeed(): number;
  19068. /**
  19069. * Defines the target the camera should look at.
  19070. * @param target Defines the new target as a Vector or a mesh
  19071. */
  19072. setTarget(target: Vector3): void;
  19073. /**
  19074. * Defines the target point of the camera.
  19075. * The camera looks towards it form the radius distance.
  19076. */
  19077. get target(): Vector3;
  19078. set target(value: Vector3);
  19079. /**
  19080. * Return the current target position of the camera. This value is expressed in local space.
  19081. * @returns the target position
  19082. */
  19083. getTarget(): Vector3;
  19084. /** @hidden */
  19085. _decideIfNeedsToMove(): boolean;
  19086. /** @hidden */
  19087. _updatePosition(): void;
  19088. /** @hidden */
  19089. _checkInputs(): void;
  19090. protected _updateCameraRotationMatrix(): void;
  19091. /**
  19092. * 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)
  19093. * @returns the current camera
  19094. */
  19095. private _rotateUpVectorWithCameraRotationMatrix;
  19096. private _cachedRotationZ;
  19097. private _cachedQuaternionRotationZ;
  19098. /** @hidden */
  19099. _getViewMatrix(): Matrix;
  19100. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19101. /**
  19102. * @hidden
  19103. */
  19104. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19105. /**
  19106. * @hidden
  19107. */
  19108. _updateRigCameras(): void;
  19109. private _getRigCamPositionAndTarget;
  19110. /**
  19111. * Gets the current object class name.
  19112. * @return the class name
  19113. */
  19114. getClassName(): string;
  19115. }
  19116. }
  19117. declare module "babylonjs/Events/keyboardEvents" {
  19118. /**
  19119. * Gather the list of keyboard event types as constants.
  19120. */
  19121. export class KeyboardEventTypes {
  19122. /**
  19123. * The keydown event is fired when a key becomes active (pressed).
  19124. */
  19125. static readonly KEYDOWN: number;
  19126. /**
  19127. * The keyup event is fired when a key has been released.
  19128. */
  19129. static readonly KEYUP: number;
  19130. }
  19131. /**
  19132. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19133. */
  19134. export class KeyboardInfo {
  19135. /**
  19136. * Defines the type of event (KeyboardEventTypes)
  19137. */
  19138. type: number;
  19139. /**
  19140. * Defines the related dom event
  19141. */
  19142. event: KeyboardEvent;
  19143. /**
  19144. * Instantiates a new keyboard info.
  19145. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19146. * @param type Defines the type of event (KeyboardEventTypes)
  19147. * @param event Defines the related dom event
  19148. */
  19149. constructor(
  19150. /**
  19151. * Defines the type of event (KeyboardEventTypes)
  19152. */
  19153. type: number,
  19154. /**
  19155. * Defines the related dom event
  19156. */
  19157. event: KeyboardEvent);
  19158. }
  19159. /**
  19160. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19161. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19162. */
  19163. export class KeyboardInfoPre extends KeyboardInfo {
  19164. /**
  19165. * Defines the type of event (KeyboardEventTypes)
  19166. */
  19167. type: number;
  19168. /**
  19169. * Defines the related dom event
  19170. */
  19171. event: KeyboardEvent;
  19172. /**
  19173. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19174. */
  19175. skipOnPointerObservable: boolean;
  19176. /**
  19177. * Instantiates a new keyboard pre info.
  19178. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19179. * @param type Defines the type of event (KeyboardEventTypes)
  19180. * @param event Defines the related dom event
  19181. */
  19182. constructor(
  19183. /**
  19184. * Defines the type of event (KeyboardEventTypes)
  19185. */
  19186. type: number,
  19187. /**
  19188. * Defines the related dom event
  19189. */
  19190. event: KeyboardEvent);
  19191. }
  19192. }
  19193. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19194. import { Nullable } from "babylonjs/types";
  19195. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19196. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19197. /**
  19198. * Manage the keyboard inputs to control the movement of a free camera.
  19199. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19200. */
  19201. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19202. /**
  19203. * Defines the camera the input is attached to.
  19204. */
  19205. camera: FreeCamera;
  19206. /**
  19207. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19208. */
  19209. keysUp: number[];
  19210. /**
  19211. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19212. */
  19213. keysUpward: number[];
  19214. /**
  19215. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19216. */
  19217. keysDown: number[];
  19218. /**
  19219. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19220. */
  19221. keysDownward: number[];
  19222. /**
  19223. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19224. */
  19225. keysLeft: number[];
  19226. /**
  19227. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19228. */
  19229. keysRight: number[];
  19230. private _keys;
  19231. private _onCanvasBlurObserver;
  19232. private _onKeyboardObserver;
  19233. private _engine;
  19234. private _scene;
  19235. /**
  19236. * Attach the input controls to a specific dom element to get the input from.
  19237. * @param element Defines the element the controls should be listened from
  19238. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19239. */
  19240. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19241. /**
  19242. * Detach the current controls from the specified dom element.
  19243. * @param element Defines the element to stop listening the inputs from
  19244. */
  19245. detachControl(element: Nullable<HTMLElement>): void;
  19246. /**
  19247. * Update the current camera state depending on the inputs that have been used this frame.
  19248. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19249. */
  19250. checkInputs(): void;
  19251. /**
  19252. * Gets the class name of the current intput.
  19253. * @returns the class name
  19254. */
  19255. getClassName(): string;
  19256. /** @hidden */
  19257. _onLostFocus(): void;
  19258. /**
  19259. * Get the friendly name associated with the input class.
  19260. * @returns the input friendly name
  19261. */
  19262. getSimpleName(): string;
  19263. }
  19264. }
  19265. declare module "babylonjs/Events/pointerEvents" {
  19266. import { Nullable } from "babylonjs/types";
  19267. import { Vector2 } from "babylonjs/Maths/math.vector";
  19268. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19269. import { Ray } from "babylonjs/Culling/ray";
  19270. /**
  19271. * Gather the list of pointer event types as constants.
  19272. */
  19273. export class PointerEventTypes {
  19274. /**
  19275. * 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.
  19276. */
  19277. static readonly POINTERDOWN: number;
  19278. /**
  19279. * The pointerup event is fired when a pointer is no longer active.
  19280. */
  19281. static readonly POINTERUP: number;
  19282. /**
  19283. * The pointermove event is fired when a pointer changes coordinates.
  19284. */
  19285. static readonly POINTERMOVE: number;
  19286. /**
  19287. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19288. */
  19289. static readonly POINTERWHEEL: number;
  19290. /**
  19291. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19292. */
  19293. static readonly POINTERPICK: number;
  19294. /**
  19295. * The pointertap event is fired when a the object has been touched and released without drag.
  19296. */
  19297. static readonly POINTERTAP: number;
  19298. /**
  19299. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19300. */
  19301. static readonly POINTERDOUBLETAP: number;
  19302. }
  19303. /**
  19304. * Base class of pointer info types.
  19305. */
  19306. export class PointerInfoBase {
  19307. /**
  19308. * Defines the type of event (PointerEventTypes)
  19309. */
  19310. type: number;
  19311. /**
  19312. * Defines the related dom event
  19313. */
  19314. event: PointerEvent | MouseWheelEvent;
  19315. /**
  19316. * Instantiates the base class of pointers info.
  19317. * @param type Defines the type of event (PointerEventTypes)
  19318. * @param event Defines the related dom event
  19319. */
  19320. constructor(
  19321. /**
  19322. * Defines the type of event (PointerEventTypes)
  19323. */
  19324. type: number,
  19325. /**
  19326. * Defines the related dom event
  19327. */
  19328. event: PointerEvent | MouseWheelEvent);
  19329. }
  19330. /**
  19331. * This class is used to store pointer related info for the onPrePointerObservable event.
  19332. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19333. */
  19334. export class PointerInfoPre extends PointerInfoBase {
  19335. /**
  19336. * Ray from a pointer if availible (eg. 6dof controller)
  19337. */
  19338. ray: Nullable<Ray>;
  19339. /**
  19340. * Defines the local position of the pointer on the canvas.
  19341. */
  19342. localPosition: Vector2;
  19343. /**
  19344. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19345. */
  19346. skipOnPointerObservable: boolean;
  19347. /**
  19348. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19349. * @param type Defines the type of event (PointerEventTypes)
  19350. * @param event Defines the related dom event
  19351. * @param localX Defines the local x coordinates of the pointer when the event occured
  19352. * @param localY Defines the local y coordinates of the pointer when the event occured
  19353. */
  19354. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19355. }
  19356. /**
  19357. * This type contains all the data related to a pointer event in Babylon.js.
  19358. * 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.
  19359. */
  19360. export class PointerInfo extends PointerInfoBase {
  19361. /**
  19362. * Defines the picking info associated to the info (if any)\
  19363. */
  19364. pickInfo: Nullable<PickingInfo>;
  19365. /**
  19366. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19367. * @param type Defines the type of event (PointerEventTypes)
  19368. * @param event Defines the related dom event
  19369. * @param pickInfo Defines the picking info associated to the info (if any)\
  19370. */
  19371. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19372. /**
  19373. * Defines the picking info associated to the info (if any)\
  19374. */
  19375. pickInfo: Nullable<PickingInfo>);
  19376. }
  19377. /**
  19378. * Data relating to a touch event on the screen.
  19379. */
  19380. export interface PointerTouch {
  19381. /**
  19382. * X coordinate of touch.
  19383. */
  19384. x: number;
  19385. /**
  19386. * Y coordinate of touch.
  19387. */
  19388. y: number;
  19389. /**
  19390. * Id of touch. Unique for each finger.
  19391. */
  19392. pointerId: number;
  19393. /**
  19394. * Event type passed from DOM.
  19395. */
  19396. type: any;
  19397. }
  19398. }
  19399. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19400. import { Observable } from "babylonjs/Misc/observable";
  19401. import { Nullable } from "babylonjs/types";
  19402. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19403. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19404. /**
  19405. * Manage the mouse inputs to control the movement of a free camera.
  19406. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19407. */
  19408. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19409. /**
  19410. * Define if touch is enabled in the mouse input
  19411. */
  19412. touchEnabled: boolean;
  19413. /**
  19414. * Defines the camera the input is attached to.
  19415. */
  19416. camera: FreeCamera;
  19417. /**
  19418. * Defines the buttons associated with the input to handle camera move.
  19419. */
  19420. buttons: number[];
  19421. /**
  19422. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19423. */
  19424. angularSensibility: number;
  19425. private _pointerInput;
  19426. private _onMouseMove;
  19427. private _observer;
  19428. private previousPosition;
  19429. /**
  19430. * Observable for when a pointer move event occurs containing the move offset
  19431. */
  19432. onPointerMovedObservable: Observable<{
  19433. offsetX: number;
  19434. offsetY: number;
  19435. }>;
  19436. /**
  19437. * @hidden
  19438. * If the camera should be rotated automatically based on pointer movement
  19439. */
  19440. _allowCameraRotation: boolean;
  19441. /**
  19442. * Manage the mouse inputs to control the movement of a free camera.
  19443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19444. * @param touchEnabled Defines if touch is enabled or not
  19445. */
  19446. constructor(
  19447. /**
  19448. * Define if touch is enabled in the mouse input
  19449. */
  19450. touchEnabled?: boolean);
  19451. /**
  19452. * Attach the input controls to a specific dom element to get the input from.
  19453. * @param element Defines the element the controls should be listened from
  19454. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19455. */
  19456. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19457. /**
  19458. * Called on JS contextmenu event.
  19459. * Override this method to provide functionality.
  19460. */
  19461. protected onContextMenu(evt: PointerEvent): void;
  19462. /**
  19463. * Detach the current controls from the specified dom element.
  19464. * @param element Defines the element to stop listening the inputs from
  19465. */
  19466. detachControl(element: Nullable<HTMLElement>): void;
  19467. /**
  19468. * Gets the class name of the current intput.
  19469. * @returns the class name
  19470. */
  19471. getClassName(): string;
  19472. /**
  19473. * Get the friendly name associated with the input class.
  19474. * @returns the input friendly name
  19475. */
  19476. getSimpleName(): string;
  19477. }
  19478. }
  19479. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19480. import { Nullable } from "babylonjs/types";
  19481. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19482. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19483. /**
  19484. * Manage the touch inputs to control the movement of a free camera.
  19485. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19486. */
  19487. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19488. /**
  19489. * Define if mouse events can be treated as touch events
  19490. */
  19491. allowMouse: boolean;
  19492. /**
  19493. * Defines the camera the input is attached to.
  19494. */
  19495. camera: FreeCamera;
  19496. /**
  19497. * Defines the touch sensibility for rotation.
  19498. * The higher the faster.
  19499. */
  19500. touchAngularSensibility: number;
  19501. /**
  19502. * Defines the touch sensibility for move.
  19503. * The higher the faster.
  19504. */
  19505. touchMoveSensibility: number;
  19506. private _offsetX;
  19507. private _offsetY;
  19508. private _pointerPressed;
  19509. private _pointerInput;
  19510. private _observer;
  19511. private _onLostFocus;
  19512. /**
  19513. * Manage the touch inputs to control the movement of a free camera.
  19514. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19515. * @param allowMouse Defines if mouse events can be treated as touch events
  19516. */
  19517. constructor(
  19518. /**
  19519. * Define if mouse events can be treated as touch events
  19520. */
  19521. allowMouse?: boolean);
  19522. /**
  19523. * Attach the input controls to a specific dom element to get the input from.
  19524. * @param element Defines the element the controls should be listened from
  19525. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19526. */
  19527. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19528. /**
  19529. * Detach the current controls from the specified dom element.
  19530. * @param element Defines the element to stop listening the inputs from
  19531. */
  19532. detachControl(element: Nullable<HTMLElement>): void;
  19533. /**
  19534. * Update the current camera state depending on the inputs that have been used this frame.
  19535. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19536. */
  19537. checkInputs(): void;
  19538. /**
  19539. * Gets the class name of the current intput.
  19540. * @returns the class name
  19541. */
  19542. getClassName(): string;
  19543. /**
  19544. * Get the friendly name associated with the input class.
  19545. * @returns the input friendly name
  19546. */
  19547. getSimpleName(): string;
  19548. }
  19549. }
  19550. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19551. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19552. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19553. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19554. import { Nullable } from "babylonjs/types";
  19555. /**
  19556. * Default Inputs manager for the FreeCamera.
  19557. * It groups all the default supported inputs for ease of use.
  19558. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19559. */
  19560. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19561. /**
  19562. * @hidden
  19563. */
  19564. _mouseInput: Nullable<FreeCameraMouseInput>;
  19565. /**
  19566. * Instantiates a new FreeCameraInputsManager.
  19567. * @param camera Defines the camera the inputs belong to
  19568. */
  19569. constructor(camera: FreeCamera);
  19570. /**
  19571. * Add keyboard input support to the input manager.
  19572. * @returns the current input manager
  19573. */
  19574. addKeyboard(): FreeCameraInputsManager;
  19575. /**
  19576. * Add mouse input support to the input manager.
  19577. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19578. * @returns the current input manager
  19579. */
  19580. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19581. /**
  19582. * Removes the mouse input support from the manager
  19583. * @returns the current input manager
  19584. */
  19585. removeMouse(): FreeCameraInputsManager;
  19586. /**
  19587. * Add touch input support to the input manager.
  19588. * @returns the current input manager
  19589. */
  19590. addTouch(): FreeCameraInputsManager;
  19591. /**
  19592. * Remove all attached input methods from a camera
  19593. */
  19594. clear(): void;
  19595. }
  19596. }
  19597. declare module "babylonjs/Cameras/freeCamera" {
  19598. import { Vector3 } from "babylonjs/Maths/math.vector";
  19599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19600. import { Scene } from "babylonjs/scene";
  19601. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19602. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19603. /**
  19604. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19605. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19606. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19607. */
  19608. export class FreeCamera extends TargetCamera {
  19609. /**
  19610. * Define the collision ellipsoid of the camera.
  19611. * This is helpful to simulate a camera body like the player body around the camera
  19612. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19613. */
  19614. ellipsoid: Vector3;
  19615. /**
  19616. * Define an offset for the position of the ellipsoid around the camera.
  19617. * This can be helpful to determine the center of the body near the gravity center of the body
  19618. * instead of its head.
  19619. */
  19620. ellipsoidOffset: Vector3;
  19621. /**
  19622. * Enable or disable collisions of the camera with the rest of the scene objects.
  19623. */
  19624. checkCollisions: boolean;
  19625. /**
  19626. * Enable or disable gravity on the camera.
  19627. */
  19628. applyGravity: boolean;
  19629. /**
  19630. * Define the input manager associated to the camera.
  19631. */
  19632. inputs: FreeCameraInputsManager;
  19633. /**
  19634. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19635. * Higher values reduce sensitivity.
  19636. */
  19637. get angularSensibility(): number;
  19638. /**
  19639. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19640. * Higher values reduce sensitivity.
  19641. */
  19642. set angularSensibility(value: number);
  19643. /**
  19644. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19645. */
  19646. get keysUp(): number[];
  19647. set keysUp(value: number[]);
  19648. /**
  19649. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19650. */
  19651. get keysUpward(): number[];
  19652. set keysUpward(value: number[]);
  19653. /**
  19654. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19655. */
  19656. get keysDown(): number[];
  19657. set keysDown(value: number[]);
  19658. /**
  19659. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19660. */
  19661. get keysDownward(): number[];
  19662. set keysDownward(value: number[]);
  19663. /**
  19664. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19665. */
  19666. get keysLeft(): number[];
  19667. set keysLeft(value: number[]);
  19668. /**
  19669. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19670. */
  19671. get keysRight(): number[];
  19672. set keysRight(value: number[]);
  19673. /**
  19674. * Event raised when the camera collide with a mesh in the scene.
  19675. */
  19676. onCollide: (collidedMesh: AbstractMesh) => void;
  19677. private _collider;
  19678. private _needMoveForGravity;
  19679. private _oldPosition;
  19680. private _diffPosition;
  19681. private _newPosition;
  19682. /** @hidden */
  19683. _localDirection: Vector3;
  19684. /** @hidden */
  19685. _transformedDirection: Vector3;
  19686. /**
  19687. * Instantiates a Free Camera.
  19688. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19689. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19690. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19691. * @param name Define the name of the camera in the scene
  19692. * @param position Define the start position of the camera in the scene
  19693. * @param scene Define the scene the camera belongs to
  19694. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19695. */
  19696. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19697. /**
  19698. * Attached controls to the current camera.
  19699. * @param element Defines the element the controls should be listened from
  19700. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19701. */
  19702. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19703. /**
  19704. * Detach the current controls from the camera.
  19705. * The camera will stop reacting to inputs.
  19706. * @param element Defines the element to stop listening the inputs from
  19707. */
  19708. detachControl(element: HTMLElement): void;
  19709. private _collisionMask;
  19710. /**
  19711. * Define a collision mask to limit the list of object the camera can collide with
  19712. */
  19713. get collisionMask(): number;
  19714. set collisionMask(mask: number);
  19715. /** @hidden */
  19716. _collideWithWorld(displacement: Vector3): void;
  19717. private _onCollisionPositionChange;
  19718. /** @hidden */
  19719. _checkInputs(): void;
  19720. /** @hidden */
  19721. _decideIfNeedsToMove(): boolean;
  19722. /** @hidden */
  19723. _updatePosition(): void;
  19724. /**
  19725. * Destroy the camera and release the current resources hold by it.
  19726. */
  19727. dispose(): void;
  19728. /**
  19729. * Gets the current object class name.
  19730. * @return the class name
  19731. */
  19732. getClassName(): string;
  19733. }
  19734. }
  19735. declare module "babylonjs/Gamepads/gamepad" {
  19736. import { Observable } from "babylonjs/Misc/observable";
  19737. /**
  19738. * Represents a gamepad control stick position
  19739. */
  19740. export class StickValues {
  19741. /**
  19742. * The x component of the control stick
  19743. */
  19744. x: number;
  19745. /**
  19746. * The y component of the control stick
  19747. */
  19748. y: number;
  19749. /**
  19750. * Initializes the gamepad x and y control stick values
  19751. * @param x The x component of the gamepad control stick value
  19752. * @param y The y component of the gamepad control stick value
  19753. */
  19754. constructor(
  19755. /**
  19756. * The x component of the control stick
  19757. */
  19758. x: number,
  19759. /**
  19760. * The y component of the control stick
  19761. */
  19762. y: number);
  19763. }
  19764. /**
  19765. * An interface which manages callbacks for gamepad button changes
  19766. */
  19767. export interface GamepadButtonChanges {
  19768. /**
  19769. * Called when a gamepad has been changed
  19770. */
  19771. changed: boolean;
  19772. /**
  19773. * Called when a gamepad press event has been triggered
  19774. */
  19775. pressChanged: boolean;
  19776. /**
  19777. * Called when a touch event has been triggered
  19778. */
  19779. touchChanged: boolean;
  19780. /**
  19781. * Called when a value has changed
  19782. */
  19783. valueChanged: boolean;
  19784. }
  19785. /**
  19786. * Represents a gamepad
  19787. */
  19788. export class Gamepad {
  19789. /**
  19790. * The id of the gamepad
  19791. */
  19792. id: string;
  19793. /**
  19794. * The index of the gamepad
  19795. */
  19796. index: number;
  19797. /**
  19798. * The browser gamepad
  19799. */
  19800. browserGamepad: any;
  19801. /**
  19802. * Specifies what type of gamepad this represents
  19803. */
  19804. type: number;
  19805. private _leftStick;
  19806. private _rightStick;
  19807. /** @hidden */
  19808. _isConnected: boolean;
  19809. private _leftStickAxisX;
  19810. private _leftStickAxisY;
  19811. private _rightStickAxisX;
  19812. private _rightStickAxisY;
  19813. /**
  19814. * Triggered when the left control stick has been changed
  19815. */
  19816. private _onleftstickchanged;
  19817. /**
  19818. * Triggered when the right control stick has been changed
  19819. */
  19820. private _onrightstickchanged;
  19821. /**
  19822. * Represents a gamepad controller
  19823. */
  19824. static GAMEPAD: number;
  19825. /**
  19826. * Represents a generic controller
  19827. */
  19828. static GENERIC: number;
  19829. /**
  19830. * Represents an XBox controller
  19831. */
  19832. static XBOX: number;
  19833. /**
  19834. * Represents a pose-enabled controller
  19835. */
  19836. static POSE_ENABLED: number;
  19837. /**
  19838. * Represents an Dual Shock controller
  19839. */
  19840. static DUALSHOCK: number;
  19841. /**
  19842. * Specifies whether the left control stick should be Y-inverted
  19843. */
  19844. protected _invertLeftStickY: boolean;
  19845. /**
  19846. * Specifies if the gamepad has been connected
  19847. */
  19848. get isConnected(): boolean;
  19849. /**
  19850. * Initializes the gamepad
  19851. * @param id The id of the gamepad
  19852. * @param index The index of the gamepad
  19853. * @param browserGamepad The browser gamepad
  19854. * @param leftStickX The x component of the left joystick
  19855. * @param leftStickY The y component of the left joystick
  19856. * @param rightStickX The x component of the right joystick
  19857. * @param rightStickY The y component of the right joystick
  19858. */
  19859. constructor(
  19860. /**
  19861. * The id of the gamepad
  19862. */
  19863. id: string,
  19864. /**
  19865. * The index of the gamepad
  19866. */
  19867. index: number,
  19868. /**
  19869. * The browser gamepad
  19870. */
  19871. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19872. /**
  19873. * Callback triggered when the left joystick has changed
  19874. * @param callback
  19875. */
  19876. onleftstickchanged(callback: (values: StickValues) => void): void;
  19877. /**
  19878. * Callback triggered when the right joystick has changed
  19879. * @param callback
  19880. */
  19881. onrightstickchanged(callback: (values: StickValues) => void): void;
  19882. /**
  19883. * Gets the left joystick
  19884. */
  19885. get leftStick(): StickValues;
  19886. /**
  19887. * Sets the left joystick values
  19888. */
  19889. set leftStick(newValues: StickValues);
  19890. /**
  19891. * Gets the right joystick
  19892. */
  19893. get rightStick(): StickValues;
  19894. /**
  19895. * Sets the right joystick value
  19896. */
  19897. set rightStick(newValues: StickValues);
  19898. /**
  19899. * Updates the gamepad joystick positions
  19900. */
  19901. update(): void;
  19902. /**
  19903. * Disposes the gamepad
  19904. */
  19905. dispose(): void;
  19906. }
  19907. /**
  19908. * Represents a generic gamepad
  19909. */
  19910. export class GenericPad extends Gamepad {
  19911. private _buttons;
  19912. private _onbuttondown;
  19913. private _onbuttonup;
  19914. /**
  19915. * Observable triggered when a button has been pressed
  19916. */
  19917. onButtonDownObservable: Observable<number>;
  19918. /**
  19919. * Observable triggered when a button has been released
  19920. */
  19921. onButtonUpObservable: Observable<number>;
  19922. /**
  19923. * Callback triggered when a button has been pressed
  19924. * @param callback Called when a button has been pressed
  19925. */
  19926. onbuttondown(callback: (buttonPressed: number) => void): void;
  19927. /**
  19928. * Callback triggered when a button has been released
  19929. * @param callback Called when a button has been released
  19930. */
  19931. onbuttonup(callback: (buttonReleased: number) => void): void;
  19932. /**
  19933. * Initializes the generic gamepad
  19934. * @param id The id of the generic gamepad
  19935. * @param index The index of the generic gamepad
  19936. * @param browserGamepad The browser gamepad
  19937. */
  19938. constructor(id: string, index: number, browserGamepad: any);
  19939. private _setButtonValue;
  19940. /**
  19941. * Updates the generic gamepad
  19942. */
  19943. update(): void;
  19944. /**
  19945. * Disposes the generic gamepad
  19946. */
  19947. dispose(): void;
  19948. }
  19949. }
  19950. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19951. import { Observable } from "babylonjs/Misc/observable";
  19952. import { Nullable } from "babylonjs/types";
  19953. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19954. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19955. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19956. import { Ray } from "babylonjs/Culling/ray";
  19957. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19958. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19959. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19960. /**
  19961. * Defines the types of pose enabled controllers that are supported
  19962. */
  19963. export enum PoseEnabledControllerType {
  19964. /**
  19965. * HTC Vive
  19966. */
  19967. VIVE = 0,
  19968. /**
  19969. * Oculus Rift
  19970. */
  19971. OCULUS = 1,
  19972. /**
  19973. * Windows mixed reality
  19974. */
  19975. WINDOWS = 2,
  19976. /**
  19977. * Samsung gear VR
  19978. */
  19979. GEAR_VR = 3,
  19980. /**
  19981. * Google Daydream
  19982. */
  19983. DAYDREAM = 4,
  19984. /**
  19985. * Generic
  19986. */
  19987. GENERIC = 5
  19988. }
  19989. /**
  19990. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19991. */
  19992. export interface MutableGamepadButton {
  19993. /**
  19994. * Value of the button/trigger
  19995. */
  19996. value: number;
  19997. /**
  19998. * If the button/trigger is currently touched
  19999. */
  20000. touched: boolean;
  20001. /**
  20002. * If the button/trigger is currently pressed
  20003. */
  20004. pressed: boolean;
  20005. }
  20006. /**
  20007. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  20008. * @hidden
  20009. */
  20010. export interface ExtendedGamepadButton extends GamepadButton {
  20011. /**
  20012. * If the button/trigger is currently pressed
  20013. */
  20014. readonly pressed: boolean;
  20015. /**
  20016. * If the button/trigger is currently touched
  20017. */
  20018. readonly touched: boolean;
  20019. /**
  20020. * Value of the button/trigger
  20021. */
  20022. readonly value: number;
  20023. }
  20024. /** @hidden */
  20025. export interface _GamePadFactory {
  20026. /**
  20027. * Returns whether or not the current gamepad can be created for this type of controller.
  20028. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  20029. * @returns true if it can be created, otherwise false
  20030. */
  20031. canCreate(gamepadInfo: any): boolean;
  20032. /**
  20033. * Creates a new instance of the Gamepad.
  20034. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  20035. * @returns the new gamepad instance
  20036. */
  20037. create(gamepadInfo: any): Gamepad;
  20038. }
  20039. /**
  20040. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  20041. */
  20042. export class PoseEnabledControllerHelper {
  20043. /** @hidden */
  20044. static _ControllerFactories: _GamePadFactory[];
  20045. /** @hidden */
  20046. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  20047. /**
  20048. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  20049. * @param vrGamepad the gamepad to initialized
  20050. * @returns a vr controller of the type the gamepad identified as
  20051. */
  20052. static InitiateController(vrGamepad: any): Gamepad;
  20053. }
  20054. /**
  20055. * Defines the PoseEnabledController object that contains state of a vr capable controller
  20056. */
  20057. export class PoseEnabledController extends Gamepad implements PoseControlled {
  20058. /**
  20059. * If the controller is used in a webXR session
  20060. */
  20061. isXR: boolean;
  20062. private _deviceRoomPosition;
  20063. private _deviceRoomRotationQuaternion;
  20064. /**
  20065. * The device position in babylon space
  20066. */
  20067. devicePosition: Vector3;
  20068. /**
  20069. * The device rotation in babylon space
  20070. */
  20071. deviceRotationQuaternion: Quaternion;
  20072. /**
  20073. * The scale factor of the device in babylon space
  20074. */
  20075. deviceScaleFactor: number;
  20076. /**
  20077. * (Likely devicePosition should be used instead) The device position in its room space
  20078. */
  20079. position: Vector3;
  20080. /**
  20081. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20082. */
  20083. rotationQuaternion: Quaternion;
  20084. /**
  20085. * The type of controller (Eg. Windows mixed reality)
  20086. */
  20087. controllerType: PoseEnabledControllerType;
  20088. protected _calculatedPosition: Vector3;
  20089. private _calculatedRotation;
  20090. /**
  20091. * The raw pose from the device
  20092. */
  20093. rawPose: DevicePose;
  20094. private _trackPosition;
  20095. private _maxRotationDistFromHeadset;
  20096. private _draggedRoomRotation;
  20097. /**
  20098. * @hidden
  20099. */
  20100. _disableTrackPosition(fixedPosition: Vector3): void;
  20101. /**
  20102. * Internal, the mesh attached to the controller
  20103. * @hidden
  20104. */
  20105. _mesh: Nullable<AbstractMesh>;
  20106. private _poseControlledCamera;
  20107. private _leftHandSystemQuaternion;
  20108. /**
  20109. * Internal, matrix used to convert room space to babylon space
  20110. * @hidden
  20111. */
  20112. _deviceToWorld: Matrix;
  20113. /**
  20114. * Node to be used when casting a ray from the controller
  20115. * @hidden
  20116. */
  20117. _pointingPoseNode: Nullable<TransformNode>;
  20118. /**
  20119. * Name of the child mesh that can be used to cast a ray from the controller
  20120. */
  20121. static readonly POINTING_POSE: string;
  20122. /**
  20123. * Creates a new PoseEnabledController from a gamepad
  20124. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20125. */
  20126. constructor(browserGamepad: any);
  20127. private _workingMatrix;
  20128. /**
  20129. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20130. */
  20131. update(): void;
  20132. /**
  20133. * Updates only the pose device and mesh without doing any button event checking
  20134. */
  20135. protected _updatePoseAndMesh(): void;
  20136. /**
  20137. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20138. * @param poseData raw pose fromthe device
  20139. */
  20140. updateFromDevice(poseData: DevicePose): void;
  20141. /**
  20142. * @hidden
  20143. */
  20144. _meshAttachedObservable: Observable<AbstractMesh>;
  20145. /**
  20146. * Attaches a mesh to the controller
  20147. * @param mesh the mesh to be attached
  20148. */
  20149. attachToMesh(mesh: AbstractMesh): void;
  20150. /**
  20151. * Attaches the controllers mesh to a camera
  20152. * @param camera the camera the mesh should be attached to
  20153. */
  20154. attachToPoseControlledCamera(camera: TargetCamera): void;
  20155. /**
  20156. * Disposes of the controller
  20157. */
  20158. dispose(): void;
  20159. /**
  20160. * The mesh that is attached to the controller
  20161. */
  20162. get mesh(): Nullable<AbstractMesh>;
  20163. /**
  20164. * Gets the ray of the controller in the direction the controller is pointing
  20165. * @param length the length the resulting ray should be
  20166. * @returns a ray in the direction the controller is pointing
  20167. */
  20168. getForwardRay(length?: number): Ray;
  20169. }
  20170. }
  20171. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20172. import { Observable } from "babylonjs/Misc/observable";
  20173. import { Scene } from "babylonjs/scene";
  20174. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20175. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20176. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20177. import { Nullable } from "babylonjs/types";
  20178. /**
  20179. * Defines the WebVRController object that represents controllers tracked in 3D space
  20180. */
  20181. export abstract class WebVRController extends PoseEnabledController {
  20182. /**
  20183. * Internal, the default controller model for the controller
  20184. */
  20185. protected _defaultModel: Nullable<AbstractMesh>;
  20186. /**
  20187. * Fired when the trigger state has changed
  20188. */
  20189. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20190. /**
  20191. * Fired when the main button state has changed
  20192. */
  20193. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20194. /**
  20195. * Fired when the secondary button state has changed
  20196. */
  20197. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20198. /**
  20199. * Fired when the pad state has changed
  20200. */
  20201. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20202. /**
  20203. * Fired when controllers stick values have changed
  20204. */
  20205. onPadValuesChangedObservable: Observable<StickValues>;
  20206. /**
  20207. * Array of button availible on the controller
  20208. */
  20209. protected _buttons: Array<MutableGamepadButton>;
  20210. private _onButtonStateChange;
  20211. /**
  20212. * Fired when a controller button's state has changed
  20213. * @param callback the callback containing the button that was modified
  20214. */
  20215. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20216. /**
  20217. * X and Y axis corresponding to the controllers joystick
  20218. */
  20219. pad: StickValues;
  20220. /**
  20221. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20222. */
  20223. hand: string;
  20224. /**
  20225. * The default controller model for the controller
  20226. */
  20227. get defaultModel(): Nullable<AbstractMesh>;
  20228. /**
  20229. * Creates a new WebVRController from a gamepad
  20230. * @param vrGamepad the gamepad that the WebVRController should be created from
  20231. */
  20232. constructor(vrGamepad: any);
  20233. /**
  20234. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20235. */
  20236. update(): void;
  20237. /**
  20238. * Function to be called when a button is modified
  20239. */
  20240. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20241. /**
  20242. * Loads a mesh and attaches it to the controller
  20243. * @param scene the scene the mesh should be added to
  20244. * @param meshLoaded callback for when the mesh has been loaded
  20245. */
  20246. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20247. private _setButtonValue;
  20248. private _changes;
  20249. private _checkChanges;
  20250. /**
  20251. * Disposes of th webVRCOntroller
  20252. */
  20253. dispose(): void;
  20254. }
  20255. }
  20256. declare module "babylonjs/Lights/hemisphericLight" {
  20257. import { Nullable } from "babylonjs/types";
  20258. import { Scene } from "babylonjs/scene";
  20259. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20260. import { Color3 } from "babylonjs/Maths/math.color";
  20261. import { Effect } from "babylonjs/Materials/effect";
  20262. import { Light } from "babylonjs/Lights/light";
  20263. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20264. /**
  20265. * The HemisphericLight simulates the ambient environment light,
  20266. * so the passed direction is the light reflection direction, not the incoming direction.
  20267. */
  20268. export class HemisphericLight extends Light {
  20269. /**
  20270. * The groundColor is the light in the opposite direction to the one specified during creation.
  20271. * 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.
  20272. */
  20273. groundColor: Color3;
  20274. /**
  20275. * The light reflection direction, not the incoming direction.
  20276. */
  20277. direction: Vector3;
  20278. /**
  20279. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20280. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20281. * The HemisphericLight can't cast shadows.
  20282. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20283. * @param name The friendly name of the light
  20284. * @param direction The direction of the light reflection
  20285. * @param scene The scene the light belongs to
  20286. */
  20287. constructor(name: string, direction: Vector3, scene: Scene);
  20288. protected _buildUniformLayout(): void;
  20289. /**
  20290. * Returns the string "HemisphericLight".
  20291. * @return The class name
  20292. */
  20293. getClassName(): string;
  20294. /**
  20295. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20296. * Returns the updated direction.
  20297. * @param target The target the direction should point to
  20298. * @return The computed direction
  20299. */
  20300. setDirectionToTarget(target: Vector3): Vector3;
  20301. /**
  20302. * Returns the shadow generator associated to the light.
  20303. * @returns Always null for hemispheric lights because it does not support shadows.
  20304. */
  20305. getShadowGenerator(): Nullable<IShadowGenerator>;
  20306. /**
  20307. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20308. * @param effect The effect to update
  20309. * @param lightIndex The index of the light in the effect to update
  20310. * @returns The hemispheric light
  20311. */
  20312. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20313. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20314. /**
  20315. * Computes the world matrix of the node
  20316. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20317. * @param useWasUpdatedFlag defines a reserved property
  20318. * @returns the world matrix
  20319. */
  20320. computeWorldMatrix(): Matrix;
  20321. /**
  20322. * Returns the integer 3.
  20323. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20324. */
  20325. getTypeID(): number;
  20326. /**
  20327. * Prepares the list of defines specific to the light type.
  20328. * @param defines the list of defines
  20329. * @param lightIndex defines the index of the light for the effect
  20330. */
  20331. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20332. }
  20333. }
  20334. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20335. /** @hidden */
  20336. export var vrMultiviewToSingleviewPixelShader: {
  20337. name: string;
  20338. shader: string;
  20339. };
  20340. }
  20341. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20342. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20343. import { Scene } from "babylonjs/scene";
  20344. /**
  20345. * Renders to multiple views with a single draw call
  20346. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20347. */
  20348. export class MultiviewRenderTarget extends RenderTargetTexture {
  20349. /**
  20350. * Creates a multiview render target
  20351. * @param scene scene used with the render target
  20352. * @param size the size of the render target (used for each view)
  20353. */
  20354. constructor(scene: Scene, size?: number | {
  20355. width: number;
  20356. height: number;
  20357. } | {
  20358. ratio: number;
  20359. });
  20360. /**
  20361. * @hidden
  20362. * @param faceIndex the face index, if its a cube texture
  20363. */
  20364. _bindFrameBuffer(faceIndex?: number): void;
  20365. /**
  20366. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20367. * @returns the view count
  20368. */
  20369. getViewCount(): number;
  20370. }
  20371. }
  20372. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20373. import { Camera } from "babylonjs/Cameras/camera";
  20374. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20375. import { Nullable } from "babylonjs/types";
  20376. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20377. import { Matrix } from "babylonjs/Maths/math.vector";
  20378. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20379. module "babylonjs/Engines/engine" {
  20380. interface Engine {
  20381. /**
  20382. * Creates a new multiview render target
  20383. * @param width defines the width of the texture
  20384. * @param height defines the height of the texture
  20385. * @returns the created multiview texture
  20386. */
  20387. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20388. /**
  20389. * Binds a multiview framebuffer to be drawn to
  20390. * @param multiviewTexture texture to bind
  20391. */
  20392. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20393. }
  20394. }
  20395. module "babylonjs/Cameras/camera" {
  20396. interface Camera {
  20397. /**
  20398. * @hidden
  20399. * 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)
  20400. */
  20401. _useMultiviewToSingleView: boolean;
  20402. /**
  20403. * @hidden
  20404. * 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)
  20405. */
  20406. _multiviewTexture: Nullable<RenderTargetTexture>;
  20407. /**
  20408. * @hidden
  20409. * ensures the multiview texture of the camera exists and has the specified width/height
  20410. * @param width height to set on the multiview texture
  20411. * @param height width to set on the multiview texture
  20412. */
  20413. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20414. }
  20415. }
  20416. module "babylonjs/scene" {
  20417. interface Scene {
  20418. /** @hidden */
  20419. _transformMatrixR: Matrix;
  20420. /** @hidden */
  20421. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20422. /** @hidden */
  20423. _createMultiviewUbo(): void;
  20424. /** @hidden */
  20425. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20426. /** @hidden */
  20427. _renderMultiviewToSingleView(camera: Camera): void;
  20428. }
  20429. }
  20430. }
  20431. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20432. import { Camera } from "babylonjs/Cameras/camera";
  20433. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20434. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20435. import "babylonjs/Engines/Extensions/engine.multiview";
  20436. /**
  20437. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20438. * This will not be used for webXR as it supports displaying texture arrays directly
  20439. */
  20440. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20441. /**
  20442. * Gets a string identifying the name of the class
  20443. * @returns "VRMultiviewToSingleviewPostProcess" string
  20444. */
  20445. getClassName(): string;
  20446. /**
  20447. * Initializes a VRMultiviewToSingleview
  20448. * @param name name of the post process
  20449. * @param camera camera to be applied to
  20450. * @param scaleFactor scaling factor to the size of the output texture
  20451. */
  20452. constructor(name: string, camera: Camera, scaleFactor: number);
  20453. }
  20454. }
  20455. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20456. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20457. import { Nullable } from "babylonjs/types";
  20458. import { Size } from "babylonjs/Maths/math.size";
  20459. import { Observable } from "babylonjs/Misc/observable";
  20460. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20461. /**
  20462. * Interface used to define additional presentation attributes
  20463. */
  20464. export interface IVRPresentationAttributes {
  20465. /**
  20466. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20467. */
  20468. highRefreshRate: boolean;
  20469. /**
  20470. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20471. */
  20472. foveationLevel: number;
  20473. }
  20474. module "babylonjs/Engines/engine" {
  20475. interface Engine {
  20476. /** @hidden */
  20477. _vrDisplay: any;
  20478. /** @hidden */
  20479. _vrSupported: boolean;
  20480. /** @hidden */
  20481. _oldSize: Size;
  20482. /** @hidden */
  20483. _oldHardwareScaleFactor: number;
  20484. /** @hidden */
  20485. _vrExclusivePointerMode: boolean;
  20486. /** @hidden */
  20487. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20488. /** @hidden */
  20489. _onVRDisplayPointerRestricted: () => void;
  20490. /** @hidden */
  20491. _onVRDisplayPointerUnrestricted: () => void;
  20492. /** @hidden */
  20493. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20494. /** @hidden */
  20495. _onVrDisplayDisconnect: Nullable<() => void>;
  20496. /** @hidden */
  20497. _onVrDisplayPresentChange: Nullable<() => void>;
  20498. /**
  20499. * Observable signaled when VR display mode changes
  20500. */
  20501. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20502. /**
  20503. * Observable signaled when VR request present is complete
  20504. */
  20505. onVRRequestPresentComplete: Observable<boolean>;
  20506. /**
  20507. * Observable signaled when VR request present starts
  20508. */
  20509. onVRRequestPresentStart: Observable<Engine>;
  20510. /**
  20511. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20512. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20513. */
  20514. isInVRExclusivePointerMode: boolean;
  20515. /**
  20516. * Gets a boolean indicating if a webVR device was detected
  20517. * @returns true if a webVR device was detected
  20518. */
  20519. isVRDevicePresent(): boolean;
  20520. /**
  20521. * Gets the current webVR device
  20522. * @returns the current webVR device (or null)
  20523. */
  20524. getVRDevice(): any;
  20525. /**
  20526. * Initializes a webVR display and starts listening to display change events
  20527. * The onVRDisplayChangedObservable will be notified upon these changes
  20528. * @returns A promise containing a VRDisplay and if vr is supported
  20529. */
  20530. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20531. /** @hidden */
  20532. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20533. /**
  20534. * Gets or sets the presentation attributes used to configure VR rendering
  20535. */
  20536. vrPresentationAttributes?: IVRPresentationAttributes;
  20537. /**
  20538. * Call this function to switch to webVR mode
  20539. * Will do nothing if webVR is not supported or if there is no webVR device
  20540. * @param options the webvr options provided to the camera. mainly used for multiview
  20541. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20542. */
  20543. enableVR(options: WebVROptions): void;
  20544. /** @hidden */
  20545. _onVRFullScreenTriggered(): void;
  20546. }
  20547. }
  20548. }
  20549. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20550. import { Nullable } from "babylonjs/types";
  20551. import { Observable } from "babylonjs/Misc/observable";
  20552. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20553. import { Scene } from "babylonjs/scene";
  20554. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20555. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20556. import { Node } from "babylonjs/node";
  20557. import { Ray } from "babylonjs/Culling/ray";
  20558. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20559. import "babylonjs/Engines/Extensions/engine.webVR";
  20560. /**
  20561. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20562. * IMPORTANT!! The data is right-hand data.
  20563. * @export
  20564. * @interface DevicePose
  20565. */
  20566. export interface DevicePose {
  20567. /**
  20568. * The position of the device, values in array are [x,y,z].
  20569. */
  20570. readonly position: Nullable<Float32Array>;
  20571. /**
  20572. * The linearVelocity of the device, values in array are [x,y,z].
  20573. */
  20574. readonly linearVelocity: Nullable<Float32Array>;
  20575. /**
  20576. * The linearAcceleration of the device, values in array are [x,y,z].
  20577. */
  20578. readonly linearAcceleration: Nullable<Float32Array>;
  20579. /**
  20580. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20581. */
  20582. readonly orientation: Nullable<Float32Array>;
  20583. /**
  20584. * The angularVelocity of the device, values in array are [x,y,z].
  20585. */
  20586. readonly angularVelocity: Nullable<Float32Array>;
  20587. /**
  20588. * The angularAcceleration of the device, values in array are [x,y,z].
  20589. */
  20590. readonly angularAcceleration: Nullable<Float32Array>;
  20591. }
  20592. /**
  20593. * Interface representing a pose controlled object in Babylon.
  20594. * A pose controlled object has both regular pose values as well as pose values
  20595. * from an external device such as a VR head mounted display
  20596. */
  20597. export interface PoseControlled {
  20598. /**
  20599. * The position of the object in babylon space.
  20600. */
  20601. position: Vector3;
  20602. /**
  20603. * The rotation quaternion of the object in babylon space.
  20604. */
  20605. rotationQuaternion: Quaternion;
  20606. /**
  20607. * The position of the device in babylon space.
  20608. */
  20609. devicePosition?: Vector3;
  20610. /**
  20611. * The rotation quaternion of the device in babylon space.
  20612. */
  20613. deviceRotationQuaternion: Quaternion;
  20614. /**
  20615. * The raw pose coming from the device.
  20616. */
  20617. rawPose: Nullable<DevicePose>;
  20618. /**
  20619. * The scale of the device to be used when translating from device space to babylon space.
  20620. */
  20621. deviceScaleFactor: number;
  20622. /**
  20623. * Updates the poseControlled values based on the input device pose.
  20624. * @param poseData the pose data to update the object with
  20625. */
  20626. updateFromDevice(poseData: DevicePose): void;
  20627. }
  20628. /**
  20629. * Set of options to customize the webVRCamera
  20630. */
  20631. export interface WebVROptions {
  20632. /**
  20633. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20634. */
  20635. trackPosition?: boolean;
  20636. /**
  20637. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20638. */
  20639. positionScale?: number;
  20640. /**
  20641. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20642. */
  20643. displayName?: string;
  20644. /**
  20645. * Should the native controller meshes be initialized. (default: true)
  20646. */
  20647. controllerMeshes?: boolean;
  20648. /**
  20649. * Creating a default HemiLight only on controllers. (default: true)
  20650. */
  20651. defaultLightingOnControllers?: boolean;
  20652. /**
  20653. * If you don't want to use the default VR button of the helper. (default: false)
  20654. */
  20655. useCustomVRButton?: boolean;
  20656. /**
  20657. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20658. */
  20659. customVRButton?: HTMLButtonElement;
  20660. /**
  20661. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20662. */
  20663. rayLength?: number;
  20664. /**
  20665. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20666. */
  20667. defaultHeight?: number;
  20668. /**
  20669. * If multiview should be used if availible (default: false)
  20670. */
  20671. useMultiview?: boolean;
  20672. }
  20673. /**
  20674. * This represents a WebVR camera.
  20675. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20676. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20677. */
  20678. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20679. private webVROptions;
  20680. /**
  20681. * @hidden
  20682. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20683. */
  20684. _vrDevice: any;
  20685. /**
  20686. * The rawPose of the vrDevice.
  20687. */
  20688. rawPose: Nullable<DevicePose>;
  20689. private _onVREnabled;
  20690. private _specsVersion;
  20691. private _attached;
  20692. private _frameData;
  20693. protected _descendants: Array<Node>;
  20694. private _deviceRoomPosition;
  20695. /** @hidden */
  20696. _deviceRoomRotationQuaternion: Quaternion;
  20697. private _standingMatrix;
  20698. /**
  20699. * Represents device position in babylon space.
  20700. */
  20701. devicePosition: Vector3;
  20702. /**
  20703. * Represents device rotation in babylon space.
  20704. */
  20705. deviceRotationQuaternion: Quaternion;
  20706. /**
  20707. * The scale of the device to be used when translating from device space to babylon space.
  20708. */
  20709. deviceScaleFactor: number;
  20710. private _deviceToWorld;
  20711. private _worldToDevice;
  20712. /**
  20713. * References to the webVR controllers for the vrDevice.
  20714. */
  20715. controllers: Array<WebVRController>;
  20716. /**
  20717. * Emits an event when a controller is attached.
  20718. */
  20719. onControllersAttachedObservable: Observable<WebVRController[]>;
  20720. /**
  20721. * Emits an event when a controller's mesh has been loaded;
  20722. */
  20723. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20724. /**
  20725. * Emits an event when the HMD's pose has been updated.
  20726. */
  20727. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20728. private _poseSet;
  20729. /**
  20730. * If the rig cameras be used as parent instead of this camera.
  20731. */
  20732. rigParenting: boolean;
  20733. private _lightOnControllers;
  20734. private _defaultHeight?;
  20735. /**
  20736. * Instantiates a WebVRFreeCamera.
  20737. * @param name The name of the WebVRFreeCamera
  20738. * @param position The starting anchor position for the camera
  20739. * @param scene The scene the camera belongs to
  20740. * @param webVROptions a set of customizable options for the webVRCamera
  20741. */
  20742. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20743. /**
  20744. * Gets the device distance from the ground in meters.
  20745. * @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.
  20746. */
  20747. deviceDistanceToRoomGround(): number;
  20748. /**
  20749. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20750. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20751. */
  20752. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20753. /**
  20754. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20755. * @returns A promise with a boolean set to if the standing matrix is supported.
  20756. */
  20757. useStandingMatrixAsync(): Promise<boolean>;
  20758. /**
  20759. * Disposes the camera
  20760. */
  20761. dispose(): void;
  20762. /**
  20763. * Gets a vrController by name.
  20764. * @param name The name of the controller to retreive
  20765. * @returns the controller matching the name specified or null if not found
  20766. */
  20767. getControllerByName(name: string): Nullable<WebVRController>;
  20768. private _leftController;
  20769. /**
  20770. * The controller corresponding to the users left hand.
  20771. */
  20772. get leftController(): Nullable<WebVRController>;
  20773. private _rightController;
  20774. /**
  20775. * The controller corresponding to the users right hand.
  20776. */
  20777. get rightController(): Nullable<WebVRController>;
  20778. /**
  20779. * Casts a ray forward from the vrCamera's gaze.
  20780. * @param length Length of the ray (default: 100)
  20781. * @returns the ray corresponding to the gaze
  20782. */
  20783. getForwardRay(length?: number): Ray;
  20784. /**
  20785. * @hidden
  20786. * Updates the camera based on device's frame data
  20787. */
  20788. _checkInputs(): void;
  20789. /**
  20790. * Updates the poseControlled values based on the input device pose.
  20791. * @param poseData Pose coming from the device
  20792. */
  20793. updateFromDevice(poseData: DevicePose): void;
  20794. private _htmlElementAttached;
  20795. private _detachIfAttached;
  20796. /**
  20797. * WebVR's attach control will start broadcasting frames to the device.
  20798. * Note that in certain browsers (chrome for example) this function must be called
  20799. * within a user-interaction callback. Example:
  20800. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20801. *
  20802. * @param element html element to attach the vrDevice to
  20803. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20804. */
  20805. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20806. /**
  20807. * Detaches the camera from the html element and disables VR
  20808. *
  20809. * @param element html element to detach from
  20810. */
  20811. detachControl(element: HTMLElement): void;
  20812. /**
  20813. * @returns the name of this class
  20814. */
  20815. getClassName(): string;
  20816. /**
  20817. * Calls resetPose on the vrDisplay
  20818. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20819. */
  20820. resetToCurrentRotation(): void;
  20821. /**
  20822. * @hidden
  20823. * Updates the rig cameras (left and right eye)
  20824. */
  20825. _updateRigCameras(): void;
  20826. private _workingVector;
  20827. private _oneVector;
  20828. private _workingMatrix;
  20829. private updateCacheCalled;
  20830. private _correctPositionIfNotTrackPosition;
  20831. /**
  20832. * @hidden
  20833. * Updates the cached values of the camera
  20834. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20835. */
  20836. _updateCache(ignoreParentClass?: boolean): void;
  20837. /**
  20838. * @hidden
  20839. * Get current device position in babylon world
  20840. */
  20841. _computeDevicePosition(): void;
  20842. /**
  20843. * Updates the current device position and rotation in the babylon world
  20844. */
  20845. update(): void;
  20846. /**
  20847. * @hidden
  20848. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20849. * @returns an identity matrix
  20850. */
  20851. _getViewMatrix(): Matrix;
  20852. private _tmpMatrix;
  20853. /**
  20854. * This function is called by the two RIG cameras.
  20855. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20856. * @hidden
  20857. */
  20858. _getWebVRViewMatrix(): Matrix;
  20859. /** @hidden */
  20860. _getWebVRProjectionMatrix(): Matrix;
  20861. private _onGamepadConnectedObserver;
  20862. private _onGamepadDisconnectedObserver;
  20863. private _updateCacheWhenTrackingDisabledObserver;
  20864. /**
  20865. * Initializes the controllers and their meshes
  20866. */
  20867. initControllers(): void;
  20868. }
  20869. }
  20870. declare module "babylonjs/Materials/materialHelper" {
  20871. import { Nullable } from "babylonjs/types";
  20872. import { Scene } from "babylonjs/scene";
  20873. import { Engine } from "babylonjs/Engines/engine";
  20874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20875. import { Light } from "babylonjs/Lights/light";
  20876. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20877. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20878. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20879. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20880. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20881. /**
  20882. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20883. *
  20884. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20885. *
  20886. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20887. */
  20888. export class MaterialHelper {
  20889. /**
  20890. * Bind the current view position to an effect.
  20891. * @param effect The effect to be bound
  20892. * @param scene The scene the eyes position is used from
  20893. * @param variableName name of the shader variable that will hold the eye position
  20894. */
  20895. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20896. /**
  20897. * Helps preparing the defines values about the UVs in used in the effect.
  20898. * UVs are shared as much as we can accross channels in the shaders.
  20899. * @param texture The texture we are preparing the UVs for
  20900. * @param defines The defines to update
  20901. * @param key The channel key "diffuse", "specular"... used in the shader
  20902. */
  20903. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20904. /**
  20905. * Binds a texture matrix value to its corrsponding uniform
  20906. * @param texture The texture to bind the matrix for
  20907. * @param uniformBuffer The uniform buffer receivin the data
  20908. * @param key The channel key "diffuse", "specular"... used in the shader
  20909. */
  20910. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20911. /**
  20912. * Gets the current status of the fog (should it be enabled?)
  20913. * @param mesh defines the mesh to evaluate for fog support
  20914. * @param scene defines the hosting scene
  20915. * @returns true if fog must be enabled
  20916. */
  20917. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20918. /**
  20919. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20920. * @param mesh defines the current mesh
  20921. * @param scene defines the current scene
  20922. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20923. * @param pointsCloud defines if point cloud rendering has to be turned on
  20924. * @param fogEnabled defines if fog has to be turned on
  20925. * @param alphaTest defines if alpha testing has to be turned on
  20926. * @param defines defines the current list of defines
  20927. */
  20928. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20929. /**
  20930. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20931. * @param scene defines the current scene
  20932. * @param engine defines the current engine
  20933. * @param defines specifies the list of active defines
  20934. * @param useInstances defines if instances have to be turned on
  20935. * @param useClipPlane defines if clip plane have to be turned on
  20936. * @param useInstances defines if instances have to be turned on
  20937. * @param useThinInstances defines if thin instances have to be turned on
  20938. */
  20939. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20940. /**
  20941. * Prepares the defines for bones
  20942. * @param mesh The mesh containing the geometry data we will draw
  20943. * @param defines The defines to update
  20944. */
  20945. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20946. /**
  20947. * Prepares the defines for morph targets
  20948. * @param mesh The mesh containing the geometry data we will draw
  20949. * @param defines The defines to update
  20950. */
  20951. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20952. /**
  20953. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20954. * @param mesh The mesh containing the geometry data we will draw
  20955. * @param defines The defines to update
  20956. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20957. * @param useBones Precise whether bones should be used or not (override mesh info)
  20958. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20959. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20960. * @returns false if defines are considered not dirty and have not been checked
  20961. */
  20962. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20963. /**
  20964. * Prepares the defines related to multiview
  20965. * @param scene The scene we are intending to draw
  20966. * @param defines The defines to update
  20967. */
  20968. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20969. /**
  20970. * Prepares the defines related to the prepass
  20971. * @param scene The scene we are intending to draw
  20972. * @param defines The defines to update
  20973. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20974. */
  20975. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20976. /**
  20977. * Prepares the defines related to the light information passed in parameter
  20978. * @param scene The scene we are intending to draw
  20979. * @param mesh The mesh the effect is compiling for
  20980. * @param light The light the effect is compiling for
  20981. * @param lightIndex The index of the light
  20982. * @param defines The defines to update
  20983. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20984. * @param state Defines the current state regarding what is needed (normals, etc...)
  20985. */
  20986. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20987. needNormals: boolean;
  20988. needRebuild: boolean;
  20989. shadowEnabled: boolean;
  20990. specularEnabled: boolean;
  20991. lightmapMode: boolean;
  20992. }): void;
  20993. /**
  20994. * Prepares the defines related to the light information passed in parameter
  20995. * @param scene The scene we are intending to draw
  20996. * @param mesh The mesh the effect is compiling for
  20997. * @param defines The defines to update
  20998. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20999. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  21000. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  21001. * @returns true if normals will be required for the rest of the effect
  21002. */
  21003. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  21004. /**
  21005. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  21006. * @param lightIndex defines the light index
  21007. * @param uniformsList The uniform list
  21008. * @param samplersList The sampler list
  21009. * @param projectedLightTexture defines if projected texture must be used
  21010. * @param uniformBuffersList defines an optional list of uniform buffers
  21011. */
  21012. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  21013. /**
  21014. * Prepares the uniforms and samplers list to be used in the effect
  21015. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  21016. * @param samplersList The sampler list
  21017. * @param defines The defines helping in the list generation
  21018. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  21019. */
  21020. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  21021. /**
  21022. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  21023. * @param defines The defines to update while falling back
  21024. * @param fallbacks The authorized effect fallbacks
  21025. * @param maxSimultaneousLights The maximum number of lights allowed
  21026. * @param rank the current rank of the Effect
  21027. * @returns The newly affected rank
  21028. */
  21029. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  21030. private static _TmpMorphInfluencers;
  21031. /**
  21032. * Prepares the list of attributes required for morph targets according to the effect defines.
  21033. * @param attribs The current list of supported attribs
  21034. * @param mesh The mesh to prepare the morph targets attributes for
  21035. * @param influencers The number of influencers
  21036. */
  21037. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  21038. /**
  21039. * Prepares the list of attributes required for morph targets according to the effect defines.
  21040. * @param attribs The current list of supported attribs
  21041. * @param mesh The mesh to prepare the morph targets attributes for
  21042. * @param defines The current Defines of the effect
  21043. */
  21044. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  21045. /**
  21046. * Prepares the list of attributes required for bones according to the effect defines.
  21047. * @param attribs The current list of supported attribs
  21048. * @param mesh The mesh to prepare the bones attributes for
  21049. * @param defines The current Defines of the effect
  21050. * @param fallbacks The current efffect fallback strategy
  21051. */
  21052. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  21053. /**
  21054. * Check and prepare the list of attributes required for instances according to the effect defines.
  21055. * @param attribs The current list of supported attribs
  21056. * @param defines The current MaterialDefines of the effect
  21057. */
  21058. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  21059. /**
  21060. * Add the list of attributes required for instances to the attribs array.
  21061. * @param attribs The current list of supported attribs
  21062. */
  21063. static PushAttributesForInstances(attribs: string[]): void;
  21064. /**
  21065. * Binds the light information to the effect.
  21066. * @param light The light containing the generator
  21067. * @param effect The effect we are binding the data to
  21068. * @param lightIndex The light index in the effect used to render
  21069. */
  21070. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  21071. /**
  21072. * Binds the lights information from the scene to the effect for the given mesh.
  21073. * @param light Light to bind
  21074. * @param lightIndex Light index
  21075. * @param scene The scene where the light belongs to
  21076. * @param effect The effect we are binding the data to
  21077. * @param useSpecular Defines if specular is supported
  21078. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21079. */
  21080. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21081. /**
  21082. * Binds the lights information from the scene to the effect for the given mesh.
  21083. * @param scene The scene the lights belongs to
  21084. * @param mesh The mesh we are binding the information to render
  21085. * @param effect The effect we are binding the data to
  21086. * @param defines The generated defines for the effect
  21087. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21088. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21089. */
  21090. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21091. private static _tempFogColor;
  21092. /**
  21093. * Binds the fog information from the scene to the effect for the given mesh.
  21094. * @param scene The scene the lights belongs to
  21095. * @param mesh The mesh we are binding the information to render
  21096. * @param effect The effect we are binding the data to
  21097. * @param linearSpace Defines if the fog effect is applied in linear space
  21098. */
  21099. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21100. /**
  21101. * Binds the bones information from the mesh to the effect.
  21102. * @param mesh The mesh we are binding the information to render
  21103. * @param effect The effect we are binding the data to
  21104. */
  21105. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21106. /**
  21107. * Binds the morph targets information from the mesh to the effect.
  21108. * @param abstractMesh The mesh we are binding the information to render
  21109. * @param effect The effect we are binding the data to
  21110. */
  21111. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21112. /**
  21113. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21114. * @param defines The generated defines used in the effect
  21115. * @param effect The effect we are binding the data to
  21116. * @param scene The scene we are willing to render with logarithmic scale for
  21117. */
  21118. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21119. /**
  21120. * Binds the clip plane information from the scene to the effect.
  21121. * @param scene The scene the clip plane information are extracted from
  21122. * @param effect The effect we are binding the data to
  21123. */
  21124. static BindClipPlane(effect: Effect, scene: Scene): void;
  21125. }
  21126. }
  21127. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21128. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21129. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21130. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21131. import { Nullable } from "babylonjs/types";
  21132. import { Effect } from "babylonjs/Materials/effect";
  21133. import { Matrix } from "babylonjs/Maths/math.vector";
  21134. import { Scene } from "babylonjs/scene";
  21135. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21136. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21137. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21138. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21139. import { Observable } from "babylonjs/Misc/observable";
  21140. /**
  21141. * Block used to expose an input value
  21142. */
  21143. export class InputBlock extends NodeMaterialBlock {
  21144. private _mode;
  21145. private _associatedVariableName;
  21146. private _storedValue;
  21147. private _valueCallback;
  21148. private _type;
  21149. private _animationType;
  21150. /** Gets or set a value used to limit the range of float values */
  21151. min: number;
  21152. /** Gets or set a value used to limit the range of float values */
  21153. max: number;
  21154. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21155. isBoolean: boolean;
  21156. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21157. matrixMode: number;
  21158. /** @hidden */
  21159. _systemValue: Nullable<NodeMaterialSystemValues>;
  21160. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21161. isConstant: boolean;
  21162. /** Gets or sets the group to use to display this block in the Inspector */
  21163. groupInInspector: string;
  21164. /** Gets an observable raised when the value is changed */
  21165. onValueChangedObservable: Observable<InputBlock>;
  21166. /**
  21167. * Gets or sets the connection point type (default is float)
  21168. */
  21169. get type(): NodeMaterialBlockConnectionPointTypes;
  21170. /**
  21171. * Creates a new InputBlock
  21172. * @param name defines the block name
  21173. * @param target defines the target of that block (Vertex by default)
  21174. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21175. */
  21176. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21177. /**
  21178. * Validates if a name is a reserve word.
  21179. * @param newName the new name to be given to the node.
  21180. * @returns false if the name is a reserve word, else true.
  21181. */
  21182. validateBlockName(newName: string): boolean;
  21183. /**
  21184. * Gets the output component
  21185. */
  21186. get output(): NodeMaterialConnectionPoint;
  21187. /**
  21188. * Set the source of this connection point to a vertex attribute
  21189. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21190. * @returns the current connection point
  21191. */
  21192. setAsAttribute(attributeName?: string): InputBlock;
  21193. /**
  21194. * Set the source of this connection point to a system value
  21195. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21196. * @returns the current connection point
  21197. */
  21198. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21199. /**
  21200. * Gets or sets the value of that point.
  21201. * Please note that this value will be ignored if valueCallback is defined
  21202. */
  21203. get value(): any;
  21204. set value(value: any);
  21205. /**
  21206. * Gets or sets a callback used to get the value of that point.
  21207. * Please note that setting this value will force the connection point to ignore the value property
  21208. */
  21209. get valueCallback(): () => any;
  21210. set valueCallback(value: () => any);
  21211. /**
  21212. * Gets or sets the associated variable name in the shader
  21213. */
  21214. get associatedVariableName(): string;
  21215. set associatedVariableName(value: string);
  21216. /** Gets or sets the type of animation applied to the input */
  21217. get animationType(): AnimatedInputBlockTypes;
  21218. set animationType(value: AnimatedInputBlockTypes);
  21219. /**
  21220. * Gets a boolean indicating that this connection point not defined yet
  21221. */
  21222. get isUndefined(): boolean;
  21223. /**
  21224. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21225. * In this case the connection point name must be the name of the uniform to use.
  21226. * Can only be set on inputs
  21227. */
  21228. get isUniform(): boolean;
  21229. set isUniform(value: boolean);
  21230. /**
  21231. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21232. * In this case the connection point name must be the name of the attribute to use
  21233. * Can only be set on inputs
  21234. */
  21235. get isAttribute(): boolean;
  21236. set isAttribute(value: boolean);
  21237. /**
  21238. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21239. * Can only be set on exit points
  21240. */
  21241. get isVarying(): boolean;
  21242. set isVarying(value: boolean);
  21243. /**
  21244. * Gets a boolean indicating that the current connection point is a system value
  21245. */
  21246. get isSystemValue(): boolean;
  21247. /**
  21248. * Gets or sets the current well known value or null if not defined as a system value
  21249. */
  21250. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21251. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21252. /**
  21253. * Gets the current class name
  21254. * @returns the class name
  21255. */
  21256. getClassName(): string;
  21257. /**
  21258. * Animate the input if animationType !== None
  21259. * @param scene defines the rendering scene
  21260. */
  21261. animate(scene: Scene): void;
  21262. private _emitDefine;
  21263. initialize(state: NodeMaterialBuildState): void;
  21264. /**
  21265. * Set the input block to its default value (based on its type)
  21266. */
  21267. setDefaultValue(): void;
  21268. private _emitConstant;
  21269. /** @hidden */
  21270. get _noContextSwitch(): boolean;
  21271. private _emit;
  21272. /** @hidden */
  21273. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21274. /** @hidden */
  21275. _transmit(effect: Effect, scene: Scene): void;
  21276. protected _buildBlock(state: NodeMaterialBuildState): void;
  21277. protected _dumpPropertiesCode(): string;
  21278. dispose(): void;
  21279. serialize(): any;
  21280. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21281. }
  21282. }
  21283. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21284. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21285. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21286. import { Nullable } from "babylonjs/types";
  21287. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21288. import { Observable } from "babylonjs/Misc/observable";
  21289. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21290. /**
  21291. * Enum used to define the compatibility state between two connection points
  21292. */
  21293. export enum NodeMaterialConnectionPointCompatibilityStates {
  21294. /** Points are compatibles */
  21295. Compatible = 0,
  21296. /** Points are incompatible because of their types */
  21297. TypeIncompatible = 1,
  21298. /** Points are incompatible because of their targets (vertex vs fragment) */
  21299. TargetIncompatible = 2
  21300. }
  21301. /**
  21302. * Defines the direction of a connection point
  21303. */
  21304. export enum NodeMaterialConnectionPointDirection {
  21305. /** Input */
  21306. Input = 0,
  21307. /** Output */
  21308. Output = 1
  21309. }
  21310. /**
  21311. * Defines a connection point for a block
  21312. */
  21313. export class NodeMaterialConnectionPoint {
  21314. /** @hidden */
  21315. _ownerBlock: NodeMaterialBlock;
  21316. /** @hidden */
  21317. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21318. private _endpoints;
  21319. private _associatedVariableName;
  21320. private _direction;
  21321. /** @hidden */
  21322. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21323. /** @hidden */
  21324. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21325. private _type;
  21326. /** @hidden */
  21327. _enforceAssociatedVariableName: boolean;
  21328. /** Gets the direction of the point */
  21329. get direction(): NodeMaterialConnectionPointDirection;
  21330. /** Indicates that this connection point needs dual validation before being connected to another point */
  21331. needDualDirectionValidation: boolean;
  21332. /**
  21333. * Gets or sets the additional types supported by this connection point
  21334. */
  21335. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21336. /**
  21337. * Gets or sets the additional types excluded by this connection point
  21338. */
  21339. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21340. /**
  21341. * Observable triggered when this point is connected
  21342. */
  21343. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21344. /**
  21345. * Gets or sets the associated variable name in the shader
  21346. */
  21347. get associatedVariableName(): string;
  21348. set associatedVariableName(value: string);
  21349. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21350. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21351. /**
  21352. * Gets or sets the connection point type (default is float)
  21353. */
  21354. get type(): NodeMaterialBlockConnectionPointTypes;
  21355. set type(value: NodeMaterialBlockConnectionPointTypes);
  21356. /**
  21357. * Gets or sets the connection point name
  21358. */
  21359. name: string;
  21360. /**
  21361. * Gets or sets the connection point name
  21362. */
  21363. displayName: string;
  21364. /**
  21365. * Gets or sets a boolean indicating that this connection point can be omitted
  21366. */
  21367. isOptional: boolean;
  21368. /**
  21369. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21370. */
  21371. isExposedOnFrame: boolean;
  21372. /**
  21373. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21374. */
  21375. define: string;
  21376. /** @hidden */
  21377. _prioritizeVertex: boolean;
  21378. private _target;
  21379. /** Gets or sets the target of that connection point */
  21380. get target(): NodeMaterialBlockTargets;
  21381. set target(value: NodeMaterialBlockTargets);
  21382. /**
  21383. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21384. */
  21385. get isConnected(): boolean;
  21386. /**
  21387. * Gets a boolean indicating that the current point is connected to an input block
  21388. */
  21389. get isConnectedToInputBlock(): boolean;
  21390. /**
  21391. * Gets a the connected input block (if any)
  21392. */
  21393. get connectInputBlock(): Nullable<InputBlock>;
  21394. /** Get the other side of the connection (if any) */
  21395. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21396. /** Get the block that owns this connection point */
  21397. get ownerBlock(): NodeMaterialBlock;
  21398. /** Get the block connected on the other side of this connection (if any) */
  21399. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21400. /** Get the block connected on the endpoints of this connection (if any) */
  21401. get connectedBlocks(): Array<NodeMaterialBlock>;
  21402. /** Gets the list of connected endpoints */
  21403. get endpoints(): NodeMaterialConnectionPoint[];
  21404. /** Gets a boolean indicating if that output point is connected to at least one input */
  21405. get hasEndpoints(): boolean;
  21406. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21407. get isConnectedInVertexShader(): boolean;
  21408. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21409. get isConnectedInFragmentShader(): boolean;
  21410. /**
  21411. * Creates a block suitable to be used as an input for this input point.
  21412. * If null is returned, a block based on the point type will be created.
  21413. * @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
  21414. */
  21415. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21416. /**
  21417. * Creates a new connection point
  21418. * @param name defines the connection point name
  21419. * @param ownerBlock defines the block hosting this connection point
  21420. * @param direction defines the direction of the connection point
  21421. */
  21422. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21423. /**
  21424. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21425. * @returns the class name
  21426. */
  21427. getClassName(): string;
  21428. /**
  21429. * Gets a boolean indicating if the current point can be connected to another point
  21430. * @param connectionPoint defines the other connection point
  21431. * @returns a boolean
  21432. */
  21433. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21434. /**
  21435. * Gets a number indicating if the current point can be connected to another point
  21436. * @param connectionPoint defines the other connection point
  21437. * @returns a number defining the compatibility state
  21438. */
  21439. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21440. /**
  21441. * Connect this point to another connection point
  21442. * @param connectionPoint defines the other connection point
  21443. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21444. * @returns the current connection point
  21445. */
  21446. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21447. /**
  21448. * Disconnect this point from one of his endpoint
  21449. * @param endpoint defines the other connection point
  21450. * @returns the current connection point
  21451. */
  21452. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21453. /**
  21454. * Serializes this point in a JSON representation
  21455. * @param isInput defines if the connection point is an input (default is true)
  21456. * @returns the serialized point object
  21457. */
  21458. serialize(isInput?: boolean): any;
  21459. /**
  21460. * Release resources
  21461. */
  21462. dispose(): void;
  21463. }
  21464. }
  21465. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21466. /**
  21467. * Enum used to define the material modes
  21468. */
  21469. export enum NodeMaterialModes {
  21470. /** Regular material */
  21471. Material = 0,
  21472. /** For post process */
  21473. PostProcess = 1,
  21474. /** For particle system */
  21475. Particle = 2,
  21476. /** For procedural texture */
  21477. ProceduralTexture = 3
  21478. }
  21479. }
  21480. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21481. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21482. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21483. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21484. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21486. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21487. import { Effect } from "babylonjs/Materials/effect";
  21488. import { Mesh } from "babylonjs/Meshes/mesh";
  21489. import { Nullable } from "babylonjs/types";
  21490. import { Texture } from "babylonjs/Materials/Textures/texture";
  21491. import { Scene } from "babylonjs/scene";
  21492. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21493. /**
  21494. * Block used to read a texture from a sampler
  21495. */
  21496. export class TextureBlock extends NodeMaterialBlock {
  21497. private _defineName;
  21498. private _linearDefineName;
  21499. private _gammaDefineName;
  21500. private _tempTextureRead;
  21501. private _samplerName;
  21502. private _transformedUVName;
  21503. private _textureTransformName;
  21504. private _textureInfoName;
  21505. private _mainUVName;
  21506. private _mainUVDefineName;
  21507. private _fragmentOnly;
  21508. /**
  21509. * Gets or sets the texture associated with the node
  21510. */
  21511. texture: Nullable<Texture>;
  21512. /**
  21513. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21514. */
  21515. convertToGammaSpace: boolean;
  21516. /**
  21517. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21518. */
  21519. convertToLinearSpace: boolean;
  21520. /**
  21521. * Create a new TextureBlock
  21522. * @param name defines the block name
  21523. */
  21524. constructor(name: string, fragmentOnly?: boolean);
  21525. /**
  21526. * Gets the current class name
  21527. * @returns the class name
  21528. */
  21529. getClassName(): string;
  21530. /**
  21531. * Gets the uv input component
  21532. */
  21533. get uv(): NodeMaterialConnectionPoint;
  21534. /**
  21535. * Gets the rgba output component
  21536. */
  21537. get rgba(): NodeMaterialConnectionPoint;
  21538. /**
  21539. * Gets the rgb output component
  21540. */
  21541. get rgb(): NodeMaterialConnectionPoint;
  21542. /**
  21543. * Gets the r output component
  21544. */
  21545. get r(): NodeMaterialConnectionPoint;
  21546. /**
  21547. * Gets the g output component
  21548. */
  21549. get g(): NodeMaterialConnectionPoint;
  21550. /**
  21551. * Gets the b output component
  21552. */
  21553. get b(): NodeMaterialConnectionPoint;
  21554. /**
  21555. * Gets the a output component
  21556. */
  21557. get a(): NodeMaterialConnectionPoint;
  21558. get target(): NodeMaterialBlockTargets;
  21559. autoConfigure(material: NodeMaterial): void;
  21560. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21561. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21562. isReady(): boolean;
  21563. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21564. private get _isMixed();
  21565. private _injectVertexCode;
  21566. private _writeTextureRead;
  21567. private _writeOutput;
  21568. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21569. protected _dumpPropertiesCode(): string;
  21570. serialize(): any;
  21571. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21572. }
  21573. }
  21574. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21575. /** @hidden */
  21576. export var reflectionFunction: {
  21577. name: string;
  21578. shader: string;
  21579. };
  21580. }
  21581. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21582. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21583. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21584. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21585. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21586. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21587. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21588. import { Effect } from "babylonjs/Materials/effect";
  21589. import { Mesh } from "babylonjs/Meshes/mesh";
  21590. import { Nullable } from "babylonjs/types";
  21591. import { Scene } from "babylonjs/scene";
  21592. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21593. /**
  21594. * Base block used to read a reflection texture from a sampler
  21595. */
  21596. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21597. /** @hidden */
  21598. _define3DName: string;
  21599. /** @hidden */
  21600. _defineCubicName: string;
  21601. /** @hidden */
  21602. _defineExplicitName: string;
  21603. /** @hidden */
  21604. _defineProjectionName: string;
  21605. /** @hidden */
  21606. _defineLocalCubicName: string;
  21607. /** @hidden */
  21608. _defineSphericalName: string;
  21609. /** @hidden */
  21610. _definePlanarName: string;
  21611. /** @hidden */
  21612. _defineEquirectangularName: string;
  21613. /** @hidden */
  21614. _defineMirroredEquirectangularFixedName: string;
  21615. /** @hidden */
  21616. _defineEquirectangularFixedName: string;
  21617. /** @hidden */
  21618. _defineSkyboxName: string;
  21619. /** @hidden */
  21620. _defineOppositeZ: string;
  21621. /** @hidden */
  21622. _cubeSamplerName: string;
  21623. /** @hidden */
  21624. _2DSamplerName: string;
  21625. protected _positionUVWName: string;
  21626. protected _directionWName: string;
  21627. protected _reflectionVectorName: string;
  21628. /** @hidden */
  21629. _reflectionCoordsName: string;
  21630. /** @hidden */
  21631. _reflectionMatrixName: string;
  21632. protected _reflectionColorName: string;
  21633. /**
  21634. * Gets or sets the texture associated with the node
  21635. */
  21636. texture: Nullable<BaseTexture>;
  21637. /**
  21638. * Create a new ReflectionTextureBaseBlock
  21639. * @param name defines the block name
  21640. */
  21641. constructor(name: string);
  21642. /**
  21643. * Gets the current class name
  21644. * @returns the class name
  21645. */
  21646. getClassName(): string;
  21647. /**
  21648. * Gets the world position input component
  21649. */
  21650. abstract get position(): NodeMaterialConnectionPoint;
  21651. /**
  21652. * Gets the world position input component
  21653. */
  21654. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21655. /**
  21656. * Gets the world normal input component
  21657. */
  21658. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21659. /**
  21660. * Gets the world input component
  21661. */
  21662. abstract get world(): NodeMaterialConnectionPoint;
  21663. /**
  21664. * Gets the camera (or eye) position component
  21665. */
  21666. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21667. /**
  21668. * Gets the view input component
  21669. */
  21670. abstract get view(): NodeMaterialConnectionPoint;
  21671. protected _getTexture(): Nullable<BaseTexture>;
  21672. autoConfigure(material: NodeMaterial): void;
  21673. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21674. isReady(): boolean;
  21675. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21676. /**
  21677. * Gets the code to inject in the vertex shader
  21678. * @param state current state of the node material building
  21679. * @returns the shader code
  21680. */
  21681. handleVertexSide(state: NodeMaterialBuildState): string;
  21682. /**
  21683. * Handles the inits for the fragment code path
  21684. * @param state node material build state
  21685. */
  21686. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21687. /**
  21688. * Generates the reflection coords code for the fragment code path
  21689. * @param worldNormalVarName name of the world normal variable
  21690. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21691. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21692. * @returns the shader code
  21693. */
  21694. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21695. /**
  21696. * Generates the reflection color code for the fragment code path
  21697. * @param lodVarName name of the lod variable
  21698. * @param swizzleLookupTexture swizzle to use for the final color variable
  21699. * @returns the shader code
  21700. */
  21701. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21702. /**
  21703. * Generates the code corresponding to the connected output points
  21704. * @param state node material build state
  21705. * @param varName name of the variable to output
  21706. * @returns the shader code
  21707. */
  21708. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21709. protected _buildBlock(state: NodeMaterialBuildState): this;
  21710. protected _dumpPropertiesCode(): string;
  21711. serialize(): any;
  21712. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21713. }
  21714. }
  21715. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21716. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21717. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21718. import { Nullable } from "babylonjs/types";
  21719. /**
  21720. * Defines a connection point to be used for points with a custom object type
  21721. */
  21722. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21723. private _blockType;
  21724. private _blockName;
  21725. private _nameForCheking?;
  21726. /**
  21727. * Creates a new connection point
  21728. * @param name defines the connection point name
  21729. * @param ownerBlock defines the block hosting this connection point
  21730. * @param direction defines the direction of the connection point
  21731. */
  21732. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21733. /**
  21734. * Gets a number indicating if the current point can be connected to another point
  21735. * @param connectionPoint defines the other connection point
  21736. * @returns a number defining the compatibility state
  21737. */
  21738. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21739. /**
  21740. * Creates a block suitable to be used as an input for this input point.
  21741. * If null is returned, a block based on the point type will be created.
  21742. * @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
  21743. */
  21744. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21745. }
  21746. }
  21747. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21748. /**
  21749. * Enum defining the type of properties that can be edited in the property pages in the NME
  21750. */
  21751. export enum PropertyTypeForEdition {
  21752. /** property is a boolean */
  21753. Boolean = 0,
  21754. /** property is a float */
  21755. Float = 1,
  21756. /** property is a Vector2 */
  21757. Vector2 = 2,
  21758. /** property is a list of values */
  21759. List = 3
  21760. }
  21761. /**
  21762. * Interface that defines an option in a variable of type list
  21763. */
  21764. export interface IEditablePropertyListOption {
  21765. /** label of the option */
  21766. "label": string;
  21767. /** value of the option */
  21768. "value": number;
  21769. }
  21770. /**
  21771. * Interface that defines the options available for an editable property
  21772. */
  21773. export interface IEditablePropertyOption {
  21774. /** min value */
  21775. "min"?: number;
  21776. /** max value */
  21777. "max"?: number;
  21778. /** notifiers: indicates which actions to take when the property is changed */
  21779. "notifiers"?: {
  21780. /** the material should be rebuilt */
  21781. "rebuild"?: boolean;
  21782. /** the preview should be updated */
  21783. "update"?: boolean;
  21784. };
  21785. /** list of the options for a variable of type list */
  21786. "options"?: IEditablePropertyListOption[];
  21787. }
  21788. /**
  21789. * Interface that describes an editable property
  21790. */
  21791. export interface IPropertyDescriptionForEdition {
  21792. /** name of the property */
  21793. "propertyName": string;
  21794. /** display name of the property */
  21795. "displayName": string;
  21796. /** type of the property */
  21797. "type": PropertyTypeForEdition;
  21798. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21799. "groupName": string;
  21800. /** options for the property */
  21801. "options": IEditablePropertyOption;
  21802. }
  21803. /**
  21804. * Decorator that flags a property in a node material block as being editable
  21805. */
  21806. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21807. }
  21808. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21809. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21810. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21811. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21812. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21813. import { Nullable } from "babylonjs/types";
  21814. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21815. import { Mesh } from "babylonjs/Meshes/mesh";
  21816. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21817. import { Effect } from "babylonjs/Materials/effect";
  21818. import { Scene } from "babylonjs/scene";
  21819. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21820. /**
  21821. * Block used to implement the refraction part of the sub surface module of the PBR material
  21822. */
  21823. export class RefractionBlock extends NodeMaterialBlock {
  21824. /** @hidden */
  21825. _define3DName: string;
  21826. /** @hidden */
  21827. _refractionMatrixName: string;
  21828. /** @hidden */
  21829. _defineLODRefractionAlpha: string;
  21830. /** @hidden */
  21831. _defineLinearSpecularRefraction: string;
  21832. /** @hidden */
  21833. _defineOppositeZ: string;
  21834. /** @hidden */
  21835. _cubeSamplerName: string;
  21836. /** @hidden */
  21837. _2DSamplerName: string;
  21838. /** @hidden */
  21839. _vRefractionMicrosurfaceInfosName: string;
  21840. /** @hidden */
  21841. _vRefractionInfosName: string;
  21842. private _scene;
  21843. /**
  21844. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21845. * Materials half opaque for instance using refraction could benefit from this control.
  21846. */
  21847. linkRefractionWithTransparency: boolean;
  21848. /**
  21849. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21850. */
  21851. invertRefractionY: boolean;
  21852. /**
  21853. * Gets or sets the texture associated with the node
  21854. */
  21855. texture: Nullable<BaseTexture>;
  21856. /**
  21857. * Create a new RefractionBlock
  21858. * @param name defines the block name
  21859. */
  21860. constructor(name: string);
  21861. /**
  21862. * Gets the current class name
  21863. * @returns the class name
  21864. */
  21865. getClassName(): string;
  21866. /**
  21867. * Gets the intensity input component
  21868. */
  21869. get intensity(): NodeMaterialConnectionPoint;
  21870. /**
  21871. * Gets the index of refraction input component
  21872. */
  21873. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21874. /**
  21875. * Gets the tint at distance input component
  21876. */
  21877. get tintAtDistance(): NodeMaterialConnectionPoint;
  21878. /**
  21879. * Gets the view input component
  21880. */
  21881. get view(): NodeMaterialConnectionPoint;
  21882. /**
  21883. * Gets the refraction object output component
  21884. */
  21885. get refraction(): NodeMaterialConnectionPoint;
  21886. /**
  21887. * Returns true if the block has a texture
  21888. */
  21889. get hasTexture(): boolean;
  21890. protected _getTexture(): Nullable<BaseTexture>;
  21891. autoConfigure(material: NodeMaterial): void;
  21892. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21893. isReady(): boolean;
  21894. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21895. /**
  21896. * Gets the main code of the block (fragment side)
  21897. * @param state current state of the node material building
  21898. * @returns the shader code
  21899. */
  21900. getCode(state: NodeMaterialBuildState): string;
  21901. protected _buildBlock(state: NodeMaterialBuildState): this;
  21902. protected _dumpPropertiesCode(): string;
  21903. serialize(): any;
  21904. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21905. }
  21906. }
  21907. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21908. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21909. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21910. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21911. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21912. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21913. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21914. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21915. import { Nullable } from "babylonjs/types";
  21916. import { Scene } from "babylonjs/scene";
  21917. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21918. /**
  21919. * Base block used as input for post process
  21920. */
  21921. export class CurrentScreenBlock extends NodeMaterialBlock {
  21922. private _samplerName;
  21923. private _linearDefineName;
  21924. private _gammaDefineName;
  21925. private _mainUVName;
  21926. private _tempTextureRead;
  21927. /**
  21928. * Gets or sets the texture associated with the node
  21929. */
  21930. texture: Nullable<BaseTexture>;
  21931. /**
  21932. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21933. */
  21934. convertToGammaSpace: boolean;
  21935. /**
  21936. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21937. */
  21938. convertToLinearSpace: boolean;
  21939. /**
  21940. * Create a new CurrentScreenBlock
  21941. * @param name defines the block name
  21942. */
  21943. constructor(name: string);
  21944. /**
  21945. * Gets the current class name
  21946. * @returns the class name
  21947. */
  21948. getClassName(): string;
  21949. /**
  21950. * Gets the uv input component
  21951. */
  21952. get uv(): NodeMaterialConnectionPoint;
  21953. /**
  21954. * Gets the rgba output component
  21955. */
  21956. get rgba(): NodeMaterialConnectionPoint;
  21957. /**
  21958. * Gets the rgb output component
  21959. */
  21960. get rgb(): NodeMaterialConnectionPoint;
  21961. /**
  21962. * Gets the r output component
  21963. */
  21964. get r(): NodeMaterialConnectionPoint;
  21965. /**
  21966. * Gets the g output component
  21967. */
  21968. get g(): NodeMaterialConnectionPoint;
  21969. /**
  21970. * Gets the b output component
  21971. */
  21972. get b(): NodeMaterialConnectionPoint;
  21973. /**
  21974. * Gets the a output component
  21975. */
  21976. get a(): NodeMaterialConnectionPoint;
  21977. /**
  21978. * Initialize the block and prepare the context for build
  21979. * @param state defines the state that will be used for the build
  21980. */
  21981. initialize(state: NodeMaterialBuildState): void;
  21982. get target(): NodeMaterialBlockTargets;
  21983. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21984. isReady(): boolean;
  21985. private _injectVertexCode;
  21986. private _writeTextureRead;
  21987. private _writeOutput;
  21988. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21989. serialize(): any;
  21990. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21991. }
  21992. }
  21993. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21994. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21995. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21996. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21997. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21998. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21999. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22000. import { Nullable } from "babylonjs/types";
  22001. import { Scene } from "babylonjs/scene";
  22002. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  22003. /**
  22004. * Base block used for the particle texture
  22005. */
  22006. export class ParticleTextureBlock extends NodeMaterialBlock {
  22007. private _samplerName;
  22008. private _linearDefineName;
  22009. private _gammaDefineName;
  22010. private _tempTextureRead;
  22011. /**
  22012. * Gets or sets the texture associated with the node
  22013. */
  22014. texture: Nullable<BaseTexture>;
  22015. /**
  22016. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  22017. */
  22018. convertToGammaSpace: boolean;
  22019. /**
  22020. * Gets or sets a boolean indicating if content needs to be converted to linear space
  22021. */
  22022. convertToLinearSpace: boolean;
  22023. /**
  22024. * Create a new ParticleTextureBlock
  22025. * @param name defines the block name
  22026. */
  22027. constructor(name: string);
  22028. /**
  22029. * Gets the current class name
  22030. * @returns the class name
  22031. */
  22032. getClassName(): string;
  22033. /**
  22034. * Gets the uv input component
  22035. */
  22036. get uv(): NodeMaterialConnectionPoint;
  22037. /**
  22038. * Gets the rgba output component
  22039. */
  22040. get rgba(): NodeMaterialConnectionPoint;
  22041. /**
  22042. * Gets the rgb output component
  22043. */
  22044. get rgb(): NodeMaterialConnectionPoint;
  22045. /**
  22046. * Gets the r output component
  22047. */
  22048. get r(): NodeMaterialConnectionPoint;
  22049. /**
  22050. * Gets the g output component
  22051. */
  22052. get g(): NodeMaterialConnectionPoint;
  22053. /**
  22054. * Gets the b output component
  22055. */
  22056. get b(): NodeMaterialConnectionPoint;
  22057. /**
  22058. * Gets the a output component
  22059. */
  22060. get a(): NodeMaterialConnectionPoint;
  22061. /**
  22062. * Initialize the block and prepare the context for build
  22063. * @param state defines the state that will be used for the build
  22064. */
  22065. initialize(state: NodeMaterialBuildState): void;
  22066. autoConfigure(material: NodeMaterial): void;
  22067. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  22068. isReady(): boolean;
  22069. private _writeOutput;
  22070. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22071. serialize(): any;
  22072. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22073. }
  22074. }
  22075. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22076. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22077. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22078. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22079. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22080. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22081. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22082. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22083. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22084. import { Scene } from "babylonjs/scene";
  22085. /**
  22086. * Class used to store shared data between 2 NodeMaterialBuildState
  22087. */
  22088. export class NodeMaterialBuildStateSharedData {
  22089. /**
  22090. * Gets the list of emitted varyings
  22091. */
  22092. temps: string[];
  22093. /**
  22094. * Gets the list of emitted varyings
  22095. */
  22096. varyings: string[];
  22097. /**
  22098. * Gets the varying declaration string
  22099. */
  22100. varyingDeclaration: string;
  22101. /**
  22102. * Input blocks
  22103. */
  22104. inputBlocks: InputBlock[];
  22105. /**
  22106. * Input blocks
  22107. */
  22108. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22109. /**
  22110. * Bindable blocks (Blocks that need to set data to the effect)
  22111. */
  22112. bindableBlocks: NodeMaterialBlock[];
  22113. /**
  22114. * List of blocks that can provide a compilation fallback
  22115. */
  22116. blocksWithFallbacks: NodeMaterialBlock[];
  22117. /**
  22118. * List of blocks that can provide a define update
  22119. */
  22120. blocksWithDefines: NodeMaterialBlock[];
  22121. /**
  22122. * List of blocks that can provide a repeatable content
  22123. */
  22124. repeatableContentBlocks: NodeMaterialBlock[];
  22125. /**
  22126. * List of blocks that can provide a dynamic list of uniforms
  22127. */
  22128. dynamicUniformBlocks: NodeMaterialBlock[];
  22129. /**
  22130. * List of blocks that can block the isReady function for the material
  22131. */
  22132. blockingBlocks: NodeMaterialBlock[];
  22133. /**
  22134. * Gets the list of animated inputs
  22135. */
  22136. animatedInputs: InputBlock[];
  22137. /**
  22138. * Build Id used to avoid multiple recompilations
  22139. */
  22140. buildId: number;
  22141. /** List of emitted variables */
  22142. variableNames: {
  22143. [key: string]: number;
  22144. };
  22145. /** List of emitted defines */
  22146. defineNames: {
  22147. [key: string]: number;
  22148. };
  22149. /** Should emit comments? */
  22150. emitComments: boolean;
  22151. /** Emit build activity */
  22152. verbose: boolean;
  22153. /** Gets or sets the hosting scene */
  22154. scene: Scene;
  22155. /**
  22156. * Gets the compilation hints emitted at compilation time
  22157. */
  22158. hints: {
  22159. needWorldViewMatrix: boolean;
  22160. needWorldViewProjectionMatrix: boolean;
  22161. needAlphaBlending: boolean;
  22162. needAlphaTesting: boolean;
  22163. };
  22164. /**
  22165. * List of compilation checks
  22166. */
  22167. checks: {
  22168. emitVertex: boolean;
  22169. emitFragment: boolean;
  22170. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22171. };
  22172. /**
  22173. * Is vertex program allowed to be empty?
  22174. */
  22175. allowEmptyVertexProgram: boolean;
  22176. /** Creates a new shared data */
  22177. constructor();
  22178. /**
  22179. * Emits console errors and exceptions if there is a failing check
  22180. */
  22181. emitErrors(): void;
  22182. }
  22183. }
  22184. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22185. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22186. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22187. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22188. /**
  22189. * Class used to store node based material build state
  22190. */
  22191. export class NodeMaterialBuildState {
  22192. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22193. supportUniformBuffers: boolean;
  22194. /**
  22195. * Gets the list of emitted attributes
  22196. */
  22197. attributes: string[];
  22198. /**
  22199. * Gets the list of emitted uniforms
  22200. */
  22201. uniforms: string[];
  22202. /**
  22203. * Gets the list of emitted constants
  22204. */
  22205. constants: string[];
  22206. /**
  22207. * Gets the list of emitted samplers
  22208. */
  22209. samplers: string[];
  22210. /**
  22211. * Gets the list of emitted functions
  22212. */
  22213. functions: {
  22214. [key: string]: string;
  22215. };
  22216. /**
  22217. * Gets the list of emitted extensions
  22218. */
  22219. extensions: {
  22220. [key: string]: string;
  22221. };
  22222. /**
  22223. * Gets the target of the compilation state
  22224. */
  22225. target: NodeMaterialBlockTargets;
  22226. /**
  22227. * Gets the list of emitted counters
  22228. */
  22229. counters: {
  22230. [key: string]: number;
  22231. };
  22232. /**
  22233. * Shared data between multiple NodeMaterialBuildState instances
  22234. */
  22235. sharedData: NodeMaterialBuildStateSharedData;
  22236. /** @hidden */
  22237. _vertexState: NodeMaterialBuildState;
  22238. /** @hidden */
  22239. _attributeDeclaration: string;
  22240. /** @hidden */
  22241. _uniformDeclaration: string;
  22242. /** @hidden */
  22243. _constantDeclaration: string;
  22244. /** @hidden */
  22245. _samplerDeclaration: string;
  22246. /** @hidden */
  22247. _varyingTransfer: string;
  22248. /** @hidden */
  22249. _injectAtEnd: string;
  22250. private _repeatableContentAnchorIndex;
  22251. /** @hidden */
  22252. _builtCompilationString: string;
  22253. /**
  22254. * Gets the emitted compilation strings
  22255. */
  22256. compilationString: string;
  22257. /**
  22258. * Finalize the compilation strings
  22259. * @param state defines the current compilation state
  22260. */
  22261. finalize(state: NodeMaterialBuildState): void;
  22262. /** @hidden */
  22263. get _repeatableContentAnchor(): string;
  22264. /** @hidden */
  22265. _getFreeVariableName(prefix: string): string;
  22266. /** @hidden */
  22267. _getFreeDefineName(prefix: string): string;
  22268. /** @hidden */
  22269. _excludeVariableName(name: string): void;
  22270. /** @hidden */
  22271. _emit2DSampler(name: string): void;
  22272. /** @hidden */
  22273. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22274. /** @hidden */
  22275. _emitExtension(name: string, extension: string, define?: string): void;
  22276. /** @hidden */
  22277. _emitFunction(name: string, code: string, comments: string): void;
  22278. /** @hidden */
  22279. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22280. replaceStrings?: {
  22281. search: RegExp;
  22282. replace: string;
  22283. }[];
  22284. repeatKey?: string;
  22285. }): string;
  22286. /** @hidden */
  22287. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22288. repeatKey?: string;
  22289. removeAttributes?: boolean;
  22290. removeUniforms?: boolean;
  22291. removeVaryings?: boolean;
  22292. removeIfDef?: boolean;
  22293. replaceStrings?: {
  22294. search: RegExp;
  22295. replace: string;
  22296. }[];
  22297. }, storeKey?: string): void;
  22298. /** @hidden */
  22299. _registerTempVariable(name: string): boolean;
  22300. /** @hidden */
  22301. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22302. /** @hidden */
  22303. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22304. /** @hidden */
  22305. _emitFloat(value: number): string;
  22306. }
  22307. }
  22308. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22309. /**
  22310. * Helper class used to generate session unique ID
  22311. */
  22312. export class UniqueIdGenerator {
  22313. private static _UniqueIdCounter;
  22314. /**
  22315. * Gets an unique (relatively to the current scene) Id
  22316. */
  22317. static get UniqueId(): number;
  22318. }
  22319. }
  22320. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22321. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22322. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22323. import { Nullable } from "babylonjs/types";
  22324. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22325. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22326. import { Effect } from "babylonjs/Materials/effect";
  22327. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22328. import { Mesh } from "babylonjs/Meshes/mesh";
  22329. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22330. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22331. import { Scene } from "babylonjs/scene";
  22332. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22333. /**
  22334. * Defines a block that can be used inside a node based material
  22335. */
  22336. export class NodeMaterialBlock {
  22337. private _buildId;
  22338. private _buildTarget;
  22339. private _target;
  22340. private _isFinalMerger;
  22341. private _isInput;
  22342. private _name;
  22343. protected _isUnique: boolean;
  22344. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22345. inputsAreExclusive: boolean;
  22346. /** @hidden */
  22347. _codeVariableName: string;
  22348. /** @hidden */
  22349. _inputs: NodeMaterialConnectionPoint[];
  22350. /** @hidden */
  22351. _outputs: NodeMaterialConnectionPoint[];
  22352. /** @hidden */
  22353. _preparationId: number;
  22354. /**
  22355. * Gets the name of the block
  22356. */
  22357. get name(): string;
  22358. /**
  22359. * Sets the name of the block. Will check if the name is valid.
  22360. */
  22361. set name(newName: string);
  22362. /**
  22363. * Gets or sets the unique id of the node
  22364. */
  22365. uniqueId: number;
  22366. /**
  22367. * Gets or sets the comments associated with this block
  22368. */
  22369. comments: string;
  22370. /**
  22371. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22372. */
  22373. get isUnique(): boolean;
  22374. /**
  22375. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22376. */
  22377. get isFinalMerger(): boolean;
  22378. /**
  22379. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22380. */
  22381. get isInput(): boolean;
  22382. /**
  22383. * Gets or sets the build Id
  22384. */
  22385. get buildId(): number;
  22386. set buildId(value: number);
  22387. /**
  22388. * Gets or sets the target of the block
  22389. */
  22390. get target(): NodeMaterialBlockTargets;
  22391. set target(value: NodeMaterialBlockTargets);
  22392. /**
  22393. * Gets the list of input points
  22394. */
  22395. get inputs(): NodeMaterialConnectionPoint[];
  22396. /** Gets the list of output points */
  22397. get outputs(): NodeMaterialConnectionPoint[];
  22398. /**
  22399. * Find an input by its name
  22400. * @param name defines the name of the input to look for
  22401. * @returns the input or null if not found
  22402. */
  22403. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22404. /**
  22405. * Find an output by its name
  22406. * @param name defines the name of the outputto look for
  22407. * @returns the output or null if not found
  22408. */
  22409. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22410. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  22411. visibleInInspector: boolean;
  22412. /**
  22413. * Creates a new NodeMaterialBlock
  22414. * @param name defines the block name
  22415. * @param target defines the target of that block (Vertex by default)
  22416. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22417. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22418. */
  22419. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22420. /**
  22421. * Initialize the block and prepare the context for build
  22422. * @param state defines the state that will be used for the build
  22423. */
  22424. initialize(state: NodeMaterialBuildState): void;
  22425. /**
  22426. * Bind data to effect. Will only be called for blocks with isBindable === true
  22427. * @param effect defines the effect to bind data to
  22428. * @param nodeMaterial defines the hosting NodeMaterial
  22429. * @param mesh defines the mesh that will be rendered
  22430. * @param subMesh defines the submesh that will be rendered
  22431. */
  22432. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22433. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22434. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22435. protected _writeFloat(value: number): string;
  22436. /**
  22437. * Gets the current class name e.g. "NodeMaterialBlock"
  22438. * @returns the class name
  22439. */
  22440. getClassName(): string;
  22441. /**
  22442. * Register a new input. Must be called inside a block constructor
  22443. * @param name defines the connection point name
  22444. * @param type defines the connection point type
  22445. * @param isOptional defines a boolean indicating that this input can be omitted
  22446. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22447. * @param point an already created connection point. If not provided, create a new one
  22448. * @returns the current block
  22449. */
  22450. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22451. /**
  22452. * Register a new output. Must be called inside a block constructor
  22453. * @param name defines the connection point name
  22454. * @param type defines the connection point type
  22455. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22456. * @param point an already created connection point. If not provided, create a new one
  22457. * @returns the current block
  22458. */
  22459. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22460. /**
  22461. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22462. * @param forOutput defines an optional connection point to check compatibility with
  22463. * @returns the first available input or null
  22464. */
  22465. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22466. /**
  22467. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22468. * @param forBlock defines an optional block to check compatibility with
  22469. * @returns the first available input or null
  22470. */
  22471. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22472. /**
  22473. * Gets the sibling of the given output
  22474. * @param current defines the current output
  22475. * @returns the next output in the list or null
  22476. */
  22477. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22478. /**
  22479. * Connect current block with another block
  22480. * @param other defines the block to connect with
  22481. * @param options define the various options to help pick the right connections
  22482. * @returns the current block
  22483. */
  22484. connectTo(other: NodeMaterialBlock, options?: {
  22485. input?: string;
  22486. output?: string;
  22487. outputSwizzle?: string;
  22488. }): this | undefined;
  22489. protected _buildBlock(state: NodeMaterialBuildState): void;
  22490. /**
  22491. * Add uniforms, samplers and uniform buffers at compilation time
  22492. * @param state defines the state to update
  22493. * @param nodeMaterial defines the node material requesting the update
  22494. * @param defines defines the material defines to update
  22495. * @param uniformBuffers defines the list of uniform buffer names
  22496. */
  22497. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22498. /**
  22499. * Add potential fallbacks if shader compilation fails
  22500. * @param mesh defines the mesh to be rendered
  22501. * @param fallbacks defines the current prioritized list of fallbacks
  22502. */
  22503. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22504. /**
  22505. * Initialize defines for shader compilation
  22506. * @param mesh defines the mesh to be rendered
  22507. * @param nodeMaterial defines the node material requesting the update
  22508. * @param defines defines the material defines to update
  22509. * @param useInstances specifies that instances should be used
  22510. */
  22511. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22512. /**
  22513. * Update defines for shader compilation
  22514. * @param mesh defines the mesh to be rendered
  22515. * @param nodeMaterial defines the node material requesting the update
  22516. * @param defines defines the material defines to update
  22517. * @param useInstances specifies that instances should be used
  22518. * @param subMesh defines which submesh to render
  22519. */
  22520. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22521. /**
  22522. * Lets the block try to connect some inputs automatically
  22523. * @param material defines the hosting NodeMaterial
  22524. */
  22525. autoConfigure(material: NodeMaterial): void;
  22526. /**
  22527. * Function called when a block is declared as repeatable content generator
  22528. * @param vertexShaderState defines the current compilation state for the vertex shader
  22529. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22530. * @param mesh defines the mesh to be rendered
  22531. * @param defines defines the material defines to update
  22532. */
  22533. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22534. /**
  22535. * Checks if the block is ready
  22536. * @param mesh defines the mesh to be rendered
  22537. * @param nodeMaterial defines the node material requesting the update
  22538. * @param defines defines the material defines to update
  22539. * @param useInstances specifies that instances should be used
  22540. * @returns true if the block is ready
  22541. */
  22542. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22543. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22544. private _processBuild;
  22545. /**
  22546. * Validates the new name for the block node.
  22547. * @param newName the new name to be given to the node.
  22548. * @returns false if the name is a reserve word, else true.
  22549. */
  22550. validateBlockName(newName: string): boolean;
  22551. /**
  22552. * Compile the current node and generate the shader code
  22553. * @param state defines the current compilation state (uniforms, samplers, current string)
  22554. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22555. * @returns true if already built
  22556. */
  22557. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22558. protected _inputRename(name: string): string;
  22559. protected _outputRename(name: string): string;
  22560. protected _dumpPropertiesCode(): string;
  22561. /** @hidden */
  22562. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22563. /** @hidden */
  22564. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22565. /**
  22566. * Clone the current block to a new identical block
  22567. * @param scene defines the hosting scene
  22568. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22569. * @returns a copy of the current block
  22570. */
  22571. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22572. /**
  22573. * Serializes this block in a JSON representation
  22574. * @returns the serialized block object
  22575. */
  22576. serialize(): any;
  22577. /** @hidden */
  22578. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22579. private _deserializePortDisplayNamesAndExposedOnFrame;
  22580. /**
  22581. * Release resources
  22582. */
  22583. dispose(): void;
  22584. }
  22585. }
  22586. declare module "babylonjs/Materials/pushMaterial" {
  22587. import { Nullable } from "babylonjs/types";
  22588. import { Scene } from "babylonjs/scene";
  22589. import { Matrix } from "babylonjs/Maths/math.vector";
  22590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22591. import { Mesh } from "babylonjs/Meshes/mesh";
  22592. import { Material } from "babylonjs/Materials/material";
  22593. import { Effect } from "babylonjs/Materials/effect";
  22594. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22595. /**
  22596. * Base class of materials working in push mode in babylon JS
  22597. * @hidden
  22598. */
  22599. export class PushMaterial extends Material {
  22600. protected _activeEffect: Effect;
  22601. protected _normalMatrix: Matrix;
  22602. constructor(name: string, scene: Scene);
  22603. getEffect(): Effect;
  22604. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22605. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22606. /**
  22607. * Binds the given world matrix to the active effect
  22608. *
  22609. * @param world the matrix to bind
  22610. */
  22611. bindOnlyWorldMatrix(world: Matrix): void;
  22612. /**
  22613. * Binds the given normal matrix to the active effect
  22614. *
  22615. * @param normalMatrix the matrix to bind
  22616. */
  22617. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22618. bind(world: Matrix, mesh?: Mesh): void;
  22619. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22620. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22621. }
  22622. }
  22623. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22624. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22625. /**
  22626. * Root class for all node material optimizers
  22627. */
  22628. export class NodeMaterialOptimizer {
  22629. /**
  22630. * Function used to optimize a NodeMaterial graph
  22631. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22632. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22633. */
  22634. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22635. }
  22636. }
  22637. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22638. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22639. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22640. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22641. import { Scene } from "babylonjs/scene";
  22642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22643. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22644. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22645. /**
  22646. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22647. */
  22648. export class TransformBlock extends NodeMaterialBlock {
  22649. /**
  22650. * Defines the value to use to complement W value to transform it to a Vector4
  22651. */
  22652. complementW: number;
  22653. /**
  22654. * Defines the value to use to complement z value to transform it to a Vector4
  22655. */
  22656. complementZ: number;
  22657. /**
  22658. * Creates a new TransformBlock
  22659. * @param name defines the block name
  22660. */
  22661. constructor(name: string);
  22662. /**
  22663. * Gets the current class name
  22664. * @returns the class name
  22665. */
  22666. getClassName(): string;
  22667. /**
  22668. * Gets the vector input
  22669. */
  22670. get vector(): NodeMaterialConnectionPoint;
  22671. /**
  22672. * Gets the output component
  22673. */
  22674. get output(): NodeMaterialConnectionPoint;
  22675. /**
  22676. * Gets the xyz output component
  22677. */
  22678. get xyz(): NodeMaterialConnectionPoint;
  22679. /**
  22680. * Gets the matrix transform input
  22681. */
  22682. get transform(): NodeMaterialConnectionPoint;
  22683. protected _buildBlock(state: NodeMaterialBuildState): this;
  22684. /**
  22685. * Update defines for shader compilation
  22686. * @param mesh defines the mesh to be rendered
  22687. * @param nodeMaterial defines the node material requesting the update
  22688. * @param defines defines the material defines to update
  22689. * @param useInstances specifies that instances should be used
  22690. * @param subMesh defines which submesh to render
  22691. */
  22692. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22693. serialize(): any;
  22694. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22695. protected _dumpPropertiesCode(): string;
  22696. }
  22697. }
  22698. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22699. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22700. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22701. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22702. /**
  22703. * Block used to output the vertex position
  22704. */
  22705. export class VertexOutputBlock extends NodeMaterialBlock {
  22706. /**
  22707. * Creates a new VertexOutputBlock
  22708. * @param name defines the block name
  22709. */
  22710. constructor(name: string);
  22711. /**
  22712. * Gets the current class name
  22713. * @returns the class name
  22714. */
  22715. getClassName(): string;
  22716. /**
  22717. * Gets the vector input component
  22718. */
  22719. get vector(): NodeMaterialConnectionPoint;
  22720. protected _buildBlock(state: NodeMaterialBuildState): this;
  22721. }
  22722. }
  22723. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22724. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22725. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22726. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22727. /**
  22728. * Block used to output the final color
  22729. */
  22730. export class FragmentOutputBlock extends NodeMaterialBlock {
  22731. /**
  22732. * Create a new FragmentOutputBlock
  22733. * @param name defines the block name
  22734. */
  22735. constructor(name: string);
  22736. /**
  22737. * Gets the current class name
  22738. * @returns the class name
  22739. */
  22740. getClassName(): string;
  22741. /**
  22742. * Gets the rgba input component
  22743. */
  22744. get rgba(): NodeMaterialConnectionPoint;
  22745. /**
  22746. * Gets the rgb input component
  22747. */
  22748. get rgb(): NodeMaterialConnectionPoint;
  22749. /**
  22750. * Gets the a input component
  22751. */
  22752. get a(): NodeMaterialConnectionPoint;
  22753. protected _buildBlock(state: NodeMaterialBuildState): this;
  22754. }
  22755. }
  22756. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22757. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22758. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22759. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22760. /**
  22761. * Block used for the particle ramp gradient section
  22762. */
  22763. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22764. /**
  22765. * Create a new ParticleRampGradientBlock
  22766. * @param name defines the block name
  22767. */
  22768. constructor(name: string);
  22769. /**
  22770. * Gets the current class name
  22771. * @returns the class name
  22772. */
  22773. getClassName(): string;
  22774. /**
  22775. * Gets the color input component
  22776. */
  22777. get color(): NodeMaterialConnectionPoint;
  22778. /**
  22779. * Gets the rampColor output component
  22780. */
  22781. get rampColor(): NodeMaterialConnectionPoint;
  22782. /**
  22783. * Initialize the block and prepare the context for build
  22784. * @param state defines the state that will be used for the build
  22785. */
  22786. initialize(state: NodeMaterialBuildState): void;
  22787. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22788. }
  22789. }
  22790. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22791. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22792. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22793. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22794. /**
  22795. * Block used for the particle blend multiply section
  22796. */
  22797. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22798. /**
  22799. * Create a new ParticleBlendMultiplyBlock
  22800. * @param name defines the block name
  22801. */
  22802. constructor(name: string);
  22803. /**
  22804. * Gets the current class name
  22805. * @returns the class name
  22806. */
  22807. getClassName(): string;
  22808. /**
  22809. * Gets the color input component
  22810. */
  22811. get color(): NodeMaterialConnectionPoint;
  22812. /**
  22813. * Gets the alphaTexture input component
  22814. */
  22815. get alphaTexture(): NodeMaterialConnectionPoint;
  22816. /**
  22817. * Gets the alphaColor input component
  22818. */
  22819. get alphaColor(): NodeMaterialConnectionPoint;
  22820. /**
  22821. * Gets the blendColor output component
  22822. */
  22823. get blendColor(): NodeMaterialConnectionPoint;
  22824. /**
  22825. * Initialize the block and prepare the context for build
  22826. * @param state defines the state that will be used for the build
  22827. */
  22828. initialize(state: NodeMaterialBuildState): void;
  22829. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22830. }
  22831. }
  22832. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22833. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22834. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22835. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22836. /**
  22837. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22838. */
  22839. export class VectorMergerBlock extends NodeMaterialBlock {
  22840. /**
  22841. * Create a new VectorMergerBlock
  22842. * @param name defines the block name
  22843. */
  22844. constructor(name: string);
  22845. /**
  22846. * Gets the current class name
  22847. * @returns the class name
  22848. */
  22849. getClassName(): string;
  22850. /**
  22851. * Gets the xyz component (input)
  22852. */
  22853. get xyzIn(): NodeMaterialConnectionPoint;
  22854. /**
  22855. * Gets the xy component (input)
  22856. */
  22857. get xyIn(): NodeMaterialConnectionPoint;
  22858. /**
  22859. * Gets the x component (input)
  22860. */
  22861. get x(): NodeMaterialConnectionPoint;
  22862. /**
  22863. * Gets the y component (input)
  22864. */
  22865. get y(): NodeMaterialConnectionPoint;
  22866. /**
  22867. * Gets the z component (input)
  22868. */
  22869. get z(): NodeMaterialConnectionPoint;
  22870. /**
  22871. * Gets the w component (input)
  22872. */
  22873. get w(): NodeMaterialConnectionPoint;
  22874. /**
  22875. * Gets the xyzw component (output)
  22876. */
  22877. get xyzw(): NodeMaterialConnectionPoint;
  22878. /**
  22879. * Gets the xyz component (output)
  22880. */
  22881. get xyzOut(): NodeMaterialConnectionPoint;
  22882. /**
  22883. * Gets the xy component (output)
  22884. */
  22885. get xyOut(): NodeMaterialConnectionPoint;
  22886. /**
  22887. * Gets the xy component (output)
  22888. * @deprecated Please use xyOut instead.
  22889. */
  22890. get xy(): NodeMaterialConnectionPoint;
  22891. /**
  22892. * Gets the xyz component (output)
  22893. * @deprecated Please use xyzOut instead.
  22894. */
  22895. get xyz(): NodeMaterialConnectionPoint;
  22896. protected _buildBlock(state: NodeMaterialBuildState): this;
  22897. }
  22898. }
  22899. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22900. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22901. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22902. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22903. import { Vector2 } from "babylonjs/Maths/math.vector";
  22904. import { Scene } from "babylonjs/scene";
  22905. /**
  22906. * Block used to remap a float from a range to a new one
  22907. */
  22908. export class RemapBlock extends NodeMaterialBlock {
  22909. /**
  22910. * Gets or sets the source range
  22911. */
  22912. sourceRange: Vector2;
  22913. /**
  22914. * Gets or sets the target range
  22915. */
  22916. targetRange: Vector2;
  22917. /**
  22918. * Creates a new RemapBlock
  22919. * @param name defines the block name
  22920. */
  22921. constructor(name: string);
  22922. /**
  22923. * Gets the current class name
  22924. * @returns the class name
  22925. */
  22926. getClassName(): string;
  22927. /**
  22928. * Gets the input component
  22929. */
  22930. get input(): NodeMaterialConnectionPoint;
  22931. /**
  22932. * Gets the source min input component
  22933. */
  22934. get sourceMin(): NodeMaterialConnectionPoint;
  22935. /**
  22936. * Gets the source max input component
  22937. */
  22938. get sourceMax(): NodeMaterialConnectionPoint;
  22939. /**
  22940. * Gets the target min input component
  22941. */
  22942. get targetMin(): NodeMaterialConnectionPoint;
  22943. /**
  22944. * Gets the target max input component
  22945. */
  22946. get targetMax(): NodeMaterialConnectionPoint;
  22947. /**
  22948. * Gets the output component
  22949. */
  22950. get output(): NodeMaterialConnectionPoint;
  22951. protected _buildBlock(state: NodeMaterialBuildState): this;
  22952. protected _dumpPropertiesCode(): string;
  22953. serialize(): any;
  22954. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22955. }
  22956. }
  22957. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22958. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22959. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22960. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22961. /**
  22962. * Block used to multiply 2 values
  22963. */
  22964. export class MultiplyBlock extends NodeMaterialBlock {
  22965. /**
  22966. * Creates a new MultiplyBlock
  22967. * @param name defines the block name
  22968. */
  22969. constructor(name: string);
  22970. /**
  22971. * Gets the current class name
  22972. * @returns the class name
  22973. */
  22974. getClassName(): string;
  22975. /**
  22976. * Gets the left operand input component
  22977. */
  22978. get left(): NodeMaterialConnectionPoint;
  22979. /**
  22980. * Gets the right operand input component
  22981. */
  22982. get right(): NodeMaterialConnectionPoint;
  22983. /**
  22984. * Gets the output component
  22985. */
  22986. get output(): NodeMaterialConnectionPoint;
  22987. protected _buildBlock(state: NodeMaterialBuildState): this;
  22988. }
  22989. }
  22990. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22991. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22992. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22993. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22994. /**
  22995. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22996. */
  22997. export class ColorSplitterBlock extends NodeMaterialBlock {
  22998. /**
  22999. * Create a new ColorSplitterBlock
  23000. * @param name defines the block name
  23001. */
  23002. constructor(name: string);
  23003. /**
  23004. * Gets the current class name
  23005. * @returns the class name
  23006. */
  23007. getClassName(): string;
  23008. /**
  23009. * Gets the rgba component (input)
  23010. */
  23011. get rgba(): NodeMaterialConnectionPoint;
  23012. /**
  23013. * Gets the rgb component (input)
  23014. */
  23015. get rgbIn(): NodeMaterialConnectionPoint;
  23016. /**
  23017. * Gets the rgb component (output)
  23018. */
  23019. get rgbOut(): NodeMaterialConnectionPoint;
  23020. /**
  23021. * Gets the r component (output)
  23022. */
  23023. get r(): NodeMaterialConnectionPoint;
  23024. /**
  23025. * Gets the g component (output)
  23026. */
  23027. get g(): NodeMaterialConnectionPoint;
  23028. /**
  23029. * Gets the b component (output)
  23030. */
  23031. get b(): NodeMaterialConnectionPoint;
  23032. /**
  23033. * Gets the a component (output)
  23034. */
  23035. get a(): NodeMaterialConnectionPoint;
  23036. protected _inputRename(name: string): string;
  23037. protected _outputRename(name: string): string;
  23038. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  23039. }
  23040. }
  23041. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  23042. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23043. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  23044. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  23045. import { Scene } from "babylonjs/scene";
  23046. /**
  23047. * Operations supported by the Trigonometry block
  23048. */
  23049. export enum TrigonometryBlockOperations {
  23050. /** Cos */
  23051. Cos = 0,
  23052. /** Sin */
  23053. Sin = 1,
  23054. /** Abs */
  23055. Abs = 2,
  23056. /** Exp */
  23057. Exp = 3,
  23058. /** Exp2 */
  23059. Exp2 = 4,
  23060. /** Round */
  23061. Round = 5,
  23062. /** Floor */
  23063. Floor = 6,
  23064. /** Ceiling */
  23065. Ceiling = 7,
  23066. /** Square root */
  23067. Sqrt = 8,
  23068. /** Log */
  23069. Log = 9,
  23070. /** Tangent */
  23071. Tan = 10,
  23072. /** Arc tangent */
  23073. ArcTan = 11,
  23074. /** Arc cosinus */
  23075. ArcCos = 12,
  23076. /** Arc sinus */
  23077. ArcSin = 13,
  23078. /** Fraction */
  23079. Fract = 14,
  23080. /** Sign */
  23081. Sign = 15,
  23082. /** To radians (from degrees) */
  23083. Radians = 16,
  23084. /** To degrees (from radians) */
  23085. Degrees = 17
  23086. }
  23087. /**
  23088. * Block used to apply trigonometry operation to floats
  23089. */
  23090. export class TrigonometryBlock extends NodeMaterialBlock {
  23091. /**
  23092. * Gets or sets the operation applied by the block
  23093. */
  23094. operation: TrigonometryBlockOperations;
  23095. /**
  23096. * Creates a new TrigonometryBlock
  23097. * @param name defines the block name
  23098. */
  23099. constructor(name: string);
  23100. /**
  23101. * Gets the current class name
  23102. * @returns the class name
  23103. */
  23104. getClassName(): string;
  23105. /**
  23106. * Gets the input component
  23107. */
  23108. get input(): NodeMaterialConnectionPoint;
  23109. /**
  23110. * Gets the output component
  23111. */
  23112. get output(): NodeMaterialConnectionPoint;
  23113. protected _buildBlock(state: NodeMaterialBuildState): this;
  23114. serialize(): any;
  23115. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  23116. protected _dumpPropertiesCode(): string;
  23117. }
  23118. }
  23119. declare module "babylonjs/Materials/Node/nodeMaterial" {
  23120. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23121. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  23122. import { Scene } from "babylonjs/scene";
  23123. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23124. import { Matrix } from "babylonjs/Maths/math.vector";
  23125. import { Mesh } from "babylonjs/Meshes/mesh";
  23126. import { Engine } from "babylonjs/Engines/engine";
  23127. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23128. import { Observable } from "babylonjs/Misc/observable";
  23129. import { SubMesh } from "babylonjs/Meshes/subMesh";
  23130. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  23131. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  23132. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  23133. import { Nullable } from "babylonjs/types";
  23134. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  23135. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  23136. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  23137. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  23138. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  23139. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  23140. import { Effect } from "babylonjs/Materials/effect";
  23141. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23142. import { Camera } from "babylonjs/Cameras/camera";
  23143. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  23144. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  23145. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  23146. /**
  23147. * Interface used to configure the node material editor
  23148. */
  23149. export interface INodeMaterialEditorOptions {
  23150. /** Define the URl to load node editor script */
  23151. editorURL?: string;
  23152. }
  23153. /** @hidden */
  23154. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  23155. NORMAL: boolean;
  23156. TANGENT: boolean;
  23157. UV1: boolean;
  23158. /** BONES */
  23159. NUM_BONE_INFLUENCERS: number;
  23160. BonesPerMesh: number;
  23161. BONETEXTURE: boolean;
  23162. /** MORPH TARGETS */
  23163. MORPHTARGETS: boolean;
  23164. MORPHTARGETS_NORMAL: boolean;
  23165. MORPHTARGETS_TANGENT: boolean;
  23166. MORPHTARGETS_UV: boolean;
  23167. NUM_MORPH_INFLUENCERS: number;
  23168. /** IMAGE PROCESSING */
  23169. IMAGEPROCESSING: boolean;
  23170. VIGNETTE: boolean;
  23171. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23172. VIGNETTEBLENDMODEOPAQUE: boolean;
  23173. TONEMAPPING: boolean;
  23174. TONEMAPPING_ACES: boolean;
  23175. CONTRAST: boolean;
  23176. EXPOSURE: boolean;
  23177. COLORCURVES: boolean;
  23178. COLORGRADING: boolean;
  23179. COLORGRADING3D: boolean;
  23180. SAMPLER3DGREENDEPTH: boolean;
  23181. SAMPLER3DBGRMAP: boolean;
  23182. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23183. /** MISC. */
  23184. BUMPDIRECTUV: number;
  23185. constructor();
  23186. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23187. }
  23188. /**
  23189. * Class used to configure NodeMaterial
  23190. */
  23191. export interface INodeMaterialOptions {
  23192. /**
  23193. * Defines if blocks should emit comments
  23194. */
  23195. emitComments: boolean;
  23196. }
  23197. /**
  23198. * Class used to create a node based material built by assembling shader blocks
  23199. */
  23200. export class NodeMaterial extends PushMaterial {
  23201. private static _BuildIdGenerator;
  23202. private _options;
  23203. private _vertexCompilationState;
  23204. private _fragmentCompilationState;
  23205. private _sharedData;
  23206. private _buildId;
  23207. private _buildWasSuccessful;
  23208. private _cachedWorldViewMatrix;
  23209. private _cachedWorldViewProjectionMatrix;
  23210. private _optimizers;
  23211. private _animationFrame;
  23212. /** Define the Url to load node editor script */
  23213. static EditorURL: string;
  23214. /** Define the Url to load snippets */
  23215. static SnippetUrl: string;
  23216. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23217. static IgnoreTexturesAtLoadTime: boolean;
  23218. private BJSNODEMATERIALEDITOR;
  23219. /** Get the inspector from bundle or global */
  23220. private _getGlobalNodeMaterialEditor;
  23221. /**
  23222. * Snippet ID if the material was created from the snippet server
  23223. */
  23224. snippetId: string;
  23225. /**
  23226. * Gets or sets data used by visual editor
  23227. * @see https://nme.babylonjs.com
  23228. */
  23229. editorData: any;
  23230. /**
  23231. * 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)
  23232. */
  23233. ignoreAlpha: boolean;
  23234. /**
  23235. * Defines the maximum number of lights that can be used in the material
  23236. */
  23237. maxSimultaneousLights: number;
  23238. /**
  23239. * Observable raised when the material is built
  23240. */
  23241. onBuildObservable: Observable<NodeMaterial>;
  23242. /**
  23243. * Gets or sets the root nodes of the material vertex shader
  23244. */
  23245. _vertexOutputNodes: NodeMaterialBlock[];
  23246. /**
  23247. * Gets or sets the root nodes of the material fragment (pixel) shader
  23248. */
  23249. _fragmentOutputNodes: NodeMaterialBlock[];
  23250. /** Gets or sets options to control the node material overall behavior */
  23251. get options(): INodeMaterialOptions;
  23252. set options(options: INodeMaterialOptions);
  23253. /**
  23254. * Default configuration related to image processing available in the standard Material.
  23255. */
  23256. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23257. /**
  23258. * Gets the image processing configuration used either in this material.
  23259. */
  23260. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23261. /**
  23262. * Sets the Default image processing configuration used either in the this material.
  23263. *
  23264. * If sets to null, the scene one is in use.
  23265. */
  23266. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23267. /**
  23268. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23269. */
  23270. attachedBlocks: NodeMaterialBlock[];
  23271. /**
  23272. * Specifies the mode of the node material
  23273. * @hidden
  23274. */
  23275. _mode: NodeMaterialModes;
  23276. /**
  23277. * Gets the mode property
  23278. */
  23279. get mode(): NodeMaterialModes;
  23280. /**
  23281. * Create a new node based material
  23282. * @param name defines the material name
  23283. * @param scene defines the hosting scene
  23284. * @param options defines creation option
  23285. */
  23286. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23287. /**
  23288. * Gets the current class name of the material e.g. "NodeMaterial"
  23289. * @returns the class name
  23290. */
  23291. getClassName(): string;
  23292. /**
  23293. * Keep track of the image processing observer to allow dispose and replace.
  23294. */
  23295. private _imageProcessingObserver;
  23296. /**
  23297. * Attaches a new image processing configuration to the Standard Material.
  23298. * @param configuration
  23299. */
  23300. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23301. /**
  23302. * Get a block by its name
  23303. * @param name defines the name of the block to retrieve
  23304. * @returns the required block or null if not found
  23305. */
  23306. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23307. /**
  23308. * Get a block by its name
  23309. * @param predicate defines the predicate used to find the good candidate
  23310. * @returns the required block or null if not found
  23311. */
  23312. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23313. /**
  23314. * Get an input block by its name
  23315. * @param predicate defines the predicate used to find the good candidate
  23316. * @returns the required input block or null if not found
  23317. */
  23318. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23319. /**
  23320. * Gets the list of input blocks attached to this material
  23321. * @returns an array of InputBlocks
  23322. */
  23323. getInputBlocks(): InputBlock[];
  23324. /**
  23325. * Adds a new optimizer to the list of optimizers
  23326. * @param optimizer defines the optimizers to add
  23327. * @returns the current material
  23328. */
  23329. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23330. /**
  23331. * Remove an optimizer from the list of optimizers
  23332. * @param optimizer defines the optimizers to remove
  23333. * @returns the current material
  23334. */
  23335. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23336. /**
  23337. * Add a new block to the list of output nodes
  23338. * @param node defines the node to add
  23339. * @returns the current material
  23340. */
  23341. addOutputNode(node: NodeMaterialBlock): this;
  23342. /**
  23343. * Remove a block from the list of root nodes
  23344. * @param node defines the node to remove
  23345. * @returns the current material
  23346. */
  23347. removeOutputNode(node: NodeMaterialBlock): this;
  23348. private _addVertexOutputNode;
  23349. private _removeVertexOutputNode;
  23350. private _addFragmentOutputNode;
  23351. private _removeFragmentOutputNode;
  23352. /**
  23353. * Specifies if the material will require alpha blending
  23354. * @returns a boolean specifying if alpha blending is needed
  23355. */
  23356. needAlphaBlending(): boolean;
  23357. /**
  23358. * Specifies if this material should be rendered in alpha test mode
  23359. * @returns a boolean specifying if an alpha test is needed.
  23360. */
  23361. needAlphaTesting(): boolean;
  23362. private _initializeBlock;
  23363. private _resetDualBlocks;
  23364. /**
  23365. * Remove a block from the current node material
  23366. * @param block defines the block to remove
  23367. */
  23368. removeBlock(block: NodeMaterialBlock): void;
  23369. /**
  23370. * Build the material and generates the inner effect
  23371. * @param verbose defines if the build should log activity
  23372. */
  23373. build(verbose?: boolean): void;
  23374. /**
  23375. * Runs an otpimization phase to try to improve the shader code
  23376. */
  23377. optimize(): void;
  23378. private _prepareDefinesForAttributes;
  23379. /**
  23380. * Create a post process from the material
  23381. * @param camera The camera to apply the render pass to.
  23382. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23383. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23384. * @param engine The engine which the post process will be applied. (default: current engine)
  23385. * @param reusable If the post process can be reused on the same frame. (default: false)
  23386. * @param textureType Type of textures used when performing the post process. (default: 0)
  23387. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23388. * @returns the post process created
  23389. */
  23390. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  23391. /**
  23392. * Create the post process effect from the material
  23393. * @param postProcess The post process to create the effect for
  23394. */
  23395. createEffectForPostProcess(postProcess: PostProcess): void;
  23396. private _createEffectForPostProcess;
  23397. /**
  23398. * Create a new procedural texture based on this node material
  23399. * @param size defines the size of the texture
  23400. * @param scene defines the hosting scene
  23401. * @returns the new procedural texture attached to this node material
  23402. */
  23403. createProceduralTexture(size: number | {
  23404. width: number;
  23405. height: number;
  23406. layers?: number;
  23407. }, scene: Scene): Nullable<ProceduralTexture>;
  23408. private _createEffectForParticles;
  23409. private _checkInternals;
  23410. /**
  23411. * Create the effect to be used as the custom effect for a particle system
  23412. * @param particleSystem Particle system to create the effect for
  23413. * @param onCompiled defines a function to call when the effect creation is successful
  23414. * @param onError defines a function to call when the effect creation has failed
  23415. */
  23416. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23417. private _processDefines;
  23418. /**
  23419. * Get if the submesh is ready to be used and all its information available.
  23420. * Child classes can use it to update shaders
  23421. * @param mesh defines the mesh to check
  23422. * @param subMesh defines which submesh to check
  23423. * @param useInstances specifies that instances should be used
  23424. * @returns a boolean indicating that the submesh is ready or not
  23425. */
  23426. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23427. /**
  23428. * Get a string representing the shaders built by the current node graph
  23429. */
  23430. get compiledShaders(): string;
  23431. /**
  23432. * Binds the world matrix to the material
  23433. * @param world defines the world transformation matrix
  23434. */
  23435. bindOnlyWorldMatrix(world: Matrix): void;
  23436. /**
  23437. * Binds the submesh to this material by preparing the effect and shader to draw
  23438. * @param world defines the world transformation matrix
  23439. * @param mesh defines the mesh containing the submesh
  23440. * @param subMesh defines the submesh to bind the material to
  23441. */
  23442. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23443. /**
  23444. * Gets the active textures from the material
  23445. * @returns an array of textures
  23446. */
  23447. getActiveTextures(): BaseTexture[];
  23448. /**
  23449. * Gets the list of texture blocks
  23450. * @returns an array of texture blocks
  23451. */
  23452. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23453. /**
  23454. * Specifies if the material uses a texture
  23455. * @param texture defines the texture to check against the material
  23456. * @returns a boolean specifying if the material uses the texture
  23457. */
  23458. hasTexture(texture: BaseTexture): boolean;
  23459. /**
  23460. * Disposes the material
  23461. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23462. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23463. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23464. */
  23465. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23466. /** Creates the node editor window. */
  23467. private _createNodeEditor;
  23468. /**
  23469. * Launch the node material editor
  23470. * @param config Define the configuration of the editor
  23471. * @return a promise fulfilled when the node editor is visible
  23472. */
  23473. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23474. /**
  23475. * Clear the current material
  23476. */
  23477. clear(): void;
  23478. /**
  23479. * Clear the current material and set it to a default state
  23480. */
  23481. setToDefault(): void;
  23482. /**
  23483. * Clear the current material and set it to a default state for post process
  23484. */
  23485. setToDefaultPostProcess(): void;
  23486. /**
  23487. * Clear the current material and set it to a default state for procedural texture
  23488. */
  23489. setToDefaultProceduralTexture(): void;
  23490. /**
  23491. * Clear the current material and set it to a default state for particle
  23492. */
  23493. setToDefaultParticle(): void;
  23494. /**
  23495. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23496. * @param url defines the url to load from
  23497. * @returns a promise that will fullfil when the material is fully loaded
  23498. */
  23499. loadAsync(url: string): Promise<void>;
  23500. private _gatherBlocks;
  23501. /**
  23502. * Generate a string containing the code declaration required to create an equivalent of this material
  23503. * @returns a string
  23504. */
  23505. generateCode(): string;
  23506. /**
  23507. * Serializes this material in a JSON representation
  23508. * @returns the serialized material object
  23509. */
  23510. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23511. private _restoreConnections;
  23512. /**
  23513. * Clear the current graph and load a new one from a serialization object
  23514. * @param source defines the JSON representation of the material
  23515. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23516. * @param merge defines whether or not the source must be merged or replace the current content
  23517. */
  23518. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23519. /**
  23520. * Makes a duplicate of the current material.
  23521. * @param name - name to use for the new material.
  23522. */
  23523. clone(name: string): NodeMaterial;
  23524. /**
  23525. * Creates a node material from parsed material data
  23526. * @param source defines the JSON representation of the material
  23527. * @param scene defines the hosting scene
  23528. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23529. * @returns a new node material
  23530. */
  23531. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23532. /**
  23533. * Creates a node material from a snippet saved in a remote file
  23534. * @param name defines the name of the material to create
  23535. * @param url defines the url to load from
  23536. * @param scene defines the hosting scene
  23537. * @returns a promise that will resolve to the new node material
  23538. */
  23539. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23540. /**
  23541. * Creates a node material from a snippet saved by the node material editor
  23542. * @param snippetId defines the snippet to load
  23543. * @param scene defines the hosting scene
  23544. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23545. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23546. * @returns a promise that will resolve to the new node material
  23547. */
  23548. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23549. /**
  23550. * Creates a new node material set to default basic configuration
  23551. * @param name defines the name of the material
  23552. * @param scene defines the hosting scene
  23553. * @returns a new NodeMaterial
  23554. */
  23555. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23556. }
  23557. }
  23558. declare module "babylonjs/PostProcesses/postProcess" {
  23559. import { Nullable } from "babylonjs/types";
  23560. import { SmartArray } from "babylonjs/Misc/smartArray";
  23561. import { Observable } from "babylonjs/Misc/observable";
  23562. import { Vector2 } from "babylonjs/Maths/math.vector";
  23563. import { Camera } from "babylonjs/Cameras/camera";
  23564. import { Effect } from "babylonjs/Materials/effect";
  23565. import "babylonjs/Shaders/postprocess.vertex";
  23566. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23567. import { Engine } from "babylonjs/Engines/engine";
  23568. import { Color4 } from "babylonjs/Maths/math.color";
  23569. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23570. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23571. import { Scene } from "babylonjs/scene";
  23572. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23573. /**
  23574. * Size options for a post process
  23575. */
  23576. export type PostProcessOptions = {
  23577. width: number;
  23578. height: number;
  23579. };
  23580. /**
  23581. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23582. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23583. */
  23584. export class PostProcess {
  23585. /**
  23586. * Gets or sets the unique id of the post process
  23587. */
  23588. uniqueId: number;
  23589. /** Name of the PostProcess. */
  23590. name: string;
  23591. /**
  23592. * Width of the texture to apply the post process on
  23593. */
  23594. width: number;
  23595. /**
  23596. * Height of the texture to apply the post process on
  23597. */
  23598. height: number;
  23599. /**
  23600. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23601. */
  23602. nodeMaterialSource: Nullable<NodeMaterial>;
  23603. /**
  23604. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23605. * @hidden
  23606. */
  23607. _outputTexture: Nullable<InternalTexture>;
  23608. /**
  23609. * Sampling mode used by the shader
  23610. * See https://doc.babylonjs.com/classes/3.1/texture
  23611. */
  23612. renderTargetSamplingMode: number;
  23613. /**
  23614. * Clear color to use when screen clearing
  23615. */
  23616. clearColor: Color4;
  23617. /**
  23618. * If the buffer needs to be cleared before applying the post process. (default: true)
  23619. * Should be set to false if shader will overwrite all previous pixels.
  23620. */
  23621. autoClear: boolean;
  23622. /**
  23623. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23624. */
  23625. alphaMode: number;
  23626. /**
  23627. * Sets the setAlphaBlendConstants of the babylon engine
  23628. */
  23629. alphaConstants: Color4;
  23630. /**
  23631. * Animations to be used for the post processing
  23632. */
  23633. animations: import("babylonjs/Animations/animation").Animation[];
  23634. /**
  23635. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23636. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23637. */
  23638. enablePixelPerfectMode: boolean;
  23639. /**
  23640. * Force the postprocess to be applied without taking in account viewport
  23641. */
  23642. forceFullscreenViewport: boolean;
  23643. /**
  23644. * List of inspectable custom properties (used by the Inspector)
  23645. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23646. */
  23647. inspectableCustomProperties: IInspectable[];
  23648. /**
  23649. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23650. *
  23651. * | Value | Type | Description |
  23652. * | ----- | ----------------------------------- | ----------- |
  23653. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23654. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23655. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23656. *
  23657. */
  23658. scaleMode: number;
  23659. /**
  23660. * Force textures to be a power of two (default: false)
  23661. */
  23662. alwaysForcePOT: boolean;
  23663. private _samples;
  23664. /**
  23665. * Number of sample textures (default: 1)
  23666. */
  23667. get samples(): number;
  23668. set samples(n: number);
  23669. /**
  23670. * Modify the scale of the post process to be the same as the viewport (default: false)
  23671. */
  23672. adaptScaleToCurrentViewport: boolean;
  23673. private _camera;
  23674. protected _scene: Scene;
  23675. private _engine;
  23676. private _options;
  23677. private _reusable;
  23678. private _textureType;
  23679. private _textureFormat;
  23680. /**
  23681. * Smart array of input and output textures for the post process.
  23682. * @hidden
  23683. */
  23684. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23685. /**
  23686. * The index in _textures that corresponds to the output texture.
  23687. * @hidden
  23688. */
  23689. _currentRenderTextureInd: number;
  23690. private _effect;
  23691. private _samplers;
  23692. private _fragmentUrl;
  23693. private _vertexUrl;
  23694. private _parameters;
  23695. private _scaleRatio;
  23696. protected _indexParameters: any;
  23697. private _shareOutputWithPostProcess;
  23698. private _texelSize;
  23699. private _forcedOutputTexture;
  23700. /**
  23701. * Returns the fragment url or shader name used in the post process.
  23702. * @returns the fragment url or name in the shader store.
  23703. */
  23704. getEffectName(): string;
  23705. /**
  23706. * An event triggered when the postprocess is activated.
  23707. */
  23708. onActivateObservable: Observable<Camera>;
  23709. private _onActivateObserver;
  23710. /**
  23711. * A function that is added to the onActivateObservable
  23712. */
  23713. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23714. /**
  23715. * An event triggered when the postprocess changes its size.
  23716. */
  23717. onSizeChangedObservable: Observable<PostProcess>;
  23718. private _onSizeChangedObserver;
  23719. /**
  23720. * A function that is added to the onSizeChangedObservable
  23721. */
  23722. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23723. /**
  23724. * An event triggered when the postprocess applies its effect.
  23725. */
  23726. onApplyObservable: Observable<Effect>;
  23727. private _onApplyObserver;
  23728. /**
  23729. * A function that is added to the onApplyObservable
  23730. */
  23731. set onApply(callback: (effect: Effect) => void);
  23732. /**
  23733. * An event triggered before rendering the postprocess
  23734. */
  23735. onBeforeRenderObservable: Observable<Effect>;
  23736. private _onBeforeRenderObserver;
  23737. /**
  23738. * A function that is added to the onBeforeRenderObservable
  23739. */
  23740. set onBeforeRender(callback: (effect: Effect) => void);
  23741. /**
  23742. * An event triggered after rendering the postprocess
  23743. */
  23744. onAfterRenderObservable: Observable<Effect>;
  23745. private _onAfterRenderObserver;
  23746. /**
  23747. * A function that is added to the onAfterRenderObservable
  23748. */
  23749. set onAfterRender(callback: (efect: Effect) => void);
  23750. /**
  23751. * 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
  23752. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23753. */
  23754. get inputTexture(): InternalTexture;
  23755. set inputTexture(value: InternalTexture);
  23756. /**
  23757. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23758. * the only way to unset it is to use this function to restore its internal state
  23759. */
  23760. restoreDefaultInputTexture(): void;
  23761. /**
  23762. * Gets the camera which post process is applied to.
  23763. * @returns The camera the post process is applied to.
  23764. */
  23765. getCamera(): Camera;
  23766. /**
  23767. * Gets the texel size of the postprocess.
  23768. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23769. */
  23770. get texelSize(): Vector2;
  23771. /**
  23772. * Creates a new instance PostProcess
  23773. * @param name The name of the PostProcess.
  23774. * @param fragmentUrl The url of the fragment shader to be used.
  23775. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23776. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23777. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23778. * @param camera The camera to apply the render pass to.
  23779. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23780. * @param engine The engine which the post process will be applied. (default: current engine)
  23781. * @param reusable If the post process can be reused on the same frame. (default: false)
  23782. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23783. * @param textureType Type of textures used when performing the post process. (default: 0)
  23784. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23785. * @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
  23786. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  23787. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23788. */
  23789. 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);
  23790. /**
  23791. * Gets a string identifying the name of the class
  23792. * @returns "PostProcess" string
  23793. */
  23794. getClassName(): string;
  23795. /**
  23796. * Gets the engine which this post process belongs to.
  23797. * @returns The engine the post process was enabled with.
  23798. */
  23799. getEngine(): Engine;
  23800. /**
  23801. * The effect that is created when initializing the post process.
  23802. * @returns The created effect corresponding the the postprocess.
  23803. */
  23804. getEffect(): Effect;
  23805. /**
  23806. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23807. * @param postProcess The post process to share the output with.
  23808. * @returns This post process.
  23809. */
  23810. shareOutputWith(postProcess: PostProcess): PostProcess;
  23811. /**
  23812. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23813. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23814. */
  23815. useOwnOutput(): void;
  23816. /**
  23817. * Updates the effect with the current post process compile time values and recompiles the shader.
  23818. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23819. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23820. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23821. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23822. * @param onCompiled Called when the shader has been compiled.
  23823. * @param onError Called if there is an error when compiling a shader.
  23824. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23825. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23826. */
  23827. 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;
  23828. /**
  23829. * The post process is reusable if it can be used multiple times within one frame.
  23830. * @returns If the post process is reusable
  23831. */
  23832. isReusable(): boolean;
  23833. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23834. markTextureDirty(): void;
  23835. /**
  23836. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23837. * 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.
  23838. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23839. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23840. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23841. * @returns The target texture that was bound to be written to.
  23842. */
  23843. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23844. /**
  23845. * If the post process is supported.
  23846. */
  23847. get isSupported(): boolean;
  23848. /**
  23849. * The aspect ratio of the output texture.
  23850. */
  23851. get aspectRatio(): number;
  23852. /**
  23853. * Get a value indicating if the post-process is ready to be used
  23854. * @returns true if the post-process is ready (shader is compiled)
  23855. */
  23856. isReady(): boolean;
  23857. /**
  23858. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23859. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23860. */
  23861. apply(): Nullable<Effect>;
  23862. private _disposeTextures;
  23863. /**
  23864. * Disposes the post process.
  23865. * @param camera The camera to dispose the post process on.
  23866. */
  23867. dispose(camera?: Camera): void;
  23868. /**
  23869. * Serializes the particle system to a JSON object
  23870. * @returns the JSON object
  23871. */
  23872. serialize(): any;
  23873. /**
  23874. * Creates a material from parsed material data
  23875. * @param parsedPostProcess defines parsed post process data
  23876. * @param scene defines the hosting scene
  23877. * @param rootUrl defines the root URL to use to load textures
  23878. * @returns a new post process
  23879. */
  23880. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23881. }
  23882. }
  23883. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23884. /** @hidden */
  23885. export var kernelBlurVaryingDeclaration: {
  23886. name: string;
  23887. shader: string;
  23888. };
  23889. }
  23890. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23891. /** @hidden */
  23892. export var kernelBlurFragment: {
  23893. name: string;
  23894. shader: string;
  23895. };
  23896. }
  23897. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23898. /** @hidden */
  23899. export var kernelBlurFragment2: {
  23900. name: string;
  23901. shader: string;
  23902. };
  23903. }
  23904. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23905. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23906. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23907. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23908. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23909. /** @hidden */
  23910. export var kernelBlurPixelShader: {
  23911. name: string;
  23912. shader: string;
  23913. };
  23914. }
  23915. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23916. /** @hidden */
  23917. export var kernelBlurVertex: {
  23918. name: string;
  23919. shader: string;
  23920. };
  23921. }
  23922. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23923. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23924. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23925. /** @hidden */
  23926. export var kernelBlurVertexShader: {
  23927. name: string;
  23928. shader: string;
  23929. };
  23930. }
  23931. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23932. import { Vector2 } from "babylonjs/Maths/math.vector";
  23933. import { Nullable } from "babylonjs/types";
  23934. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23935. import { Camera } from "babylonjs/Cameras/camera";
  23936. import { Effect } from "babylonjs/Materials/effect";
  23937. import { Engine } from "babylonjs/Engines/engine";
  23938. import "babylonjs/Shaders/kernelBlur.fragment";
  23939. import "babylonjs/Shaders/kernelBlur.vertex";
  23940. import { Scene } from "babylonjs/scene";
  23941. /**
  23942. * The Blur Post Process which blurs an image based on a kernel and direction.
  23943. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23944. */
  23945. export class BlurPostProcess extends PostProcess {
  23946. private blockCompilation;
  23947. protected _kernel: number;
  23948. protected _idealKernel: number;
  23949. protected _packedFloat: boolean;
  23950. private _staticDefines;
  23951. /** The direction in which to blur the image. */
  23952. direction: Vector2;
  23953. /**
  23954. * Sets the length in pixels of the blur sample region
  23955. */
  23956. set kernel(v: number);
  23957. /**
  23958. * Gets the length in pixels of the blur sample region
  23959. */
  23960. get kernel(): number;
  23961. /**
  23962. * Sets wether or not the blur needs to unpack/repack floats
  23963. */
  23964. set packedFloat(v: boolean);
  23965. /**
  23966. * Gets wether or not the blur is unpacking/repacking floats
  23967. */
  23968. get packedFloat(): boolean;
  23969. /**
  23970. * Gets a string identifying the name of the class
  23971. * @returns "BlurPostProcess" string
  23972. */
  23973. getClassName(): string;
  23974. /**
  23975. * Creates a new instance BlurPostProcess
  23976. * @param name The name of the effect.
  23977. * @param direction The direction in which to blur the image.
  23978. * @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.
  23979. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23980. * @param camera The camera to apply the render pass to.
  23981. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23982. * @param engine The engine which the post process will be applied. (default: current engine)
  23983. * @param reusable If the post process can be reused on the same frame. (default: false)
  23984. * @param textureType Type of textures used when performing the post process. (default: 0)
  23985. * @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)
  23986. */
  23987. 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);
  23988. /**
  23989. * Updates the effect with the current post process compile time values and recompiles the shader.
  23990. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23991. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23992. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23993. * @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
  23994. * @param onCompiled Called when the shader has been compiled.
  23995. * @param onError Called if there is an error when compiling a shader.
  23996. */
  23997. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23998. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23999. /**
  24000. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  24001. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  24002. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  24003. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  24004. * The gaps between physical kernels are compensated for in the weighting of the samples
  24005. * @param idealKernel Ideal blur kernel.
  24006. * @return Nearest best kernel.
  24007. */
  24008. protected _nearestBestKernel(idealKernel: number): number;
  24009. /**
  24010. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  24011. * @param x The point on the Gaussian distribution to sample.
  24012. * @return the value of the Gaussian function at x.
  24013. */
  24014. protected _gaussianWeight(x: number): number;
  24015. /**
  24016. * Generates a string that can be used as a floating point number in GLSL.
  24017. * @param x Value to print.
  24018. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  24019. * @return GLSL float string.
  24020. */
  24021. protected _glslFloat(x: number, decimalFigures?: number): string;
  24022. /** @hidden */
  24023. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  24024. }
  24025. }
  24026. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  24027. import { Scene } from "babylonjs/scene";
  24028. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24029. import { Plane } from "babylonjs/Maths/math.plane";
  24030. /**
  24031. * Mirror texture can be used to simulate the view from a mirror in a scene.
  24032. * It will dynamically be rendered every frame to adapt to the camera point of view.
  24033. * You can then easily use it as a reflectionTexture on a flat surface.
  24034. * In case the surface is not a plane, please consider relying on reflection probes.
  24035. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  24036. */
  24037. export class MirrorTexture extends RenderTargetTexture {
  24038. private scene;
  24039. /**
  24040. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  24041. * 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.
  24042. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  24043. */
  24044. mirrorPlane: Plane;
  24045. /**
  24046. * Define the blur ratio used to blur the reflection if needed.
  24047. */
  24048. set blurRatio(value: number);
  24049. get blurRatio(): number;
  24050. /**
  24051. * Define the adaptive blur kernel used to blur the reflection if needed.
  24052. * This will autocompute the closest best match for the `blurKernel`
  24053. */
  24054. set adaptiveBlurKernel(value: number);
  24055. /**
  24056. * Define the blur kernel used to blur the reflection if needed.
  24057. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  24058. */
  24059. set blurKernel(value: number);
  24060. /**
  24061. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  24062. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  24063. */
  24064. set blurKernelX(value: number);
  24065. get blurKernelX(): number;
  24066. /**
  24067. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  24068. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  24069. */
  24070. set blurKernelY(value: number);
  24071. get blurKernelY(): number;
  24072. private _autoComputeBlurKernel;
  24073. protected _onRatioRescale(): void;
  24074. private _updateGammaSpace;
  24075. private _imageProcessingConfigChangeObserver;
  24076. private _transformMatrix;
  24077. private _mirrorMatrix;
  24078. private _savedViewMatrix;
  24079. private _blurX;
  24080. private _blurY;
  24081. private _adaptiveBlurKernel;
  24082. private _blurKernelX;
  24083. private _blurKernelY;
  24084. private _blurRatio;
  24085. /**
  24086. * Instantiates a Mirror Texture.
  24087. * Mirror texture can be used to simulate the view from a mirror in a scene.
  24088. * It will dynamically be rendered every frame to adapt to the camera point of view.
  24089. * You can then easily use it as a reflectionTexture on a flat surface.
  24090. * In case the surface is not a plane, please consider relying on reflection probes.
  24091. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  24092. * @param name
  24093. * @param size
  24094. * @param scene
  24095. * @param generateMipMaps
  24096. * @param type
  24097. * @param samplingMode
  24098. * @param generateDepthBuffer
  24099. */
  24100. constructor(name: string, size: number | {
  24101. width: number;
  24102. height: number;
  24103. } | {
  24104. ratio: number;
  24105. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  24106. private _preparePostProcesses;
  24107. /**
  24108. * Clone the mirror texture.
  24109. * @returns the cloned texture
  24110. */
  24111. clone(): MirrorTexture;
  24112. /**
  24113. * Serialize the texture to a JSON representation you could use in Parse later on
  24114. * @returns the serialized JSON representation
  24115. */
  24116. serialize(): any;
  24117. /**
  24118. * Dispose the texture and release its associated resources.
  24119. */
  24120. dispose(): void;
  24121. }
  24122. }
  24123. declare module "babylonjs/Materials/Textures/texture" {
  24124. import { Observable } from "babylonjs/Misc/observable";
  24125. import { Nullable } from "babylonjs/types";
  24126. import { Matrix } from "babylonjs/Maths/math.vector";
  24127. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24128. import { IInspectable } from "babylonjs/Misc/iInspectable";
  24129. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  24130. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  24131. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  24132. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24133. import { Scene } from "babylonjs/scene";
  24134. /**
  24135. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24136. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24137. */
  24138. export class Texture extends BaseTexture {
  24139. /**
  24140. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  24141. */
  24142. static SerializeBuffers: boolean;
  24143. /** @hidden */
  24144. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  24145. /** @hidden */
  24146. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  24147. /** @hidden */
  24148. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  24149. /** nearest is mag = nearest and min = nearest and mip = linear */
  24150. static readonly NEAREST_SAMPLINGMODE: number;
  24151. /** nearest is mag = nearest and min = nearest and mip = linear */
  24152. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  24153. /** Bilinear is mag = linear and min = linear and mip = nearest */
  24154. static readonly BILINEAR_SAMPLINGMODE: number;
  24155. /** Bilinear is mag = linear and min = linear and mip = nearest */
  24156. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  24157. /** Trilinear is mag = linear and min = linear and mip = linear */
  24158. static readonly TRILINEAR_SAMPLINGMODE: number;
  24159. /** Trilinear is mag = linear and min = linear and mip = linear */
  24160. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  24161. /** mag = nearest and min = nearest and mip = nearest */
  24162. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  24163. /** mag = nearest and min = linear and mip = nearest */
  24164. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  24165. /** mag = nearest and min = linear and mip = linear */
  24166. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  24167. /** mag = nearest and min = linear and mip = none */
  24168. static readonly NEAREST_LINEAR: number;
  24169. /** mag = nearest and min = nearest and mip = none */
  24170. static readonly NEAREST_NEAREST: number;
  24171. /** mag = linear and min = nearest and mip = nearest */
  24172. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24173. /** mag = linear and min = nearest and mip = linear */
  24174. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24175. /** mag = linear and min = linear and mip = none */
  24176. static readonly LINEAR_LINEAR: number;
  24177. /** mag = linear and min = nearest and mip = none */
  24178. static readonly LINEAR_NEAREST: number;
  24179. /** Explicit coordinates mode */
  24180. static readonly EXPLICIT_MODE: number;
  24181. /** Spherical coordinates mode */
  24182. static readonly SPHERICAL_MODE: number;
  24183. /** Planar coordinates mode */
  24184. static readonly PLANAR_MODE: number;
  24185. /** Cubic coordinates mode */
  24186. static readonly CUBIC_MODE: number;
  24187. /** Projection coordinates mode */
  24188. static readonly PROJECTION_MODE: number;
  24189. /** Inverse Cubic coordinates mode */
  24190. static readonly SKYBOX_MODE: number;
  24191. /** Inverse Cubic coordinates mode */
  24192. static readonly INVCUBIC_MODE: number;
  24193. /** Equirectangular coordinates mode */
  24194. static readonly EQUIRECTANGULAR_MODE: number;
  24195. /** Equirectangular Fixed coordinates mode */
  24196. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24197. /** Equirectangular Fixed Mirrored coordinates mode */
  24198. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24199. /** Texture is not repeating outside of 0..1 UVs */
  24200. static readonly CLAMP_ADDRESSMODE: number;
  24201. /** Texture is repeating outside of 0..1 UVs */
  24202. static readonly WRAP_ADDRESSMODE: number;
  24203. /** Texture is repeating and mirrored */
  24204. static readonly MIRROR_ADDRESSMODE: number;
  24205. /**
  24206. * 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
  24207. */
  24208. static UseSerializedUrlIfAny: boolean;
  24209. /**
  24210. * Define the url of the texture.
  24211. */
  24212. url: Nullable<string>;
  24213. /**
  24214. * Define an offset on the texture to offset the u coordinates of the UVs
  24215. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24216. */
  24217. uOffset: number;
  24218. /**
  24219. * Define an offset on the texture to offset the v coordinates of the UVs
  24220. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24221. */
  24222. vOffset: number;
  24223. /**
  24224. * Define an offset on the texture to scale the u coordinates of the UVs
  24225. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24226. */
  24227. uScale: number;
  24228. /**
  24229. * Define an offset on the texture to scale the v coordinates of the UVs
  24230. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24231. */
  24232. vScale: number;
  24233. /**
  24234. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24235. * @see https://doc.babylonjs.com/how_to/more_materials
  24236. */
  24237. uAng: number;
  24238. /**
  24239. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24240. * @see https://doc.babylonjs.com/how_to/more_materials
  24241. */
  24242. vAng: number;
  24243. /**
  24244. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24245. * @see https://doc.babylonjs.com/how_to/more_materials
  24246. */
  24247. wAng: number;
  24248. /**
  24249. * Defines the center of rotation (U)
  24250. */
  24251. uRotationCenter: number;
  24252. /**
  24253. * Defines the center of rotation (V)
  24254. */
  24255. vRotationCenter: number;
  24256. /**
  24257. * Defines the center of rotation (W)
  24258. */
  24259. wRotationCenter: number;
  24260. /**
  24261. * Are mip maps generated for this texture or not.
  24262. */
  24263. get noMipmap(): boolean;
  24264. /**
  24265. * List of inspectable custom properties (used by the Inspector)
  24266. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24267. */
  24268. inspectableCustomProperties: Nullable<IInspectable[]>;
  24269. private _noMipmap;
  24270. /** @hidden */
  24271. _invertY: boolean;
  24272. private _rowGenerationMatrix;
  24273. private _cachedTextureMatrix;
  24274. private _projectionModeMatrix;
  24275. private _t0;
  24276. private _t1;
  24277. private _t2;
  24278. private _cachedUOffset;
  24279. private _cachedVOffset;
  24280. private _cachedUScale;
  24281. private _cachedVScale;
  24282. private _cachedUAng;
  24283. private _cachedVAng;
  24284. private _cachedWAng;
  24285. private _cachedProjectionMatrixId;
  24286. private _cachedCoordinatesMode;
  24287. /** @hidden */
  24288. protected _initialSamplingMode: number;
  24289. /** @hidden */
  24290. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24291. private _deleteBuffer;
  24292. protected _format: Nullable<number>;
  24293. private _delayedOnLoad;
  24294. private _delayedOnError;
  24295. private _mimeType?;
  24296. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24297. get mimeType(): string | undefined;
  24298. /**
  24299. * Observable triggered once the texture has been loaded.
  24300. */
  24301. onLoadObservable: Observable<Texture>;
  24302. protected _isBlocking: boolean;
  24303. /**
  24304. * Is the texture preventing material to render while loading.
  24305. * If false, a default texture will be used instead of the loading one during the preparation step.
  24306. */
  24307. set isBlocking(value: boolean);
  24308. get isBlocking(): boolean;
  24309. /**
  24310. * Get the current sampling mode associated with the texture.
  24311. */
  24312. get samplingMode(): number;
  24313. /**
  24314. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24315. */
  24316. get invertY(): boolean;
  24317. /**
  24318. * Instantiates a new texture.
  24319. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24320. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24321. * @param url defines the url of the picture to load as a texture
  24322. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24323. * @param noMipmap defines if the texture will require mip maps or not
  24324. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24325. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24326. * @param onLoad defines a callback triggered when the texture has been loaded
  24327. * @param onError defines a callback triggered when an error occurred during the loading session
  24328. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24329. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24330. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24331. * @param mimeType defines an optional mime type information
  24332. */
  24333. 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);
  24334. /**
  24335. * Update the url (and optional buffer) of this texture if url was null during construction.
  24336. * @param url the url of the texture
  24337. * @param buffer the buffer of the texture (defaults to null)
  24338. * @param onLoad callback called when the texture is loaded (defaults to null)
  24339. */
  24340. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24341. /**
  24342. * Finish the loading sequence of a texture flagged as delayed load.
  24343. * @hidden
  24344. */
  24345. delayLoad(): void;
  24346. private _prepareRowForTextureGeneration;
  24347. /**
  24348. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24349. * @returns the transform matrix of the texture.
  24350. */
  24351. getTextureMatrix(uBase?: number): Matrix;
  24352. /**
  24353. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24354. * @returns The reflection texture transform
  24355. */
  24356. getReflectionTextureMatrix(): Matrix;
  24357. /**
  24358. * Clones the texture.
  24359. * @returns the cloned texture
  24360. */
  24361. clone(): Texture;
  24362. /**
  24363. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24364. * @returns The JSON representation of the texture
  24365. */
  24366. serialize(): any;
  24367. /**
  24368. * Get the current class name of the texture useful for serialization or dynamic coding.
  24369. * @returns "Texture"
  24370. */
  24371. getClassName(): string;
  24372. /**
  24373. * Dispose the texture and release its associated resources.
  24374. */
  24375. dispose(): void;
  24376. /**
  24377. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24378. * @param parsedTexture Define the JSON representation of the texture
  24379. * @param scene Define the scene the parsed texture should be instantiated in
  24380. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24381. * @returns The parsed texture if successful
  24382. */
  24383. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24384. /**
  24385. * Creates a texture from its base 64 representation.
  24386. * @param data Define the base64 payload without the data: prefix
  24387. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24388. * @param scene Define the scene the texture should belong to
  24389. * @param noMipmap Forces the texture to not create mip map information if true
  24390. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24391. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24392. * @param onLoad define a callback triggered when the texture has been loaded
  24393. * @param onError define a callback triggered when an error occurred during the loading session
  24394. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24395. * @returns the created texture
  24396. */
  24397. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24398. /**
  24399. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24400. * @param data Define the base64 payload without the data: prefix
  24401. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24402. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24403. * @param scene Define the scene the texture should belong to
  24404. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24405. * @param noMipmap Forces the texture to not create mip map information if true
  24406. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24407. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24408. * @param onLoad define a callback triggered when the texture has been loaded
  24409. * @param onError define a callback triggered when an error occurred during the loading session
  24410. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24411. * @returns the created texture
  24412. */
  24413. 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;
  24414. }
  24415. }
  24416. declare module "babylonjs/PostProcesses/postProcessManager" {
  24417. import { Nullable } from "babylonjs/types";
  24418. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24419. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24420. import { Scene } from "babylonjs/scene";
  24421. /**
  24422. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24423. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24424. */
  24425. export class PostProcessManager {
  24426. private _scene;
  24427. private _indexBuffer;
  24428. private _vertexBuffers;
  24429. /**
  24430. * Creates a new instance PostProcess
  24431. * @param scene The scene that the post process is associated with.
  24432. */
  24433. constructor(scene: Scene);
  24434. private _prepareBuffers;
  24435. private _buildIndexBuffer;
  24436. /**
  24437. * Rebuilds the vertex buffers of the manager.
  24438. * @hidden
  24439. */
  24440. _rebuild(): void;
  24441. /**
  24442. * Prepares a frame to be run through a post process.
  24443. * @param sourceTexture The input texture to the post procesess. (default: null)
  24444. * @param postProcesses An array of post processes to be run. (default: null)
  24445. * @returns True if the post processes were able to be run.
  24446. * @hidden
  24447. */
  24448. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24449. /**
  24450. * Manually render a set of post processes to a texture.
  24451. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24452. * @param postProcesses An array of post processes to be run.
  24453. * @param targetTexture The target texture to render to.
  24454. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24455. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24456. * @param lodLevel defines which lod of the texture to render to
  24457. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24458. */
  24459. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24460. /**
  24461. * Finalize the result of the output of the postprocesses.
  24462. * @param doNotPresent If true the result will not be displayed to the screen.
  24463. * @param targetTexture The target texture to render to.
  24464. * @param faceIndex The index of the face to bind the target texture to.
  24465. * @param postProcesses The array of post processes to render.
  24466. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24467. * @hidden
  24468. */
  24469. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24470. /**
  24471. * Disposes of the post process manager.
  24472. */
  24473. dispose(): void;
  24474. }
  24475. }
  24476. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24477. import { Observable } from "babylonjs/Misc/observable";
  24478. import { SmartArray } from "babylonjs/Misc/smartArray";
  24479. import { Nullable, Immutable } from "babylonjs/types";
  24480. import { Camera } from "babylonjs/Cameras/camera";
  24481. import { Scene } from "babylonjs/scene";
  24482. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24483. import { Color4 } from "babylonjs/Maths/math.color";
  24484. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24486. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24487. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24488. import { Texture } from "babylonjs/Materials/Textures/texture";
  24489. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24490. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24491. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24492. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24493. import { Engine } from "babylonjs/Engines/engine";
  24494. /**
  24495. * This Helps creating a texture that will be created from a camera in your scene.
  24496. * It is basically a dynamic texture that could be used to create special effects for instance.
  24497. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24498. */
  24499. export class RenderTargetTexture extends Texture {
  24500. /**
  24501. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24502. */
  24503. static readonly REFRESHRATE_RENDER_ONCE: number;
  24504. /**
  24505. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24506. */
  24507. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24508. /**
  24509. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24510. * the central point of your effect and can save a lot of performances.
  24511. */
  24512. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24513. /**
  24514. * Use this predicate to dynamically define the list of mesh you want to render.
  24515. * If set, the renderList property will be overwritten.
  24516. */
  24517. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24518. private _renderList;
  24519. /**
  24520. * Use this list to define the list of mesh you want to render.
  24521. */
  24522. get renderList(): Nullable<Array<AbstractMesh>>;
  24523. set renderList(value: Nullable<Array<AbstractMesh>>);
  24524. /**
  24525. * Use this function to overload the renderList array at rendering time.
  24526. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24527. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24528. * the cube (if the RTT is a cube, else layerOrFace=0).
  24529. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24530. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24531. * hold dummy elements!
  24532. */
  24533. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24534. private _hookArray;
  24535. /**
  24536. * Define if particles should be rendered in your texture.
  24537. */
  24538. renderParticles: boolean;
  24539. /**
  24540. * Define if sprites should be rendered in your texture.
  24541. */
  24542. renderSprites: boolean;
  24543. /**
  24544. * Define the camera used to render the texture.
  24545. */
  24546. activeCamera: Nullable<Camera>;
  24547. /**
  24548. * Override the mesh isReady function with your own one.
  24549. */
  24550. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24551. /**
  24552. * Override the render function of the texture with your own one.
  24553. */
  24554. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24555. /**
  24556. * Define if camera post processes should be use while rendering the texture.
  24557. */
  24558. useCameraPostProcesses: boolean;
  24559. /**
  24560. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24561. */
  24562. ignoreCameraViewport: boolean;
  24563. private _postProcessManager;
  24564. private _postProcesses;
  24565. private _resizeObserver;
  24566. /**
  24567. * An event triggered when the texture is unbind.
  24568. */
  24569. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24570. /**
  24571. * An event triggered when the texture is unbind.
  24572. */
  24573. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24574. private _onAfterUnbindObserver;
  24575. /**
  24576. * Set a after unbind callback in the texture.
  24577. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24578. */
  24579. set onAfterUnbind(callback: () => void);
  24580. /**
  24581. * An event triggered before rendering the texture
  24582. */
  24583. onBeforeRenderObservable: Observable<number>;
  24584. private _onBeforeRenderObserver;
  24585. /**
  24586. * Set a before render callback in the texture.
  24587. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24588. */
  24589. set onBeforeRender(callback: (faceIndex: number) => void);
  24590. /**
  24591. * An event triggered after rendering the texture
  24592. */
  24593. onAfterRenderObservable: Observable<number>;
  24594. private _onAfterRenderObserver;
  24595. /**
  24596. * Set a after render callback in the texture.
  24597. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24598. */
  24599. set onAfterRender(callback: (faceIndex: number) => void);
  24600. /**
  24601. * An event triggered after the texture clear
  24602. */
  24603. onClearObservable: Observable<Engine>;
  24604. private _onClearObserver;
  24605. /**
  24606. * Set a clear callback in the texture.
  24607. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24608. */
  24609. set onClear(callback: (Engine: Engine) => void);
  24610. /**
  24611. * An event triggered when the texture is resized.
  24612. */
  24613. onResizeObservable: Observable<RenderTargetTexture>;
  24614. /**
  24615. * Define the clear color of the Render Target if it should be different from the scene.
  24616. */
  24617. clearColor: Color4;
  24618. protected _size: number | {
  24619. width: number;
  24620. height: number;
  24621. layers?: number;
  24622. };
  24623. protected _initialSizeParameter: number | {
  24624. width: number;
  24625. height: number;
  24626. } | {
  24627. ratio: number;
  24628. };
  24629. protected _sizeRatio: Nullable<number>;
  24630. /** @hidden */
  24631. _generateMipMaps: boolean;
  24632. protected _renderingManager: RenderingManager;
  24633. /** @hidden */
  24634. _waitingRenderList?: string[];
  24635. protected _doNotChangeAspectRatio: boolean;
  24636. protected _currentRefreshId: number;
  24637. protected _refreshRate: number;
  24638. protected _textureMatrix: Matrix;
  24639. protected _samples: number;
  24640. protected _renderTargetOptions: RenderTargetCreationOptions;
  24641. /**
  24642. * Gets render target creation options that were used.
  24643. */
  24644. get renderTargetOptions(): RenderTargetCreationOptions;
  24645. protected _onRatioRescale(): void;
  24646. /**
  24647. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24648. * It must define where the camera used to render the texture is set
  24649. */
  24650. boundingBoxPosition: Vector3;
  24651. private _boundingBoxSize;
  24652. /**
  24653. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24654. * When defined, the cubemap will switch to local mode
  24655. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24656. * @example https://www.babylonjs-playground.com/#RNASML
  24657. */
  24658. set boundingBoxSize(value: Vector3);
  24659. get boundingBoxSize(): Vector3;
  24660. /**
  24661. * In case the RTT has been created with a depth texture, get the associated
  24662. * depth texture.
  24663. * Otherwise, return null.
  24664. */
  24665. get depthStencilTexture(): Nullable<InternalTexture>;
  24666. /**
  24667. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24668. * or used a shadow, depth texture...
  24669. * @param name The friendly name of the texture
  24670. * @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)
  24671. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24672. * @param generateMipMaps True if mip maps need to be generated after render.
  24673. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24674. * @param type The type of the buffer in the RTT (int, half float, float...)
  24675. * @param isCube True if a cube texture needs to be created
  24676. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24677. * @param generateDepthBuffer True to generate a depth buffer
  24678. * @param generateStencilBuffer True to generate a stencil buffer
  24679. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24680. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24681. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24682. */
  24683. constructor(name: string, size: number | {
  24684. width: number;
  24685. height: number;
  24686. layers?: number;
  24687. } | {
  24688. ratio: number;
  24689. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24690. /**
  24691. * Creates a depth stencil texture.
  24692. * This is only available in WebGL 2 or with the depth texture extension available.
  24693. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24694. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24695. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24696. */
  24697. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24698. private _processSizeParameter;
  24699. /**
  24700. * Define the number of samples to use in case of MSAA.
  24701. * It defaults to one meaning no MSAA has been enabled.
  24702. */
  24703. get samples(): number;
  24704. set samples(value: number);
  24705. /**
  24706. * Resets the refresh counter of the texture and start bak from scratch.
  24707. * Could be useful to regenerate the texture if it is setup to render only once.
  24708. */
  24709. resetRefreshCounter(): void;
  24710. /**
  24711. * Define the refresh rate of the texture or the rendering frequency.
  24712. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24713. */
  24714. get refreshRate(): number;
  24715. set refreshRate(value: number);
  24716. /**
  24717. * Adds a post process to the render target rendering passes.
  24718. * @param postProcess define the post process to add
  24719. */
  24720. addPostProcess(postProcess: PostProcess): void;
  24721. /**
  24722. * Clear all the post processes attached to the render target
  24723. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24724. */
  24725. clearPostProcesses(dispose?: boolean): void;
  24726. /**
  24727. * Remove one of the post process from the list of attached post processes to the texture
  24728. * @param postProcess define the post process to remove from the list
  24729. */
  24730. removePostProcess(postProcess: PostProcess): void;
  24731. /** @hidden */
  24732. _shouldRender(): boolean;
  24733. /**
  24734. * Gets the actual render size of the texture.
  24735. * @returns the width of the render size
  24736. */
  24737. getRenderSize(): number;
  24738. /**
  24739. * Gets the actual render width of the texture.
  24740. * @returns the width of the render size
  24741. */
  24742. getRenderWidth(): number;
  24743. /**
  24744. * Gets the actual render height of the texture.
  24745. * @returns the height of the render size
  24746. */
  24747. getRenderHeight(): number;
  24748. /**
  24749. * Gets the actual number of layers of the texture.
  24750. * @returns the number of layers
  24751. */
  24752. getRenderLayers(): number;
  24753. /**
  24754. * Get if the texture can be rescaled or not.
  24755. */
  24756. get canRescale(): boolean;
  24757. /**
  24758. * Resize the texture using a ratio.
  24759. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24760. */
  24761. scale(ratio: number): void;
  24762. /**
  24763. * Get the texture reflection matrix used to rotate/transform the reflection.
  24764. * @returns the reflection matrix
  24765. */
  24766. getReflectionTextureMatrix(): Matrix;
  24767. /**
  24768. * Resize the texture to a new desired size.
  24769. * Be carrefull as it will recreate all the data in the new texture.
  24770. * @param size Define the new size. It can be:
  24771. * - a number for squared texture,
  24772. * - an object containing { width: number, height: number }
  24773. * - or an object containing a ratio { ratio: number }
  24774. */
  24775. resize(size: number | {
  24776. width: number;
  24777. height: number;
  24778. } | {
  24779. ratio: number;
  24780. }): void;
  24781. private _defaultRenderListPrepared;
  24782. /**
  24783. * Renders all the objects from the render list into the texture.
  24784. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24785. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24786. */
  24787. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24788. private _bestReflectionRenderTargetDimension;
  24789. private _prepareRenderingManager;
  24790. /**
  24791. * @hidden
  24792. * @param faceIndex face index to bind to if this is a cubetexture
  24793. * @param layer defines the index of the texture to bind in the array
  24794. */
  24795. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24796. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24797. private renderToTarget;
  24798. /**
  24799. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24800. * This allowed control for front to back rendering or reversly depending of the special needs.
  24801. *
  24802. * @param renderingGroupId The rendering group id corresponding to its index
  24803. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24804. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24805. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24806. */
  24807. 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;
  24808. /**
  24809. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24810. *
  24811. * @param renderingGroupId The rendering group id corresponding to its index
  24812. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24813. */
  24814. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24815. /**
  24816. * Clones the texture.
  24817. * @returns the cloned texture
  24818. */
  24819. clone(): RenderTargetTexture;
  24820. /**
  24821. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24822. * @returns The JSON representation of the texture
  24823. */
  24824. serialize(): any;
  24825. /**
  24826. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24827. */
  24828. disposeFramebufferObjects(): void;
  24829. /**
  24830. * Dispose the texture and release its associated resources.
  24831. */
  24832. dispose(): void;
  24833. /** @hidden */
  24834. _rebuild(): void;
  24835. /**
  24836. * Clear the info related to rendering groups preventing retention point in material dispose.
  24837. */
  24838. freeRenderingGroups(): void;
  24839. /**
  24840. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24841. * @returns the view count
  24842. */
  24843. getViewCount(): number;
  24844. }
  24845. }
  24846. declare module "babylonjs/Misc/guid" {
  24847. /**
  24848. * Class used to manipulate GUIDs
  24849. */
  24850. export class GUID {
  24851. /**
  24852. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24853. * Be aware Math.random() could cause collisions, but:
  24854. * "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"
  24855. * @returns a pseudo random id
  24856. */
  24857. static RandomId(): string;
  24858. }
  24859. }
  24860. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24861. import { Nullable } from "babylonjs/types";
  24862. import { Scene } from "babylonjs/scene";
  24863. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24864. import { Material } from "babylonjs/Materials/material";
  24865. import { Effect } from "babylonjs/Materials/effect";
  24866. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24867. /**
  24868. * Options to be used when creating a shadow depth material
  24869. */
  24870. export interface IIOptionShadowDepthMaterial {
  24871. /** Variables in the vertex shader code that need to have their names remapped.
  24872. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24873. * "var_name" should be either: worldPos or vNormalW
  24874. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24875. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24876. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24877. */
  24878. remappedVariables?: string[];
  24879. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24880. standalone?: boolean;
  24881. }
  24882. /**
  24883. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24884. */
  24885. export class ShadowDepthWrapper {
  24886. private _scene;
  24887. private _options?;
  24888. private _baseMaterial;
  24889. private _onEffectCreatedObserver;
  24890. private _subMeshToEffect;
  24891. private _subMeshToDepthEffect;
  24892. private _meshes;
  24893. /** @hidden */
  24894. _matriceNames: any;
  24895. /** Gets the standalone status of the wrapper */
  24896. get standalone(): boolean;
  24897. /** Gets the base material the wrapper is built upon */
  24898. get baseMaterial(): Material;
  24899. /**
  24900. * Instantiate a new shadow depth wrapper.
  24901. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24902. * generate the shadow depth map. For more information, please refer to the documentation:
  24903. * https://doc.babylonjs.com/babylon101/shadows
  24904. * @param baseMaterial Material to wrap
  24905. * @param scene Define the scene the material belongs to
  24906. * @param options Options used to create the wrapper
  24907. */
  24908. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24909. /**
  24910. * Gets the effect to use to generate the depth map
  24911. * @param subMesh subMesh to get the effect for
  24912. * @param shadowGenerator shadow generator to get the effect for
  24913. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24914. */
  24915. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24916. /**
  24917. * Specifies that the submesh is ready to be used for depth rendering
  24918. * @param subMesh submesh to check
  24919. * @param defines the list of defines to take into account when checking the effect
  24920. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24921. * @param useInstances specifies that instances should be used
  24922. * @returns a boolean indicating that the submesh is ready or not
  24923. */
  24924. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24925. /**
  24926. * Disposes the resources
  24927. */
  24928. dispose(): void;
  24929. private _makeEffect;
  24930. }
  24931. }
  24932. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24933. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24934. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24935. import { Nullable } from "babylonjs/types";
  24936. module "babylonjs/Engines/thinEngine" {
  24937. interface ThinEngine {
  24938. /**
  24939. * Unbind a list of render target textures from the webGL context
  24940. * This is used only when drawBuffer extension or webGL2 are active
  24941. * @param textures defines the render target textures to unbind
  24942. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24943. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24944. */
  24945. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24946. /**
  24947. * Create a multi render target texture
  24948. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24949. * @param size defines the size of the texture
  24950. * @param options defines the creation options
  24951. * @returns the cube texture as an InternalTexture
  24952. */
  24953. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24954. /**
  24955. * Update the sample count for a given multiple render target texture
  24956. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24957. * @param textures defines the textures to update
  24958. * @param samples defines the sample count to set
  24959. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24960. */
  24961. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24962. /**
  24963. * Select a subsets of attachments to draw to.
  24964. * @param attachments gl attachments
  24965. */
  24966. bindAttachments(attachments: number[]): void;
  24967. }
  24968. }
  24969. }
  24970. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24971. import { Scene } from "babylonjs/scene";
  24972. import { Engine } from "babylonjs/Engines/engine";
  24973. import { Texture } from "babylonjs/Materials/Textures/texture";
  24974. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24975. import "babylonjs/Engines/Extensions/engine.multiRender";
  24976. /**
  24977. * Creation options of the multi render target texture.
  24978. */
  24979. export interface IMultiRenderTargetOptions {
  24980. /**
  24981. * Define if the texture needs to create mip maps after render.
  24982. */
  24983. generateMipMaps?: boolean;
  24984. /**
  24985. * Define the types of all the draw buffers we want to create
  24986. */
  24987. types?: number[];
  24988. /**
  24989. * Define the sampling modes of all the draw buffers we want to create
  24990. */
  24991. samplingModes?: number[];
  24992. /**
  24993. * Define if a depth buffer is required
  24994. */
  24995. generateDepthBuffer?: boolean;
  24996. /**
  24997. * Define if a stencil buffer is required
  24998. */
  24999. generateStencilBuffer?: boolean;
  25000. /**
  25001. * Define if a depth texture is required instead of a depth buffer
  25002. */
  25003. generateDepthTexture?: boolean;
  25004. /**
  25005. * Define the number of desired draw buffers
  25006. */
  25007. textureCount?: number;
  25008. /**
  25009. * Define if aspect ratio should be adapted to the texture or stay the scene one
  25010. */
  25011. doNotChangeAspectRatio?: boolean;
  25012. /**
  25013. * Define the default type of the buffers we are creating
  25014. */
  25015. defaultType?: number;
  25016. }
  25017. /**
  25018. * A multi render target, like a render target provides the ability to render to a texture.
  25019. * Unlike the render target, it can render to several draw buffers in one draw.
  25020. * This is specially interesting in deferred rendering or for any effects requiring more than
  25021. * just one color from a single pass.
  25022. */
  25023. export class MultiRenderTarget extends RenderTargetTexture {
  25024. private _internalTextures;
  25025. private _textures;
  25026. private _multiRenderTargetOptions;
  25027. private _count;
  25028. /**
  25029. * Get if draw buffers are currently supported by the used hardware and browser.
  25030. */
  25031. get isSupported(): boolean;
  25032. /**
  25033. * Get the list of textures generated by the multi render target.
  25034. */
  25035. get textures(): Texture[];
  25036. /**
  25037. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  25038. */
  25039. get count(): number;
  25040. /**
  25041. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  25042. */
  25043. get depthTexture(): Texture;
  25044. /**
  25045. * Set the wrapping mode on U of all the textures we are rendering to.
  25046. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  25047. */
  25048. set wrapU(wrap: number);
  25049. /**
  25050. * Set the wrapping mode on V of all the textures we are rendering to.
  25051. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  25052. */
  25053. set wrapV(wrap: number);
  25054. /**
  25055. * Instantiate a new multi render target texture.
  25056. * A multi render target, like a render target provides the ability to render to a texture.
  25057. * Unlike the render target, it can render to several draw buffers in one draw.
  25058. * This is specially interesting in deferred rendering or for any effects requiring more than
  25059. * just one color from a single pass.
  25060. * @param name Define the name of the texture
  25061. * @param size Define the size of the buffers to render to
  25062. * @param count Define the number of target we are rendering into
  25063. * @param scene Define the scene the texture belongs to
  25064. * @param options Define the options used to create the multi render target
  25065. */
  25066. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  25067. private _initTypes;
  25068. /** @hidden */
  25069. _rebuild(forceFullRebuild?: boolean): void;
  25070. private _createInternalTextures;
  25071. private _createTextures;
  25072. /**
  25073. * Define the number of samples used if MSAA is enabled.
  25074. */
  25075. get samples(): number;
  25076. set samples(value: number);
  25077. /**
  25078. * Resize all the textures in the multi render target.
  25079. * Be careful as it will recreate all the data in the new texture.
  25080. * @param size Define the new size
  25081. */
  25082. resize(size: any): void;
  25083. /**
  25084. * Changes the number of render targets in this MRT
  25085. * Be careful as it will recreate all the data in the new texture.
  25086. * @param count new texture count
  25087. * @param options Specifies texture types and sampling modes for new textures
  25088. */
  25089. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  25090. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  25091. /**
  25092. * Dispose the render targets and their associated resources
  25093. */
  25094. dispose(): void;
  25095. /**
  25096. * Release all the underlying texture used as draw buffers.
  25097. */
  25098. releaseInternalTextures(): void;
  25099. }
  25100. }
  25101. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  25102. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  25103. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25104. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  25105. /** @hidden */
  25106. export var imageProcessingPixelShader: {
  25107. name: string;
  25108. shader: string;
  25109. };
  25110. }
  25111. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  25112. import { Nullable } from "babylonjs/types";
  25113. import { Color4 } from "babylonjs/Maths/math.color";
  25114. import { Camera } from "babylonjs/Cameras/camera";
  25115. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25116. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  25117. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  25118. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25119. import { Engine } from "babylonjs/Engines/engine";
  25120. import "babylonjs/Shaders/imageProcessing.fragment";
  25121. import "babylonjs/Shaders/postprocess.vertex";
  25122. /**
  25123. * ImageProcessingPostProcess
  25124. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  25125. */
  25126. export class ImageProcessingPostProcess extends PostProcess {
  25127. /**
  25128. * Default configuration related to image processing available in the PBR Material.
  25129. */
  25130. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  25131. /**
  25132. * Gets the image processing configuration used either in this material.
  25133. */
  25134. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  25135. /**
  25136. * Sets the Default image processing configuration used either in the this material.
  25137. *
  25138. * If sets to null, the scene one is in use.
  25139. */
  25140. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  25141. /**
  25142. * Keep track of the image processing observer to allow dispose and replace.
  25143. */
  25144. private _imageProcessingObserver;
  25145. /**
  25146. * Attaches a new image processing configuration to the PBR Material.
  25147. * @param configuration
  25148. */
  25149. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  25150. /**
  25151. * If the post process is supported.
  25152. */
  25153. get isSupported(): boolean;
  25154. /**
  25155. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  25156. */
  25157. get colorCurves(): Nullable<ColorCurves>;
  25158. /**
  25159. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  25160. */
  25161. set colorCurves(value: Nullable<ColorCurves>);
  25162. /**
  25163. * Gets wether the color curves effect is enabled.
  25164. */
  25165. get colorCurvesEnabled(): boolean;
  25166. /**
  25167. * Sets wether the color curves effect is enabled.
  25168. */
  25169. set colorCurvesEnabled(value: boolean);
  25170. /**
  25171. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  25172. */
  25173. get colorGradingTexture(): Nullable<BaseTexture>;
  25174. /**
  25175. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  25176. */
  25177. set colorGradingTexture(value: Nullable<BaseTexture>);
  25178. /**
  25179. * Gets wether the color grading effect is enabled.
  25180. */
  25181. get colorGradingEnabled(): boolean;
  25182. /**
  25183. * Gets wether the color grading effect is enabled.
  25184. */
  25185. set colorGradingEnabled(value: boolean);
  25186. /**
  25187. * Gets exposure used in the effect.
  25188. */
  25189. get exposure(): number;
  25190. /**
  25191. * Sets exposure used in the effect.
  25192. */
  25193. set exposure(value: number);
  25194. /**
  25195. * Gets wether tonemapping is enabled or not.
  25196. */
  25197. get toneMappingEnabled(): boolean;
  25198. /**
  25199. * Sets wether tonemapping is enabled or not
  25200. */
  25201. set toneMappingEnabled(value: boolean);
  25202. /**
  25203. * Gets the type of tone mapping effect.
  25204. */
  25205. get toneMappingType(): number;
  25206. /**
  25207. * Sets the type of tone mapping effect.
  25208. */
  25209. set toneMappingType(value: number);
  25210. /**
  25211. * Gets contrast used in the effect.
  25212. */
  25213. get contrast(): number;
  25214. /**
  25215. * Sets contrast used in the effect.
  25216. */
  25217. set contrast(value: number);
  25218. /**
  25219. * Gets Vignette stretch size.
  25220. */
  25221. get vignetteStretch(): number;
  25222. /**
  25223. * Sets Vignette stretch size.
  25224. */
  25225. set vignetteStretch(value: number);
  25226. /**
  25227. * Gets Vignette centre X Offset.
  25228. */
  25229. get vignetteCentreX(): number;
  25230. /**
  25231. * Sets Vignette centre X Offset.
  25232. */
  25233. set vignetteCentreX(value: number);
  25234. /**
  25235. * Gets Vignette centre Y Offset.
  25236. */
  25237. get vignetteCentreY(): number;
  25238. /**
  25239. * Sets Vignette centre Y Offset.
  25240. */
  25241. set vignetteCentreY(value: number);
  25242. /**
  25243. * Gets Vignette weight or intensity of the vignette effect.
  25244. */
  25245. get vignetteWeight(): number;
  25246. /**
  25247. * Sets Vignette weight or intensity of the vignette effect.
  25248. */
  25249. set vignetteWeight(value: number);
  25250. /**
  25251. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25252. * if vignetteEnabled is set to true.
  25253. */
  25254. get vignetteColor(): Color4;
  25255. /**
  25256. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25257. * if vignetteEnabled is set to true.
  25258. */
  25259. set vignetteColor(value: Color4);
  25260. /**
  25261. * Gets Camera field of view used by the Vignette effect.
  25262. */
  25263. get vignetteCameraFov(): number;
  25264. /**
  25265. * Sets Camera field of view used by the Vignette effect.
  25266. */
  25267. set vignetteCameraFov(value: number);
  25268. /**
  25269. * Gets the vignette blend mode allowing different kind of effect.
  25270. */
  25271. get vignetteBlendMode(): number;
  25272. /**
  25273. * Sets the vignette blend mode allowing different kind of effect.
  25274. */
  25275. set vignetteBlendMode(value: number);
  25276. /**
  25277. * Gets wether the vignette effect is enabled.
  25278. */
  25279. get vignetteEnabled(): boolean;
  25280. /**
  25281. * Sets wether the vignette effect is enabled.
  25282. */
  25283. set vignetteEnabled(value: boolean);
  25284. private _fromLinearSpace;
  25285. /**
  25286. * Gets wether the input of the processing is in Gamma or Linear Space.
  25287. */
  25288. get fromLinearSpace(): boolean;
  25289. /**
  25290. * Sets wether the input of the processing is in Gamma or Linear Space.
  25291. */
  25292. set fromLinearSpace(value: boolean);
  25293. /**
  25294. * Defines cache preventing GC.
  25295. */
  25296. private _defines;
  25297. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25298. /**
  25299. * "ImageProcessingPostProcess"
  25300. * @returns "ImageProcessingPostProcess"
  25301. */
  25302. getClassName(): string;
  25303. /**
  25304. * @hidden
  25305. */
  25306. _updateParameters(): void;
  25307. dispose(camera?: Camera): void;
  25308. }
  25309. }
  25310. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25311. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25312. /**
  25313. * Interface for defining prepass effects in the prepass post-process pipeline
  25314. */
  25315. export interface PrePassEffectConfiguration {
  25316. /**
  25317. * Name of the effect
  25318. */
  25319. name: string;
  25320. /**
  25321. * Post process to attach for this effect
  25322. */
  25323. postProcess?: PostProcess;
  25324. /**
  25325. * Textures required in the MRT
  25326. */
  25327. texturesRequired: number[];
  25328. /**
  25329. * Is the effect enabled
  25330. */
  25331. enabled: boolean;
  25332. /**
  25333. * Disposes the effect configuration
  25334. */
  25335. dispose(): void;
  25336. /**
  25337. * Creates the associated post process
  25338. */
  25339. createPostProcess?: () => PostProcess;
  25340. }
  25341. }
  25342. declare module "babylonjs/Rendering/prePassRenderer" {
  25343. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25344. import { Scene } from "babylonjs/scene";
  25345. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25346. import { Effect } from "babylonjs/Materials/effect";
  25347. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25348. /**
  25349. * Renders a pre pass of the scene
  25350. * This means every mesh in the scene will be rendered to a render target texture
  25351. * And then this texture will be composited to the rendering canvas with post processes
  25352. * It is necessary for effects like subsurface scattering or deferred shading
  25353. */
  25354. export class PrePassRenderer {
  25355. /** @hidden */
  25356. static _SceneComponentInitialization: (scene: Scene) => void;
  25357. private _textureFormats;
  25358. private _textureIndices;
  25359. private _scene;
  25360. private _engine;
  25361. private _isDirty;
  25362. /**
  25363. * Number of textures in the multi render target texture where the scene is directly rendered
  25364. */
  25365. mrtCount: number;
  25366. /**
  25367. * The render target where the scene is directly rendered
  25368. */
  25369. prePassRT: MultiRenderTarget;
  25370. private _multiRenderAttachments;
  25371. private _defaultAttachments;
  25372. private _clearAttachments;
  25373. private _postProcesses;
  25374. private readonly _clearColor;
  25375. /**
  25376. * Image processing post process for composition
  25377. */
  25378. imageProcessingPostProcess: ImageProcessingPostProcess;
  25379. /**
  25380. * Configuration for prepass effects
  25381. */
  25382. private _effectConfigurations;
  25383. /**
  25384. * Should materials render their geometry on the MRT
  25385. */
  25386. materialsShouldRenderGeometry: boolean;
  25387. /**
  25388. * Should materials render the irradiance information on the MRT
  25389. */
  25390. materialsShouldRenderIrradiance: boolean;
  25391. private _mrtFormats;
  25392. private _mrtLayout;
  25393. private _enabled;
  25394. /**
  25395. * Indicates if the prepass is enabled
  25396. */
  25397. get enabled(): boolean;
  25398. /**
  25399. * How many samples are used for MSAA of the scene render target
  25400. */
  25401. get samples(): number;
  25402. set samples(n: number);
  25403. /**
  25404. * Instanciates a prepass renderer
  25405. * @param scene The scene
  25406. */
  25407. constructor(scene: Scene);
  25408. private _initializeAttachments;
  25409. private _createCompositionEffect;
  25410. /**
  25411. * Indicates if rendering a prepass is supported
  25412. */
  25413. get isSupported(): boolean;
  25414. /**
  25415. * Sets the proper output textures to draw in the engine.
  25416. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25417. */
  25418. bindAttachmentsForEffect(effect: Effect): void;
  25419. /**
  25420. * @hidden
  25421. */
  25422. _beforeCameraDraw(): void;
  25423. /**
  25424. * @hidden
  25425. */
  25426. _afterCameraDraw(): void;
  25427. private _checkRTSize;
  25428. private _bindFrameBuffer;
  25429. /**
  25430. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25431. */
  25432. clear(): void;
  25433. private _setState;
  25434. private _checkTextureType;
  25435. /**
  25436. * Adds an effect configuration to the prepass.
  25437. * If an effect has already been added, it won't add it twice and will return the configuration
  25438. * already present.
  25439. * @param cfg the effect configuration
  25440. * @return the effect configuration now used by the prepass
  25441. */
  25442. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  25443. /**
  25444. * Returns the index of a texture in the multi render target texture array.
  25445. * @param type Texture type
  25446. * @return The index
  25447. */
  25448. getIndex(type: number): number;
  25449. private _enable;
  25450. private _disable;
  25451. private _resetLayout;
  25452. private _resetPostProcessChain;
  25453. private _bindPostProcessChain;
  25454. /**
  25455. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25456. */
  25457. markAsDirty(): void;
  25458. /**
  25459. * Enables a texture on the MultiRenderTarget for prepass
  25460. */
  25461. private _enableTextures;
  25462. private _update;
  25463. /**
  25464. * Disposes the prepass renderer.
  25465. */
  25466. dispose(): void;
  25467. }
  25468. }
  25469. declare module "babylonjs/Materials/material" {
  25470. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25471. import { SmartArray } from "babylonjs/Misc/smartArray";
  25472. import { Observable } from "babylonjs/Misc/observable";
  25473. import { Nullable } from "babylonjs/types";
  25474. import { Scene } from "babylonjs/scene";
  25475. import { Matrix } from "babylonjs/Maths/math.vector";
  25476. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25477. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25478. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25479. import { Effect } from "babylonjs/Materials/effect";
  25480. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25481. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25482. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25483. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25484. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25485. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25486. import { Mesh } from "babylonjs/Meshes/mesh";
  25487. import { Animation } from "babylonjs/Animations/animation";
  25488. /**
  25489. * Options for compiling materials.
  25490. */
  25491. export interface IMaterialCompilationOptions {
  25492. /**
  25493. * Defines whether clip planes are enabled.
  25494. */
  25495. clipPlane: boolean;
  25496. /**
  25497. * Defines whether instances are enabled.
  25498. */
  25499. useInstances: boolean;
  25500. }
  25501. /**
  25502. * Options passed when calling customShaderNameResolve
  25503. */
  25504. export interface ICustomShaderNameResolveOptions {
  25505. /**
  25506. * 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
  25507. */
  25508. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25509. }
  25510. /**
  25511. * Base class for the main features of a material in Babylon.js
  25512. */
  25513. export class Material implements IAnimatable {
  25514. /**
  25515. * Returns the triangle fill mode
  25516. */
  25517. static readonly TriangleFillMode: number;
  25518. /**
  25519. * Returns the wireframe mode
  25520. */
  25521. static readonly WireFrameFillMode: number;
  25522. /**
  25523. * Returns the point fill mode
  25524. */
  25525. static readonly PointFillMode: number;
  25526. /**
  25527. * Returns the point list draw mode
  25528. */
  25529. static readonly PointListDrawMode: number;
  25530. /**
  25531. * Returns the line list draw mode
  25532. */
  25533. static readonly LineListDrawMode: number;
  25534. /**
  25535. * Returns the line loop draw mode
  25536. */
  25537. static readonly LineLoopDrawMode: number;
  25538. /**
  25539. * Returns the line strip draw mode
  25540. */
  25541. static readonly LineStripDrawMode: number;
  25542. /**
  25543. * Returns the triangle strip draw mode
  25544. */
  25545. static readonly TriangleStripDrawMode: number;
  25546. /**
  25547. * Returns the triangle fan draw mode
  25548. */
  25549. static readonly TriangleFanDrawMode: number;
  25550. /**
  25551. * Stores the clock-wise side orientation
  25552. */
  25553. static readonly ClockWiseSideOrientation: number;
  25554. /**
  25555. * Stores the counter clock-wise side orientation
  25556. */
  25557. static readonly CounterClockWiseSideOrientation: number;
  25558. /**
  25559. * The dirty texture flag value
  25560. */
  25561. static readonly TextureDirtyFlag: number;
  25562. /**
  25563. * The dirty light flag value
  25564. */
  25565. static readonly LightDirtyFlag: number;
  25566. /**
  25567. * The dirty fresnel flag value
  25568. */
  25569. static readonly FresnelDirtyFlag: number;
  25570. /**
  25571. * The dirty attribute flag value
  25572. */
  25573. static readonly AttributesDirtyFlag: number;
  25574. /**
  25575. * The dirty misc flag value
  25576. */
  25577. static readonly MiscDirtyFlag: number;
  25578. /**
  25579. * The all dirty flag value
  25580. */
  25581. static readonly AllDirtyFlag: number;
  25582. /**
  25583. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25584. */
  25585. static readonly MATERIAL_OPAQUE: number;
  25586. /**
  25587. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25588. */
  25589. static readonly MATERIAL_ALPHATEST: number;
  25590. /**
  25591. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25592. */
  25593. static readonly MATERIAL_ALPHABLEND: number;
  25594. /**
  25595. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25596. * They are also discarded below the alpha cutoff threshold to improve performances.
  25597. */
  25598. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25599. /**
  25600. * The Whiteout method is used to blend normals.
  25601. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25602. */
  25603. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25604. /**
  25605. * The Reoriented Normal Mapping method is used to blend normals.
  25606. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25607. */
  25608. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25609. /**
  25610. * Custom callback helping to override the default shader used in the material.
  25611. */
  25612. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25613. /**
  25614. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25615. */
  25616. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25617. /**
  25618. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25619. * This means that the material can keep using a previous shader while a new one is being compiled.
  25620. * This is mostly used when shader parallel compilation is supported (true by default)
  25621. */
  25622. allowShaderHotSwapping: boolean;
  25623. /**
  25624. * The ID of the material
  25625. */
  25626. id: string;
  25627. /**
  25628. * Gets or sets the unique id of the material
  25629. */
  25630. uniqueId: number;
  25631. /**
  25632. * The name of the material
  25633. */
  25634. name: string;
  25635. /**
  25636. * Gets or sets user defined metadata
  25637. */
  25638. metadata: any;
  25639. /**
  25640. * For internal use only. Please do not use.
  25641. */
  25642. reservedDataStore: any;
  25643. /**
  25644. * Specifies if the ready state should be checked on each call
  25645. */
  25646. checkReadyOnEveryCall: boolean;
  25647. /**
  25648. * Specifies if the ready state should be checked once
  25649. */
  25650. checkReadyOnlyOnce: boolean;
  25651. /**
  25652. * The state of the material
  25653. */
  25654. state: string;
  25655. /**
  25656. * If the material can be rendered to several textures with MRT extension
  25657. */
  25658. get canRenderToMRT(): boolean;
  25659. /**
  25660. * The alpha value of the material
  25661. */
  25662. protected _alpha: number;
  25663. /**
  25664. * List of inspectable custom properties (used by the Inspector)
  25665. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25666. */
  25667. inspectableCustomProperties: IInspectable[];
  25668. /**
  25669. * Sets the alpha value of the material
  25670. */
  25671. set alpha(value: number);
  25672. /**
  25673. * Gets the alpha value of the material
  25674. */
  25675. get alpha(): number;
  25676. /**
  25677. * Specifies if back face culling is enabled
  25678. */
  25679. protected _backFaceCulling: boolean;
  25680. /**
  25681. * Sets the back-face culling state
  25682. */
  25683. set backFaceCulling(value: boolean);
  25684. /**
  25685. * Gets the back-face culling state
  25686. */
  25687. get backFaceCulling(): boolean;
  25688. /**
  25689. * Stores the value for side orientation
  25690. */
  25691. sideOrientation: number;
  25692. /**
  25693. * Callback triggered when the material is compiled
  25694. */
  25695. onCompiled: Nullable<(effect: Effect) => void>;
  25696. /**
  25697. * Callback triggered when an error occurs
  25698. */
  25699. onError: Nullable<(effect: Effect, errors: string) => void>;
  25700. /**
  25701. * Callback triggered to get the render target textures
  25702. */
  25703. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25704. /**
  25705. * Gets a boolean indicating that current material needs to register RTT
  25706. */
  25707. get hasRenderTargetTextures(): boolean;
  25708. /**
  25709. * Specifies if the material should be serialized
  25710. */
  25711. doNotSerialize: boolean;
  25712. /**
  25713. * @hidden
  25714. */
  25715. _storeEffectOnSubMeshes: boolean;
  25716. /**
  25717. * Stores the animations for the material
  25718. */
  25719. animations: Nullable<Array<Animation>>;
  25720. /**
  25721. * An event triggered when the material is disposed
  25722. */
  25723. onDisposeObservable: Observable<Material>;
  25724. /**
  25725. * An observer which watches for dispose events
  25726. */
  25727. private _onDisposeObserver;
  25728. private _onUnBindObservable;
  25729. /**
  25730. * Called during a dispose event
  25731. */
  25732. set onDispose(callback: () => void);
  25733. private _onBindObservable;
  25734. /**
  25735. * An event triggered when the material is bound
  25736. */
  25737. get onBindObservable(): Observable<AbstractMesh>;
  25738. /**
  25739. * An observer which watches for bind events
  25740. */
  25741. private _onBindObserver;
  25742. /**
  25743. * Called during a bind event
  25744. */
  25745. set onBind(callback: (Mesh: AbstractMesh) => void);
  25746. /**
  25747. * An event triggered when the material is unbound
  25748. */
  25749. get onUnBindObservable(): Observable<Material>;
  25750. protected _onEffectCreatedObservable: Nullable<Observable<{
  25751. effect: Effect;
  25752. subMesh: Nullable<SubMesh>;
  25753. }>>;
  25754. /**
  25755. * An event triggered when the effect is (re)created
  25756. */
  25757. get onEffectCreatedObservable(): Observable<{
  25758. effect: Effect;
  25759. subMesh: Nullable<SubMesh>;
  25760. }>;
  25761. /**
  25762. * Stores the value of the alpha mode
  25763. */
  25764. private _alphaMode;
  25765. /**
  25766. * Sets the value of the alpha mode.
  25767. *
  25768. * | Value | Type | Description |
  25769. * | --- | --- | --- |
  25770. * | 0 | ALPHA_DISABLE | |
  25771. * | 1 | ALPHA_ADD | |
  25772. * | 2 | ALPHA_COMBINE | |
  25773. * | 3 | ALPHA_SUBTRACT | |
  25774. * | 4 | ALPHA_MULTIPLY | |
  25775. * | 5 | ALPHA_MAXIMIZED | |
  25776. * | 6 | ALPHA_ONEONE | |
  25777. * | 7 | ALPHA_PREMULTIPLIED | |
  25778. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25779. * | 9 | ALPHA_INTERPOLATE | |
  25780. * | 10 | ALPHA_SCREENMODE | |
  25781. *
  25782. */
  25783. set alphaMode(value: number);
  25784. /**
  25785. * Gets the value of the alpha mode
  25786. */
  25787. get alphaMode(): number;
  25788. /**
  25789. * Stores the state of the need depth pre-pass value
  25790. */
  25791. private _needDepthPrePass;
  25792. /**
  25793. * Sets the need depth pre-pass value
  25794. */
  25795. set needDepthPrePass(value: boolean);
  25796. /**
  25797. * Gets the depth pre-pass value
  25798. */
  25799. get needDepthPrePass(): boolean;
  25800. /**
  25801. * Specifies if depth writing should be disabled
  25802. */
  25803. disableDepthWrite: boolean;
  25804. /**
  25805. * Specifies if color writing should be disabled
  25806. */
  25807. disableColorWrite: boolean;
  25808. /**
  25809. * Specifies if depth writing should be forced
  25810. */
  25811. forceDepthWrite: boolean;
  25812. /**
  25813. * Specifies the depth function that should be used. 0 means the default engine function
  25814. */
  25815. depthFunction: number;
  25816. /**
  25817. * Specifies if there should be a separate pass for culling
  25818. */
  25819. separateCullingPass: boolean;
  25820. /**
  25821. * Stores the state specifing if fog should be enabled
  25822. */
  25823. private _fogEnabled;
  25824. /**
  25825. * Sets the state for enabling fog
  25826. */
  25827. set fogEnabled(value: boolean);
  25828. /**
  25829. * Gets the value of the fog enabled state
  25830. */
  25831. get fogEnabled(): boolean;
  25832. /**
  25833. * Stores the size of points
  25834. */
  25835. pointSize: number;
  25836. /**
  25837. * Stores the z offset value
  25838. */
  25839. zOffset: number;
  25840. get wireframe(): boolean;
  25841. /**
  25842. * Sets the state of wireframe mode
  25843. */
  25844. set wireframe(value: boolean);
  25845. /**
  25846. * Gets the value specifying if point clouds are enabled
  25847. */
  25848. get pointsCloud(): boolean;
  25849. /**
  25850. * Sets the state of point cloud mode
  25851. */
  25852. set pointsCloud(value: boolean);
  25853. /**
  25854. * Gets the material fill mode
  25855. */
  25856. get fillMode(): number;
  25857. /**
  25858. * Sets the material fill mode
  25859. */
  25860. set fillMode(value: number);
  25861. /**
  25862. * @hidden
  25863. * Stores the effects for the material
  25864. */
  25865. _effect: Nullable<Effect>;
  25866. /**
  25867. * Specifies if uniform buffers should be used
  25868. */
  25869. private _useUBO;
  25870. /**
  25871. * Stores a reference to the scene
  25872. */
  25873. private _scene;
  25874. /**
  25875. * Stores the fill mode state
  25876. */
  25877. private _fillMode;
  25878. /**
  25879. * Specifies if the depth write state should be cached
  25880. */
  25881. private _cachedDepthWriteState;
  25882. /**
  25883. * Specifies if the color write state should be cached
  25884. */
  25885. private _cachedColorWriteState;
  25886. /**
  25887. * Specifies if the depth function state should be cached
  25888. */
  25889. private _cachedDepthFunctionState;
  25890. /**
  25891. * Stores the uniform buffer
  25892. */
  25893. protected _uniformBuffer: UniformBuffer;
  25894. /** @hidden */
  25895. _indexInSceneMaterialArray: number;
  25896. /** @hidden */
  25897. meshMap: Nullable<{
  25898. [id: string]: AbstractMesh | undefined;
  25899. }>;
  25900. /**
  25901. * Creates a material instance
  25902. * @param name defines the name of the material
  25903. * @param scene defines the scene to reference
  25904. * @param doNotAdd specifies if the material should be added to the scene
  25905. */
  25906. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25907. /**
  25908. * Returns a string representation of the current material
  25909. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25910. * @returns a string with material information
  25911. */
  25912. toString(fullDetails?: boolean): string;
  25913. /**
  25914. * Gets the class name of the material
  25915. * @returns a string with the class name of the material
  25916. */
  25917. getClassName(): string;
  25918. /**
  25919. * Specifies if updates for the material been locked
  25920. */
  25921. get isFrozen(): boolean;
  25922. /**
  25923. * Locks updates for the material
  25924. */
  25925. freeze(): void;
  25926. /**
  25927. * Unlocks updates for the material
  25928. */
  25929. unfreeze(): void;
  25930. /**
  25931. * Specifies if the material is ready to be used
  25932. * @param mesh defines the mesh to check
  25933. * @param useInstances specifies if instances should be used
  25934. * @returns a boolean indicating if the material is ready to be used
  25935. */
  25936. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25937. /**
  25938. * Specifies that the submesh is ready to be used
  25939. * @param mesh defines the mesh to check
  25940. * @param subMesh defines which submesh to check
  25941. * @param useInstances specifies that instances should be used
  25942. * @returns a boolean indicating that the submesh is ready or not
  25943. */
  25944. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25945. /**
  25946. * Returns the material effect
  25947. * @returns the effect associated with the material
  25948. */
  25949. getEffect(): Nullable<Effect>;
  25950. /**
  25951. * Returns the current scene
  25952. * @returns a Scene
  25953. */
  25954. getScene(): Scene;
  25955. /**
  25956. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25957. */
  25958. protected _forceAlphaTest: boolean;
  25959. /**
  25960. * The transparency mode of the material.
  25961. */
  25962. protected _transparencyMode: Nullable<number>;
  25963. /**
  25964. * Gets the current transparency mode.
  25965. */
  25966. get transparencyMode(): Nullable<number>;
  25967. /**
  25968. * Sets the transparency mode of the material.
  25969. *
  25970. * | Value | Type | Description |
  25971. * | ----- | ----------------------------------- | ----------- |
  25972. * | 0 | OPAQUE | |
  25973. * | 1 | ALPHATEST | |
  25974. * | 2 | ALPHABLEND | |
  25975. * | 3 | ALPHATESTANDBLEND | |
  25976. *
  25977. */
  25978. set transparencyMode(value: Nullable<number>);
  25979. /**
  25980. * Returns true if alpha blending should be disabled.
  25981. */
  25982. protected get _disableAlphaBlending(): boolean;
  25983. /**
  25984. * Specifies whether or not this material should be rendered in alpha blend mode.
  25985. * @returns a boolean specifying if alpha blending is needed
  25986. */
  25987. needAlphaBlending(): boolean;
  25988. /**
  25989. * Specifies if the mesh will require alpha blending
  25990. * @param mesh defines the mesh to check
  25991. * @returns a boolean specifying if alpha blending is needed for the mesh
  25992. */
  25993. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25994. /**
  25995. * Specifies whether or not this material should be rendered in alpha test mode.
  25996. * @returns a boolean specifying if an alpha test is needed.
  25997. */
  25998. needAlphaTesting(): boolean;
  25999. /**
  26000. * Specifies if material alpha testing should be turned on for the mesh
  26001. * @param mesh defines the mesh to check
  26002. */
  26003. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  26004. /**
  26005. * Gets the texture used for the alpha test
  26006. * @returns the texture to use for alpha testing
  26007. */
  26008. getAlphaTestTexture(): Nullable<BaseTexture>;
  26009. /**
  26010. * Marks the material to indicate that it needs to be re-calculated
  26011. */
  26012. markDirty(): void;
  26013. /** @hidden */
  26014. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  26015. /**
  26016. * Binds the material to the mesh
  26017. * @param world defines the world transformation matrix
  26018. * @param mesh defines the mesh to bind the material to
  26019. */
  26020. bind(world: Matrix, mesh?: Mesh): void;
  26021. /**
  26022. * Binds the submesh to the material
  26023. * @param world defines the world transformation matrix
  26024. * @param mesh defines the mesh containing the submesh
  26025. * @param subMesh defines the submesh to bind the material to
  26026. */
  26027. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  26028. /**
  26029. * Binds the world matrix to the material
  26030. * @param world defines the world transformation matrix
  26031. */
  26032. bindOnlyWorldMatrix(world: Matrix): void;
  26033. /**
  26034. * Binds the scene's uniform buffer to the effect.
  26035. * @param effect defines the effect to bind to the scene uniform buffer
  26036. * @param sceneUbo defines the uniform buffer storing scene data
  26037. */
  26038. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  26039. /**
  26040. * Binds the view matrix to the effect
  26041. * @param effect defines the effect to bind the view matrix to
  26042. */
  26043. bindView(effect: Effect): void;
  26044. /**
  26045. * Binds the view projection matrix to the effect
  26046. * @param effect defines the effect to bind the view projection matrix to
  26047. */
  26048. bindViewProjection(effect: Effect): void;
  26049. /**
  26050. * Processes to execute after binding the material to a mesh
  26051. * @param mesh defines the rendered mesh
  26052. */
  26053. protected _afterBind(mesh?: Mesh): void;
  26054. /**
  26055. * Unbinds the material from the mesh
  26056. */
  26057. unbind(): void;
  26058. /**
  26059. * Gets the active textures from the material
  26060. * @returns an array of textures
  26061. */
  26062. getActiveTextures(): BaseTexture[];
  26063. /**
  26064. * Specifies if the material uses a texture
  26065. * @param texture defines the texture to check against the material
  26066. * @returns a boolean specifying if the material uses the texture
  26067. */
  26068. hasTexture(texture: BaseTexture): boolean;
  26069. /**
  26070. * Makes a duplicate of the material, and gives it a new name
  26071. * @param name defines the new name for the duplicated material
  26072. * @returns the cloned material
  26073. */
  26074. clone(name: string): Nullable<Material>;
  26075. /**
  26076. * Gets the meshes bound to the material
  26077. * @returns an array of meshes bound to the material
  26078. */
  26079. getBindedMeshes(): AbstractMesh[];
  26080. /**
  26081. * Force shader compilation
  26082. * @param mesh defines the mesh associated with this material
  26083. * @param onCompiled defines a function to execute once the material is compiled
  26084. * @param options defines the options to configure the compilation
  26085. * @param onError defines a function to execute if the material fails compiling
  26086. */
  26087. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26088. /**
  26089. * Force shader compilation
  26090. * @param mesh defines the mesh that will use this material
  26091. * @param options defines additional options for compiling the shaders
  26092. * @returns a promise that resolves when the compilation completes
  26093. */
  26094. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26095. private static readonly _AllDirtyCallBack;
  26096. private static readonly _ImageProcessingDirtyCallBack;
  26097. private static readonly _TextureDirtyCallBack;
  26098. private static readonly _FresnelDirtyCallBack;
  26099. private static readonly _MiscDirtyCallBack;
  26100. private static readonly _LightsDirtyCallBack;
  26101. private static readonly _AttributeDirtyCallBack;
  26102. private static _FresnelAndMiscDirtyCallBack;
  26103. private static _TextureAndMiscDirtyCallBack;
  26104. private static readonly _DirtyCallbackArray;
  26105. private static readonly _RunDirtyCallBacks;
  26106. /**
  26107. * Marks a define in the material to indicate that it needs to be re-computed
  26108. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26109. */
  26110. markAsDirty(flag: number): void;
  26111. /**
  26112. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26113. * @param func defines a function which checks material defines against the submeshes
  26114. */
  26115. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26116. /**
  26117. * Indicates that the scene should check if the rendering now needs a prepass
  26118. */
  26119. protected _markScenePrePassDirty(): void;
  26120. /**
  26121. * Indicates that we need to re-calculated for all submeshes
  26122. */
  26123. protected _markAllSubMeshesAsAllDirty(): void;
  26124. /**
  26125. * Indicates that image processing needs to be re-calculated for all submeshes
  26126. */
  26127. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26128. /**
  26129. * Indicates that textures need to be re-calculated for all submeshes
  26130. */
  26131. protected _markAllSubMeshesAsTexturesDirty(): void;
  26132. /**
  26133. * Indicates that fresnel needs to be re-calculated for all submeshes
  26134. */
  26135. protected _markAllSubMeshesAsFresnelDirty(): void;
  26136. /**
  26137. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26138. */
  26139. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26140. /**
  26141. * Indicates that lights need to be re-calculated for all submeshes
  26142. */
  26143. protected _markAllSubMeshesAsLightsDirty(): void;
  26144. /**
  26145. * Indicates that attributes need to be re-calculated for all submeshes
  26146. */
  26147. protected _markAllSubMeshesAsAttributesDirty(): void;
  26148. /**
  26149. * Indicates that misc needs to be re-calculated for all submeshes
  26150. */
  26151. protected _markAllSubMeshesAsMiscDirty(): void;
  26152. /**
  26153. * Indicates that textures and misc need to be re-calculated for all submeshes
  26154. */
  26155. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26156. /**
  26157. * Sets the required values to the prepass renderer.
  26158. * @param prePassRenderer defines the prepass renderer to setup.
  26159. * @returns true if the pre pass is needed.
  26160. */
  26161. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26162. /**
  26163. * Disposes the material
  26164. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26165. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26166. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26167. */
  26168. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26169. /** @hidden */
  26170. private releaseVertexArrayObject;
  26171. /**
  26172. * Serializes this material
  26173. * @returns the serialized material object
  26174. */
  26175. serialize(): any;
  26176. /**
  26177. * Creates a material from parsed material data
  26178. * @param parsedMaterial defines parsed material data
  26179. * @param scene defines the hosting scene
  26180. * @param rootUrl defines the root URL to use to load textures
  26181. * @returns a new material
  26182. */
  26183. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26184. }
  26185. }
  26186. declare module "babylonjs/Materials/multiMaterial" {
  26187. import { Nullable } from "babylonjs/types";
  26188. import { Scene } from "babylonjs/scene";
  26189. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26190. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26191. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26192. import { Material } from "babylonjs/Materials/material";
  26193. /**
  26194. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26195. * separate meshes. This can be use to improve performances.
  26196. * @see https://doc.babylonjs.com/how_to/multi_materials
  26197. */
  26198. export class MultiMaterial extends Material {
  26199. private _subMaterials;
  26200. /**
  26201. * Gets or Sets the list of Materials used within the multi material.
  26202. * They need to be ordered according to the submeshes order in the associated mesh
  26203. */
  26204. get subMaterials(): Nullable<Material>[];
  26205. set subMaterials(value: Nullable<Material>[]);
  26206. /**
  26207. * Function used to align with Node.getChildren()
  26208. * @returns the list of Materials used within the multi material
  26209. */
  26210. getChildren(): Nullable<Material>[];
  26211. /**
  26212. * Instantiates a new Multi Material
  26213. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26214. * separate meshes. This can be use to improve performances.
  26215. * @see https://doc.babylonjs.com/how_to/multi_materials
  26216. * @param name Define the name in the scene
  26217. * @param scene Define the scene the material belongs to
  26218. */
  26219. constructor(name: string, scene: Scene);
  26220. private _hookArray;
  26221. /**
  26222. * Get one of the submaterial by its index in the submaterials array
  26223. * @param index The index to look the sub material at
  26224. * @returns The Material if the index has been defined
  26225. */
  26226. getSubMaterial(index: number): Nullable<Material>;
  26227. /**
  26228. * Get the list of active textures for the whole sub materials list.
  26229. * @returns All the textures that will be used during the rendering
  26230. */
  26231. getActiveTextures(): BaseTexture[];
  26232. /**
  26233. * Gets the current class name of the material e.g. "MultiMaterial"
  26234. * Mainly use in serialization.
  26235. * @returns the class name
  26236. */
  26237. getClassName(): string;
  26238. /**
  26239. * Checks if the material is ready to render the requested sub mesh
  26240. * @param mesh Define the mesh the submesh belongs to
  26241. * @param subMesh Define the sub mesh to look readyness for
  26242. * @param useInstances Define whether or not the material is used with instances
  26243. * @returns true if ready, otherwise false
  26244. */
  26245. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26246. /**
  26247. * Clones the current material and its related sub materials
  26248. * @param name Define the name of the newly cloned material
  26249. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26250. * @returns the cloned material
  26251. */
  26252. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26253. /**
  26254. * Serializes the materials into a JSON representation.
  26255. * @returns the JSON representation
  26256. */
  26257. serialize(): any;
  26258. /**
  26259. * Dispose the material and release its associated resources
  26260. * @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)
  26261. * @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)
  26262. * @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)
  26263. */
  26264. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26265. /**
  26266. * Creates a MultiMaterial from parsed MultiMaterial data.
  26267. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26268. * @param scene defines the hosting scene
  26269. * @returns a new MultiMaterial
  26270. */
  26271. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26272. }
  26273. }
  26274. declare module "babylonjs/Meshes/subMesh" {
  26275. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26276. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26277. import { Engine } from "babylonjs/Engines/engine";
  26278. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26279. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26280. import { Effect } from "babylonjs/Materials/effect";
  26281. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26282. import { Plane } from "babylonjs/Maths/math.plane";
  26283. import { Collider } from "babylonjs/Collisions/collider";
  26284. import { Material } from "babylonjs/Materials/material";
  26285. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26287. import { Mesh } from "babylonjs/Meshes/mesh";
  26288. import { Ray } from "babylonjs/Culling/ray";
  26289. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26290. /**
  26291. * Defines a subdivision inside a mesh
  26292. */
  26293. export class SubMesh implements ICullable {
  26294. /** the material index to use */
  26295. materialIndex: number;
  26296. /** vertex index start */
  26297. verticesStart: number;
  26298. /** vertices count */
  26299. verticesCount: number;
  26300. /** index start */
  26301. indexStart: number;
  26302. /** indices count */
  26303. indexCount: number;
  26304. /** @hidden */
  26305. _materialDefines: Nullable<MaterialDefines>;
  26306. /** @hidden */
  26307. _materialEffect: Nullable<Effect>;
  26308. /** @hidden */
  26309. _effectOverride: Nullable<Effect>;
  26310. /**
  26311. * Gets material defines used by the effect associated to the sub mesh
  26312. */
  26313. get materialDefines(): Nullable<MaterialDefines>;
  26314. /**
  26315. * Sets material defines used by the effect associated to the sub mesh
  26316. */
  26317. set materialDefines(defines: Nullable<MaterialDefines>);
  26318. /**
  26319. * Gets associated effect
  26320. */
  26321. get effect(): Nullable<Effect>;
  26322. /**
  26323. * Sets associated effect (effect used to render this submesh)
  26324. * @param effect defines the effect to associate with
  26325. * @param defines defines the set of defines used to compile this effect
  26326. */
  26327. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26328. /** @hidden */
  26329. _linesIndexCount: number;
  26330. private _mesh;
  26331. private _renderingMesh;
  26332. private _boundingInfo;
  26333. private _linesIndexBuffer;
  26334. /** @hidden */
  26335. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26336. /** @hidden */
  26337. _trianglePlanes: Plane[];
  26338. /** @hidden */
  26339. _lastColliderTransformMatrix: Nullable<Matrix>;
  26340. /** @hidden */
  26341. _renderId: number;
  26342. /** @hidden */
  26343. _alphaIndex: number;
  26344. /** @hidden */
  26345. _distanceToCamera: number;
  26346. /** @hidden */
  26347. _id: number;
  26348. private _currentMaterial;
  26349. /**
  26350. * Add a new submesh to a mesh
  26351. * @param materialIndex defines the material index to use
  26352. * @param verticesStart defines vertex index start
  26353. * @param verticesCount defines vertices count
  26354. * @param indexStart defines index start
  26355. * @param indexCount defines indices count
  26356. * @param mesh defines the parent mesh
  26357. * @param renderingMesh defines an optional rendering mesh
  26358. * @param createBoundingBox defines if bounding box should be created for this submesh
  26359. * @returns the new submesh
  26360. */
  26361. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26362. /**
  26363. * Creates a new submesh
  26364. * @param materialIndex defines the material index to use
  26365. * @param verticesStart defines vertex index start
  26366. * @param verticesCount defines vertices count
  26367. * @param indexStart defines index start
  26368. * @param indexCount defines indices count
  26369. * @param mesh defines the parent mesh
  26370. * @param renderingMesh defines an optional rendering mesh
  26371. * @param createBoundingBox defines if bounding box should be created for this submesh
  26372. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26373. */
  26374. constructor(
  26375. /** the material index to use */
  26376. materialIndex: number,
  26377. /** vertex index start */
  26378. verticesStart: number,
  26379. /** vertices count */
  26380. verticesCount: number,
  26381. /** index start */
  26382. indexStart: number,
  26383. /** indices count */
  26384. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26385. /**
  26386. * Returns true if this submesh covers the entire parent mesh
  26387. * @ignorenaming
  26388. */
  26389. get IsGlobal(): boolean;
  26390. /**
  26391. * Returns the submesh BoudingInfo object
  26392. * @returns current bounding info (or mesh's one if the submesh is global)
  26393. */
  26394. getBoundingInfo(): BoundingInfo;
  26395. /**
  26396. * Sets the submesh BoundingInfo
  26397. * @param boundingInfo defines the new bounding info to use
  26398. * @returns the SubMesh
  26399. */
  26400. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26401. /**
  26402. * Returns the mesh of the current submesh
  26403. * @return the parent mesh
  26404. */
  26405. getMesh(): AbstractMesh;
  26406. /**
  26407. * Returns the rendering mesh of the submesh
  26408. * @returns the rendering mesh (could be different from parent mesh)
  26409. */
  26410. getRenderingMesh(): Mesh;
  26411. /**
  26412. * Returns the replacement mesh of the submesh
  26413. * @returns the replacement mesh (could be different from parent mesh)
  26414. */
  26415. getReplacementMesh(): Nullable<AbstractMesh>;
  26416. /**
  26417. * Returns the effective mesh of the submesh
  26418. * @returns the effective mesh (could be different from parent mesh)
  26419. */
  26420. getEffectiveMesh(): AbstractMesh;
  26421. /**
  26422. * Returns the submesh material
  26423. * @returns null or the current material
  26424. */
  26425. getMaterial(): Nullable<Material>;
  26426. private _IsMultiMaterial;
  26427. /**
  26428. * Sets a new updated BoundingInfo object to the submesh
  26429. * @param data defines an optional position array to use to determine the bounding info
  26430. * @returns the SubMesh
  26431. */
  26432. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26433. /** @hidden */
  26434. _checkCollision(collider: Collider): boolean;
  26435. /**
  26436. * Updates the submesh BoundingInfo
  26437. * @param world defines the world matrix to use to update the bounding info
  26438. * @returns the submesh
  26439. */
  26440. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26441. /**
  26442. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26443. * @param frustumPlanes defines the frustum planes
  26444. * @returns true if the submesh is intersecting with the frustum
  26445. */
  26446. isInFrustum(frustumPlanes: Plane[]): boolean;
  26447. /**
  26448. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26449. * @param frustumPlanes defines the frustum planes
  26450. * @returns true if the submesh is inside the frustum
  26451. */
  26452. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26453. /**
  26454. * Renders the submesh
  26455. * @param enableAlphaMode defines if alpha needs to be used
  26456. * @returns the submesh
  26457. */
  26458. render(enableAlphaMode: boolean): SubMesh;
  26459. /**
  26460. * @hidden
  26461. */
  26462. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26463. /**
  26464. * Checks if the submesh intersects with a ray
  26465. * @param ray defines the ray to test
  26466. * @returns true is the passed ray intersects the submesh bounding box
  26467. */
  26468. canIntersects(ray: Ray): boolean;
  26469. /**
  26470. * Intersects current submesh with a ray
  26471. * @param ray defines the ray to test
  26472. * @param positions defines mesh's positions array
  26473. * @param indices defines mesh's indices array
  26474. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26475. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26476. * @returns intersection info or null if no intersection
  26477. */
  26478. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26479. /** @hidden */
  26480. private _intersectLines;
  26481. /** @hidden */
  26482. private _intersectUnIndexedLines;
  26483. /** @hidden */
  26484. private _intersectTriangles;
  26485. /** @hidden */
  26486. private _intersectUnIndexedTriangles;
  26487. /** @hidden */
  26488. _rebuild(): void;
  26489. /**
  26490. * Creates a new submesh from the passed mesh
  26491. * @param newMesh defines the new hosting mesh
  26492. * @param newRenderingMesh defines an optional rendering mesh
  26493. * @returns the new submesh
  26494. */
  26495. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26496. /**
  26497. * Release associated resources
  26498. */
  26499. dispose(): void;
  26500. /**
  26501. * Gets the class name
  26502. * @returns the string "SubMesh".
  26503. */
  26504. getClassName(): string;
  26505. /**
  26506. * Creates a new submesh from indices data
  26507. * @param materialIndex the index of the main mesh material
  26508. * @param startIndex the index where to start the copy in the mesh indices array
  26509. * @param indexCount the number of indices to copy then from the startIndex
  26510. * @param mesh the main mesh to create the submesh from
  26511. * @param renderingMesh the optional rendering mesh
  26512. * @returns a new submesh
  26513. */
  26514. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26515. }
  26516. }
  26517. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26518. /**
  26519. * Class used to represent data loading progression
  26520. */
  26521. export class SceneLoaderFlags {
  26522. private static _ForceFullSceneLoadingForIncremental;
  26523. private static _ShowLoadingScreen;
  26524. private static _CleanBoneMatrixWeights;
  26525. private static _loggingLevel;
  26526. /**
  26527. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26528. */
  26529. static get ForceFullSceneLoadingForIncremental(): boolean;
  26530. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26531. /**
  26532. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26533. */
  26534. static get ShowLoadingScreen(): boolean;
  26535. static set ShowLoadingScreen(value: boolean);
  26536. /**
  26537. * Defines the current logging level (while loading the scene)
  26538. * @ignorenaming
  26539. */
  26540. static get loggingLevel(): number;
  26541. static set loggingLevel(value: number);
  26542. /**
  26543. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26544. */
  26545. static get CleanBoneMatrixWeights(): boolean;
  26546. static set CleanBoneMatrixWeights(value: boolean);
  26547. }
  26548. }
  26549. declare module "babylonjs/Meshes/geometry" {
  26550. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26551. import { Scene } from "babylonjs/scene";
  26552. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26553. import { Engine } from "babylonjs/Engines/engine";
  26554. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26555. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26556. import { Effect } from "babylonjs/Materials/effect";
  26557. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26558. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26559. import { Mesh } from "babylonjs/Meshes/mesh";
  26560. /**
  26561. * Class used to store geometry data (vertex buffers + index buffer)
  26562. */
  26563. export class Geometry implements IGetSetVerticesData {
  26564. /**
  26565. * Gets or sets the ID of the geometry
  26566. */
  26567. id: string;
  26568. /**
  26569. * Gets or sets the unique ID of the geometry
  26570. */
  26571. uniqueId: number;
  26572. /**
  26573. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26574. */
  26575. delayLoadState: number;
  26576. /**
  26577. * Gets the file containing the data to load when running in delay load state
  26578. */
  26579. delayLoadingFile: Nullable<string>;
  26580. /**
  26581. * Callback called when the geometry is updated
  26582. */
  26583. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26584. private _scene;
  26585. private _engine;
  26586. private _meshes;
  26587. private _totalVertices;
  26588. /** @hidden */
  26589. _indices: IndicesArray;
  26590. /** @hidden */
  26591. _vertexBuffers: {
  26592. [key: string]: VertexBuffer;
  26593. };
  26594. private _isDisposed;
  26595. private _extend;
  26596. private _boundingBias;
  26597. /** @hidden */
  26598. _delayInfo: Array<string>;
  26599. private _indexBuffer;
  26600. private _indexBufferIsUpdatable;
  26601. /** @hidden */
  26602. _boundingInfo: Nullable<BoundingInfo>;
  26603. /** @hidden */
  26604. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26605. /** @hidden */
  26606. _softwareSkinningFrameId: number;
  26607. private _vertexArrayObjects;
  26608. private _updatable;
  26609. /** @hidden */
  26610. _positions: Nullable<Vector3[]>;
  26611. /**
  26612. * 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
  26613. */
  26614. get boundingBias(): Vector2;
  26615. /**
  26616. * 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
  26617. */
  26618. set boundingBias(value: Vector2);
  26619. /**
  26620. * Static function used to attach a new empty geometry to a mesh
  26621. * @param mesh defines the mesh to attach the geometry to
  26622. * @returns the new Geometry
  26623. */
  26624. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26625. /** Get the list of meshes using this geometry */
  26626. get meshes(): Mesh[];
  26627. /**
  26628. * 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
  26629. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26630. */
  26631. useBoundingInfoFromGeometry: boolean;
  26632. /**
  26633. * Creates a new geometry
  26634. * @param id defines the unique ID
  26635. * @param scene defines the hosting scene
  26636. * @param vertexData defines the VertexData used to get geometry data
  26637. * @param updatable defines if geometry must be updatable (false by default)
  26638. * @param mesh defines the mesh that will be associated with the geometry
  26639. */
  26640. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26641. /**
  26642. * Gets the current extend of the geometry
  26643. */
  26644. get extend(): {
  26645. minimum: Vector3;
  26646. maximum: Vector3;
  26647. };
  26648. /**
  26649. * Gets the hosting scene
  26650. * @returns the hosting Scene
  26651. */
  26652. getScene(): Scene;
  26653. /**
  26654. * Gets the hosting engine
  26655. * @returns the hosting Engine
  26656. */
  26657. getEngine(): Engine;
  26658. /**
  26659. * Defines if the geometry is ready to use
  26660. * @returns true if the geometry is ready to be used
  26661. */
  26662. isReady(): boolean;
  26663. /**
  26664. * Gets a value indicating that the geometry should not be serialized
  26665. */
  26666. get doNotSerialize(): boolean;
  26667. /** @hidden */
  26668. _rebuild(): void;
  26669. /**
  26670. * Affects all geometry data in one call
  26671. * @param vertexData defines the geometry data
  26672. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26673. */
  26674. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26675. /**
  26676. * Set specific vertex data
  26677. * @param kind defines the data kind (Position, normal, etc...)
  26678. * @param data defines the vertex data to use
  26679. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26680. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26681. */
  26682. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26683. /**
  26684. * Removes a specific vertex data
  26685. * @param kind defines the data kind (Position, normal, etc...)
  26686. */
  26687. removeVerticesData(kind: string): void;
  26688. /**
  26689. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26690. * @param buffer defines the vertex buffer to use
  26691. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26692. */
  26693. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26694. /**
  26695. * Update a specific vertex buffer
  26696. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26697. * It will do nothing if the buffer is not updatable
  26698. * @param kind defines the data kind (Position, normal, etc...)
  26699. * @param data defines the data to use
  26700. * @param offset defines the offset in the target buffer where to store the data
  26701. * @param useBytes set to true if the offset is in bytes
  26702. */
  26703. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26704. /**
  26705. * Update a specific vertex buffer
  26706. * This function will create a new buffer if the current one is not updatable
  26707. * @param kind defines the data kind (Position, normal, etc...)
  26708. * @param data defines the data to use
  26709. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26710. */
  26711. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26712. private _updateBoundingInfo;
  26713. /** @hidden */
  26714. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26715. /**
  26716. * Gets total number of vertices
  26717. * @returns the total number of vertices
  26718. */
  26719. getTotalVertices(): number;
  26720. /**
  26721. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26722. * @param kind defines the data kind (Position, normal, etc...)
  26723. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26724. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26725. * @returns a float array containing vertex data
  26726. */
  26727. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26728. /**
  26729. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26730. * @param kind defines the data kind (Position, normal, etc...)
  26731. * @returns true if the vertex buffer with the specified kind is updatable
  26732. */
  26733. isVertexBufferUpdatable(kind: string): boolean;
  26734. /**
  26735. * Gets a specific vertex buffer
  26736. * @param kind defines the data kind (Position, normal, etc...)
  26737. * @returns a VertexBuffer
  26738. */
  26739. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26740. /**
  26741. * Returns all vertex buffers
  26742. * @return an object holding all vertex buffers indexed by kind
  26743. */
  26744. getVertexBuffers(): Nullable<{
  26745. [key: string]: VertexBuffer;
  26746. }>;
  26747. /**
  26748. * Gets a boolean indicating if specific vertex buffer is present
  26749. * @param kind defines the data kind (Position, normal, etc...)
  26750. * @returns true if data is present
  26751. */
  26752. isVerticesDataPresent(kind: string): boolean;
  26753. /**
  26754. * Gets a list of all attached data kinds (Position, normal, etc...)
  26755. * @returns a list of string containing all kinds
  26756. */
  26757. getVerticesDataKinds(): string[];
  26758. /**
  26759. * Update index buffer
  26760. * @param indices defines the indices to store in the index buffer
  26761. * @param offset defines the offset in the target buffer where to store the data
  26762. * @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)
  26763. */
  26764. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26765. /**
  26766. * Creates a new index buffer
  26767. * @param indices defines the indices to store in the index buffer
  26768. * @param totalVertices defines the total number of vertices (could be null)
  26769. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26770. */
  26771. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26772. /**
  26773. * Return the total number of indices
  26774. * @returns the total number of indices
  26775. */
  26776. getTotalIndices(): number;
  26777. /**
  26778. * Gets the index buffer array
  26779. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26780. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26781. * @returns the index buffer array
  26782. */
  26783. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26784. /**
  26785. * Gets the index buffer
  26786. * @return the index buffer
  26787. */
  26788. getIndexBuffer(): Nullable<DataBuffer>;
  26789. /** @hidden */
  26790. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26791. /**
  26792. * Release the associated resources for a specific mesh
  26793. * @param mesh defines the source mesh
  26794. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26795. */
  26796. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26797. /**
  26798. * Apply current geometry to a given mesh
  26799. * @param mesh defines the mesh to apply geometry to
  26800. */
  26801. applyToMesh(mesh: Mesh): void;
  26802. private _updateExtend;
  26803. private _applyToMesh;
  26804. private notifyUpdate;
  26805. /**
  26806. * Load the geometry if it was flagged as delay loaded
  26807. * @param scene defines the hosting scene
  26808. * @param onLoaded defines a callback called when the geometry is loaded
  26809. */
  26810. load(scene: Scene, onLoaded?: () => void): void;
  26811. private _queueLoad;
  26812. /**
  26813. * Invert the geometry to move from a right handed system to a left handed one.
  26814. */
  26815. toLeftHanded(): void;
  26816. /** @hidden */
  26817. _resetPointsArrayCache(): void;
  26818. /** @hidden */
  26819. _generatePointsArray(): boolean;
  26820. /**
  26821. * Gets a value indicating if the geometry is disposed
  26822. * @returns true if the geometry was disposed
  26823. */
  26824. isDisposed(): boolean;
  26825. private _disposeVertexArrayObjects;
  26826. /**
  26827. * Free all associated resources
  26828. */
  26829. dispose(): void;
  26830. /**
  26831. * Clone the current geometry into a new geometry
  26832. * @param id defines the unique ID of the new geometry
  26833. * @returns a new geometry object
  26834. */
  26835. copy(id: string): Geometry;
  26836. /**
  26837. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26838. * @return a JSON representation of the current geometry data (without the vertices data)
  26839. */
  26840. serialize(): any;
  26841. private toNumberArray;
  26842. /**
  26843. * Serialize all vertices data into a JSON oject
  26844. * @returns a JSON representation of the current geometry data
  26845. */
  26846. serializeVerticeData(): any;
  26847. /**
  26848. * Extracts a clone of a mesh geometry
  26849. * @param mesh defines the source mesh
  26850. * @param id defines the unique ID of the new geometry object
  26851. * @returns the new geometry object
  26852. */
  26853. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26854. /**
  26855. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26856. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26857. * Be aware Math.random() could cause collisions, but:
  26858. * "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"
  26859. * @returns a string containing a new GUID
  26860. */
  26861. static RandomId(): string;
  26862. /** @hidden */
  26863. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26864. private static _CleanMatricesWeights;
  26865. /**
  26866. * Create a new geometry from persisted data (Using .babylon file format)
  26867. * @param parsedVertexData defines the persisted data
  26868. * @param scene defines the hosting scene
  26869. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26870. * @returns the new geometry object
  26871. */
  26872. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26873. }
  26874. }
  26875. declare module "babylonjs/Meshes/mesh.vertexData" {
  26876. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26877. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26878. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26879. import { Geometry } from "babylonjs/Meshes/geometry";
  26880. import { Mesh } from "babylonjs/Meshes/mesh";
  26881. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  26882. /**
  26883. * Define an interface for all classes that will get and set the data on vertices
  26884. */
  26885. export interface IGetSetVerticesData {
  26886. /**
  26887. * Gets a boolean indicating if specific vertex data is present
  26888. * @param kind defines the vertex data kind to use
  26889. * @returns true is data kind is present
  26890. */
  26891. isVerticesDataPresent(kind: string): boolean;
  26892. /**
  26893. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26894. * @param kind defines the data kind (Position, normal, etc...)
  26895. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26896. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26897. * @returns a float array containing vertex data
  26898. */
  26899. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26900. /**
  26901. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26902. * @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.
  26903. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26904. * @returns the indices array or an empty array if the mesh has no geometry
  26905. */
  26906. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26907. /**
  26908. * Set specific vertex data
  26909. * @param kind defines the data kind (Position, normal, etc...)
  26910. * @param data defines the vertex data to use
  26911. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26912. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26913. */
  26914. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26915. /**
  26916. * Update a specific associated vertex buffer
  26917. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26918. * - VertexBuffer.PositionKind
  26919. * - VertexBuffer.UVKind
  26920. * - VertexBuffer.UV2Kind
  26921. * - VertexBuffer.UV3Kind
  26922. * - VertexBuffer.UV4Kind
  26923. * - VertexBuffer.UV5Kind
  26924. * - VertexBuffer.UV6Kind
  26925. * - VertexBuffer.ColorKind
  26926. * - VertexBuffer.MatricesIndicesKind
  26927. * - VertexBuffer.MatricesIndicesExtraKind
  26928. * - VertexBuffer.MatricesWeightsKind
  26929. * - VertexBuffer.MatricesWeightsExtraKind
  26930. * @param data defines the data source
  26931. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26932. * @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)
  26933. */
  26934. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26935. /**
  26936. * Creates a new index buffer
  26937. * @param indices defines the indices to store in the index buffer
  26938. * @param totalVertices defines the total number of vertices (could be null)
  26939. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26940. */
  26941. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26942. }
  26943. /**
  26944. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26945. */
  26946. export class VertexData {
  26947. /**
  26948. * Mesh side orientation : usually the external or front surface
  26949. */
  26950. static readonly FRONTSIDE: number;
  26951. /**
  26952. * Mesh side orientation : usually the internal or back surface
  26953. */
  26954. static readonly BACKSIDE: number;
  26955. /**
  26956. * Mesh side orientation : both internal and external or front and back surfaces
  26957. */
  26958. static readonly DOUBLESIDE: number;
  26959. /**
  26960. * Mesh side orientation : by default, `FRONTSIDE`
  26961. */
  26962. static readonly DEFAULTSIDE: number;
  26963. /**
  26964. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26965. */
  26966. positions: Nullable<FloatArray>;
  26967. /**
  26968. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26969. */
  26970. normals: Nullable<FloatArray>;
  26971. /**
  26972. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26973. */
  26974. tangents: Nullable<FloatArray>;
  26975. /**
  26976. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26977. */
  26978. uvs: Nullable<FloatArray>;
  26979. /**
  26980. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26981. */
  26982. uvs2: Nullable<FloatArray>;
  26983. /**
  26984. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26985. */
  26986. uvs3: Nullable<FloatArray>;
  26987. /**
  26988. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26989. */
  26990. uvs4: Nullable<FloatArray>;
  26991. /**
  26992. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26993. */
  26994. uvs5: Nullable<FloatArray>;
  26995. /**
  26996. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26997. */
  26998. uvs6: Nullable<FloatArray>;
  26999. /**
  27000. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  27001. */
  27002. colors: Nullable<FloatArray>;
  27003. /**
  27004. * 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).
  27005. */
  27006. matricesIndices: Nullable<FloatArray>;
  27007. /**
  27008. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  27009. */
  27010. matricesWeights: Nullable<FloatArray>;
  27011. /**
  27012. * An array extending the number of possible indices
  27013. */
  27014. matricesIndicesExtra: Nullable<FloatArray>;
  27015. /**
  27016. * An array extending the number of possible weights when the number of indices is extended
  27017. */
  27018. matricesWeightsExtra: Nullable<FloatArray>;
  27019. /**
  27020. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  27021. */
  27022. indices: Nullable<IndicesArray>;
  27023. /**
  27024. * Uses the passed data array to set the set the values for the specified kind of data
  27025. * @param data a linear array of floating numbers
  27026. * @param kind the type of data that is being set, eg positions, colors etc
  27027. */
  27028. set(data: FloatArray, kind: string): void;
  27029. /**
  27030. * Associates the vertexData to the passed Mesh.
  27031. * Sets it as updatable or not (default `false`)
  27032. * @param mesh the mesh the vertexData is applied to
  27033. * @param updatable when used and having the value true allows new data to update the vertexData
  27034. * @returns the VertexData
  27035. */
  27036. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  27037. /**
  27038. * Associates the vertexData to the passed Geometry.
  27039. * Sets it as updatable or not (default `false`)
  27040. * @param geometry the geometry the vertexData is applied to
  27041. * @param updatable when used and having the value true allows new data to update the vertexData
  27042. * @returns VertexData
  27043. */
  27044. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  27045. /**
  27046. * Updates the associated mesh
  27047. * @param mesh the mesh to be updated
  27048. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  27049. * @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
  27050. * @returns VertexData
  27051. */
  27052. updateMesh(mesh: Mesh): VertexData;
  27053. /**
  27054. * Updates the associated geometry
  27055. * @param geometry the geometry to be updated
  27056. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  27057. * @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
  27058. * @returns VertexData.
  27059. */
  27060. updateGeometry(geometry: Geometry): VertexData;
  27061. private _applyTo;
  27062. private _update;
  27063. /**
  27064. * Transforms each position and each normal of the vertexData according to the passed Matrix
  27065. * @param matrix the transforming matrix
  27066. * @returns the VertexData
  27067. */
  27068. transform(matrix: Matrix): VertexData;
  27069. /**
  27070. * Merges the passed VertexData into the current one
  27071. * @param other the VertexData to be merged into the current one
  27072. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27073. * @returns the modified VertexData
  27074. */
  27075. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27076. private _mergeElement;
  27077. private _validate;
  27078. /**
  27079. * Serializes the VertexData
  27080. * @returns a serialized object
  27081. */
  27082. serialize(): any;
  27083. /**
  27084. * Extracts the vertexData from a mesh
  27085. * @param mesh the mesh from which to extract the VertexData
  27086. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27087. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27088. * @returns the object VertexData associated to the passed mesh
  27089. */
  27090. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27091. /**
  27092. * Extracts the vertexData from the geometry
  27093. * @param geometry the geometry from which to extract the VertexData
  27094. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27095. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27096. * @returns the object VertexData associated to the passed mesh
  27097. */
  27098. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27099. private static _ExtractFrom;
  27100. /**
  27101. * Creates the VertexData for a Ribbon
  27102. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27103. * * pathArray array of paths, each of which an array of successive Vector3
  27104. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27105. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27106. * * 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
  27107. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27108. * * 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)
  27109. * * 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)
  27110. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27111. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27112. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27113. * @returns the VertexData of the ribbon
  27114. */
  27115. static CreateRibbon(options: {
  27116. pathArray: Vector3[][];
  27117. closeArray?: boolean;
  27118. closePath?: boolean;
  27119. offset?: number;
  27120. sideOrientation?: number;
  27121. frontUVs?: Vector4;
  27122. backUVs?: Vector4;
  27123. invertUV?: boolean;
  27124. uvs?: Vector2[];
  27125. colors?: Color4[];
  27126. }): VertexData;
  27127. /**
  27128. * Creates the VertexData for a box
  27129. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27130. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27131. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27132. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27133. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27134. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27135. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27136. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27137. * * 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)
  27138. * * 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)
  27139. * @returns the VertexData of the box
  27140. */
  27141. static CreateBox(options: {
  27142. size?: number;
  27143. width?: number;
  27144. height?: number;
  27145. depth?: number;
  27146. faceUV?: Vector4[];
  27147. faceColors?: Color4[];
  27148. sideOrientation?: number;
  27149. frontUVs?: Vector4;
  27150. backUVs?: Vector4;
  27151. }): VertexData;
  27152. /**
  27153. * Creates the VertexData for a tiled box
  27154. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27155. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27156. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27157. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27158. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27159. * @returns the VertexData of the box
  27160. */
  27161. static CreateTiledBox(options: {
  27162. pattern?: number;
  27163. width?: number;
  27164. height?: number;
  27165. depth?: number;
  27166. tileSize?: number;
  27167. tileWidth?: number;
  27168. tileHeight?: number;
  27169. alignHorizontal?: number;
  27170. alignVertical?: number;
  27171. faceUV?: Vector4[];
  27172. faceColors?: Color4[];
  27173. sideOrientation?: number;
  27174. }): VertexData;
  27175. /**
  27176. * Creates the VertexData for a tiled plane
  27177. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27178. * * pattern a limited pattern arrangement depending on the number
  27179. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27180. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27181. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27182. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27183. * * 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)
  27184. * * 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)
  27185. * @returns the VertexData of the tiled plane
  27186. */
  27187. static CreateTiledPlane(options: {
  27188. pattern?: number;
  27189. tileSize?: number;
  27190. tileWidth?: number;
  27191. tileHeight?: number;
  27192. size?: number;
  27193. width?: number;
  27194. height?: number;
  27195. alignHorizontal?: number;
  27196. alignVertical?: number;
  27197. sideOrientation?: number;
  27198. frontUVs?: Vector4;
  27199. backUVs?: Vector4;
  27200. }): VertexData;
  27201. /**
  27202. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27203. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27204. * * segments sets the number of horizontal strips optional, default 32
  27205. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27206. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27207. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27208. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27209. * * 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
  27210. * * 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
  27211. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27212. * * 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)
  27213. * * 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)
  27214. * @returns the VertexData of the ellipsoid
  27215. */
  27216. static CreateSphere(options: {
  27217. segments?: number;
  27218. diameter?: number;
  27219. diameterX?: number;
  27220. diameterY?: number;
  27221. diameterZ?: number;
  27222. arc?: number;
  27223. slice?: number;
  27224. sideOrientation?: number;
  27225. frontUVs?: Vector4;
  27226. backUVs?: Vector4;
  27227. }): VertexData;
  27228. /**
  27229. * Creates the VertexData for a cylinder, cone or prism
  27230. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27231. * * height sets the height (y direction) of the cylinder, optional, default 2
  27232. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27233. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27234. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27235. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27236. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27237. * * 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
  27238. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27239. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27240. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27241. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27242. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27243. * * 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)
  27244. * * 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)
  27245. * @returns the VertexData of the cylinder, cone or prism
  27246. */
  27247. static CreateCylinder(options: {
  27248. height?: number;
  27249. diameterTop?: number;
  27250. diameterBottom?: number;
  27251. diameter?: number;
  27252. tessellation?: number;
  27253. subdivisions?: number;
  27254. arc?: number;
  27255. faceColors?: Color4[];
  27256. faceUV?: Vector4[];
  27257. hasRings?: boolean;
  27258. enclose?: boolean;
  27259. sideOrientation?: number;
  27260. frontUVs?: Vector4;
  27261. backUVs?: Vector4;
  27262. }): VertexData;
  27263. /**
  27264. * Creates the VertexData for a torus
  27265. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27266. * * diameter the diameter of the torus, optional default 1
  27267. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27268. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27269. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27270. * * 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)
  27271. * * 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)
  27272. * @returns the VertexData of the torus
  27273. */
  27274. static CreateTorus(options: {
  27275. diameter?: number;
  27276. thickness?: number;
  27277. tessellation?: number;
  27278. sideOrientation?: number;
  27279. frontUVs?: Vector4;
  27280. backUVs?: Vector4;
  27281. }): VertexData;
  27282. /**
  27283. * Creates the VertexData of the LineSystem
  27284. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27285. * - lines an array of lines, each line being an array of successive Vector3
  27286. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27287. * @returns the VertexData of the LineSystem
  27288. */
  27289. static CreateLineSystem(options: {
  27290. lines: Vector3[][];
  27291. colors?: Nullable<Color4[][]>;
  27292. }): VertexData;
  27293. /**
  27294. * Create the VertexData for a DashedLines
  27295. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27296. * - points an array successive Vector3
  27297. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27298. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27299. * - dashNb the intended total number of dashes, optional, default 200
  27300. * @returns the VertexData for the DashedLines
  27301. */
  27302. static CreateDashedLines(options: {
  27303. points: Vector3[];
  27304. dashSize?: number;
  27305. gapSize?: number;
  27306. dashNb?: number;
  27307. }): VertexData;
  27308. /**
  27309. * Creates the VertexData for a Ground
  27310. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27311. * - width the width (x direction) of the ground, optional, default 1
  27312. * - height the height (z direction) of the ground, optional, default 1
  27313. * - subdivisions the number of subdivisions per side, optional, default 1
  27314. * @returns the VertexData of the Ground
  27315. */
  27316. static CreateGround(options: {
  27317. width?: number;
  27318. height?: number;
  27319. subdivisions?: number;
  27320. subdivisionsX?: number;
  27321. subdivisionsY?: number;
  27322. }): VertexData;
  27323. /**
  27324. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27325. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27326. * * xmin the ground minimum X coordinate, optional, default -1
  27327. * * zmin the ground minimum Z coordinate, optional, default -1
  27328. * * xmax the ground maximum X coordinate, optional, default 1
  27329. * * zmax the ground maximum Z coordinate, optional, default 1
  27330. * * 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}
  27331. * * 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}
  27332. * @returns the VertexData of the TiledGround
  27333. */
  27334. static CreateTiledGround(options: {
  27335. xmin: number;
  27336. zmin: number;
  27337. xmax: number;
  27338. zmax: number;
  27339. subdivisions?: {
  27340. w: number;
  27341. h: number;
  27342. };
  27343. precision?: {
  27344. w: number;
  27345. h: number;
  27346. };
  27347. }): VertexData;
  27348. /**
  27349. * Creates the VertexData of the Ground designed from a heightmap
  27350. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27351. * * width the width (x direction) of the ground
  27352. * * height the height (z direction) of the ground
  27353. * * subdivisions the number of subdivisions per side
  27354. * * minHeight the minimum altitude on the ground, optional, default 0
  27355. * * maxHeight the maximum altitude on the ground, optional default 1
  27356. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27357. * * buffer the array holding the image color data
  27358. * * bufferWidth the width of image
  27359. * * bufferHeight the height of image
  27360. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27361. * @returns the VertexData of the Ground designed from a heightmap
  27362. */
  27363. static CreateGroundFromHeightMap(options: {
  27364. width: number;
  27365. height: number;
  27366. subdivisions: number;
  27367. minHeight: number;
  27368. maxHeight: number;
  27369. colorFilter: Color3;
  27370. buffer: Uint8Array;
  27371. bufferWidth: number;
  27372. bufferHeight: number;
  27373. alphaFilter: number;
  27374. }): VertexData;
  27375. /**
  27376. * Creates the VertexData for a Plane
  27377. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27378. * * size sets the width and height of the plane to the value of size, optional default 1
  27379. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27380. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27381. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27382. * * 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)
  27383. * * 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)
  27384. * @returns the VertexData of the box
  27385. */
  27386. static CreatePlane(options: {
  27387. size?: number;
  27388. width?: number;
  27389. height?: number;
  27390. sideOrientation?: number;
  27391. frontUVs?: Vector4;
  27392. backUVs?: Vector4;
  27393. }): VertexData;
  27394. /**
  27395. * Creates the VertexData of the Disc or regular Polygon
  27396. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27397. * * radius the radius of the disc, optional default 0.5
  27398. * * tessellation the number of polygon sides, optional, default 64
  27399. * * 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
  27400. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27401. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27402. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27403. * @returns the VertexData of the box
  27404. */
  27405. static CreateDisc(options: {
  27406. radius?: number;
  27407. tessellation?: number;
  27408. arc?: number;
  27409. sideOrientation?: number;
  27410. frontUVs?: Vector4;
  27411. backUVs?: Vector4;
  27412. }): VertexData;
  27413. /**
  27414. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27415. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27416. * @param polygon a mesh built from polygonTriangulation.build()
  27417. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27418. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27419. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27420. * @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)
  27421. * @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)
  27422. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27423. * @returns the VertexData of the Polygon
  27424. */
  27425. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27426. /**
  27427. * Creates the VertexData of the IcoSphere
  27428. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27429. * * radius the radius of the IcoSphere, optional default 1
  27430. * * radiusX allows stretching in the x direction, optional, default radius
  27431. * * radiusY allows stretching in the y direction, optional, default radius
  27432. * * radiusZ allows stretching in the z direction, optional, default radius
  27433. * * flat when true creates a flat shaded mesh, optional, default true
  27434. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27435. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27436. * * 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)
  27437. * * 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)
  27438. * @returns the VertexData of the IcoSphere
  27439. */
  27440. static CreateIcoSphere(options: {
  27441. radius?: number;
  27442. radiusX?: number;
  27443. radiusY?: number;
  27444. radiusZ?: number;
  27445. flat?: boolean;
  27446. subdivisions?: number;
  27447. sideOrientation?: number;
  27448. frontUVs?: Vector4;
  27449. backUVs?: Vector4;
  27450. }): VertexData;
  27451. /**
  27452. * Creates the VertexData for a Polyhedron
  27453. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27454. * * type provided types are:
  27455. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27456. * * 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)
  27457. * * size the size of the IcoSphere, optional default 1
  27458. * * sizeX allows stretching in the x direction, optional, default size
  27459. * * sizeY allows stretching in the y direction, optional, default size
  27460. * * sizeZ allows stretching in the z direction, optional, default size
  27461. * * 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
  27462. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27463. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27464. * * flat when true creates a flat shaded mesh, optional, default true
  27465. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27466. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27467. * * 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)
  27468. * * 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)
  27469. * @returns the VertexData of the Polyhedron
  27470. */
  27471. static CreatePolyhedron(options: {
  27472. type?: number;
  27473. size?: number;
  27474. sizeX?: number;
  27475. sizeY?: number;
  27476. sizeZ?: number;
  27477. custom?: any;
  27478. faceUV?: Vector4[];
  27479. faceColors?: Color4[];
  27480. flat?: boolean;
  27481. sideOrientation?: number;
  27482. frontUVs?: Vector4;
  27483. backUVs?: Vector4;
  27484. }): VertexData;
  27485. /**
  27486. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  27487. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  27488. * @returns the VertexData of the Capsule
  27489. */
  27490. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  27491. /**
  27492. * Creates the VertexData for a TorusKnot
  27493. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27494. * * radius the radius of the torus knot, optional, default 2
  27495. * * tube the thickness of the tube, optional, default 0.5
  27496. * * radialSegments the number of sides on each tube segments, optional, default 32
  27497. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27498. * * p the number of windings around the z axis, optional, default 2
  27499. * * q the number of windings around the x axis, optional, default 3
  27500. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27501. * * 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)
  27502. * * 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)
  27503. * @returns the VertexData of the Torus Knot
  27504. */
  27505. static CreateTorusKnot(options: {
  27506. radius?: number;
  27507. tube?: number;
  27508. radialSegments?: number;
  27509. tubularSegments?: number;
  27510. p?: number;
  27511. q?: number;
  27512. sideOrientation?: number;
  27513. frontUVs?: Vector4;
  27514. backUVs?: Vector4;
  27515. }): VertexData;
  27516. /**
  27517. * Compute normals for given positions and indices
  27518. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27519. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27520. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27521. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27522. * * facetNormals : optional array of facet normals (vector3)
  27523. * * facetPositions : optional array of facet positions (vector3)
  27524. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27525. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27526. * * bInfo : optional bounding info, required for facetPartitioning computation
  27527. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27528. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27529. * * useRightHandedSystem: optional boolean to for right handed system computation
  27530. * * depthSort : optional boolean to enable the facet depth sort computation
  27531. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27532. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27533. */
  27534. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27535. facetNormals?: any;
  27536. facetPositions?: any;
  27537. facetPartitioning?: any;
  27538. ratio?: number;
  27539. bInfo?: any;
  27540. bbSize?: Vector3;
  27541. subDiv?: any;
  27542. useRightHandedSystem?: boolean;
  27543. depthSort?: boolean;
  27544. distanceTo?: Vector3;
  27545. depthSortedFacets?: any;
  27546. }): void;
  27547. /** @hidden */
  27548. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27549. /**
  27550. * Applies VertexData created from the imported parameters to the geometry
  27551. * @param parsedVertexData the parsed data from an imported file
  27552. * @param geometry the geometry to apply the VertexData to
  27553. */
  27554. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27555. }
  27556. }
  27557. declare module "babylonjs/Morph/morphTarget" {
  27558. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27559. import { Observable } from "babylonjs/Misc/observable";
  27560. import { Nullable, FloatArray } from "babylonjs/types";
  27561. import { Scene } from "babylonjs/scene";
  27562. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27563. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27564. /**
  27565. * Defines a target to use with MorphTargetManager
  27566. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27567. */
  27568. export class MorphTarget implements IAnimatable {
  27569. /** defines the name of the target */
  27570. name: string;
  27571. /**
  27572. * Gets or sets the list of animations
  27573. */
  27574. animations: import("babylonjs/Animations/animation").Animation[];
  27575. private _scene;
  27576. private _positions;
  27577. private _normals;
  27578. private _tangents;
  27579. private _uvs;
  27580. private _influence;
  27581. private _uniqueId;
  27582. /**
  27583. * Observable raised when the influence changes
  27584. */
  27585. onInfluenceChanged: Observable<boolean>;
  27586. /** @hidden */
  27587. _onDataLayoutChanged: Observable<void>;
  27588. /**
  27589. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27590. */
  27591. get influence(): number;
  27592. set influence(influence: number);
  27593. /**
  27594. * Gets or sets the id of the morph Target
  27595. */
  27596. id: string;
  27597. private _animationPropertiesOverride;
  27598. /**
  27599. * Gets or sets the animation properties override
  27600. */
  27601. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27602. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27603. /**
  27604. * Creates a new MorphTarget
  27605. * @param name defines the name of the target
  27606. * @param influence defines the influence to use
  27607. * @param scene defines the scene the morphtarget belongs to
  27608. */
  27609. constructor(
  27610. /** defines the name of the target */
  27611. name: string, influence?: number, scene?: Nullable<Scene>);
  27612. /**
  27613. * Gets the unique ID of this manager
  27614. */
  27615. get uniqueId(): number;
  27616. /**
  27617. * Gets a boolean defining if the target contains position data
  27618. */
  27619. get hasPositions(): boolean;
  27620. /**
  27621. * Gets a boolean defining if the target contains normal data
  27622. */
  27623. get hasNormals(): boolean;
  27624. /**
  27625. * Gets a boolean defining if the target contains tangent data
  27626. */
  27627. get hasTangents(): boolean;
  27628. /**
  27629. * Gets a boolean defining if the target contains texture coordinates data
  27630. */
  27631. get hasUVs(): boolean;
  27632. /**
  27633. * Affects position data to this target
  27634. * @param data defines the position data to use
  27635. */
  27636. setPositions(data: Nullable<FloatArray>): void;
  27637. /**
  27638. * Gets the position data stored in this target
  27639. * @returns a FloatArray containing the position data (or null if not present)
  27640. */
  27641. getPositions(): Nullable<FloatArray>;
  27642. /**
  27643. * Affects normal data to this target
  27644. * @param data defines the normal data to use
  27645. */
  27646. setNormals(data: Nullable<FloatArray>): void;
  27647. /**
  27648. * Gets the normal data stored in this target
  27649. * @returns a FloatArray containing the normal data (or null if not present)
  27650. */
  27651. getNormals(): Nullable<FloatArray>;
  27652. /**
  27653. * Affects tangent data to this target
  27654. * @param data defines the tangent data to use
  27655. */
  27656. setTangents(data: Nullable<FloatArray>): void;
  27657. /**
  27658. * Gets the tangent data stored in this target
  27659. * @returns a FloatArray containing the tangent data (or null if not present)
  27660. */
  27661. getTangents(): Nullable<FloatArray>;
  27662. /**
  27663. * Affects texture coordinates data to this target
  27664. * @param data defines the texture coordinates data to use
  27665. */
  27666. setUVs(data: Nullable<FloatArray>): void;
  27667. /**
  27668. * Gets the texture coordinates data stored in this target
  27669. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27670. */
  27671. getUVs(): Nullable<FloatArray>;
  27672. /**
  27673. * Clone the current target
  27674. * @returns a new MorphTarget
  27675. */
  27676. clone(): MorphTarget;
  27677. /**
  27678. * Serializes the current target into a Serialization object
  27679. * @returns the serialized object
  27680. */
  27681. serialize(): any;
  27682. /**
  27683. * Returns the string "MorphTarget"
  27684. * @returns "MorphTarget"
  27685. */
  27686. getClassName(): string;
  27687. /**
  27688. * Creates a new target from serialized data
  27689. * @param serializationObject defines the serialized data to use
  27690. * @returns a new MorphTarget
  27691. */
  27692. static Parse(serializationObject: any): MorphTarget;
  27693. /**
  27694. * Creates a MorphTarget from mesh data
  27695. * @param mesh defines the source mesh
  27696. * @param name defines the name to use for the new target
  27697. * @param influence defines the influence to attach to the target
  27698. * @returns a new MorphTarget
  27699. */
  27700. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27701. }
  27702. }
  27703. declare module "babylonjs/Morph/morphTargetManager" {
  27704. import { Nullable } from "babylonjs/types";
  27705. import { Scene } from "babylonjs/scene";
  27706. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27707. /**
  27708. * This class is used to deform meshes using morphing between different targets
  27709. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27710. */
  27711. export class MorphTargetManager {
  27712. private _targets;
  27713. private _targetInfluenceChangedObservers;
  27714. private _targetDataLayoutChangedObservers;
  27715. private _activeTargets;
  27716. private _scene;
  27717. private _influences;
  27718. private _supportsNormals;
  27719. private _supportsTangents;
  27720. private _supportsUVs;
  27721. private _vertexCount;
  27722. private _uniqueId;
  27723. private _tempInfluences;
  27724. /**
  27725. * Gets or sets a boolean indicating if normals must be morphed
  27726. */
  27727. enableNormalMorphing: boolean;
  27728. /**
  27729. * Gets or sets a boolean indicating if tangents must be morphed
  27730. */
  27731. enableTangentMorphing: boolean;
  27732. /**
  27733. * Gets or sets a boolean indicating if UV must be morphed
  27734. */
  27735. enableUVMorphing: boolean;
  27736. /**
  27737. * Creates a new MorphTargetManager
  27738. * @param scene defines the current scene
  27739. */
  27740. constructor(scene?: Nullable<Scene>);
  27741. /**
  27742. * Gets the unique ID of this manager
  27743. */
  27744. get uniqueId(): number;
  27745. /**
  27746. * Gets the number of vertices handled by this manager
  27747. */
  27748. get vertexCount(): number;
  27749. /**
  27750. * Gets a boolean indicating if this manager supports morphing of normals
  27751. */
  27752. get supportsNormals(): boolean;
  27753. /**
  27754. * Gets a boolean indicating if this manager supports morphing of tangents
  27755. */
  27756. get supportsTangents(): boolean;
  27757. /**
  27758. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27759. */
  27760. get supportsUVs(): boolean;
  27761. /**
  27762. * Gets the number of targets stored in this manager
  27763. */
  27764. get numTargets(): number;
  27765. /**
  27766. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27767. */
  27768. get numInfluencers(): number;
  27769. /**
  27770. * Gets the list of influences (one per target)
  27771. */
  27772. get influences(): Float32Array;
  27773. /**
  27774. * Gets the active target at specified index. An active target is a target with an influence > 0
  27775. * @param index defines the index to check
  27776. * @returns the requested target
  27777. */
  27778. getActiveTarget(index: number): MorphTarget;
  27779. /**
  27780. * Gets the target at specified index
  27781. * @param index defines the index to check
  27782. * @returns the requested target
  27783. */
  27784. getTarget(index: number): MorphTarget;
  27785. /**
  27786. * Add a new target to this manager
  27787. * @param target defines the target to add
  27788. */
  27789. addTarget(target: MorphTarget): void;
  27790. /**
  27791. * Removes a target from the manager
  27792. * @param target defines the target to remove
  27793. */
  27794. removeTarget(target: MorphTarget): void;
  27795. /**
  27796. * Clone the current manager
  27797. * @returns a new MorphTargetManager
  27798. */
  27799. clone(): MorphTargetManager;
  27800. /**
  27801. * Serializes the current manager into a Serialization object
  27802. * @returns the serialized object
  27803. */
  27804. serialize(): any;
  27805. private _syncActiveTargets;
  27806. /**
  27807. * Syncrhonize the targets with all the meshes using this morph target manager
  27808. */
  27809. synchronize(): void;
  27810. /**
  27811. * Creates a new MorphTargetManager from serialized data
  27812. * @param serializationObject defines the serialized data
  27813. * @param scene defines the hosting scene
  27814. * @returns the new MorphTargetManager
  27815. */
  27816. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27817. }
  27818. }
  27819. declare module "babylonjs/Meshes/meshLODLevel" {
  27820. import { Mesh } from "babylonjs/Meshes/mesh";
  27821. import { Nullable } from "babylonjs/types";
  27822. /**
  27823. * Class used to represent a specific level of detail of a mesh
  27824. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27825. */
  27826. export class MeshLODLevel {
  27827. /** Defines the distance where this level should start being displayed */
  27828. distance: number;
  27829. /** Defines the mesh to use to render this level */
  27830. mesh: Nullable<Mesh>;
  27831. /**
  27832. * Creates a new LOD level
  27833. * @param distance defines the distance where this level should star being displayed
  27834. * @param mesh defines the mesh to use to render this level
  27835. */
  27836. constructor(
  27837. /** Defines the distance where this level should start being displayed */
  27838. distance: number,
  27839. /** Defines the mesh to use to render this level */
  27840. mesh: Nullable<Mesh>);
  27841. }
  27842. }
  27843. declare module "babylonjs/Misc/canvasGenerator" {
  27844. /**
  27845. * Helper class used to generate a canvas to manipulate images
  27846. */
  27847. export class CanvasGenerator {
  27848. /**
  27849. * Create a new canvas (or offscreen canvas depending on the context)
  27850. * @param width defines the expected width
  27851. * @param height defines the expected height
  27852. * @return a new canvas or offscreen canvas
  27853. */
  27854. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27855. }
  27856. }
  27857. declare module "babylonjs/Meshes/groundMesh" {
  27858. import { Scene } from "babylonjs/scene";
  27859. import { Vector3 } from "babylonjs/Maths/math.vector";
  27860. import { Mesh } from "babylonjs/Meshes/mesh";
  27861. /**
  27862. * Mesh representing the gorund
  27863. */
  27864. export class GroundMesh extends Mesh {
  27865. /** If octree should be generated */
  27866. generateOctree: boolean;
  27867. private _heightQuads;
  27868. /** @hidden */
  27869. _subdivisionsX: number;
  27870. /** @hidden */
  27871. _subdivisionsY: number;
  27872. /** @hidden */
  27873. _width: number;
  27874. /** @hidden */
  27875. _height: number;
  27876. /** @hidden */
  27877. _minX: number;
  27878. /** @hidden */
  27879. _maxX: number;
  27880. /** @hidden */
  27881. _minZ: number;
  27882. /** @hidden */
  27883. _maxZ: number;
  27884. constructor(name: string, scene: Scene);
  27885. /**
  27886. * "GroundMesh"
  27887. * @returns "GroundMesh"
  27888. */
  27889. getClassName(): string;
  27890. /**
  27891. * The minimum of x and y subdivisions
  27892. */
  27893. get subdivisions(): number;
  27894. /**
  27895. * X subdivisions
  27896. */
  27897. get subdivisionsX(): number;
  27898. /**
  27899. * Y subdivisions
  27900. */
  27901. get subdivisionsY(): number;
  27902. /**
  27903. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27904. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27905. * @param chunksCount the number of subdivisions for x and y
  27906. * @param octreeBlocksSize (Default: 32)
  27907. */
  27908. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27909. /**
  27910. * Returns a height (y) value in the Worl system :
  27911. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27912. * @param x x coordinate
  27913. * @param z z coordinate
  27914. * @returns the ground y position if (x, z) are outside the ground surface.
  27915. */
  27916. getHeightAtCoordinates(x: number, z: number): number;
  27917. /**
  27918. * Returns a normalized vector (Vector3) orthogonal to the ground
  27919. * at the ground coordinates (x, z) expressed in the World system.
  27920. * @param x x coordinate
  27921. * @param z z coordinate
  27922. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27923. */
  27924. getNormalAtCoordinates(x: number, z: number): Vector3;
  27925. /**
  27926. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27927. * at the ground coordinates (x, z) expressed in the World system.
  27928. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27929. * @param x x coordinate
  27930. * @param z z coordinate
  27931. * @param ref vector to store the result
  27932. * @returns the GroundMesh.
  27933. */
  27934. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27935. /**
  27936. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27937. * if the ground has been updated.
  27938. * This can be used in the render loop.
  27939. * @returns the GroundMesh.
  27940. */
  27941. updateCoordinateHeights(): GroundMesh;
  27942. private _getFacetAt;
  27943. private _initHeightQuads;
  27944. private _computeHeightQuads;
  27945. /**
  27946. * Serializes this ground mesh
  27947. * @param serializationObject object to write serialization to
  27948. */
  27949. serialize(serializationObject: any): void;
  27950. /**
  27951. * Parses a serialized ground mesh
  27952. * @param parsedMesh the serialized mesh
  27953. * @param scene the scene to create the ground mesh in
  27954. * @returns the created ground mesh
  27955. */
  27956. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27957. }
  27958. }
  27959. declare module "babylonjs/Physics/physicsJoint" {
  27960. import { Vector3 } from "babylonjs/Maths/math.vector";
  27961. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27962. /**
  27963. * Interface for Physics-Joint data
  27964. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27965. */
  27966. export interface PhysicsJointData {
  27967. /**
  27968. * The main pivot of the joint
  27969. */
  27970. mainPivot?: Vector3;
  27971. /**
  27972. * The connected pivot of the joint
  27973. */
  27974. connectedPivot?: Vector3;
  27975. /**
  27976. * The main axis of the joint
  27977. */
  27978. mainAxis?: Vector3;
  27979. /**
  27980. * The connected axis of the joint
  27981. */
  27982. connectedAxis?: Vector3;
  27983. /**
  27984. * The collision of the joint
  27985. */
  27986. collision?: boolean;
  27987. /**
  27988. * Native Oimo/Cannon/Energy data
  27989. */
  27990. nativeParams?: any;
  27991. }
  27992. /**
  27993. * This is a holder class for the physics joint created by the physics plugin
  27994. * It holds a set of functions to control the underlying joint
  27995. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27996. */
  27997. export class PhysicsJoint {
  27998. /**
  27999. * The type of the physics joint
  28000. */
  28001. type: number;
  28002. /**
  28003. * The data for the physics joint
  28004. */
  28005. jointData: PhysicsJointData;
  28006. private _physicsJoint;
  28007. protected _physicsPlugin: IPhysicsEnginePlugin;
  28008. /**
  28009. * Initializes the physics joint
  28010. * @param type The type of the physics joint
  28011. * @param jointData The data for the physics joint
  28012. */
  28013. constructor(
  28014. /**
  28015. * The type of the physics joint
  28016. */
  28017. type: number,
  28018. /**
  28019. * The data for the physics joint
  28020. */
  28021. jointData: PhysicsJointData);
  28022. /**
  28023. * Gets the physics joint
  28024. */
  28025. get physicsJoint(): any;
  28026. /**
  28027. * Sets the physics joint
  28028. */
  28029. set physicsJoint(newJoint: any);
  28030. /**
  28031. * Sets the physics plugin
  28032. */
  28033. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  28034. /**
  28035. * Execute a function that is physics-plugin specific.
  28036. * @param {Function} func the function that will be executed.
  28037. * It accepts two parameters: the physics world and the physics joint
  28038. */
  28039. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  28040. /**
  28041. * Distance-Joint type
  28042. */
  28043. static DistanceJoint: number;
  28044. /**
  28045. * Hinge-Joint type
  28046. */
  28047. static HingeJoint: number;
  28048. /**
  28049. * Ball-and-Socket joint type
  28050. */
  28051. static BallAndSocketJoint: number;
  28052. /**
  28053. * Wheel-Joint type
  28054. */
  28055. static WheelJoint: number;
  28056. /**
  28057. * Slider-Joint type
  28058. */
  28059. static SliderJoint: number;
  28060. /**
  28061. * Prismatic-Joint type
  28062. */
  28063. static PrismaticJoint: number;
  28064. /**
  28065. * Universal-Joint type
  28066. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  28067. */
  28068. static UniversalJoint: number;
  28069. /**
  28070. * Hinge-Joint 2 type
  28071. */
  28072. static Hinge2Joint: number;
  28073. /**
  28074. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28075. */
  28076. static PointToPointJoint: number;
  28077. /**
  28078. * Spring-Joint type
  28079. */
  28080. static SpringJoint: number;
  28081. /**
  28082. * Lock-Joint type
  28083. */
  28084. static LockJoint: number;
  28085. }
  28086. /**
  28087. * A class representing a physics distance joint
  28088. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28089. */
  28090. export class DistanceJoint extends PhysicsJoint {
  28091. /**
  28092. *
  28093. * @param jointData The data for the Distance-Joint
  28094. */
  28095. constructor(jointData: DistanceJointData);
  28096. /**
  28097. * Update the predefined distance.
  28098. * @param maxDistance The maximum preferred distance
  28099. * @param minDistance The minimum preferred distance
  28100. */
  28101. updateDistance(maxDistance: number, minDistance?: number): void;
  28102. }
  28103. /**
  28104. * Represents a Motor-Enabled Joint
  28105. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28106. */
  28107. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28108. /**
  28109. * Initializes the Motor-Enabled Joint
  28110. * @param type The type of the joint
  28111. * @param jointData The physica joint data for the joint
  28112. */
  28113. constructor(type: number, jointData: PhysicsJointData);
  28114. /**
  28115. * Set the motor values.
  28116. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28117. * @param force the force to apply
  28118. * @param maxForce max force for this motor.
  28119. */
  28120. setMotor(force?: number, maxForce?: number): void;
  28121. /**
  28122. * Set the motor's limits.
  28123. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28124. * @param upperLimit The upper limit of the motor
  28125. * @param lowerLimit The lower limit of the motor
  28126. */
  28127. setLimit(upperLimit: number, lowerLimit?: number): void;
  28128. }
  28129. /**
  28130. * This class represents a single physics Hinge-Joint
  28131. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28132. */
  28133. export class HingeJoint extends MotorEnabledJoint {
  28134. /**
  28135. * Initializes the Hinge-Joint
  28136. * @param jointData The joint data for the Hinge-Joint
  28137. */
  28138. constructor(jointData: PhysicsJointData);
  28139. /**
  28140. * Set the motor values.
  28141. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28142. * @param {number} force the force to apply
  28143. * @param {number} maxForce max force for this motor.
  28144. */
  28145. setMotor(force?: number, maxForce?: number): void;
  28146. /**
  28147. * Set the motor's limits.
  28148. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28149. * @param upperLimit The upper limit of the motor
  28150. * @param lowerLimit The lower limit of the motor
  28151. */
  28152. setLimit(upperLimit: number, lowerLimit?: number): void;
  28153. }
  28154. /**
  28155. * This class represents a dual hinge physics joint (same as wheel joint)
  28156. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28157. */
  28158. export class Hinge2Joint extends MotorEnabledJoint {
  28159. /**
  28160. * Initializes the Hinge2-Joint
  28161. * @param jointData The joint data for the Hinge2-Joint
  28162. */
  28163. constructor(jointData: PhysicsJointData);
  28164. /**
  28165. * Set the motor values.
  28166. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28167. * @param {number} targetSpeed the speed the motor is to reach
  28168. * @param {number} maxForce max force for this motor.
  28169. * @param {motorIndex} the motor's index, 0 or 1.
  28170. */
  28171. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28172. /**
  28173. * Set the motor limits.
  28174. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28175. * @param {number} upperLimit the upper limit
  28176. * @param {number} lowerLimit lower limit
  28177. * @param {motorIndex} the motor's index, 0 or 1.
  28178. */
  28179. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28180. }
  28181. /**
  28182. * Interface for a motor enabled joint
  28183. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28184. */
  28185. export interface IMotorEnabledJoint {
  28186. /**
  28187. * Physics joint
  28188. */
  28189. physicsJoint: any;
  28190. /**
  28191. * Sets the motor of the motor-enabled joint
  28192. * @param force The force of the motor
  28193. * @param maxForce The maximum force of the motor
  28194. * @param motorIndex The index of the motor
  28195. */
  28196. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28197. /**
  28198. * Sets the limit of the motor
  28199. * @param upperLimit The upper limit of the motor
  28200. * @param lowerLimit The lower limit of the motor
  28201. * @param motorIndex The index of the motor
  28202. */
  28203. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28204. }
  28205. /**
  28206. * Joint data for a Distance-Joint
  28207. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28208. */
  28209. export interface DistanceJointData extends PhysicsJointData {
  28210. /**
  28211. * Max distance the 2 joint objects can be apart
  28212. */
  28213. maxDistance: number;
  28214. }
  28215. /**
  28216. * Joint data from a spring joint
  28217. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28218. */
  28219. export interface SpringJointData extends PhysicsJointData {
  28220. /**
  28221. * Length of the spring
  28222. */
  28223. length: number;
  28224. /**
  28225. * Stiffness of the spring
  28226. */
  28227. stiffness: number;
  28228. /**
  28229. * Damping of the spring
  28230. */
  28231. damping: number;
  28232. /** this callback will be called when applying the force to the impostors. */
  28233. forceApplicationCallback: () => void;
  28234. }
  28235. }
  28236. declare module "babylonjs/Physics/physicsRaycastResult" {
  28237. import { Vector3 } from "babylonjs/Maths/math.vector";
  28238. /**
  28239. * Holds the data for the raycast result
  28240. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28241. */
  28242. export class PhysicsRaycastResult {
  28243. private _hasHit;
  28244. private _hitDistance;
  28245. private _hitNormalWorld;
  28246. private _hitPointWorld;
  28247. private _rayFromWorld;
  28248. private _rayToWorld;
  28249. /**
  28250. * Gets if there was a hit
  28251. */
  28252. get hasHit(): boolean;
  28253. /**
  28254. * Gets the distance from the hit
  28255. */
  28256. get hitDistance(): number;
  28257. /**
  28258. * Gets the hit normal/direction in the world
  28259. */
  28260. get hitNormalWorld(): Vector3;
  28261. /**
  28262. * Gets the hit point in the world
  28263. */
  28264. get hitPointWorld(): Vector3;
  28265. /**
  28266. * Gets the ray "start point" of the ray in the world
  28267. */
  28268. get rayFromWorld(): Vector3;
  28269. /**
  28270. * Gets the ray "end point" of the ray in the world
  28271. */
  28272. get rayToWorld(): Vector3;
  28273. /**
  28274. * Sets the hit data (normal & point in world space)
  28275. * @param hitNormalWorld defines the normal in world space
  28276. * @param hitPointWorld defines the point in world space
  28277. */
  28278. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28279. /**
  28280. * Sets the distance from the start point to the hit point
  28281. * @param distance
  28282. */
  28283. setHitDistance(distance: number): void;
  28284. /**
  28285. * Calculates the distance manually
  28286. */
  28287. calculateHitDistance(): void;
  28288. /**
  28289. * Resets all the values to default
  28290. * @param from The from point on world space
  28291. * @param to The to point on world space
  28292. */
  28293. reset(from?: Vector3, to?: Vector3): void;
  28294. }
  28295. /**
  28296. * Interface for the size containing width and height
  28297. */
  28298. interface IXYZ {
  28299. /**
  28300. * X
  28301. */
  28302. x: number;
  28303. /**
  28304. * Y
  28305. */
  28306. y: number;
  28307. /**
  28308. * Z
  28309. */
  28310. z: number;
  28311. }
  28312. }
  28313. declare module "babylonjs/Physics/IPhysicsEngine" {
  28314. import { Nullable } from "babylonjs/types";
  28315. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28317. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28318. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28319. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28320. /**
  28321. * Interface used to describe a physics joint
  28322. */
  28323. export interface PhysicsImpostorJoint {
  28324. /** Defines the main impostor to which the joint is linked */
  28325. mainImpostor: PhysicsImpostor;
  28326. /** Defines the impostor that is connected to the main impostor using this joint */
  28327. connectedImpostor: PhysicsImpostor;
  28328. /** Defines the joint itself */
  28329. joint: PhysicsJoint;
  28330. }
  28331. /** @hidden */
  28332. export interface IPhysicsEnginePlugin {
  28333. world: any;
  28334. name: string;
  28335. setGravity(gravity: Vector3): void;
  28336. setTimeStep(timeStep: number): void;
  28337. getTimeStep(): number;
  28338. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28339. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28340. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28341. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28342. removePhysicsBody(impostor: PhysicsImpostor): void;
  28343. generateJoint(joint: PhysicsImpostorJoint): void;
  28344. removeJoint(joint: PhysicsImpostorJoint): void;
  28345. isSupported(): boolean;
  28346. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28347. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28348. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28349. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28350. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28351. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28352. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28353. getBodyMass(impostor: PhysicsImpostor): number;
  28354. getBodyFriction(impostor: PhysicsImpostor): number;
  28355. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28356. getBodyRestitution(impostor: PhysicsImpostor): number;
  28357. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28358. getBodyPressure?(impostor: PhysicsImpostor): number;
  28359. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28360. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28361. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28362. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28363. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28364. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28365. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28366. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28367. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28368. sleepBody(impostor: PhysicsImpostor): void;
  28369. wakeUpBody(impostor: PhysicsImpostor): void;
  28370. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28371. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28372. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28373. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28374. getRadius(impostor: PhysicsImpostor): number;
  28375. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28376. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28377. dispose(): void;
  28378. }
  28379. /**
  28380. * Interface used to define a physics engine
  28381. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28382. */
  28383. export interface IPhysicsEngine {
  28384. /**
  28385. * Gets the gravity vector used by the simulation
  28386. */
  28387. gravity: Vector3;
  28388. /**
  28389. * Sets the gravity vector used by the simulation
  28390. * @param gravity defines the gravity vector to use
  28391. */
  28392. setGravity(gravity: Vector3): void;
  28393. /**
  28394. * Set the time step of the physics engine.
  28395. * Default is 1/60.
  28396. * To slow it down, enter 1/600 for example.
  28397. * To speed it up, 1/30
  28398. * @param newTimeStep the new timestep to apply to this world.
  28399. */
  28400. setTimeStep(newTimeStep: number): void;
  28401. /**
  28402. * Get the time step of the physics engine.
  28403. * @returns the current time step
  28404. */
  28405. getTimeStep(): number;
  28406. /**
  28407. * Set the sub time step of the physics engine.
  28408. * Default is 0 meaning there is no sub steps
  28409. * To increase physics resolution precision, set a small value (like 1 ms)
  28410. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28411. */
  28412. setSubTimeStep(subTimeStep: number): void;
  28413. /**
  28414. * Get the sub time step of the physics engine.
  28415. * @returns the current sub time step
  28416. */
  28417. getSubTimeStep(): number;
  28418. /**
  28419. * Release all resources
  28420. */
  28421. dispose(): void;
  28422. /**
  28423. * Gets the name of the current physics plugin
  28424. * @returns the name of the plugin
  28425. */
  28426. getPhysicsPluginName(): string;
  28427. /**
  28428. * Adding a new impostor for the impostor tracking.
  28429. * This will be done by the impostor itself.
  28430. * @param impostor the impostor to add
  28431. */
  28432. addImpostor(impostor: PhysicsImpostor): void;
  28433. /**
  28434. * Remove an impostor from the engine.
  28435. * This impostor and its mesh will not longer be updated by the physics engine.
  28436. * @param impostor the impostor to remove
  28437. */
  28438. removeImpostor(impostor: PhysicsImpostor): void;
  28439. /**
  28440. * Add a joint to the physics engine
  28441. * @param mainImpostor defines the main impostor to which the joint is added.
  28442. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28443. * @param joint defines the joint that will connect both impostors.
  28444. */
  28445. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28446. /**
  28447. * Removes a joint from the simulation
  28448. * @param mainImpostor defines the impostor used with the joint
  28449. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28450. * @param joint defines the joint to remove
  28451. */
  28452. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28453. /**
  28454. * Gets the current plugin used to run the simulation
  28455. * @returns current plugin
  28456. */
  28457. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28458. /**
  28459. * Gets the list of physic impostors
  28460. * @returns an array of PhysicsImpostor
  28461. */
  28462. getImpostors(): Array<PhysicsImpostor>;
  28463. /**
  28464. * Gets the impostor for a physics enabled object
  28465. * @param object defines the object impersonated by the impostor
  28466. * @returns the PhysicsImpostor or null if not found
  28467. */
  28468. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28469. /**
  28470. * Gets the impostor for a physics body object
  28471. * @param body defines physics body used by the impostor
  28472. * @returns the PhysicsImpostor or null if not found
  28473. */
  28474. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28475. /**
  28476. * Does a raycast in the physics world
  28477. * @param from when should the ray start?
  28478. * @param to when should the ray end?
  28479. * @returns PhysicsRaycastResult
  28480. */
  28481. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28482. /**
  28483. * Called by the scene. No need to call it.
  28484. * @param delta defines the timespam between frames
  28485. */
  28486. _step(delta: number): void;
  28487. }
  28488. }
  28489. declare module "babylonjs/Physics/physicsImpostor" {
  28490. import { Nullable, IndicesArray } from "babylonjs/types";
  28491. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28492. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28493. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28494. import { Scene } from "babylonjs/scene";
  28495. import { Bone } from "babylonjs/Bones/bone";
  28496. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28497. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28498. import { Space } from "babylonjs/Maths/math.axis";
  28499. /**
  28500. * The interface for the physics imposter parameters
  28501. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28502. */
  28503. export interface PhysicsImpostorParameters {
  28504. /**
  28505. * The mass of the physics imposter
  28506. */
  28507. mass: number;
  28508. /**
  28509. * The friction of the physics imposter
  28510. */
  28511. friction?: number;
  28512. /**
  28513. * The coefficient of restitution of the physics imposter
  28514. */
  28515. restitution?: number;
  28516. /**
  28517. * The native options of the physics imposter
  28518. */
  28519. nativeOptions?: any;
  28520. /**
  28521. * Specifies if the parent should be ignored
  28522. */
  28523. ignoreParent?: boolean;
  28524. /**
  28525. * Specifies if bi-directional transformations should be disabled
  28526. */
  28527. disableBidirectionalTransformation?: boolean;
  28528. /**
  28529. * The pressure inside the physics imposter, soft object only
  28530. */
  28531. pressure?: number;
  28532. /**
  28533. * The stiffness the physics imposter, soft object only
  28534. */
  28535. stiffness?: number;
  28536. /**
  28537. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28538. */
  28539. velocityIterations?: number;
  28540. /**
  28541. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28542. */
  28543. positionIterations?: number;
  28544. /**
  28545. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28546. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28547. * Add to fix multiple points
  28548. */
  28549. fixedPoints?: number;
  28550. /**
  28551. * The collision margin around a soft object
  28552. */
  28553. margin?: number;
  28554. /**
  28555. * The collision margin around a soft object
  28556. */
  28557. damping?: number;
  28558. /**
  28559. * The path for a rope based on an extrusion
  28560. */
  28561. path?: any;
  28562. /**
  28563. * The shape of an extrusion used for a rope based on an extrusion
  28564. */
  28565. shape?: any;
  28566. }
  28567. /**
  28568. * Interface for a physics-enabled object
  28569. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28570. */
  28571. export interface IPhysicsEnabledObject {
  28572. /**
  28573. * The position of the physics-enabled object
  28574. */
  28575. position: Vector3;
  28576. /**
  28577. * The rotation of the physics-enabled object
  28578. */
  28579. rotationQuaternion: Nullable<Quaternion>;
  28580. /**
  28581. * The scale of the physics-enabled object
  28582. */
  28583. scaling: Vector3;
  28584. /**
  28585. * The rotation of the physics-enabled object
  28586. */
  28587. rotation?: Vector3;
  28588. /**
  28589. * The parent of the physics-enabled object
  28590. */
  28591. parent?: any;
  28592. /**
  28593. * The bounding info of the physics-enabled object
  28594. * @returns The bounding info of the physics-enabled object
  28595. */
  28596. getBoundingInfo(): BoundingInfo;
  28597. /**
  28598. * Computes the world matrix
  28599. * @param force Specifies if the world matrix should be computed by force
  28600. * @returns A world matrix
  28601. */
  28602. computeWorldMatrix(force: boolean): Matrix;
  28603. /**
  28604. * Gets the world matrix
  28605. * @returns A world matrix
  28606. */
  28607. getWorldMatrix?(): Matrix;
  28608. /**
  28609. * Gets the child meshes
  28610. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28611. * @returns An array of abstract meshes
  28612. */
  28613. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28614. /**
  28615. * Gets the vertex data
  28616. * @param kind The type of vertex data
  28617. * @returns A nullable array of numbers, or a float32 array
  28618. */
  28619. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28620. /**
  28621. * Gets the indices from the mesh
  28622. * @returns A nullable array of index arrays
  28623. */
  28624. getIndices?(): Nullable<IndicesArray>;
  28625. /**
  28626. * Gets the scene from the mesh
  28627. * @returns the indices array or null
  28628. */
  28629. getScene?(): Scene;
  28630. /**
  28631. * Gets the absolute position from the mesh
  28632. * @returns the absolute position
  28633. */
  28634. getAbsolutePosition(): Vector3;
  28635. /**
  28636. * Gets the absolute pivot point from the mesh
  28637. * @returns the absolute pivot point
  28638. */
  28639. getAbsolutePivotPoint(): Vector3;
  28640. /**
  28641. * Rotates the mesh
  28642. * @param axis The axis of rotation
  28643. * @param amount The amount of rotation
  28644. * @param space The space of the rotation
  28645. * @returns The rotation transform node
  28646. */
  28647. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28648. /**
  28649. * Translates the mesh
  28650. * @param axis The axis of translation
  28651. * @param distance The distance of translation
  28652. * @param space The space of the translation
  28653. * @returns The transform node
  28654. */
  28655. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28656. /**
  28657. * Sets the absolute position of the mesh
  28658. * @param absolutePosition The absolute position of the mesh
  28659. * @returns The transform node
  28660. */
  28661. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28662. /**
  28663. * Gets the class name of the mesh
  28664. * @returns The class name
  28665. */
  28666. getClassName(): string;
  28667. }
  28668. /**
  28669. * Represents a physics imposter
  28670. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28671. */
  28672. export class PhysicsImpostor {
  28673. /**
  28674. * The physics-enabled object used as the physics imposter
  28675. */
  28676. object: IPhysicsEnabledObject;
  28677. /**
  28678. * The type of the physics imposter
  28679. */
  28680. type: number;
  28681. private _options;
  28682. private _scene?;
  28683. /**
  28684. * The default object size of the imposter
  28685. */
  28686. static DEFAULT_OBJECT_SIZE: Vector3;
  28687. /**
  28688. * The identity quaternion of the imposter
  28689. */
  28690. static IDENTITY_QUATERNION: Quaternion;
  28691. /** @hidden */
  28692. _pluginData: any;
  28693. private _physicsEngine;
  28694. private _physicsBody;
  28695. private _bodyUpdateRequired;
  28696. private _onBeforePhysicsStepCallbacks;
  28697. private _onAfterPhysicsStepCallbacks;
  28698. /** @hidden */
  28699. _onPhysicsCollideCallbacks: Array<{
  28700. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28701. otherImpostors: Array<PhysicsImpostor>;
  28702. }>;
  28703. private _deltaPosition;
  28704. private _deltaRotation;
  28705. private _deltaRotationConjugated;
  28706. /** @hidden */
  28707. _isFromLine: boolean;
  28708. private _parent;
  28709. private _isDisposed;
  28710. private static _tmpVecs;
  28711. private static _tmpQuat;
  28712. /**
  28713. * Specifies if the physics imposter is disposed
  28714. */
  28715. get isDisposed(): boolean;
  28716. /**
  28717. * Gets the mass of the physics imposter
  28718. */
  28719. get mass(): number;
  28720. set mass(value: number);
  28721. /**
  28722. * Gets the coefficient of friction
  28723. */
  28724. get friction(): number;
  28725. /**
  28726. * Sets the coefficient of friction
  28727. */
  28728. set friction(value: number);
  28729. /**
  28730. * Gets the coefficient of restitution
  28731. */
  28732. get restitution(): number;
  28733. /**
  28734. * Sets the coefficient of restitution
  28735. */
  28736. set restitution(value: number);
  28737. /**
  28738. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28739. */
  28740. get pressure(): number;
  28741. /**
  28742. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28743. */
  28744. set pressure(value: number);
  28745. /**
  28746. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28747. */
  28748. get stiffness(): number;
  28749. /**
  28750. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28751. */
  28752. set stiffness(value: number);
  28753. /**
  28754. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28755. */
  28756. get velocityIterations(): number;
  28757. /**
  28758. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28759. */
  28760. set velocityIterations(value: number);
  28761. /**
  28762. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28763. */
  28764. get positionIterations(): number;
  28765. /**
  28766. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28767. */
  28768. set positionIterations(value: number);
  28769. /**
  28770. * The unique id of the physics imposter
  28771. * set by the physics engine when adding this impostor to the array
  28772. */
  28773. uniqueId: number;
  28774. /**
  28775. * @hidden
  28776. */
  28777. soft: boolean;
  28778. /**
  28779. * @hidden
  28780. */
  28781. segments: number;
  28782. private _joints;
  28783. /**
  28784. * Initializes the physics imposter
  28785. * @param object The physics-enabled object used as the physics imposter
  28786. * @param type The type of the physics imposter
  28787. * @param _options The options for the physics imposter
  28788. * @param _scene The Babylon scene
  28789. */
  28790. constructor(
  28791. /**
  28792. * The physics-enabled object used as the physics imposter
  28793. */
  28794. object: IPhysicsEnabledObject,
  28795. /**
  28796. * The type of the physics imposter
  28797. */
  28798. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28799. /**
  28800. * This function will completly initialize this impostor.
  28801. * It will create a new body - but only if this mesh has no parent.
  28802. * If it has, this impostor will not be used other than to define the impostor
  28803. * of the child mesh.
  28804. * @hidden
  28805. */
  28806. _init(): void;
  28807. private _getPhysicsParent;
  28808. /**
  28809. * Should a new body be generated.
  28810. * @returns boolean specifying if body initialization is required
  28811. */
  28812. isBodyInitRequired(): boolean;
  28813. /**
  28814. * Sets the updated scaling
  28815. * @param updated Specifies if the scaling is updated
  28816. */
  28817. setScalingUpdated(): void;
  28818. /**
  28819. * Force a regeneration of this or the parent's impostor's body.
  28820. * Use under cautious - This will remove all joints already implemented.
  28821. */
  28822. forceUpdate(): void;
  28823. /**
  28824. * Gets the body that holds this impostor. Either its own, or its parent.
  28825. */
  28826. get physicsBody(): any;
  28827. /**
  28828. * Get the parent of the physics imposter
  28829. * @returns Physics imposter or null
  28830. */
  28831. get parent(): Nullable<PhysicsImpostor>;
  28832. /**
  28833. * Sets the parent of the physics imposter
  28834. */
  28835. set parent(value: Nullable<PhysicsImpostor>);
  28836. /**
  28837. * Set the physics body. Used mainly by the physics engine/plugin
  28838. */
  28839. set physicsBody(physicsBody: any);
  28840. /**
  28841. * Resets the update flags
  28842. */
  28843. resetUpdateFlags(): void;
  28844. /**
  28845. * Gets the object extend size
  28846. * @returns the object extend size
  28847. */
  28848. getObjectExtendSize(): Vector3;
  28849. /**
  28850. * Gets the object center
  28851. * @returns The object center
  28852. */
  28853. getObjectCenter(): Vector3;
  28854. /**
  28855. * Get a specific parameter from the options parameters
  28856. * @param paramName The object parameter name
  28857. * @returns The object parameter
  28858. */
  28859. getParam(paramName: string): any;
  28860. /**
  28861. * Sets a specific parameter in the options given to the physics plugin
  28862. * @param paramName The parameter name
  28863. * @param value The value of the parameter
  28864. */
  28865. setParam(paramName: string, value: number): void;
  28866. /**
  28867. * Specifically change the body's mass option. Won't recreate the physics body object
  28868. * @param mass The mass of the physics imposter
  28869. */
  28870. setMass(mass: number): void;
  28871. /**
  28872. * Gets the linear velocity
  28873. * @returns linear velocity or null
  28874. */
  28875. getLinearVelocity(): Nullable<Vector3>;
  28876. /**
  28877. * Sets the linear velocity
  28878. * @param velocity linear velocity or null
  28879. */
  28880. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28881. /**
  28882. * Gets the angular velocity
  28883. * @returns angular velocity or null
  28884. */
  28885. getAngularVelocity(): Nullable<Vector3>;
  28886. /**
  28887. * Sets the angular velocity
  28888. * @param velocity The velocity or null
  28889. */
  28890. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28891. /**
  28892. * Execute a function with the physics plugin native code
  28893. * Provide a function the will have two variables - the world object and the physics body object
  28894. * @param func The function to execute with the physics plugin native code
  28895. */
  28896. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28897. /**
  28898. * Register a function that will be executed before the physics world is stepping forward
  28899. * @param func The function to execute before the physics world is stepped forward
  28900. */
  28901. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28902. /**
  28903. * Unregister a function that will be executed before the physics world is stepping forward
  28904. * @param func The function to execute before the physics world is stepped forward
  28905. */
  28906. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28907. /**
  28908. * Register a function that will be executed after the physics step
  28909. * @param func The function to execute after physics step
  28910. */
  28911. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28912. /**
  28913. * Unregisters a function that will be executed after the physics step
  28914. * @param func The function to execute after physics step
  28915. */
  28916. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28917. /**
  28918. * register a function that will be executed when this impostor collides against a different body
  28919. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28920. * @param func Callback that is executed on collision
  28921. */
  28922. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28923. /**
  28924. * Unregisters the physics imposter on contact
  28925. * @param collideAgainst The physics object to collide against
  28926. * @param func Callback to execute on collision
  28927. */
  28928. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28929. private _tmpQuat;
  28930. private _tmpQuat2;
  28931. /**
  28932. * Get the parent rotation
  28933. * @returns The parent rotation
  28934. */
  28935. getParentsRotation(): Quaternion;
  28936. /**
  28937. * this function is executed by the physics engine.
  28938. */
  28939. beforeStep: () => void;
  28940. /**
  28941. * this function is executed by the physics engine
  28942. */
  28943. afterStep: () => void;
  28944. /**
  28945. * Legacy collision detection event support
  28946. */
  28947. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28948. /**
  28949. * event and body object due to cannon's event-based architecture.
  28950. */
  28951. onCollide: (e: {
  28952. body: any;
  28953. }) => void;
  28954. /**
  28955. * Apply a force
  28956. * @param force The force to apply
  28957. * @param contactPoint The contact point for the force
  28958. * @returns The physics imposter
  28959. */
  28960. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28961. /**
  28962. * Apply an impulse
  28963. * @param force The impulse force
  28964. * @param contactPoint The contact point for the impulse force
  28965. * @returns The physics imposter
  28966. */
  28967. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28968. /**
  28969. * A help function to create a joint
  28970. * @param otherImpostor A physics imposter used to create a joint
  28971. * @param jointType The type of joint
  28972. * @param jointData The data for the joint
  28973. * @returns The physics imposter
  28974. */
  28975. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28976. /**
  28977. * Add a joint to this impostor with a different impostor
  28978. * @param otherImpostor A physics imposter used to add a joint
  28979. * @param joint The joint to add
  28980. * @returns The physics imposter
  28981. */
  28982. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28983. /**
  28984. * Add an anchor to a cloth impostor
  28985. * @param otherImpostor rigid impostor to anchor to
  28986. * @param width ratio across width from 0 to 1
  28987. * @param height ratio up height from 0 to 1
  28988. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28989. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28990. * @returns impostor the soft imposter
  28991. */
  28992. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28993. /**
  28994. * Add a hook to a rope impostor
  28995. * @param otherImpostor rigid impostor to anchor to
  28996. * @param length ratio across rope from 0 to 1
  28997. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28998. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28999. * @returns impostor the rope imposter
  29000. */
  29001. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  29002. /**
  29003. * Will keep this body still, in a sleep mode.
  29004. * @returns the physics imposter
  29005. */
  29006. sleep(): PhysicsImpostor;
  29007. /**
  29008. * Wake the body up.
  29009. * @returns The physics imposter
  29010. */
  29011. wakeUp(): PhysicsImpostor;
  29012. /**
  29013. * Clones the physics imposter
  29014. * @param newObject The physics imposter clones to this physics-enabled object
  29015. * @returns A nullable physics imposter
  29016. */
  29017. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  29018. /**
  29019. * Disposes the physics imposter
  29020. */
  29021. dispose(): void;
  29022. /**
  29023. * Sets the delta position
  29024. * @param position The delta position amount
  29025. */
  29026. setDeltaPosition(position: Vector3): void;
  29027. /**
  29028. * Sets the delta rotation
  29029. * @param rotation The delta rotation amount
  29030. */
  29031. setDeltaRotation(rotation: Quaternion): void;
  29032. /**
  29033. * Gets the box size of the physics imposter and stores the result in the input parameter
  29034. * @param result Stores the box size
  29035. * @returns The physics imposter
  29036. */
  29037. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  29038. /**
  29039. * Gets the radius of the physics imposter
  29040. * @returns Radius of the physics imposter
  29041. */
  29042. getRadius(): number;
  29043. /**
  29044. * Sync a bone with this impostor
  29045. * @param bone The bone to sync to the impostor.
  29046. * @param boneMesh The mesh that the bone is influencing.
  29047. * @param jointPivot The pivot of the joint / bone in local space.
  29048. * @param distToJoint Optional distance from the impostor to the joint.
  29049. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  29050. */
  29051. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  29052. /**
  29053. * Sync impostor to a bone
  29054. * @param bone The bone that the impostor will be synced to.
  29055. * @param boneMesh The mesh that the bone is influencing.
  29056. * @param jointPivot The pivot of the joint / bone in local space.
  29057. * @param distToJoint Optional distance from the impostor to the joint.
  29058. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  29059. * @param boneAxis Optional vector3 axis the bone is aligned with
  29060. */
  29061. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  29062. /**
  29063. * No-Imposter type
  29064. */
  29065. static NoImpostor: number;
  29066. /**
  29067. * Sphere-Imposter type
  29068. */
  29069. static SphereImpostor: number;
  29070. /**
  29071. * Box-Imposter type
  29072. */
  29073. static BoxImpostor: number;
  29074. /**
  29075. * Plane-Imposter type
  29076. */
  29077. static PlaneImpostor: number;
  29078. /**
  29079. * Mesh-imposter type
  29080. */
  29081. static MeshImpostor: number;
  29082. /**
  29083. * Capsule-Impostor type (Ammo.js plugin only)
  29084. */
  29085. static CapsuleImpostor: number;
  29086. /**
  29087. * Cylinder-Imposter type
  29088. */
  29089. static CylinderImpostor: number;
  29090. /**
  29091. * Particle-Imposter type
  29092. */
  29093. static ParticleImpostor: number;
  29094. /**
  29095. * Heightmap-Imposter type
  29096. */
  29097. static HeightmapImpostor: number;
  29098. /**
  29099. * ConvexHull-Impostor type (Ammo.js plugin only)
  29100. */
  29101. static ConvexHullImpostor: number;
  29102. /**
  29103. * Custom-Imposter type (Ammo.js plugin only)
  29104. */
  29105. static CustomImpostor: number;
  29106. /**
  29107. * Rope-Imposter type
  29108. */
  29109. static RopeImpostor: number;
  29110. /**
  29111. * Cloth-Imposter type
  29112. */
  29113. static ClothImpostor: number;
  29114. /**
  29115. * Softbody-Imposter type
  29116. */
  29117. static SoftbodyImpostor: number;
  29118. }
  29119. }
  29120. declare module "babylonjs/Meshes/mesh" {
  29121. import { Observable } from "babylonjs/Misc/observable";
  29122. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29123. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29124. import { Camera } from "babylonjs/Cameras/camera";
  29125. import { Scene } from "babylonjs/scene";
  29126. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29127. import { Color4 } from "babylonjs/Maths/math.color";
  29128. import { Engine } from "babylonjs/Engines/engine";
  29129. import { Node } from "babylonjs/node";
  29130. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29131. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29132. import { Buffer } from "babylonjs/Meshes/buffer";
  29133. import { Geometry } from "babylonjs/Meshes/geometry";
  29134. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29135. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29136. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29137. import { Effect } from "babylonjs/Materials/effect";
  29138. import { Material } from "babylonjs/Materials/material";
  29139. import { Skeleton } from "babylonjs/Bones/skeleton";
  29140. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29141. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29142. import { Path3D } from "babylonjs/Maths/math.path";
  29143. import { Plane } from "babylonjs/Maths/math.plane";
  29144. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29145. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  29146. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29147. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29148. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29149. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29150. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29151. /**
  29152. * @hidden
  29153. **/
  29154. export class _CreationDataStorage {
  29155. closePath?: boolean;
  29156. closeArray?: boolean;
  29157. idx: number[];
  29158. dashSize: number;
  29159. gapSize: number;
  29160. path3D: Path3D;
  29161. pathArray: Vector3[][];
  29162. arc: number;
  29163. radius: number;
  29164. cap: number;
  29165. tessellation: number;
  29166. }
  29167. /**
  29168. * @hidden
  29169. **/
  29170. class _InstanceDataStorage {
  29171. visibleInstances: any;
  29172. batchCache: _InstancesBatch;
  29173. instancesBufferSize: number;
  29174. instancesBuffer: Nullable<Buffer>;
  29175. instancesData: Float32Array;
  29176. overridenInstanceCount: number;
  29177. isFrozen: boolean;
  29178. previousBatch: Nullable<_InstancesBatch>;
  29179. hardwareInstancedRendering: boolean;
  29180. sideOrientation: number;
  29181. manualUpdate: boolean;
  29182. previousRenderId: number;
  29183. }
  29184. /**
  29185. * @hidden
  29186. **/
  29187. export class _InstancesBatch {
  29188. mustReturn: boolean;
  29189. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29190. renderSelf: boolean[];
  29191. hardwareInstancedRendering: boolean[];
  29192. }
  29193. /**
  29194. * @hidden
  29195. **/
  29196. class _ThinInstanceDataStorage {
  29197. instancesCount: number;
  29198. matrixBuffer: Nullable<Buffer>;
  29199. matrixBufferSize: number;
  29200. matrixData: Nullable<Float32Array>;
  29201. boundingVectors: Array<Vector3>;
  29202. worldMatrices: Nullable<Matrix[]>;
  29203. }
  29204. /**
  29205. * Class used to represent renderable models
  29206. */
  29207. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29208. /**
  29209. * Mesh side orientation : usually the external or front surface
  29210. */
  29211. static readonly FRONTSIDE: number;
  29212. /**
  29213. * Mesh side orientation : usually the internal or back surface
  29214. */
  29215. static readonly BACKSIDE: number;
  29216. /**
  29217. * Mesh side orientation : both internal and external or front and back surfaces
  29218. */
  29219. static readonly DOUBLESIDE: number;
  29220. /**
  29221. * Mesh side orientation : by default, `FRONTSIDE`
  29222. */
  29223. static readonly DEFAULTSIDE: number;
  29224. /**
  29225. * Mesh cap setting : no cap
  29226. */
  29227. static readonly NO_CAP: number;
  29228. /**
  29229. * Mesh cap setting : one cap at the beginning of the mesh
  29230. */
  29231. static readonly CAP_START: number;
  29232. /**
  29233. * Mesh cap setting : one cap at the end of the mesh
  29234. */
  29235. static readonly CAP_END: number;
  29236. /**
  29237. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29238. */
  29239. static readonly CAP_ALL: number;
  29240. /**
  29241. * Mesh pattern setting : no flip or rotate
  29242. */
  29243. static readonly NO_FLIP: number;
  29244. /**
  29245. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29246. */
  29247. static readonly FLIP_TILE: number;
  29248. /**
  29249. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29250. */
  29251. static readonly ROTATE_TILE: number;
  29252. /**
  29253. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29254. */
  29255. static readonly FLIP_ROW: number;
  29256. /**
  29257. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29258. */
  29259. static readonly ROTATE_ROW: number;
  29260. /**
  29261. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29262. */
  29263. static readonly FLIP_N_ROTATE_TILE: number;
  29264. /**
  29265. * Mesh pattern setting : rotate pattern and rotate
  29266. */
  29267. static readonly FLIP_N_ROTATE_ROW: number;
  29268. /**
  29269. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29270. */
  29271. static readonly CENTER: number;
  29272. /**
  29273. * Mesh tile positioning : part tiles on left
  29274. */
  29275. static readonly LEFT: number;
  29276. /**
  29277. * Mesh tile positioning : part tiles on right
  29278. */
  29279. static readonly RIGHT: number;
  29280. /**
  29281. * Mesh tile positioning : part tiles on top
  29282. */
  29283. static readonly TOP: number;
  29284. /**
  29285. * Mesh tile positioning : part tiles on bottom
  29286. */
  29287. static readonly BOTTOM: number;
  29288. /**
  29289. * Gets the default side orientation.
  29290. * @param orientation the orientation to value to attempt to get
  29291. * @returns the default orientation
  29292. * @hidden
  29293. */
  29294. static _GetDefaultSideOrientation(orientation?: number): number;
  29295. private _internalMeshDataInfo;
  29296. get computeBonesUsingShaders(): boolean;
  29297. set computeBonesUsingShaders(value: boolean);
  29298. /**
  29299. * An event triggered before rendering the mesh
  29300. */
  29301. get onBeforeRenderObservable(): Observable<Mesh>;
  29302. /**
  29303. * An event triggered before binding the mesh
  29304. */
  29305. get onBeforeBindObservable(): Observable<Mesh>;
  29306. /**
  29307. * An event triggered after rendering the mesh
  29308. */
  29309. get onAfterRenderObservable(): Observable<Mesh>;
  29310. /**
  29311. * An event triggered before drawing the mesh
  29312. */
  29313. get onBeforeDrawObservable(): Observable<Mesh>;
  29314. private _onBeforeDrawObserver;
  29315. /**
  29316. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29317. */
  29318. set onBeforeDraw(callback: () => void);
  29319. get hasInstances(): boolean;
  29320. get hasThinInstances(): boolean;
  29321. /**
  29322. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29323. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29324. */
  29325. delayLoadState: number;
  29326. /**
  29327. * Gets the list of instances created from this mesh
  29328. * it is not supposed to be modified manually.
  29329. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29330. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29331. */
  29332. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29333. /**
  29334. * Gets the file containing delay loading data for this mesh
  29335. */
  29336. delayLoadingFile: string;
  29337. /** @hidden */
  29338. _binaryInfo: any;
  29339. /**
  29340. * User defined function used to change how LOD level selection is done
  29341. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29342. */
  29343. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29344. /**
  29345. * Gets or sets the morph target manager
  29346. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29347. */
  29348. get morphTargetManager(): Nullable<MorphTargetManager>;
  29349. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29350. /** @hidden */
  29351. _creationDataStorage: Nullable<_CreationDataStorage>;
  29352. /** @hidden */
  29353. _geometry: Nullable<Geometry>;
  29354. /** @hidden */
  29355. _delayInfo: Array<string>;
  29356. /** @hidden */
  29357. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29358. /** @hidden */
  29359. _instanceDataStorage: _InstanceDataStorage;
  29360. /** @hidden */
  29361. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29362. private _effectiveMaterial;
  29363. /** @hidden */
  29364. _shouldGenerateFlatShading: boolean;
  29365. /** @hidden */
  29366. _originalBuilderSideOrientation: number;
  29367. /**
  29368. * Use this property to change the original side orientation defined at construction time
  29369. */
  29370. overrideMaterialSideOrientation: Nullable<number>;
  29371. /**
  29372. * Gets the source mesh (the one used to clone this one from)
  29373. */
  29374. get source(): Nullable<Mesh>;
  29375. /**
  29376. * Gets the list of clones of this mesh
  29377. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29378. * Note that useClonedMeshMap=true is the default setting
  29379. */
  29380. get cloneMeshMap(): Nullable<{
  29381. [id: string]: Mesh | undefined;
  29382. }>;
  29383. /**
  29384. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29385. */
  29386. get isUnIndexed(): boolean;
  29387. set isUnIndexed(value: boolean);
  29388. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29389. get worldMatrixInstancedBuffer(): Float32Array;
  29390. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29391. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29392. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29393. /**
  29394. * @constructor
  29395. * @param name The value used by scene.getMeshByName() to do a lookup.
  29396. * @param scene The scene to add this mesh to.
  29397. * @param parent The parent of this mesh, if it has one
  29398. * @param source An optional Mesh from which geometry is shared, cloned.
  29399. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29400. * When false, achieved by calling a clone(), also passing False.
  29401. * This will make creation of children, recursive.
  29402. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29403. */
  29404. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29405. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29406. doNotInstantiate: boolean;
  29407. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29408. /**
  29409. * Gets the class name
  29410. * @returns the string "Mesh".
  29411. */
  29412. getClassName(): string;
  29413. /** @hidden */
  29414. get _isMesh(): boolean;
  29415. /**
  29416. * Returns a description of this mesh
  29417. * @param fullDetails define if full details about this mesh must be used
  29418. * @returns a descriptive string representing this mesh
  29419. */
  29420. toString(fullDetails?: boolean): string;
  29421. /** @hidden */
  29422. _unBindEffect(): void;
  29423. /**
  29424. * Gets a boolean indicating if this mesh has LOD
  29425. */
  29426. get hasLODLevels(): boolean;
  29427. /**
  29428. * Gets the list of MeshLODLevel associated with the current mesh
  29429. * @returns an array of MeshLODLevel
  29430. */
  29431. getLODLevels(): MeshLODLevel[];
  29432. private _sortLODLevels;
  29433. /**
  29434. * Add a mesh as LOD level triggered at the given distance.
  29435. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29436. * @param distance The distance from the center of the object to show this level
  29437. * @param mesh The mesh to be added as LOD level (can be null)
  29438. * @return This mesh (for chaining)
  29439. */
  29440. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29441. /**
  29442. * Returns the LOD level mesh at the passed distance or null if not found.
  29443. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29444. * @param distance The distance from the center of the object to show this level
  29445. * @returns a Mesh or `null`
  29446. */
  29447. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29448. /**
  29449. * Remove a mesh from the LOD array
  29450. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29451. * @param mesh defines the mesh to be removed
  29452. * @return This mesh (for chaining)
  29453. */
  29454. removeLODLevel(mesh: Mesh): Mesh;
  29455. /**
  29456. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29457. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29458. * @param camera defines the camera to use to compute distance
  29459. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29460. * @return This mesh (for chaining)
  29461. */
  29462. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29463. /**
  29464. * Gets the mesh internal Geometry object
  29465. */
  29466. get geometry(): Nullable<Geometry>;
  29467. /**
  29468. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29469. * @returns the total number of vertices
  29470. */
  29471. getTotalVertices(): number;
  29472. /**
  29473. * Returns the content of an associated vertex buffer
  29474. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29475. * - VertexBuffer.PositionKind
  29476. * - VertexBuffer.UVKind
  29477. * - VertexBuffer.UV2Kind
  29478. * - VertexBuffer.UV3Kind
  29479. * - VertexBuffer.UV4Kind
  29480. * - VertexBuffer.UV5Kind
  29481. * - VertexBuffer.UV6Kind
  29482. * - VertexBuffer.ColorKind
  29483. * - VertexBuffer.MatricesIndicesKind
  29484. * - VertexBuffer.MatricesIndicesExtraKind
  29485. * - VertexBuffer.MatricesWeightsKind
  29486. * - VertexBuffer.MatricesWeightsExtraKind
  29487. * @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
  29488. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29489. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29490. */
  29491. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29492. /**
  29493. * Returns the mesh VertexBuffer object from the requested `kind`
  29494. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29495. * - VertexBuffer.PositionKind
  29496. * - VertexBuffer.NormalKind
  29497. * - VertexBuffer.UVKind
  29498. * - VertexBuffer.UV2Kind
  29499. * - VertexBuffer.UV3Kind
  29500. * - VertexBuffer.UV4Kind
  29501. * - VertexBuffer.UV5Kind
  29502. * - VertexBuffer.UV6Kind
  29503. * - VertexBuffer.ColorKind
  29504. * - VertexBuffer.MatricesIndicesKind
  29505. * - VertexBuffer.MatricesIndicesExtraKind
  29506. * - VertexBuffer.MatricesWeightsKind
  29507. * - VertexBuffer.MatricesWeightsExtraKind
  29508. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29509. */
  29510. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29511. /**
  29512. * Tests if a specific vertex buffer is associated with this mesh
  29513. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29514. * - VertexBuffer.PositionKind
  29515. * - VertexBuffer.NormalKind
  29516. * - VertexBuffer.UVKind
  29517. * - VertexBuffer.UV2Kind
  29518. * - VertexBuffer.UV3Kind
  29519. * - VertexBuffer.UV4Kind
  29520. * - VertexBuffer.UV5Kind
  29521. * - VertexBuffer.UV6Kind
  29522. * - VertexBuffer.ColorKind
  29523. * - VertexBuffer.MatricesIndicesKind
  29524. * - VertexBuffer.MatricesIndicesExtraKind
  29525. * - VertexBuffer.MatricesWeightsKind
  29526. * - VertexBuffer.MatricesWeightsExtraKind
  29527. * @returns a boolean
  29528. */
  29529. isVerticesDataPresent(kind: string): boolean;
  29530. /**
  29531. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29532. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29533. * - VertexBuffer.PositionKind
  29534. * - VertexBuffer.UVKind
  29535. * - VertexBuffer.UV2Kind
  29536. * - VertexBuffer.UV3Kind
  29537. * - VertexBuffer.UV4Kind
  29538. * - VertexBuffer.UV5Kind
  29539. * - VertexBuffer.UV6Kind
  29540. * - VertexBuffer.ColorKind
  29541. * - VertexBuffer.MatricesIndicesKind
  29542. * - VertexBuffer.MatricesIndicesExtraKind
  29543. * - VertexBuffer.MatricesWeightsKind
  29544. * - VertexBuffer.MatricesWeightsExtraKind
  29545. * @returns a boolean
  29546. */
  29547. isVertexBufferUpdatable(kind: string): boolean;
  29548. /**
  29549. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29550. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29551. * - VertexBuffer.PositionKind
  29552. * - VertexBuffer.NormalKind
  29553. * - VertexBuffer.UVKind
  29554. * - VertexBuffer.UV2Kind
  29555. * - VertexBuffer.UV3Kind
  29556. * - VertexBuffer.UV4Kind
  29557. * - VertexBuffer.UV5Kind
  29558. * - VertexBuffer.UV6Kind
  29559. * - VertexBuffer.ColorKind
  29560. * - VertexBuffer.MatricesIndicesKind
  29561. * - VertexBuffer.MatricesIndicesExtraKind
  29562. * - VertexBuffer.MatricesWeightsKind
  29563. * - VertexBuffer.MatricesWeightsExtraKind
  29564. * @returns an array of strings
  29565. */
  29566. getVerticesDataKinds(): string[];
  29567. /**
  29568. * Returns a positive integer : the total number of indices in this mesh geometry.
  29569. * @returns the numner of indices or zero if the mesh has no geometry.
  29570. */
  29571. getTotalIndices(): number;
  29572. /**
  29573. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29574. * @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.
  29575. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29576. * @returns the indices array or an empty array if the mesh has no geometry
  29577. */
  29578. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29579. get isBlocked(): boolean;
  29580. /**
  29581. * Determine if the current mesh is ready to be rendered
  29582. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29583. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29584. * @returns true if all associated assets are ready (material, textures, shaders)
  29585. */
  29586. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29587. /**
  29588. * 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.
  29589. */
  29590. get areNormalsFrozen(): boolean;
  29591. /**
  29592. * 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.
  29593. * @returns the current mesh
  29594. */
  29595. freezeNormals(): Mesh;
  29596. /**
  29597. * 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
  29598. * @returns the current mesh
  29599. */
  29600. unfreezeNormals(): Mesh;
  29601. /**
  29602. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29603. */
  29604. set overridenInstanceCount(count: number);
  29605. /** @hidden */
  29606. _preActivate(): Mesh;
  29607. /** @hidden */
  29608. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29609. /** @hidden */
  29610. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29611. protected _afterComputeWorldMatrix(): void;
  29612. /** @hidden */
  29613. _postActivate(): void;
  29614. /**
  29615. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29616. * This means the mesh underlying bounding box and sphere are recomputed.
  29617. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29618. * @returns the current mesh
  29619. */
  29620. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29621. /** @hidden */
  29622. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29623. /**
  29624. * This function will subdivide the mesh into multiple submeshes
  29625. * @param count defines the expected number of submeshes
  29626. */
  29627. subdivide(count: number): void;
  29628. /**
  29629. * Copy a FloatArray into a specific associated vertex buffer
  29630. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29631. * - VertexBuffer.PositionKind
  29632. * - VertexBuffer.UVKind
  29633. * - VertexBuffer.UV2Kind
  29634. * - VertexBuffer.UV3Kind
  29635. * - VertexBuffer.UV4Kind
  29636. * - VertexBuffer.UV5Kind
  29637. * - VertexBuffer.UV6Kind
  29638. * - VertexBuffer.ColorKind
  29639. * - VertexBuffer.MatricesIndicesKind
  29640. * - VertexBuffer.MatricesIndicesExtraKind
  29641. * - VertexBuffer.MatricesWeightsKind
  29642. * - VertexBuffer.MatricesWeightsExtraKind
  29643. * @param data defines the data source
  29644. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29645. * @param stride defines the data stride size (can be null)
  29646. * @returns the current mesh
  29647. */
  29648. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29649. /**
  29650. * Delete a vertex buffer associated with this mesh
  29651. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29652. * - VertexBuffer.PositionKind
  29653. * - VertexBuffer.UVKind
  29654. * - VertexBuffer.UV2Kind
  29655. * - VertexBuffer.UV3Kind
  29656. * - VertexBuffer.UV4Kind
  29657. * - VertexBuffer.UV5Kind
  29658. * - VertexBuffer.UV6Kind
  29659. * - VertexBuffer.ColorKind
  29660. * - VertexBuffer.MatricesIndicesKind
  29661. * - VertexBuffer.MatricesIndicesExtraKind
  29662. * - VertexBuffer.MatricesWeightsKind
  29663. * - VertexBuffer.MatricesWeightsExtraKind
  29664. */
  29665. removeVerticesData(kind: string): void;
  29666. /**
  29667. * Flags an associated vertex buffer as updatable
  29668. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29669. * - VertexBuffer.PositionKind
  29670. * - VertexBuffer.UVKind
  29671. * - VertexBuffer.UV2Kind
  29672. * - VertexBuffer.UV3Kind
  29673. * - VertexBuffer.UV4Kind
  29674. * - VertexBuffer.UV5Kind
  29675. * - VertexBuffer.UV6Kind
  29676. * - VertexBuffer.ColorKind
  29677. * - VertexBuffer.MatricesIndicesKind
  29678. * - VertexBuffer.MatricesIndicesExtraKind
  29679. * - VertexBuffer.MatricesWeightsKind
  29680. * - VertexBuffer.MatricesWeightsExtraKind
  29681. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29682. */
  29683. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29684. /**
  29685. * Sets the mesh global Vertex Buffer
  29686. * @param buffer defines the buffer to use
  29687. * @returns the current mesh
  29688. */
  29689. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29690. /**
  29691. * Update a specific associated vertex buffer
  29692. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29693. * - VertexBuffer.PositionKind
  29694. * - VertexBuffer.UVKind
  29695. * - VertexBuffer.UV2Kind
  29696. * - VertexBuffer.UV3Kind
  29697. * - VertexBuffer.UV4Kind
  29698. * - VertexBuffer.UV5Kind
  29699. * - VertexBuffer.UV6Kind
  29700. * - VertexBuffer.ColorKind
  29701. * - VertexBuffer.MatricesIndicesKind
  29702. * - VertexBuffer.MatricesIndicesExtraKind
  29703. * - VertexBuffer.MatricesWeightsKind
  29704. * - VertexBuffer.MatricesWeightsExtraKind
  29705. * @param data defines the data source
  29706. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29707. * @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)
  29708. * @returns the current mesh
  29709. */
  29710. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29711. /**
  29712. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29713. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29714. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29715. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29716. * @returns the current mesh
  29717. */
  29718. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29719. /**
  29720. * Creates a un-shared specific occurence of the geometry for the mesh.
  29721. * @returns the current mesh
  29722. */
  29723. makeGeometryUnique(): Mesh;
  29724. /**
  29725. * Set the index buffer of this mesh
  29726. * @param indices defines the source data
  29727. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29728. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29729. * @returns the current mesh
  29730. */
  29731. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29732. /**
  29733. * Update the current index buffer
  29734. * @param indices defines the source data
  29735. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29736. * @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)
  29737. * @returns the current mesh
  29738. */
  29739. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29740. /**
  29741. * Invert the geometry to move from a right handed system to a left handed one.
  29742. * @returns the current mesh
  29743. */
  29744. toLeftHanded(): Mesh;
  29745. /** @hidden */
  29746. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29747. /** @hidden */
  29748. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29749. /**
  29750. * Registers for this mesh a javascript function called just before the rendering process
  29751. * @param func defines the function to call before rendering this mesh
  29752. * @returns the current mesh
  29753. */
  29754. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29755. /**
  29756. * Disposes a previously registered javascript function called before the rendering
  29757. * @param func defines the function to remove
  29758. * @returns the current mesh
  29759. */
  29760. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29761. /**
  29762. * Registers for this mesh a javascript function called just after the rendering is complete
  29763. * @param func defines the function to call after rendering this mesh
  29764. * @returns the current mesh
  29765. */
  29766. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29767. /**
  29768. * Disposes a previously registered javascript function called after the rendering.
  29769. * @param func defines the function to remove
  29770. * @returns the current mesh
  29771. */
  29772. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29773. /** @hidden */
  29774. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29775. /** @hidden */
  29776. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29777. /** @hidden */
  29778. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29779. /** @hidden */
  29780. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29781. /** @hidden */
  29782. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29783. /** @hidden */
  29784. _rebuild(): void;
  29785. /** @hidden */
  29786. _freeze(): void;
  29787. /** @hidden */
  29788. _unFreeze(): void;
  29789. /**
  29790. * 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
  29791. * @param subMesh defines the subMesh to render
  29792. * @param enableAlphaMode defines if alpha mode can be changed
  29793. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29794. * @returns the current mesh
  29795. */
  29796. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29797. private _onBeforeDraw;
  29798. /**
  29799. * Renormalize the mesh and patch it up if there are no weights
  29800. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29801. * However in the case of zero weights then we set just a single influence to 1.
  29802. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29803. */
  29804. cleanMatrixWeights(): void;
  29805. private normalizeSkinFourWeights;
  29806. private normalizeSkinWeightsAndExtra;
  29807. /**
  29808. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29809. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29810. * the user know there was an issue with importing the mesh
  29811. * @returns a validation object with skinned, valid and report string
  29812. */
  29813. validateSkinning(): {
  29814. skinned: boolean;
  29815. valid: boolean;
  29816. report: string;
  29817. };
  29818. /** @hidden */
  29819. _checkDelayState(): Mesh;
  29820. private _queueLoad;
  29821. /**
  29822. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29823. * A mesh is in the frustum if its bounding box intersects the frustum
  29824. * @param frustumPlanes defines the frustum to test
  29825. * @returns true if the mesh is in the frustum planes
  29826. */
  29827. isInFrustum(frustumPlanes: Plane[]): boolean;
  29828. /**
  29829. * Sets the mesh material by the material or multiMaterial `id` property
  29830. * @param id is a string identifying the material or the multiMaterial
  29831. * @returns the current mesh
  29832. */
  29833. setMaterialByID(id: string): Mesh;
  29834. /**
  29835. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29836. * @returns an array of IAnimatable
  29837. */
  29838. getAnimatables(): IAnimatable[];
  29839. /**
  29840. * Modifies the mesh geometry according to the passed transformation matrix.
  29841. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29842. * The mesh normals are modified using the same transformation.
  29843. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29844. * @param transform defines the transform matrix to use
  29845. * @see https://doc.babylonjs.com/resources/baking_transformations
  29846. * @returns the current mesh
  29847. */
  29848. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29849. /**
  29850. * Modifies the mesh geometry according to its own current World Matrix.
  29851. * The mesh World Matrix is then reset.
  29852. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29853. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29854. * @see https://doc.babylonjs.com/resources/baking_transformations
  29855. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29856. * @returns the current mesh
  29857. */
  29858. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29859. /** @hidden */
  29860. get _positions(): Nullable<Vector3[]>;
  29861. /** @hidden */
  29862. _resetPointsArrayCache(): Mesh;
  29863. /** @hidden */
  29864. _generatePointsArray(): boolean;
  29865. /**
  29866. * Returns a new Mesh object generated from the current mesh properties.
  29867. * This method must not get confused with createInstance()
  29868. * @param name is a string, the name given to the new mesh
  29869. * @param newParent can be any Node object (default `null`)
  29870. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29871. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29872. * @returns a new mesh
  29873. */
  29874. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29875. /**
  29876. * Releases resources associated with this mesh.
  29877. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29878. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29879. */
  29880. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29881. /** @hidden */
  29882. _disposeInstanceSpecificData(): void;
  29883. /** @hidden */
  29884. _disposeThinInstanceSpecificData(): void;
  29885. /**
  29886. * Modifies the mesh geometry according to a displacement map.
  29887. * 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.
  29888. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29889. * @param url is a string, the URL from the image file is to be downloaded.
  29890. * @param minHeight is the lower limit of the displacement.
  29891. * @param maxHeight is the upper limit of the displacement.
  29892. * @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.
  29893. * @param uvOffset is an optional vector2 used to offset UV.
  29894. * @param uvScale is an optional vector2 used to scale UV.
  29895. * @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.
  29896. * @returns the Mesh.
  29897. */
  29898. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29899. /**
  29900. * Modifies the mesh geometry according to a displacementMap buffer.
  29901. * 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.
  29902. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29903. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29904. * @param heightMapWidth is the width of the buffer image.
  29905. * @param heightMapHeight is the height of the buffer image.
  29906. * @param minHeight is the lower limit of the displacement.
  29907. * @param maxHeight is the upper limit of the displacement.
  29908. * @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.
  29909. * @param uvOffset is an optional vector2 used to offset UV.
  29910. * @param uvScale is an optional vector2 used to scale UV.
  29911. * @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.
  29912. * @returns the Mesh.
  29913. */
  29914. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29915. /**
  29916. * Modify the mesh to get a flat shading rendering.
  29917. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29918. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29919. * @returns current mesh
  29920. */
  29921. convertToFlatShadedMesh(): Mesh;
  29922. /**
  29923. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29924. * In other words, more vertices, no more indices and a single bigger VBO.
  29925. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29926. * @returns current mesh
  29927. */
  29928. convertToUnIndexedMesh(): Mesh;
  29929. /**
  29930. * Inverses facet orientations.
  29931. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29932. * @param flipNormals will also inverts the normals
  29933. * @returns current mesh
  29934. */
  29935. flipFaces(flipNormals?: boolean): Mesh;
  29936. /**
  29937. * Increase the number of facets and hence vertices in a mesh
  29938. * Vertex normals are interpolated from existing vertex normals
  29939. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29940. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29941. */
  29942. increaseVertices(numberPerEdge: number): void;
  29943. /**
  29944. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29945. * This will undo any application of covertToFlatShadedMesh
  29946. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29947. */
  29948. forceSharedVertices(): void;
  29949. /** @hidden */
  29950. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29951. /** @hidden */
  29952. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29953. /**
  29954. * Creates a new InstancedMesh object from the mesh model.
  29955. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29956. * @param name defines the name of the new instance
  29957. * @returns a new InstancedMesh
  29958. */
  29959. createInstance(name: string): InstancedMesh;
  29960. /**
  29961. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29962. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29963. * @returns the current mesh
  29964. */
  29965. synchronizeInstances(): Mesh;
  29966. /**
  29967. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29968. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29969. * This should be used together with the simplification to avoid disappearing triangles.
  29970. * @param successCallback an optional success callback to be called after the optimization finished.
  29971. * @returns the current mesh
  29972. */
  29973. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29974. /**
  29975. * Serialize current mesh
  29976. * @param serializationObject defines the object which will receive the serialization data
  29977. */
  29978. serialize(serializationObject: any): void;
  29979. /** @hidden */
  29980. _syncGeometryWithMorphTargetManager(): void;
  29981. /** @hidden */
  29982. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29983. /**
  29984. * Returns a new Mesh object parsed from the source provided.
  29985. * @param parsedMesh is the source
  29986. * @param scene defines the hosting scene
  29987. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29988. * @returns a new Mesh
  29989. */
  29990. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29991. /**
  29992. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29993. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29994. * @param name defines the name of the mesh to create
  29995. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29996. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29997. * @param closePath creates a seam between the first and the last points of each path of the path array
  29998. * @param offset is taken in account only if the `pathArray` is containing a single path
  29999. * @param scene defines the hosting scene
  30000. * @param updatable defines if the mesh must be flagged as updatable
  30001. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30002. * @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)
  30003. * @returns a new Mesh
  30004. */
  30005. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30006. /**
  30007. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  30008. * @param name defines the name of the mesh to create
  30009. * @param radius sets the radius size (float) of the polygon (default 0.5)
  30010. * @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
  30011. * @param scene defines the hosting scene
  30012. * @param updatable defines if the mesh must be flagged as updatable
  30013. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30014. * @returns a new Mesh
  30015. */
  30016. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  30017. /**
  30018. * Creates a box 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 size sets the size (float) of each box side (default 1)
  30021. * @param scene defines the hosting scene
  30022. * @param updatable defines if the mesh must be flagged as updatable
  30023. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30024. * @returns a new Mesh
  30025. */
  30026. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  30027. /**
  30028. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  30029. * @param name defines the name of the mesh to create
  30030. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  30031. * @param diameter sets the diameter size (float) of the sphere (default 1)
  30032. * @param scene defines the hosting scene
  30033. * @param updatable defines if the mesh must be flagged as updatable
  30034. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30035. * @returns a new Mesh
  30036. */
  30037. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30038. /**
  30039. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  30040. * @param name defines the name of the mesh to create
  30041. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  30042. * @param diameter sets the diameter size (float) of the sphere (default 1)
  30043. * @param scene defines the hosting scene
  30044. * @returns a new Mesh
  30045. */
  30046. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  30047. /**
  30048. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  30049. * @param name defines the name of the mesh to create
  30050. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  30051. * @param diameterTop set the top cap diameter (floats, default 1)
  30052. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  30053. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  30054. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  30055. * @param scene defines the hosting scene
  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. * @returns a new Mesh
  30059. */
  30060. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  30061. /**
  30062. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  30063. * @param name defines the name of the mesh to create
  30064. * @param diameter sets the diameter size (float) of the torus (default 1)
  30065. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  30066. * @param tessellation sets the number of torus sides (postive integer, default 16)
  30067. * @param scene defines the hosting scene
  30068. * @param updatable defines if the mesh must be flagged as updatable
  30069. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30070. * @returns a new Mesh
  30071. */
  30072. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30073. /**
  30074. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30075. * @param name defines the name of the mesh to create
  30076. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30077. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30078. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30079. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30080. * @param p the number of windings on X axis (positive integers, default 2)
  30081. * @param q the number of windings on Y axis (positive integers, default 3)
  30082. * @param scene defines the hosting scene
  30083. * @param updatable defines if the mesh must be flagged as updatable
  30084. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30085. * @returns a new Mesh
  30086. */
  30087. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30088. /**
  30089. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30090. * @param name defines the name of the mesh to create
  30091. * @param points is an array successive Vector3
  30092. * @param scene defines the hosting scene
  30093. * @param updatable defines if the mesh must be flagged as updatable
  30094. * @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).
  30095. * @returns a new Mesh
  30096. */
  30097. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30098. /**
  30099. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30100. * @param name defines the name of the mesh to create
  30101. * @param points is an array successive Vector3
  30102. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30103. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30104. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30105. * @param scene defines the hosting scene
  30106. * @param updatable defines if the mesh must be flagged as updatable
  30107. * @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)
  30108. * @returns a new Mesh
  30109. */
  30110. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30111. /**
  30112. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30113. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30114. * 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.
  30115. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30116. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30117. * Remember you can only change the shape positions, not their number when updating a polygon.
  30118. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30119. * @param name defines the name of the mesh to create
  30120. * @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
  30121. * @param scene defines the hosting scene
  30122. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30123. * @param updatable defines if the mesh must be flagged as updatable
  30124. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30125. * @param earcutInjection can be used to inject your own earcut reference
  30126. * @returns a new Mesh
  30127. */
  30128. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30129. /**
  30130. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30131. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30132. * @param name defines the name of the mesh to create
  30133. * @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
  30134. * @param depth defines the height of extrusion
  30135. * @param scene defines the hosting scene
  30136. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30137. * @param updatable defines if the mesh must be flagged as updatable
  30138. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30139. * @param earcutInjection can be used to inject your own earcut reference
  30140. * @returns a new Mesh
  30141. */
  30142. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30143. /**
  30144. * Creates an extruded shape mesh.
  30145. * 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
  30146. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30147. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30148. * @param name defines the name of the mesh to create
  30149. * @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
  30150. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30151. * @param scale is the value to scale the shape
  30152. * @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
  30153. * @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
  30154. * @param scene defines the hosting scene
  30155. * @param updatable defines if the mesh must be flagged as updatable
  30156. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30157. * @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)
  30158. * @returns a new Mesh
  30159. */
  30160. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30161. /**
  30162. * Creates an custom extruded shape mesh.
  30163. * The custom extrusion is a parametric shape.
  30164. * It has no predefined shape. Its final shape will depend on the input parameters.
  30165. * Please consider using the same method from the MeshBuilder class instead
  30166. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30167. * @param name defines the name of the mesh to create
  30168. * @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
  30169. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30170. * @param scaleFunction is a custom Javascript function called on each path point
  30171. * @param rotationFunction is a custom Javascript function called on each path point
  30172. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30173. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30174. * @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
  30175. * @param scene defines the hosting scene
  30176. * @param updatable defines if the mesh must be flagged as updatable
  30177. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30178. * @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)
  30179. * @returns a new Mesh
  30180. */
  30181. 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;
  30182. /**
  30183. * Creates lathe mesh.
  30184. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30185. * Please consider using the same method from the MeshBuilder class instead
  30186. * @param name defines the name of the mesh to create
  30187. * @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
  30188. * @param radius is the radius value of the lathe
  30189. * @param tessellation is the side number of the lathe.
  30190. * @param scene defines the hosting scene
  30191. * @param updatable defines if the mesh must be flagged as updatable
  30192. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30193. * @returns a new Mesh
  30194. */
  30195. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30196. /**
  30197. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30198. * @param name defines the name of the mesh to create
  30199. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30200. * @param scene defines the hosting scene
  30201. * @param updatable defines if the mesh must be flagged as updatable
  30202. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30203. * @returns a new Mesh
  30204. */
  30205. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30206. /**
  30207. * Creates a ground mesh.
  30208. * Please consider using the same method from the MeshBuilder class instead
  30209. * @param name defines the name of the mesh to create
  30210. * @param width set the width of the ground
  30211. * @param height set the height of the ground
  30212. * @param subdivisions sets the number of subdivisions per side
  30213. * @param scene defines the hosting scene
  30214. * @param updatable defines if the mesh must be flagged as updatable
  30215. * @returns a new Mesh
  30216. */
  30217. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30218. /**
  30219. * Creates a tiled ground mesh.
  30220. * Please consider using the same method from the MeshBuilder class instead
  30221. * @param name defines the name of the mesh to create
  30222. * @param xmin set the ground minimum X coordinate
  30223. * @param zmin set the ground minimum Y coordinate
  30224. * @param xmax set the ground maximum X coordinate
  30225. * @param zmax set the ground maximum Z coordinate
  30226. * @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
  30227. * @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
  30228. * @param scene defines the hosting scene
  30229. * @param updatable defines if the mesh must be flagged as updatable
  30230. * @returns a new Mesh
  30231. */
  30232. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30233. w: number;
  30234. h: number;
  30235. }, precision: {
  30236. w: number;
  30237. h: number;
  30238. }, scene: Scene, updatable?: boolean): Mesh;
  30239. /**
  30240. * Creates a ground mesh from a height map.
  30241. * Please consider using the same method from the MeshBuilder class instead
  30242. * @see https://doc.babylonjs.com/babylon101/height_map
  30243. * @param name defines the name of the mesh to create
  30244. * @param url sets the URL of the height map image resource
  30245. * @param width set the ground width size
  30246. * @param height set the ground height size
  30247. * @param subdivisions sets the number of subdivision per side
  30248. * @param minHeight is the minimum altitude on the ground
  30249. * @param maxHeight is the maximum altitude on the ground
  30250. * @param scene defines the hosting scene
  30251. * @param updatable defines if the mesh must be flagged as updatable
  30252. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30253. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30254. * @returns a new Mesh
  30255. */
  30256. 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;
  30257. /**
  30258. * Creates a tube mesh.
  30259. * The tube is a parametric shape.
  30260. * It has no predefined shape. Its final shape will depend on the input parameters.
  30261. * Please consider using the same method from the MeshBuilder class instead
  30262. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30263. * @param name defines the name of the mesh to create
  30264. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30265. * @param radius sets the tube radius size
  30266. * @param tessellation is the number of sides on the tubular surface
  30267. * @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
  30268. * @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
  30269. * @param scene defines the hosting scene
  30270. * @param updatable defines if the mesh must be flagged as updatable
  30271. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30272. * @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)
  30273. * @returns a new Mesh
  30274. */
  30275. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30276. (i: number, distance: number): number;
  30277. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30278. /**
  30279. * Creates a polyhedron mesh.
  30280. * Please consider using the same method from the MeshBuilder class instead.
  30281. * * 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
  30282. * * The parameter `size` (positive float, default 1) sets the polygon size
  30283. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30284. * * 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`
  30285. * * 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
  30286. * * 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)`)
  30287. * * 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
  30288. * * 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
  30289. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30290. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30291. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30292. * @param name defines the name of the mesh to create
  30293. * @param options defines the options used to create the mesh
  30294. * @param scene defines the hosting scene
  30295. * @returns a new Mesh
  30296. */
  30297. static CreatePolyhedron(name: string, options: {
  30298. type?: number;
  30299. size?: number;
  30300. sizeX?: number;
  30301. sizeY?: number;
  30302. sizeZ?: number;
  30303. custom?: any;
  30304. faceUV?: Vector4[];
  30305. faceColors?: Color4[];
  30306. updatable?: boolean;
  30307. sideOrientation?: number;
  30308. }, scene: Scene): Mesh;
  30309. /**
  30310. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30311. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30312. * * 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`)
  30313. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30314. * * 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
  30315. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30316. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30317. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30318. * @param name defines the name of the mesh
  30319. * @param options defines the options used to create the mesh
  30320. * @param scene defines the hosting scene
  30321. * @returns a new Mesh
  30322. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30323. */
  30324. static CreateIcoSphere(name: string, options: {
  30325. radius?: number;
  30326. flat?: boolean;
  30327. subdivisions?: number;
  30328. sideOrientation?: number;
  30329. updatable?: boolean;
  30330. }, scene: Scene): Mesh;
  30331. /**
  30332. * Creates a decal mesh.
  30333. * Please consider using the same method from the MeshBuilder class instead.
  30334. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30335. * @param name defines the name of the mesh
  30336. * @param sourceMesh defines the mesh receiving the decal
  30337. * @param position sets the position of the decal in world coordinates
  30338. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30339. * @param size sets the decal scaling
  30340. * @param angle sets the angle to rotate the decal
  30341. * @returns a new Mesh
  30342. */
  30343. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30344. /** Creates a Capsule Mesh
  30345. * @param name defines the name of the mesh.
  30346. * @param options the constructors options used to shape the mesh.
  30347. * @param scene defines the scene the mesh is scoped to.
  30348. * @returns the capsule mesh
  30349. * @see https://doc.babylonjs.com/how_to/capsule_shape
  30350. */
  30351. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  30352. /**
  30353. * Prepare internal position array for software CPU skinning
  30354. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30355. */
  30356. setPositionsForCPUSkinning(): Float32Array;
  30357. /**
  30358. * Prepare internal normal array for software CPU skinning
  30359. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30360. */
  30361. setNormalsForCPUSkinning(): Float32Array;
  30362. /**
  30363. * Updates the vertex buffer by applying transformation from the bones
  30364. * @param skeleton defines the skeleton to apply to current mesh
  30365. * @returns the current mesh
  30366. */
  30367. applySkeleton(skeleton: Skeleton): Mesh;
  30368. /**
  30369. * 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
  30370. * @param meshes defines the list of meshes to scan
  30371. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30372. */
  30373. static MinMax(meshes: AbstractMesh[]): {
  30374. min: Vector3;
  30375. max: Vector3;
  30376. };
  30377. /**
  30378. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30379. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30380. * @returns a vector3
  30381. */
  30382. static Center(meshesOrMinMaxVector: {
  30383. min: Vector3;
  30384. max: Vector3;
  30385. } | AbstractMesh[]): Vector3;
  30386. /**
  30387. * Merge the array of meshes into a single mesh for performance reasons.
  30388. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30389. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30390. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30391. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30392. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30393. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30394. * @returns a new mesh
  30395. */
  30396. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30397. /** @hidden */
  30398. addInstance(instance: InstancedMesh): void;
  30399. /** @hidden */
  30400. removeInstance(instance: InstancedMesh): void;
  30401. }
  30402. }
  30403. declare module "babylonjs/Cameras/camera" {
  30404. import { SmartArray } from "babylonjs/Misc/smartArray";
  30405. import { Observable } from "babylonjs/Misc/observable";
  30406. import { Nullable } from "babylonjs/types";
  30407. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30408. import { Scene } from "babylonjs/scene";
  30409. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30410. import { Node } from "babylonjs/node";
  30411. import { Mesh } from "babylonjs/Meshes/mesh";
  30412. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30413. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30414. import { Viewport } from "babylonjs/Maths/math.viewport";
  30415. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30416. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30417. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30418. import { Ray } from "babylonjs/Culling/ray";
  30419. /**
  30420. * This is the base class of all the camera used in the application.
  30421. * @see https://doc.babylonjs.com/features/cameras
  30422. */
  30423. export class Camera extends Node {
  30424. /** @hidden */
  30425. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30426. /**
  30427. * This is the default projection mode used by the cameras.
  30428. * It helps recreating a feeling of perspective and better appreciate depth.
  30429. * This is the best way to simulate real life cameras.
  30430. */
  30431. static readonly PERSPECTIVE_CAMERA: number;
  30432. /**
  30433. * This helps creating camera with an orthographic mode.
  30434. * 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.
  30435. */
  30436. static readonly ORTHOGRAPHIC_CAMERA: number;
  30437. /**
  30438. * This is the default FOV mode for perspective cameras.
  30439. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30440. */
  30441. static readonly FOVMODE_VERTICAL_FIXED: number;
  30442. /**
  30443. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30444. */
  30445. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30446. /**
  30447. * This specifies ther is no need for a camera rig.
  30448. * Basically only one eye is rendered corresponding to the camera.
  30449. */
  30450. static readonly RIG_MODE_NONE: number;
  30451. /**
  30452. * Simulates a camera Rig with one blue eye and one red eye.
  30453. * This can be use with 3d blue and red glasses.
  30454. */
  30455. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30456. /**
  30457. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30458. */
  30459. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30460. /**
  30461. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30462. */
  30463. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30464. /**
  30465. * Defines that both eyes of the camera will be rendered over under each other.
  30466. */
  30467. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30468. /**
  30469. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30470. */
  30471. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30472. /**
  30473. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30474. */
  30475. static readonly RIG_MODE_VR: number;
  30476. /**
  30477. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30478. */
  30479. static readonly RIG_MODE_WEBVR: number;
  30480. /**
  30481. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30482. */
  30483. static readonly RIG_MODE_CUSTOM: number;
  30484. /**
  30485. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30486. */
  30487. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30488. /**
  30489. * Define the input manager associated with the camera.
  30490. */
  30491. inputs: CameraInputsManager<Camera>;
  30492. /** @hidden */
  30493. _position: Vector3;
  30494. /**
  30495. * Define the current local position of the camera in the scene
  30496. */
  30497. get position(): Vector3;
  30498. set position(newPosition: Vector3);
  30499. protected _upVector: Vector3;
  30500. /**
  30501. * The vector the camera should consider as up.
  30502. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30503. */
  30504. set upVector(vec: Vector3);
  30505. get upVector(): Vector3;
  30506. /**
  30507. * Define the current limit on the left side for an orthographic camera
  30508. * In scene unit
  30509. */
  30510. orthoLeft: Nullable<number>;
  30511. /**
  30512. * Define the current limit on the right side for an orthographic camera
  30513. * In scene unit
  30514. */
  30515. orthoRight: Nullable<number>;
  30516. /**
  30517. * Define the current limit on the bottom side for an orthographic camera
  30518. * In scene unit
  30519. */
  30520. orthoBottom: Nullable<number>;
  30521. /**
  30522. * Define the current limit on the top side for an orthographic camera
  30523. * In scene unit
  30524. */
  30525. orthoTop: Nullable<number>;
  30526. /**
  30527. * Field Of View is set in Radians. (default is 0.8)
  30528. */
  30529. fov: number;
  30530. /**
  30531. * Define the minimum distance the camera can see from.
  30532. * This is important to note that the depth buffer are not infinite and the closer it starts
  30533. * the more your scene might encounter depth fighting issue.
  30534. */
  30535. minZ: number;
  30536. /**
  30537. * Define the maximum distance the camera can see to.
  30538. * This is important to note that the depth buffer are not infinite and the further it end
  30539. * the more your scene might encounter depth fighting issue.
  30540. */
  30541. maxZ: number;
  30542. /**
  30543. * Define the default inertia of the camera.
  30544. * This helps giving a smooth feeling to the camera movement.
  30545. */
  30546. inertia: number;
  30547. /**
  30548. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30549. */
  30550. mode: number;
  30551. /**
  30552. * Define whether the camera is intermediate.
  30553. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30554. */
  30555. isIntermediate: boolean;
  30556. /**
  30557. * Define the viewport of the camera.
  30558. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30559. */
  30560. viewport: Viewport;
  30561. /**
  30562. * Restricts the camera to viewing objects with the same layerMask.
  30563. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30564. */
  30565. layerMask: number;
  30566. /**
  30567. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30568. */
  30569. fovMode: number;
  30570. /**
  30571. * Rig mode of the camera.
  30572. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30573. * This is normally controlled byt the camera themselves as internal use.
  30574. */
  30575. cameraRigMode: number;
  30576. /**
  30577. * Defines the distance between both "eyes" in case of a RIG
  30578. */
  30579. interaxialDistance: number;
  30580. /**
  30581. * Defines if stereoscopic rendering is done side by side or over under.
  30582. */
  30583. isStereoscopicSideBySide: boolean;
  30584. /**
  30585. * 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
  30586. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30587. * else in the scene. (Eg. security camera)
  30588. *
  30589. * 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)
  30590. */
  30591. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30592. /**
  30593. * When set, the camera will render to this render target instead of the default canvas
  30594. *
  30595. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30596. */
  30597. outputRenderTarget: Nullable<RenderTargetTexture>;
  30598. /**
  30599. * Observable triggered when the camera view matrix has changed.
  30600. */
  30601. onViewMatrixChangedObservable: Observable<Camera>;
  30602. /**
  30603. * Observable triggered when the camera Projection matrix has changed.
  30604. */
  30605. onProjectionMatrixChangedObservable: Observable<Camera>;
  30606. /**
  30607. * Observable triggered when the inputs have been processed.
  30608. */
  30609. onAfterCheckInputsObservable: Observable<Camera>;
  30610. /**
  30611. * Observable triggered when reset has been called and applied to the camera.
  30612. */
  30613. onRestoreStateObservable: Observable<Camera>;
  30614. /**
  30615. * Is this camera a part of a rig system?
  30616. */
  30617. isRigCamera: boolean;
  30618. /**
  30619. * If isRigCamera set to true this will be set with the parent camera.
  30620. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30621. */
  30622. rigParent?: Camera;
  30623. /** @hidden */
  30624. _cameraRigParams: any;
  30625. /** @hidden */
  30626. _rigCameras: Camera[];
  30627. /** @hidden */
  30628. _rigPostProcess: Nullable<PostProcess>;
  30629. protected _webvrViewMatrix: Matrix;
  30630. /** @hidden */
  30631. _skipRendering: boolean;
  30632. /** @hidden */
  30633. _projectionMatrix: Matrix;
  30634. /** @hidden */
  30635. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30636. /** @hidden */
  30637. _activeMeshes: SmartArray<AbstractMesh>;
  30638. protected _globalPosition: Vector3;
  30639. /** @hidden */
  30640. _computedViewMatrix: Matrix;
  30641. private _doNotComputeProjectionMatrix;
  30642. private _transformMatrix;
  30643. private _frustumPlanes;
  30644. private _refreshFrustumPlanes;
  30645. private _storedFov;
  30646. private _stateStored;
  30647. /**
  30648. * Instantiates a new camera object.
  30649. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30650. * @see https://doc.babylonjs.com/features/cameras
  30651. * @param name Defines the name of the camera in the scene
  30652. * @param position Defines the position of the camera
  30653. * @param scene Defines the scene the camera belongs too
  30654. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30655. */
  30656. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30657. /**
  30658. * Store current camera state (fov, position, etc..)
  30659. * @returns the camera
  30660. */
  30661. storeState(): Camera;
  30662. /**
  30663. * Restores the camera state values if it has been stored. You must call storeState() first
  30664. */
  30665. protected _restoreStateValues(): boolean;
  30666. /**
  30667. * Restored camera state. You must call storeState() first.
  30668. * @returns true if restored and false otherwise
  30669. */
  30670. restoreState(): boolean;
  30671. /**
  30672. * Gets the class name of the camera.
  30673. * @returns the class name
  30674. */
  30675. getClassName(): string;
  30676. /** @hidden */
  30677. readonly _isCamera: boolean;
  30678. /**
  30679. * Gets a string representation of the camera useful for debug purpose.
  30680. * @param fullDetails Defines that a more verboe level of logging is required
  30681. * @returns the string representation
  30682. */
  30683. toString(fullDetails?: boolean): string;
  30684. /**
  30685. * Gets the current world space position of the camera.
  30686. */
  30687. get globalPosition(): Vector3;
  30688. /**
  30689. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30690. * @returns the active meshe list
  30691. */
  30692. getActiveMeshes(): SmartArray<AbstractMesh>;
  30693. /**
  30694. * Check whether a mesh is part of the current active mesh list of the camera
  30695. * @param mesh Defines the mesh to check
  30696. * @returns true if active, false otherwise
  30697. */
  30698. isActiveMesh(mesh: Mesh): boolean;
  30699. /**
  30700. * Is this camera ready to be used/rendered
  30701. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30702. * @return true if the camera is ready
  30703. */
  30704. isReady(completeCheck?: boolean): boolean;
  30705. /** @hidden */
  30706. _initCache(): void;
  30707. /** @hidden */
  30708. _updateCache(ignoreParentClass?: boolean): void;
  30709. /** @hidden */
  30710. _isSynchronized(): boolean;
  30711. /** @hidden */
  30712. _isSynchronizedViewMatrix(): boolean;
  30713. /** @hidden */
  30714. _isSynchronizedProjectionMatrix(): boolean;
  30715. /**
  30716. * Attach the input controls to a specific dom element to get the input from.
  30717. * @param element Defines the element the controls should be listened from
  30718. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30719. */
  30720. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30721. /**
  30722. * Detach the current controls from the specified dom element.
  30723. * @param element Defines the element to stop listening the inputs from
  30724. */
  30725. detachControl(element: HTMLElement): void;
  30726. /**
  30727. * Update the camera state according to the different inputs gathered during the frame.
  30728. */
  30729. update(): void;
  30730. /** @hidden */
  30731. _checkInputs(): void;
  30732. /** @hidden */
  30733. get rigCameras(): Camera[];
  30734. /**
  30735. * Gets the post process used by the rig cameras
  30736. */
  30737. get rigPostProcess(): Nullable<PostProcess>;
  30738. /**
  30739. * Internal, gets the first post proces.
  30740. * @returns the first post process to be run on this camera.
  30741. */
  30742. _getFirstPostProcess(): Nullable<PostProcess>;
  30743. private _cascadePostProcessesToRigCams;
  30744. /**
  30745. * Attach a post process to the camera.
  30746. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30747. * @param postProcess The post process to attach to the camera
  30748. * @param insertAt The position of the post process in case several of them are in use in the scene
  30749. * @returns the position the post process has been inserted at
  30750. */
  30751. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30752. /**
  30753. * Detach a post process to the camera.
  30754. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30755. * @param postProcess The post process to detach from the camera
  30756. */
  30757. detachPostProcess(postProcess: PostProcess): void;
  30758. /**
  30759. * Gets the current world matrix of the camera
  30760. */
  30761. getWorldMatrix(): Matrix;
  30762. /** @hidden */
  30763. _getViewMatrix(): Matrix;
  30764. /**
  30765. * Gets the current view matrix of the camera.
  30766. * @param force forces the camera to recompute the matrix without looking at the cached state
  30767. * @returns the view matrix
  30768. */
  30769. getViewMatrix(force?: boolean): Matrix;
  30770. /**
  30771. * Freeze the projection matrix.
  30772. * It will prevent the cache check of the camera projection compute and can speed up perf
  30773. * if no parameter of the camera are meant to change
  30774. * @param projection Defines manually a projection if necessary
  30775. */
  30776. freezeProjectionMatrix(projection?: Matrix): void;
  30777. /**
  30778. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30779. */
  30780. unfreezeProjectionMatrix(): void;
  30781. /**
  30782. * Gets the current projection matrix of the camera.
  30783. * @param force forces the camera to recompute the matrix without looking at the cached state
  30784. * @returns the projection matrix
  30785. */
  30786. getProjectionMatrix(force?: boolean): Matrix;
  30787. /**
  30788. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30789. * @returns a Matrix
  30790. */
  30791. getTransformationMatrix(): Matrix;
  30792. private _updateFrustumPlanes;
  30793. /**
  30794. * Checks if a cullable object (mesh...) is in the camera frustum
  30795. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30796. * @param target The object to check
  30797. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30798. * @returns true if the object is in frustum otherwise false
  30799. */
  30800. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30801. /**
  30802. * Checks if a cullable object (mesh...) is in the camera frustum
  30803. * Unlike isInFrustum this cheks the full bounding box
  30804. * @param target The object to check
  30805. * @returns true if the object is in frustum otherwise false
  30806. */
  30807. isCompletelyInFrustum(target: ICullable): boolean;
  30808. /**
  30809. * Gets a ray in the forward direction from the camera.
  30810. * @param length Defines the length of the ray to create
  30811. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30812. * @param origin Defines the start point of the ray which defaults to the camera position
  30813. * @returns the forward ray
  30814. */
  30815. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30816. /**
  30817. * Gets a ray in the forward direction from the camera.
  30818. * @param refRay the ray to (re)use when setting the values
  30819. * @param length Defines the length of the ray to create
  30820. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30821. * @param origin Defines the start point of the ray which defaults to the camera position
  30822. * @returns the forward ray
  30823. */
  30824. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30825. /**
  30826. * Releases resources associated with this node.
  30827. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30828. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30829. */
  30830. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30831. /** @hidden */
  30832. _isLeftCamera: boolean;
  30833. /**
  30834. * Gets the left camera of a rig setup in case of Rigged Camera
  30835. */
  30836. get isLeftCamera(): boolean;
  30837. /** @hidden */
  30838. _isRightCamera: boolean;
  30839. /**
  30840. * Gets the right camera of a rig setup in case of Rigged Camera
  30841. */
  30842. get isRightCamera(): boolean;
  30843. /**
  30844. * Gets the left camera of a rig setup in case of Rigged Camera
  30845. */
  30846. get leftCamera(): Nullable<FreeCamera>;
  30847. /**
  30848. * Gets the right camera of a rig setup in case of Rigged Camera
  30849. */
  30850. get rightCamera(): Nullable<FreeCamera>;
  30851. /**
  30852. * Gets the left camera target of a rig setup in case of Rigged Camera
  30853. * @returns the target position
  30854. */
  30855. getLeftTarget(): Nullable<Vector3>;
  30856. /**
  30857. * Gets the right camera target of a rig setup in case of Rigged Camera
  30858. * @returns the target position
  30859. */
  30860. getRightTarget(): Nullable<Vector3>;
  30861. /**
  30862. * @hidden
  30863. */
  30864. setCameraRigMode(mode: number, rigParams: any): void;
  30865. /** @hidden */
  30866. static _setStereoscopicRigMode(camera: Camera): void;
  30867. /** @hidden */
  30868. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30869. /** @hidden */
  30870. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30871. /** @hidden */
  30872. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30873. /** @hidden */
  30874. _getVRProjectionMatrix(): Matrix;
  30875. protected _updateCameraRotationMatrix(): void;
  30876. protected _updateWebVRCameraRotationMatrix(): void;
  30877. /**
  30878. * This function MUST be overwritten by the different WebVR cameras available.
  30879. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30880. * @hidden
  30881. */
  30882. _getWebVRProjectionMatrix(): Matrix;
  30883. /**
  30884. * This function MUST be overwritten by the different WebVR cameras available.
  30885. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30886. * @hidden
  30887. */
  30888. _getWebVRViewMatrix(): Matrix;
  30889. /** @hidden */
  30890. setCameraRigParameter(name: string, value: any): void;
  30891. /**
  30892. * needs to be overridden by children so sub has required properties to be copied
  30893. * @hidden
  30894. */
  30895. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30896. /**
  30897. * May need to be overridden by children
  30898. * @hidden
  30899. */
  30900. _updateRigCameras(): void;
  30901. /** @hidden */
  30902. _setupInputs(): void;
  30903. /**
  30904. * Serialiaze the camera setup to a json represention
  30905. * @returns the JSON representation
  30906. */
  30907. serialize(): any;
  30908. /**
  30909. * Clones the current camera.
  30910. * @param name The cloned camera name
  30911. * @returns the cloned camera
  30912. */
  30913. clone(name: string): Camera;
  30914. /**
  30915. * Gets the direction of the camera relative to a given local axis.
  30916. * @param localAxis Defines the reference axis to provide a relative direction.
  30917. * @return the direction
  30918. */
  30919. getDirection(localAxis: Vector3): Vector3;
  30920. /**
  30921. * Returns the current camera absolute rotation
  30922. */
  30923. get absoluteRotation(): Quaternion;
  30924. /**
  30925. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30926. * @param localAxis Defines the reference axis to provide a relative direction.
  30927. * @param result Defines the vector to store the result in
  30928. */
  30929. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30930. /**
  30931. * Gets a camera constructor for a given camera type
  30932. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30933. * @param name The name of the camera the result will be able to instantiate
  30934. * @param scene The scene the result will construct the camera in
  30935. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30936. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30937. * @returns a factory method to construc the camera
  30938. */
  30939. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30940. /**
  30941. * Compute the world matrix of the camera.
  30942. * @returns the camera world matrix
  30943. */
  30944. computeWorldMatrix(): Matrix;
  30945. /**
  30946. * Parse a JSON and creates the camera from the parsed information
  30947. * @param parsedCamera The JSON to parse
  30948. * @param scene The scene to instantiate the camera in
  30949. * @returns the newly constructed camera
  30950. */
  30951. static Parse(parsedCamera: any, scene: Scene): Camera;
  30952. }
  30953. }
  30954. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30955. import { Nullable } from "babylonjs/types";
  30956. import { Scene } from "babylonjs/scene";
  30957. import { Vector4 } from "babylonjs/Maths/math.vector";
  30958. import { Mesh } from "babylonjs/Meshes/mesh";
  30959. /**
  30960. * Class containing static functions to help procedurally build meshes
  30961. */
  30962. export class DiscBuilder {
  30963. /**
  30964. * Creates a plane polygonal mesh. By default, this is a disc
  30965. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30966. * * 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
  30967. * * 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
  30968. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30969. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30970. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30971. * @param name defines the name of the mesh
  30972. * @param options defines the options used to create the mesh
  30973. * @param scene defines the hosting scene
  30974. * @returns the plane polygonal mesh
  30975. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30976. */
  30977. static CreateDisc(name: string, options: {
  30978. radius?: number;
  30979. tessellation?: number;
  30980. arc?: number;
  30981. updatable?: boolean;
  30982. sideOrientation?: number;
  30983. frontUVs?: Vector4;
  30984. backUVs?: Vector4;
  30985. }, scene?: Nullable<Scene>): Mesh;
  30986. }
  30987. }
  30988. declare module "babylonjs/Materials/fresnelParameters" {
  30989. import { DeepImmutable } from "babylonjs/types";
  30990. import { Color3 } from "babylonjs/Maths/math.color";
  30991. /**
  30992. * Options to be used when creating a FresnelParameters.
  30993. */
  30994. export type IFresnelParametersCreationOptions = {
  30995. /**
  30996. * Define the color used on edges (grazing angle)
  30997. */
  30998. leftColor?: Color3;
  30999. /**
  31000. * Define the color used on center
  31001. */
  31002. rightColor?: Color3;
  31003. /**
  31004. * Define bias applied to computed fresnel term
  31005. */
  31006. bias?: number;
  31007. /**
  31008. * Defined the power exponent applied to fresnel term
  31009. */
  31010. power?: number;
  31011. /**
  31012. * Define if the fresnel effect is enable or not.
  31013. */
  31014. isEnabled?: boolean;
  31015. };
  31016. /**
  31017. * Serialized format for FresnelParameters.
  31018. */
  31019. export type IFresnelParametersSerialized = {
  31020. /**
  31021. * Define the color used on edges (grazing angle) [as an array]
  31022. */
  31023. leftColor: number[];
  31024. /**
  31025. * Define the color used on center [as an array]
  31026. */
  31027. rightColor: number[];
  31028. /**
  31029. * Define bias applied to computed fresnel term
  31030. */
  31031. bias: number;
  31032. /**
  31033. * Defined the power exponent applied to fresnel term
  31034. */
  31035. power?: number;
  31036. /**
  31037. * Define if the fresnel effect is enable or not.
  31038. */
  31039. isEnabled: boolean;
  31040. };
  31041. /**
  31042. * This represents all the required information to add a fresnel effect on a material:
  31043. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31044. */
  31045. export class FresnelParameters {
  31046. private _isEnabled;
  31047. /**
  31048. * Define if the fresnel effect is enable or not.
  31049. */
  31050. get isEnabled(): boolean;
  31051. set isEnabled(value: boolean);
  31052. /**
  31053. * Define the color used on edges (grazing angle)
  31054. */
  31055. leftColor: Color3;
  31056. /**
  31057. * Define the color used on center
  31058. */
  31059. rightColor: Color3;
  31060. /**
  31061. * Define bias applied to computed fresnel term
  31062. */
  31063. bias: number;
  31064. /**
  31065. * Defined the power exponent applied to fresnel term
  31066. */
  31067. power: number;
  31068. /**
  31069. * Creates a new FresnelParameters object.
  31070. *
  31071. * @param options provide your own settings to optionally to override defaults
  31072. */
  31073. constructor(options?: IFresnelParametersCreationOptions);
  31074. /**
  31075. * Clones the current fresnel and its valuues
  31076. * @returns a clone fresnel configuration
  31077. */
  31078. clone(): FresnelParameters;
  31079. /**
  31080. * Determines equality between FresnelParameters objects
  31081. * @param otherFresnelParameters defines the second operand
  31082. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31083. */
  31084. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31085. /**
  31086. * Serializes the current fresnel parameters to a JSON representation.
  31087. * @return the JSON serialization
  31088. */
  31089. serialize(): IFresnelParametersSerialized;
  31090. /**
  31091. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31092. * @param parsedFresnelParameters Define the JSON representation
  31093. * @returns the parsed parameters
  31094. */
  31095. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31096. }
  31097. }
  31098. declare module "babylonjs/Materials/materialFlags" {
  31099. /**
  31100. * This groups all the flags used to control the materials channel.
  31101. */
  31102. export class MaterialFlags {
  31103. private static _DiffuseTextureEnabled;
  31104. /**
  31105. * Are diffuse textures enabled in the application.
  31106. */
  31107. static get DiffuseTextureEnabled(): boolean;
  31108. static set DiffuseTextureEnabled(value: boolean);
  31109. private static _DetailTextureEnabled;
  31110. /**
  31111. * Are detail textures enabled in the application.
  31112. */
  31113. static get DetailTextureEnabled(): boolean;
  31114. static set DetailTextureEnabled(value: boolean);
  31115. private static _AmbientTextureEnabled;
  31116. /**
  31117. * Are ambient textures enabled in the application.
  31118. */
  31119. static get AmbientTextureEnabled(): boolean;
  31120. static set AmbientTextureEnabled(value: boolean);
  31121. private static _OpacityTextureEnabled;
  31122. /**
  31123. * Are opacity textures enabled in the application.
  31124. */
  31125. static get OpacityTextureEnabled(): boolean;
  31126. static set OpacityTextureEnabled(value: boolean);
  31127. private static _ReflectionTextureEnabled;
  31128. /**
  31129. * Are reflection textures enabled in the application.
  31130. */
  31131. static get ReflectionTextureEnabled(): boolean;
  31132. static set ReflectionTextureEnabled(value: boolean);
  31133. private static _EmissiveTextureEnabled;
  31134. /**
  31135. * Are emissive textures enabled in the application.
  31136. */
  31137. static get EmissiveTextureEnabled(): boolean;
  31138. static set EmissiveTextureEnabled(value: boolean);
  31139. private static _SpecularTextureEnabled;
  31140. /**
  31141. * Are specular textures enabled in the application.
  31142. */
  31143. static get SpecularTextureEnabled(): boolean;
  31144. static set SpecularTextureEnabled(value: boolean);
  31145. private static _BumpTextureEnabled;
  31146. /**
  31147. * Are bump textures enabled in the application.
  31148. */
  31149. static get BumpTextureEnabled(): boolean;
  31150. static set BumpTextureEnabled(value: boolean);
  31151. private static _LightmapTextureEnabled;
  31152. /**
  31153. * Are lightmap textures enabled in the application.
  31154. */
  31155. static get LightmapTextureEnabled(): boolean;
  31156. static set LightmapTextureEnabled(value: boolean);
  31157. private static _RefractionTextureEnabled;
  31158. /**
  31159. * Are refraction textures enabled in the application.
  31160. */
  31161. static get RefractionTextureEnabled(): boolean;
  31162. static set RefractionTextureEnabled(value: boolean);
  31163. private static _ColorGradingTextureEnabled;
  31164. /**
  31165. * Are color grading textures enabled in the application.
  31166. */
  31167. static get ColorGradingTextureEnabled(): boolean;
  31168. static set ColorGradingTextureEnabled(value: boolean);
  31169. private static _FresnelEnabled;
  31170. /**
  31171. * Are fresnels enabled in the application.
  31172. */
  31173. static get FresnelEnabled(): boolean;
  31174. static set FresnelEnabled(value: boolean);
  31175. private static _ClearCoatTextureEnabled;
  31176. /**
  31177. * Are clear coat textures enabled in the application.
  31178. */
  31179. static get ClearCoatTextureEnabled(): boolean;
  31180. static set ClearCoatTextureEnabled(value: boolean);
  31181. private static _ClearCoatBumpTextureEnabled;
  31182. /**
  31183. * Are clear coat bump textures enabled in the application.
  31184. */
  31185. static get ClearCoatBumpTextureEnabled(): boolean;
  31186. static set ClearCoatBumpTextureEnabled(value: boolean);
  31187. private static _ClearCoatTintTextureEnabled;
  31188. /**
  31189. * Are clear coat tint textures enabled in the application.
  31190. */
  31191. static get ClearCoatTintTextureEnabled(): boolean;
  31192. static set ClearCoatTintTextureEnabled(value: boolean);
  31193. private static _SheenTextureEnabled;
  31194. /**
  31195. * Are sheen textures enabled in the application.
  31196. */
  31197. static get SheenTextureEnabled(): boolean;
  31198. static set SheenTextureEnabled(value: boolean);
  31199. private static _AnisotropicTextureEnabled;
  31200. /**
  31201. * Are anisotropic textures enabled in the application.
  31202. */
  31203. static get AnisotropicTextureEnabled(): boolean;
  31204. static set AnisotropicTextureEnabled(value: boolean);
  31205. private static _ThicknessTextureEnabled;
  31206. /**
  31207. * Are thickness textures enabled in the application.
  31208. */
  31209. static get ThicknessTextureEnabled(): boolean;
  31210. static set ThicknessTextureEnabled(value: boolean);
  31211. }
  31212. }
  31213. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31214. /** @hidden */
  31215. export var defaultFragmentDeclaration: {
  31216. name: string;
  31217. shader: string;
  31218. };
  31219. }
  31220. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31221. /** @hidden */
  31222. export var defaultUboDeclaration: {
  31223. name: string;
  31224. shader: string;
  31225. };
  31226. }
  31227. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31228. /** @hidden */
  31229. export var prePassDeclaration: {
  31230. name: string;
  31231. shader: string;
  31232. };
  31233. }
  31234. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31235. /** @hidden */
  31236. export var lightFragmentDeclaration: {
  31237. name: string;
  31238. shader: string;
  31239. };
  31240. }
  31241. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31242. /** @hidden */
  31243. export var lightUboDeclaration: {
  31244. name: string;
  31245. shader: string;
  31246. };
  31247. }
  31248. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31249. /** @hidden */
  31250. export var lightsFragmentFunctions: {
  31251. name: string;
  31252. shader: string;
  31253. };
  31254. }
  31255. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31256. /** @hidden */
  31257. export var shadowsFragmentFunctions: {
  31258. name: string;
  31259. shader: string;
  31260. };
  31261. }
  31262. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31263. /** @hidden */
  31264. export var fresnelFunction: {
  31265. name: string;
  31266. shader: string;
  31267. };
  31268. }
  31269. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31270. /** @hidden */
  31271. export var bumpFragmentMainFunctions: {
  31272. name: string;
  31273. shader: string;
  31274. };
  31275. }
  31276. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31277. /** @hidden */
  31278. export var bumpFragmentFunctions: {
  31279. name: string;
  31280. shader: string;
  31281. };
  31282. }
  31283. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31284. /** @hidden */
  31285. export var logDepthDeclaration: {
  31286. name: string;
  31287. shader: string;
  31288. };
  31289. }
  31290. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31291. /** @hidden */
  31292. export var bumpFragment: {
  31293. name: string;
  31294. shader: string;
  31295. };
  31296. }
  31297. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31298. /** @hidden */
  31299. export var depthPrePass: {
  31300. name: string;
  31301. shader: string;
  31302. };
  31303. }
  31304. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31305. /** @hidden */
  31306. export var lightFragment: {
  31307. name: string;
  31308. shader: string;
  31309. };
  31310. }
  31311. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31312. /** @hidden */
  31313. export var logDepthFragment: {
  31314. name: string;
  31315. shader: string;
  31316. };
  31317. }
  31318. declare module "babylonjs/Shaders/default.fragment" {
  31319. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31322. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31323. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31326. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31327. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31328. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31329. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31330. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31331. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31332. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31333. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31334. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31335. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31336. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31337. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31338. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31339. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31340. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31341. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31342. /** @hidden */
  31343. export var defaultPixelShader: {
  31344. name: string;
  31345. shader: string;
  31346. };
  31347. }
  31348. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31349. /** @hidden */
  31350. export var defaultVertexDeclaration: {
  31351. name: string;
  31352. shader: string;
  31353. };
  31354. }
  31355. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31356. /** @hidden */
  31357. export var bumpVertexDeclaration: {
  31358. name: string;
  31359. shader: string;
  31360. };
  31361. }
  31362. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31363. /** @hidden */
  31364. export var bumpVertex: {
  31365. name: string;
  31366. shader: string;
  31367. };
  31368. }
  31369. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31370. /** @hidden */
  31371. export var fogVertex: {
  31372. name: string;
  31373. shader: string;
  31374. };
  31375. }
  31376. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31377. /** @hidden */
  31378. export var shadowsVertex: {
  31379. name: string;
  31380. shader: string;
  31381. };
  31382. }
  31383. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31384. /** @hidden */
  31385. export var pointCloudVertex: {
  31386. name: string;
  31387. shader: string;
  31388. };
  31389. }
  31390. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31391. /** @hidden */
  31392. export var logDepthVertex: {
  31393. name: string;
  31394. shader: string;
  31395. };
  31396. }
  31397. declare module "babylonjs/Shaders/default.vertex" {
  31398. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31399. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31400. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31401. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31402. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31403. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31404. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31405. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31406. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31407. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31408. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31409. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31410. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31411. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31412. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31413. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31414. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31415. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31416. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31417. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31418. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31419. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31420. /** @hidden */
  31421. export var defaultVertexShader: {
  31422. name: string;
  31423. shader: string;
  31424. };
  31425. }
  31426. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31427. import { Nullable } from "babylonjs/types";
  31428. import { Scene } from "babylonjs/scene";
  31429. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31430. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31431. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31432. /**
  31433. * @hidden
  31434. */
  31435. export interface IMaterialDetailMapDefines {
  31436. DETAIL: boolean;
  31437. DETAILDIRECTUV: number;
  31438. DETAIL_NORMALBLENDMETHOD: number;
  31439. /** @hidden */
  31440. _areTexturesDirty: boolean;
  31441. }
  31442. /**
  31443. * Define the code related to the detail map parameters of a material
  31444. *
  31445. * Inspired from:
  31446. * 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
  31447. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31448. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31449. */
  31450. export class DetailMapConfiguration {
  31451. private _texture;
  31452. /**
  31453. * The detail texture of the material.
  31454. */
  31455. texture: Nullable<BaseTexture>;
  31456. /**
  31457. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31458. * Bigger values mean stronger blending
  31459. */
  31460. diffuseBlendLevel: number;
  31461. /**
  31462. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31463. * Bigger values mean stronger blending. Only used with PBR materials
  31464. */
  31465. roughnessBlendLevel: number;
  31466. /**
  31467. * Defines how strong the bump effect from the detail map is
  31468. * Bigger values mean stronger effect
  31469. */
  31470. bumpLevel: number;
  31471. private _normalBlendMethod;
  31472. /**
  31473. * The method used to blend the bump and detail normals together
  31474. */
  31475. normalBlendMethod: number;
  31476. private _isEnabled;
  31477. /**
  31478. * Enable or disable the detail map on this material
  31479. */
  31480. isEnabled: boolean;
  31481. /** @hidden */
  31482. private _internalMarkAllSubMeshesAsTexturesDirty;
  31483. /** @hidden */
  31484. _markAllSubMeshesAsTexturesDirty(): void;
  31485. /**
  31486. * Instantiate a new detail map
  31487. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31488. */
  31489. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31490. /**
  31491. * Gets whether the submesh is ready to be used or not.
  31492. * @param defines the list of "defines" to update.
  31493. * @param scene defines the scene the material belongs to.
  31494. * @returns - boolean indicating that the submesh is ready or not.
  31495. */
  31496. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31497. /**
  31498. * Update the defines for detail map usage
  31499. * @param defines the list of "defines" to update.
  31500. * @param scene defines the scene the material belongs to.
  31501. */
  31502. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31503. /**
  31504. * Binds the material data.
  31505. * @param uniformBuffer defines the Uniform buffer to fill in.
  31506. * @param scene defines the scene the material belongs to.
  31507. * @param isFrozen defines whether the material is frozen or not.
  31508. */
  31509. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31510. /**
  31511. * Checks to see if a texture is used in the material.
  31512. * @param texture - Base texture to use.
  31513. * @returns - Boolean specifying if a texture is used in the material.
  31514. */
  31515. hasTexture(texture: BaseTexture): boolean;
  31516. /**
  31517. * Returns an array of the actively used textures.
  31518. * @param activeTextures Array of BaseTextures
  31519. */
  31520. getActiveTextures(activeTextures: BaseTexture[]): void;
  31521. /**
  31522. * Returns the animatable textures.
  31523. * @param animatables Array of animatable textures.
  31524. */
  31525. getAnimatables(animatables: IAnimatable[]): void;
  31526. /**
  31527. * Disposes the resources of the material.
  31528. * @param forceDisposeTextures - Forces the disposal of all textures.
  31529. */
  31530. dispose(forceDisposeTextures?: boolean): void;
  31531. /**
  31532. * Get the current class name useful for serialization or dynamic coding.
  31533. * @returns "DetailMap"
  31534. */
  31535. getClassName(): string;
  31536. /**
  31537. * Add the required uniforms to the current list.
  31538. * @param uniforms defines the current uniform list.
  31539. */
  31540. static AddUniforms(uniforms: string[]): void;
  31541. /**
  31542. * Add the required samplers to the current list.
  31543. * @param samplers defines the current sampler list.
  31544. */
  31545. static AddSamplers(samplers: string[]): void;
  31546. /**
  31547. * Add the required uniforms to the current buffer.
  31548. * @param uniformBuffer defines the current uniform buffer.
  31549. */
  31550. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31551. /**
  31552. * Makes a duplicate of the current instance into another one.
  31553. * @param detailMap define the instance where to copy the info
  31554. */
  31555. copyTo(detailMap: DetailMapConfiguration): void;
  31556. /**
  31557. * Serializes this detail map instance
  31558. * @returns - An object with the serialized instance.
  31559. */
  31560. serialize(): any;
  31561. /**
  31562. * Parses a detail map setting from a serialized object.
  31563. * @param source - Serialized object.
  31564. * @param scene Defines the scene we are parsing for
  31565. * @param rootUrl Defines the rootUrl to load from
  31566. */
  31567. parse(source: any, scene: Scene, rootUrl: string): void;
  31568. }
  31569. }
  31570. declare module "babylonjs/Materials/standardMaterial" {
  31571. import { SmartArray } from "babylonjs/Misc/smartArray";
  31572. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31573. import { Nullable } from "babylonjs/types";
  31574. import { Scene } from "babylonjs/scene";
  31575. import { Matrix } from "babylonjs/Maths/math.vector";
  31576. import { Color3 } from "babylonjs/Maths/math.color";
  31577. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31578. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31579. import { Mesh } from "babylonjs/Meshes/mesh";
  31580. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31581. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31582. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31583. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31584. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31585. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31586. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31587. import "babylonjs/Shaders/default.fragment";
  31588. import "babylonjs/Shaders/default.vertex";
  31589. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31590. /** @hidden */
  31591. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31592. MAINUV1: boolean;
  31593. MAINUV2: boolean;
  31594. DIFFUSE: boolean;
  31595. DIFFUSEDIRECTUV: number;
  31596. DETAIL: boolean;
  31597. DETAILDIRECTUV: number;
  31598. DETAIL_NORMALBLENDMETHOD: number;
  31599. AMBIENT: boolean;
  31600. AMBIENTDIRECTUV: number;
  31601. OPACITY: boolean;
  31602. OPACITYDIRECTUV: number;
  31603. OPACITYRGB: boolean;
  31604. REFLECTION: boolean;
  31605. EMISSIVE: boolean;
  31606. EMISSIVEDIRECTUV: number;
  31607. SPECULAR: boolean;
  31608. SPECULARDIRECTUV: number;
  31609. BUMP: boolean;
  31610. BUMPDIRECTUV: number;
  31611. PARALLAX: boolean;
  31612. PARALLAXOCCLUSION: boolean;
  31613. SPECULAROVERALPHA: boolean;
  31614. CLIPPLANE: boolean;
  31615. CLIPPLANE2: boolean;
  31616. CLIPPLANE3: boolean;
  31617. CLIPPLANE4: boolean;
  31618. CLIPPLANE5: boolean;
  31619. CLIPPLANE6: boolean;
  31620. ALPHATEST: boolean;
  31621. DEPTHPREPASS: boolean;
  31622. ALPHAFROMDIFFUSE: boolean;
  31623. POINTSIZE: boolean;
  31624. FOG: boolean;
  31625. SPECULARTERM: boolean;
  31626. DIFFUSEFRESNEL: boolean;
  31627. OPACITYFRESNEL: boolean;
  31628. REFLECTIONFRESNEL: boolean;
  31629. REFRACTIONFRESNEL: boolean;
  31630. EMISSIVEFRESNEL: boolean;
  31631. FRESNEL: boolean;
  31632. NORMAL: boolean;
  31633. UV1: boolean;
  31634. UV2: boolean;
  31635. VERTEXCOLOR: boolean;
  31636. VERTEXALPHA: boolean;
  31637. NUM_BONE_INFLUENCERS: number;
  31638. BonesPerMesh: number;
  31639. BONETEXTURE: boolean;
  31640. INSTANCES: boolean;
  31641. THIN_INSTANCES: boolean;
  31642. GLOSSINESS: boolean;
  31643. ROUGHNESS: boolean;
  31644. EMISSIVEASILLUMINATION: boolean;
  31645. LINKEMISSIVEWITHDIFFUSE: boolean;
  31646. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31647. LIGHTMAP: boolean;
  31648. LIGHTMAPDIRECTUV: number;
  31649. OBJECTSPACE_NORMALMAP: boolean;
  31650. USELIGHTMAPASSHADOWMAP: boolean;
  31651. REFLECTIONMAP_3D: boolean;
  31652. REFLECTIONMAP_SPHERICAL: boolean;
  31653. REFLECTIONMAP_PLANAR: boolean;
  31654. REFLECTIONMAP_CUBIC: boolean;
  31655. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31656. REFLECTIONMAP_PROJECTION: boolean;
  31657. REFLECTIONMAP_SKYBOX: boolean;
  31658. REFLECTIONMAP_EXPLICIT: boolean;
  31659. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31660. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31661. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31662. INVERTCUBICMAP: boolean;
  31663. LOGARITHMICDEPTH: boolean;
  31664. REFRACTION: boolean;
  31665. REFRACTIONMAP_3D: boolean;
  31666. REFLECTIONOVERALPHA: boolean;
  31667. TWOSIDEDLIGHTING: boolean;
  31668. SHADOWFLOAT: boolean;
  31669. MORPHTARGETS: boolean;
  31670. MORPHTARGETS_NORMAL: boolean;
  31671. MORPHTARGETS_TANGENT: boolean;
  31672. MORPHTARGETS_UV: boolean;
  31673. NUM_MORPH_INFLUENCERS: number;
  31674. NONUNIFORMSCALING: boolean;
  31675. PREMULTIPLYALPHA: boolean;
  31676. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31677. ALPHABLEND: boolean;
  31678. PREPASS: boolean;
  31679. PREPASS_IRRADIANCE: boolean;
  31680. PREPASS_IRRADIANCE_INDEX: number;
  31681. PREPASS_ALBEDO: boolean;
  31682. PREPASS_ALBEDO_INDEX: number;
  31683. PREPASS_DEPTHNORMAL: boolean;
  31684. PREPASS_DEPTHNORMAL_INDEX: number;
  31685. SCENE_MRT_COUNT: number;
  31686. RGBDLIGHTMAP: boolean;
  31687. RGBDREFLECTION: boolean;
  31688. RGBDREFRACTION: boolean;
  31689. IMAGEPROCESSING: boolean;
  31690. VIGNETTE: boolean;
  31691. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31692. VIGNETTEBLENDMODEOPAQUE: boolean;
  31693. TONEMAPPING: boolean;
  31694. TONEMAPPING_ACES: boolean;
  31695. CONTRAST: boolean;
  31696. COLORCURVES: boolean;
  31697. COLORGRADING: boolean;
  31698. COLORGRADING3D: boolean;
  31699. SAMPLER3DGREENDEPTH: boolean;
  31700. SAMPLER3DBGRMAP: boolean;
  31701. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31702. MULTIVIEW: boolean;
  31703. /**
  31704. * If the reflection texture on this material is in linear color space
  31705. * @hidden
  31706. */
  31707. IS_REFLECTION_LINEAR: boolean;
  31708. /**
  31709. * If the refraction texture on this material is in linear color space
  31710. * @hidden
  31711. */
  31712. IS_REFRACTION_LINEAR: boolean;
  31713. EXPOSURE: boolean;
  31714. constructor();
  31715. setReflectionMode(modeToEnable: string): void;
  31716. }
  31717. /**
  31718. * This is the default material used in Babylon. It is the best trade off between quality
  31719. * and performances.
  31720. * @see https://doc.babylonjs.com/babylon101/materials
  31721. */
  31722. export class StandardMaterial extends PushMaterial {
  31723. private _diffuseTexture;
  31724. /**
  31725. * The basic texture of the material as viewed under a light.
  31726. */
  31727. diffuseTexture: Nullable<BaseTexture>;
  31728. private _ambientTexture;
  31729. /**
  31730. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31731. */
  31732. ambientTexture: Nullable<BaseTexture>;
  31733. private _opacityTexture;
  31734. /**
  31735. * Define the transparency of the material from a texture.
  31736. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31737. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31738. */
  31739. opacityTexture: Nullable<BaseTexture>;
  31740. private _reflectionTexture;
  31741. /**
  31742. * Define the texture used to display the reflection.
  31743. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31744. */
  31745. reflectionTexture: Nullable<BaseTexture>;
  31746. private _emissiveTexture;
  31747. /**
  31748. * Define texture of the material as if self lit.
  31749. * This will be mixed in the final result even in the absence of light.
  31750. */
  31751. emissiveTexture: Nullable<BaseTexture>;
  31752. private _specularTexture;
  31753. /**
  31754. * Define how the color and intensity of the highlight given by the light in the material.
  31755. */
  31756. specularTexture: Nullable<BaseTexture>;
  31757. private _bumpTexture;
  31758. /**
  31759. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31760. * 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.
  31761. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31762. */
  31763. bumpTexture: Nullable<BaseTexture>;
  31764. private _lightmapTexture;
  31765. /**
  31766. * Complex lighting can be computationally expensive to compute at runtime.
  31767. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31768. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31769. */
  31770. lightmapTexture: Nullable<BaseTexture>;
  31771. private _refractionTexture;
  31772. /**
  31773. * Define the texture used to display the refraction.
  31774. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31775. */
  31776. refractionTexture: Nullable<BaseTexture>;
  31777. /**
  31778. * The color of the material lit by the environmental background lighting.
  31779. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31780. */
  31781. ambientColor: Color3;
  31782. /**
  31783. * The basic color of the material as viewed under a light.
  31784. */
  31785. diffuseColor: Color3;
  31786. /**
  31787. * Define how the color and intensity of the highlight given by the light in the material.
  31788. */
  31789. specularColor: Color3;
  31790. /**
  31791. * Define the color of the material as if self lit.
  31792. * This will be mixed in the final result even in the absence of light.
  31793. */
  31794. emissiveColor: Color3;
  31795. /**
  31796. * Defines how sharp are the highlights in the material.
  31797. * The bigger the value the sharper giving a more glossy feeling to the result.
  31798. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31799. */
  31800. specularPower: number;
  31801. private _useAlphaFromDiffuseTexture;
  31802. /**
  31803. * Does the transparency come from the diffuse texture alpha channel.
  31804. */
  31805. useAlphaFromDiffuseTexture: boolean;
  31806. private _useEmissiveAsIllumination;
  31807. /**
  31808. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31809. */
  31810. useEmissiveAsIllumination: boolean;
  31811. private _linkEmissiveWithDiffuse;
  31812. /**
  31813. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31814. * the emissive level when the final color is close to one.
  31815. */
  31816. linkEmissiveWithDiffuse: boolean;
  31817. private _useSpecularOverAlpha;
  31818. /**
  31819. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31820. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31821. */
  31822. useSpecularOverAlpha: boolean;
  31823. private _useReflectionOverAlpha;
  31824. /**
  31825. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31826. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31827. */
  31828. useReflectionOverAlpha: boolean;
  31829. private _disableLighting;
  31830. /**
  31831. * Does lights from the scene impacts this material.
  31832. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31833. */
  31834. disableLighting: boolean;
  31835. private _useObjectSpaceNormalMap;
  31836. /**
  31837. * Allows using an object space normal map (instead of tangent space).
  31838. */
  31839. useObjectSpaceNormalMap: boolean;
  31840. private _useParallax;
  31841. /**
  31842. * Is parallax enabled or not.
  31843. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31844. */
  31845. useParallax: boolean;
  31846. private _useParallaxOcclusion;
  31847. /**
  31848. * Is parallax occlusion enabled or not.
  31849. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31850. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31851. */
  31852. useParallaxOcclusion: boolean;
  31853. /**
  31854. * 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.
  31855. */
  31856. parallaxScaleBias: number;
  31857. private _roughness;
  31858. /**
  31859. * Helps to define how blurry the reflections should appears in the material.
  31860. */
  31861. roughness: number;
  31862. /**
  31863. * In case of refraction, define the value of the index of refraction.
  31864. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31865. */
  31866. indexOfRefraction: number;
  31867. /**
  31868. * Invert the refraction texture alongside the y axis.
  31869. * It can be useful with procedural textures or probe for instance.
  31870. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31871. */
  31872. invertRefractionY: boolean;
  31873. /**
  31874. * Defines the alpha limits in alpha test mode.
  31875. */
  31876. alphaCutOff: number;
  31877. private _useLightmapAsShadowmap;
  31878. /**
  31879. * In case of light mapping, define whether the map contains light or shadow informations.
  31880. */
  31881. useLightmapAsShadowmap: boolean;
  31882. private _diffuseFresnelParameters;
  31883. /**
  31884. * Define the diffuse fresnel parameters of the material.
  31885. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31886. */
  31887. diffuseFresnelParameters: FresnelParameters;
  31888. private _opacityFresnelParameters;
  31889. /**
  31890. * Define the opacity fresnel parameters of the material.
  31891. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31892. */
  31893. opacityFresnelParameters: FresnelParameters;
  31894. private _reflectionFresnelParameters;
  31895. /**
  31896. * Define the reflection fresnel parameters of the material.
  31897. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31898. */
  31899. reflectionFresnelParameters: FresnelParameters;
  31900. private _refractionFresnelParameters;
  31901. /**
  31902. * Define the refraction fresnel parameters of the material.
  31903. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31904. */
  31905. refractionFresnelParameters: FresnelParameters;
  31906. private _emissiveFresnelParameters;
  31907. /**
  31908. * Define the emissive fresnel parameters of the material.
  31909. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31910. */
  31911. emissiveFresnelParameters: FresnelParameters;
  31912. private _useReflectionFresnelFromSpecular;
  31913. /**
  31914. * If true automatically deducts the fresnels values from the material specularity.
  31915. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31916. */
  31917. useReflectionFresnelFromSpecular: boolean;
  31918. private _useGlossinessFromSpecularMapAlpha;
  31919. /**
  31920. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31921. */
  31922. useGlossinessFromSpecularMapAlpha: boolean;
  31923. private _maxSimultaneousLights;
  31924. /**
  31925. * Defines the maximum number of lights that can be used in the material
  31926. */
  31927. maxSimultaneousLights: number;
  31928. private _invertNormalMapX;
  31929. /**
  31930. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31931. */
  31932. invertNormalMapX: boolean;
  31933. private _invertNormalMapY;
  31934. /**
  31935. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31936. */
  31937. invertNormalMapY: boolean;
  31938. private _twoSidedLighting;
  31939. /**
  31940. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31941. */
  31942. twoSidedLighting: boolean;
  31943. /**
  31944. * Default configuration related to image processing available in the standard Material.
  31945. */
  31946. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31947. /**
  31948. * Gets the image processing configuration used either in this material.
  31949. */
  31950. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31951. /**
  31952. * Sets the Default image processing configuration used either in the this material.
  31953. *
  31954. * If sets to null, the scene one is in use.
  31955. */
  31956. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31957. /**
  31958. * Keep track of the image processing observer to allow dispose and replace.
  31959. */
  31960. private _imageProcessingObserver;
  31961. /**
  31962. * Attaches a new image processing configuration to the Standard Material.
  31963. * @param configuration
  31964. */
  31965. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31966. /**
  31967. * Gets wether the color curves effect is enabled.
  31968. */
  31969. get cameraColorCurvesEnabled(): boolean;
  31970. /**
  31971. * Sets wether the color curves effect is enabled.
  31972. */
  31973. set cameraColorCurvesEnabled(value: boolean);
  31974. /**
  31975. * Gets wether the color grading effect is enabled.
  31976. */
  31977. get cameraColorGradingEnabled(): boolean;
  31978. /**
  31979. * Gets wether the color grading effect is enabled.
  31980. */
  31981. set cameraColorGradingEnabled(value: boolean);
  31982. /**
  31983. * Gets wether tonemapping is enabled or not.
  31984. */
  31985. get cameraToneMappingEnabled(): boolean;
  31986. /**
  31987. * Sets wether tonemapping is enabled or not
  31988. */
  31989. set cameraToneMappingEnabled(value: boolean);
  31990. /**
  31991. * The camera exposure used on this material.
  31992. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31993. * This corresponds to a photographic exposure.
  31994. */
  31995. get cameraExposure(): number;
  31996. /**
  31997. * The camera exposure used on this material.
  31998. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31999. * This corresponds to a photographic exposure.
  32000. */
  32001. set cameraExposure(value: number);
  32002. /**
  32003. * Gets The camera contrast used on this material.
  32004. */
  32005. get cameraContrast(): number;
  32006. /**
  32007. * Sets The camera contrast used on this material.
  32008. */
  32009. set cameraContrast(value: number);
  32010. /**
  32011. * Gets the Color Grading 2D Lookup Texture.
  32012. */
  32013. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  32014. /**
  32015. * Sets the Color Grading 2D Lookup Texture.
  32016. */
  32017. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  32018. /**
  32019. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  32020. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  32021. * 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;
  32022. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  32023. */
  32024. get cameraColorCurves(): Nullable<ColorCurves>;
  32025. /**
  32026. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  32027. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  32028. * 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;
  32029. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  32030. */
  32031. set cameraColorCurves(value: Nullable<ColorCurves>);
  32032. /**
  32033. * Can this material render to several textures at once
  32034. */
  32035. get canRenderToMRT(): boolean;
  32036. /**
  32037. * Defines the detail map parameters for the material.
  32038. */
  32039. readonly detailMap: DetailMapConfiguration;
  32040. protected _renderTargets: SmartArray<RenderTargetTexture>;
  32041. protected _worldViewProjectionMatrix: Matrix;
  32042. protected _globalAmbientColor: Color3;
  32043. protected _useLogarithmicDepth: boolean;
  32044. protected _rebuildInParallel: boolean;
  32045. /**
  32046. * Instantiates a new standard material.
  32047. * This is the default material used in Babylon. It is the best trade off between quality
  32048. * and performances.
  32049. * @see https://doc.babylonjs.com/babylon101/materials
  32050. * @param name Define the name of the material in the scene
  32051. * @param scene Define the scene the material belong to
  32052. */
  32053. constructor(name: string, scene: Scene);
  32054. /**
  32055. * Gets a boolean indicating that current material needs to register RTT
  32056. */
  32057. get hasRenderTargetTextures(): boolean;
  32058. /**
  32059. * Gets the current class name of the material e.g. "StandardMaterial"
  32060. * Mainly use in serialization.
  32061. * @returns the class name
  32062. */
  32063. getClassName(): string;
  32064. /**
  32065. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  32066. * You can try switching to logarithmic depth.
  32067. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  32068. */
  32069. get useLogarithmicDepth(): boolean;
  32070. set useLogarithmicDepth(value: boolean);
  32071. /**
  32072. * Specifies if the material will require alpha blending
  32073. * @returns a boolean specifying if alpha blending is needed
  32074. */
  32075. needAlphaBlending(): boolean;
  32076. /**
  32077. * Specifies if this material should be rendered in alpha test mode
  32078. * @returns a boolean specifying if an alpha test is needed.
  32079. */
  32080. needAlphaTesting(): boolean;
  32081. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  32082. /**
  32083. * Get the texture used for alpha test purpose.
  32084. * @returns the diffuse texture in case of the standard material.
  32085. */
  32086. getAlphaTestTexture(): Nullable<BaseTexture>;
  32087. /**
  32088. * Get if the submesh is ready to be used and all its information available.
  32089. * Child classes can use it to update shaders
  32090. * @param mesh defines the mesh to check
  32091. * @param subMesh defines which submesh to check
  32092. * @param useInstances specifies that instances should be used
  32093. * @returns a boolean indicating that the submesh is ready or not
  32094. */
  32095. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32096. /**
  32097. * Builds the material UBO layouts.
  32098. * Used internally during the effect preparation.
  32099. */
  32100. buildUniformLayout(): void;
  32101. /**
  32102. * Unbinds the material from the mesh
  32103. */
  32104. unbind(): void;
  32105. /**
  32106. * Binds the submesh to this material by preparing the effect and shader to draw
  32107. * @param world defines the world transformation matrix
  32108. * @param mesh defines the mesh containing the submesh
  32109. * @param subMesh defines the submesh to bind the material to
  32110. */
  32111. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32112. /**
  32113. * Get the list of animatables in the material.
  32114. * @returns the list of animatables object used in the material
  32115. */
  32116. getAnimatables(): IAnimatable[];
  32117. /**
  32118. * Gets the active textures from the material
  32119. * @returns an array of textures
  32120. */
  32121. getActiveTextures(): BaseTexture[];
  32122. /**
  32123. * Specifies if the material uses a texture
  32124. * @param texture defines the texture to check against the material
  32125. * @returns a boolean specifying if the material uses the texture
  32126. */
  32127. hasTexture(texture: BaseTexture): boolean;
  32128. /**
  32129. * Disposes the material
  32130. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32131. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32132. */
  32133. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32134. /**
  32135. * Makes a duplicate of the material, and gives it a new name
  32136. * @param name defines the new name for the duplicated material
  32137. * @returns the cloned material
  32138. */
  32139. clone(name: string): StandardMaterial;
  32140. /**
  32141. * Serializes this material in a JSON representation
  32142. * @returns the serialized material object
  32143. */
  32144. serialize(): any;
  32145. /**
  32146. * Creates a standard material from parsed material data
  32147. * @param source defines the JSON representation of the material
  32148. * @param scene defines the hosting scene
  32149. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32150. * @returns a new standard material
  32151. */
  32152. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32153. /**
  32154. * Are diffuse textures enabled in the application.
  32155. */
  32156. static get DiffuseTextureEnabled(): boolean;
  32157. static set DiffuseTextureEnabled(value: boolean);
  32158. /**
  32159. * Are detail textures enabled in the application.
  32160. */
  32161. static get DetailTextureEnabled(): boolean;
  32162. static set DetailTextureEnabled(value: boolean);
  32163. /**
  32164. * Are ambient textures enabled in the application.
  32165. */
  32166. static get AmbientTextureEnabled(): boolean;
  32167. static set AmbientTextureEnabled(value: boolean);
  32168. /**
  32169. * Are opacity textures enabled in the application.
  32170. */
  32171. static get OpacityTextureEnabled(): boolean;
  32172. static set OpacityTextureEnabled(value: boolean);
  32173. /**
  32174. * Are reflection textures enabled in the application.
  32175. */
  32176. static get ReflectionTextureEnabled(): boolean;
  32177. static set ReflectionTextureEnabled(value: boolean);
  32178. /**
  32179. * Are emissive textures enabled in the application.
  32180. */
  32181. static get EmissiveTextureEnabled(): boolean;
  32182. static set EmissiveTextureEnabled(value: boolean);
  32183. /**
  32184. * Are specular textures enabled in the application.
  32185. */
  32186. static get SpecularTextureEnabled(): boolean;
  32187. static set SpecularTextureEnabled(value: boolean);
  32188. /**
  32189. * Are bump textures enabled in the application.
  32190. */
  32191. static get BumpTextureEnabled(): boolean;
  32192. static set BumpTextureEnabled(value: boolean);
  32193. /**
  32194. * Are lightmap textures enabled in the application.
  32195. */
  32196. static get LightmapTextureEnabled(): boolean;
  32197. static set LightmapTextureEnabled(value: boolean);
  32198. /**
  32199. * Are refraction textures enabled in the application.
  32200. */
  32201. static get RefractionTextureEnabled(): boolean;
  32202. static set RefractionTextureEnabled(value: boolean);
  32203. /**
  32204. * Are color grading textures enabled in the application.
  32205. */
  32206. static get ColorGradingTextureEnabled(): boolean;
  32207. static set ColorGradingTextureEnabled(value: boolean);
  32208. /**
  32209. * Are fresnels enabled in the application.
  32210. */
  32211. static get FresnelEnabled(): boolean;
  32212. static set FresnelEnabled(value: boolean);
  32213. }
  32214. }
  32215. declare module "babylonjs/Particles/solidParticleSystem" {
  32216. import { Nullable } from "babylonjs/types";
  32217. import { Mesh } from "babylonjs/Meshes/mesh";
  32218. import { Scene, IDisposable } from "babylonjs/scene";
  32219. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32220. import { Material } from "babylonjs/Materials/material";
  32221. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32222. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32223. /**
  32224. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32225. *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.
  32226. * The SPS is also a particle system. It provides some methods to manage the particles.
  32227. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32228. *
  32229. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32230. */
  32231. export class SolidParticleSystem implements IDisposable {
  32232. /**
  32233. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32234. * Example : var p = SPS.particles[i];
  32235. */
  32236. particles: SolidParticle[];
  32237. /**
  32238. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32239. */
  32240. nbParticles: number;
  32241. /**
  32242. * If the particles must ever face the camera (default false). Useful for planar particles.
  32243. */
  32244. billboard: boolean;
  32245. /**
  32246. * Recompute normals when adding a shape
  32247. */
  32248. recomputeNormals: boolean;
  32249. /**
  32250. * This a counter ofr your own usage. It's not set by any SPS functions.
  32251. */
  32252. counter: number;
  32253. /**
  32254. * The SPS name. This name is also given to the underlying mesh.
  32255. */
  32256. name: string;
  32257. /**
  32258. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32259. */
  32260. mesh: Mesh;
  32261. /**
  32262. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32263. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32264. */
  32265. vars: any;
  32266. /**
  32267. * This array is populated when the SPS is set as 'pickable'.
  32268. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32269. * Each element of this array is an object `{idx: int, faceId: int}`.
  32270. * `idx` is the picked particle index in the `SPS.particles` array
  32271. * `faceId` is the picked face index counted within this particle.
  32272. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32273. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32274. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32275. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32276. */
  32277. pickedParticles: {
  32278. idx: number;
  32279. faceId: number;
  32280. }[];
  32281. /**
  32282. * This array is populated when the SPS is set as 'pickable'
  32283. * Each key of this array is a submesh index.
  32284. * Each element of this array is a second array defined like this :
  32285. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32286. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32287. * `idx` is the picked particle index in the `SPS.particles` array
  32288. * `faceId` is the picked face index counted within this particle.
  32289. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32290. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32291. */
  32292. pickedBySubMesh: {
  32293. idx: number;
  32294. faceId: number;
  32295. }[][];
  32296. /**
  32297. * This array is populated when `enableDepthSort` is set to true.
  32298. * Each element of this array is an instance of the class DepthSortedParticle.
  32299. */
  32300. depthSortedParticles: DepthSortedParticle[];
  32301. /**
  32302. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32303. * @hidden
  32304. */
  32305. _bSphereOnly: boolean;
  32306. /**
  32307. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32308. * @hidden
  32309. */
  32310. _bSphereRadiusFactor: number;
  32311. private _scene;
  32312. private _positions;
  32313. private _indices;
  32314. private _normals;
  32315. private _colors;
  32316. private _uvs;
  32317. private _indices32;
  32318. private _positions32;
  32319. private _normals32;
  32320. private _fixedNormal32;
  32321. private _colors32;
  32322. private _uvs32;
  32323. private _index;
  32324. private _updatable;
  32325. private _pickable;
  32326. private _isVisibilityBoxLocked;
  32327. private _alwaysVisible;
  32328. private _depthSort;
  32329. private _expandable;
  32330. private _shapeCounter;
  32331. private _copy;
  32332. private _color;
  32333. private _computeParticleColor;
  32334. private _computeParticleTexture;
  32335. private _computeParticleRotation;
  32336. private _computeParticleVertex;
  32337. private _computeBoundingBox;
  32338. private _depthSortParticles;
  32339. private _camera;
  32340. private _mustUnrotateFixedNormals;
  32341. private _particlesIntersect;
  32342. private _needs32Bits;
  32343. private _isNotBuilt;
  32344. private _lastParticleId;
  32345. private _idxOfId;
  32346. private _multimaterialEnabled;
  32347. private _useModelMaterial;
  32348. private _indicesByMaterial;
  32349. private _materialIndexes;
  32350. private _depthSortFunction;
  32351. private _materialSortFunction;
  32352. private _materials;
  32353. private _multimaterial;
  32354. private _materialIndexesById;
  32355. private _defaultMaterial;
  32356. private _autoUpdateSubMeshes;
  32357. private _tmpVertex;
  32358. /**
  32359. * Creates a SPS (Solid Particle System) object.
  32360. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32361. * @param scene (Scene) is the scene in which the SPS is added.
  32362. * @param options defines the options of the sps e.g.
  32363. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32364. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32365. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32366. * * 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.
  32367. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32368. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32369. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32370. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32371. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32372. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32373. */
  32374. constructor(name: string, scene: Scene, options?: {
  32375. updatable?: boolean;
  32376. isPickable?: boolean;
  32377. enableDepthSort?: boolean;
  32378. particleIntersection?: boolean;
  32379. boundingSphereOnly?: boolean;
  32380. bSphereRadiusFactor?: number;
  32381. expandable?: boolean;
  32382. useModelMaterial?: boolean;
  32383. enableMultiMaterial?: boolean;
  32384. });
  32385. /**
  32386. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32387. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32388. * @returns the created mesh
  32389. */
  32390. buildMesh(): Mesh;
  32391. /**
  32392. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32393. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32394. * Thus the particles generated from `digest()` have their property `position` set yet.
  32395. * @param mesh ( Mesh ) is the mesh to be digested
  32396. * @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
  32397. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32398. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32399. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32400. * @returns the current SPS
  32401. */
  32402. digest(mesh: Mesh, options?: {
  32403. facetNb?: number;
  32404. number?: number;
  32405. delta?: number;
  32406. storage?: [];
  32407. }): SolidParticleSystem;
  32408. /**
  32409. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32410. * @hidden
  32411. */
  32412. private _unrotateFixedNormals;
  32413. /**
  32414. * Resets the temporary working copy particle
  32415. * @hidden
  32416. */
  32417. private _resetCopy;
  32418. /**
  32419. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32420. * @param p the current index in the positions array to be updated
  32421. * @param ind the current index in the indices array
  32422. * @param shape a Vector3 array, the shape geometry
  32423. * @param positions the positions array to be updated
  32424. * @param meshInd the shape indices array
  32425. * @param indices the indices array to be updated
  32426. * @param meshUV the shape uv array
  32427. * @param uvs the uv array to be updated
  32428. * @param meshCol the shape color array
  32429. * @param colors the color array to be updated
  32430. * @param meshNor the shape normals array
  32431. * @param normals the normals array to be updated
  32432. * @param idx the particle index
  32433. * @param idxInShape the particle index in its shape
  32434. * @param options the addShape() method passed options
  32435. * @model the particle model
  32436. * @hidden
  32437. */
  32438. private _meshBuilder;
  32439. /**
  32440. * Returns a shape Vector3 array from positions float array
  32441. * @param positions float array
  32442. * @returns a vector3 array
  32443. * @hidden
  32444. */
  32445. private _posToShape;
  32446. /**
  32447. * Returns a shapeUV array from a float uvs (array deep copy)
  32448. * @param uvs as a float array
  32449. * @returns a shapeUV array
  32450. * @hidden
  32451. */
  32452. private _uvsToShapeUV;
  32453. /**
  32454. * Adds a new particle object in the particles array
  32455. * @param idx particle index in particles array
  32456. * @param id particle id
  32457. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32458. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32459. * @param model particle ModelShape object
  32460. * @param shapeId model shape identifier
  32461. * @param idxInShape index of the particle in the current model
  32462. * @param bInfo model bounding info object
  32463. * @param storage target storage array, if any
  32464. * @hidden
  32465. */
  32466. private _addParticle;
  32467. /**
  32468. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32469. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32470. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32471. * @param nb (positive integer) the number of particles to be created from this model
  32472. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32473. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32474. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32475. * @returns the number of shapes in the system
  32476. */
  32477. addShape(mesh: Mesh, nb: number, options?: {
  32478. positionFunction?: any;
  32479. vertexFunction?: any;
  32480. storage?: [];
  32481. }): number;
  32482. /**
  32483. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32484. * @hidden
  32485. */
  32486. private _rebuildParticle;
  32487. /**
  32488. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32489. * @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.
  32490. * @returns the SPS.
  32491. */
  32492. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32493. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32494. * Returns an array with the removed particles.
  32495. * 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.
  32496. * The SPS can't be empty so at least one particle needs to remain in place.
  32497. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32498. * @param start index of the first particle to remove
  32499. * @param end index of the last particle to remove (included)
  32500. * @returns an array populated with the removed particles
  32501. */
  32502. removeParticles(start: number, end: number): SolidParticle[];
  32503. /**
  32504. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32505. * @param solidParticleArray an array populated with Solid Particles objects
  32506. * @returns the SPS
  32507. */
  32508. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32509. /**
  32510. * Creates a new particle and modifies the SPS mesh geometry :
  32511. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32512. * - calls _addParticle() to populate the particle array
  32513. * factorized code from addShape() and insertParticlesFromArray()
  32514. * @param idx particle index in the particles array
  32515. * @param i particle index in its shape
  32516. * @param modelShape particle ModelShape object
  32517. * @param shape shape vertex array
  32518. * @param meshInd shape indices array
  32519. * @param meshUV shape uv array
  32520. * @param meshCol shape color array
  32521. * @param meshNor shape normals array
  32522. * @param bbInfo shape bounding info
  32523. * @param storage target particle storage
  32524. * @options addShape() passed options
  32525. * @hidden
  32526. */
  32527. private _insertNewParticle;
  32528. /**
  32529. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32530. * This method calls `updateParticle()` for each particle of the SPS.
  32531. * For an animated SPS, it is usually called within the render loop.
  32532. * 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.
  32533. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32534. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32535. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32536. * @returns the SPS.
  32537. */
  32538. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32539. /**
  32540. * Disposes the SPS.
  32541. */
  32542. dispose(): void;
  32543. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32544. * idx is the particle index in the SPS
  32545. * faceId is the picked face index counted within this particle.
  32546. * Returns null if the pickInfo can't identify a picked particle.
  32547. * @param pickingInfo (PickingInfo object)
  32548. * @returns {idx: number, faceId: number} or null
  32549. */
  32550. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32551. idx: number;
  32552. faceId: number;
  32553. }>;
  32554. /**
  32555. * Returns a SolidParticle object from its identifier : particle.id
  32556. * @param id (integer) the particle Id
  32557. * @returns the searched particle or null if not found in the SPS.
  32558. */
  32559. getParticleById(id: number): Nullable<SolidParticle>;
  32560. /**
  32561. * Returns a new array populated with the particles having the passed shapeId.
  32562. * @param shapeId (integer) the shape identifier
  32563. * @returns a new solid particle array
  32564. */
  32565. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32566. /**
  32567. * Populates the passed array "ref" with the particles having the passed shapeId.
  32568. * @param shapeId the shape identifier
  32569. * @returns the SPS
  32570. * @param ref
  32571. */
  32572. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32573. /**
  32574. * Computes the required SubMeshes according the materials assigned to the particles.
  32575. * @returns the solid particle system.
  32576. * Does nothing if called before the SPS mesh is built.
  32577. */
  32578. computeSubMeshes(): SolidParticleSystem;
  32579. /**
  32580. * Sorts the solid particles by material when MultiMaterial is enabled.
  32581. * Updates the indices32 array.
  32582. * Updates the indicesByMaterial array.
  32583. * Updates the mesh indices array.
  32584. * @returns the SPS
  32585. * @hidden
  32586. */
  32587. private _sortParticlesByMaterial;
  32588. /**
  32589. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32590. * @hidden
  32591. */
  32592. private _setMaterialIndexesById;
  32593. /**
  32594. * Returns an array with unique values of Materials from the passed array
  32595. * @param array the material array to be checked and filtered
  32596. * @hidden
  32597. */
  32598. private _filterUniqueMaterialId;
  32599. /**
  32600. * Sets a new Standard Material as _defaultMaterial if not already set.
  32601. * @hidden
  32602. */
  32603. private _setDefaultMaterial;
  32604. /**
  32605. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32606. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32607. * @returns the SPS.
  32608. */
  32609. refreshVisibleSize(): SolidParticleSystem;
  32610. /**
  32611. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32612. * @param size the size (float) of the visibility box
  32613. * note : this doesn't lock the SPS mesh bounding box.
  32614. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32615. */
  32616. setVisibilityBox(size: number): void;
  32617. /**
  32618. * Gets whether the SPS as always visible or not
  32619. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32620. */
  32621. get isAlwaysVisible(): boolean;
  32622. /**
  32623. * Sets the SPS as always visible or not
  32624. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32625. */
  32626. set isAlwaysVisible(val: boolean);
  32627. /**
  32628. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32629. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32630. */
  32631. set isVisibilityBoxLocked(val: boolean);
  32632. /**
  32633. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32634. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32635. */
  32636. get isVisibilityBoxLocked(): boolean;
  32637. /**
  32638. * Tells to `setParticles()` to compute the particle rotations or not.
  32639. * Default value : true. The SPS is faster when it's set to false.
  32640. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32641. */
  32642. set computeParticleRotation(val: boolean);
  32643. /**
  32644. * Tells to `setParticles()` to compute the particle colors or not.
  32645. * Default value : true. The SPS is faster when it's set to false.
  32646. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32647. */
  32648. set computeParticleColor(val: boolean);
  32649. set computeParticleTexture(val: boolean);
  32650. /**
  32651. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32652. * Default value : false. The SPS is faster when it's set to false.
  32653. * Note : the particle custom vertex positions aren't stored values.
  32654. */
  32655. set computeParticleVertex(val: boolean);
  32656. /**
  32657. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32658. */
  32659. set computeBoundingBox(val: boolean);
  32660. /**
  32661. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32662. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32663. * Default : `true`
  32664. */
  32665. set depthSortParticles(val: boolean);
  32666. /**
  32667. * Gets if `setParticles()` computes the particle rotations or not.
  32668. * Default value : true. The SPS is faster when it's set to false.
  32669. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32670. */
  32671. get computeParticleRotation(): boolean;
  32672. /**
  32673. * Gets if `setParticles()` computes the particle colors or not.
  32674. * Default value : true. The SPS is faster when it's set to false.
  32675. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32676. */
  32677. get computeParticleColor(): boolean;
  32678. /**
  32679. * Gets if `setParticles()` computes the particle textures or not.
  32680. * Default value : true. The SPS is faster when it's set to false.
  32681. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32682. */
  32683. get computeParticleTexture(): boolean;
  32684. /**
  32685. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32686. * Default value : false. The SPS is faster when it's set to false.
  32687. * Note : the particle custom vertex positions aren't stored values.
  32688. */
  32689. get computeParticleVertex(): boolean;
  32690. /**
  32691. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32692. */
  32693. get computeBoundingBox(): boolean;
  32694. /**
  32695. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32696. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32697. * Default : `true`
  32698. */
  32699. get depthSortParticles(): boolean;
  32700. /**
  32701. * Gets if the SPS is created as expandable at construction time.
  32702. * Default : `false`
  32703. */
  32704. get expandable(): boolean;
  32705. /**
  32706. * Gets if the SPS supports the Multi Materials
  32707. */
  32708. get multimaterialEnabled(): boolean;
  32709. /**
  32710. * Gets if the SPS uses the model materials for its own multimaterial.
  32711. */
  32712. get useModelMaterial(): boolean;
  32713. /**
  32714. * The SPS used material array.
  32715. */
  32716. get materials(): Material[];
  32717. /**
  32718. * Sets the SPS MultiMaterial from the passed materials.
  32719. * Note : the passed array is internally copied and not used then by reference.
  32720. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32721. */
  32722. setMultiMaterial(materials: Material[]): void;
  32723. /**
  32724. * The SPS computed multimaterial object
  32725. */
  32726. get multimaterial(): MultiMaterial;
  32727. set multimaterial(mm: MultiMaterial);
  32728. /**
  32729. * If the subMeshes must be updated on the next call to setParticles()
  32730. */
  32731. get autoUpdateSubMeshes(): boolean;
  32732. set autoUpdateSubMeshes(val: boolean);
  32733. /**
  32734. * This function does nothing. It may be overwritten to set all the particle first values.
  32735. * The SPS doesn't call this function, you may have to call it by your own.
  32736. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32737. */
  32738. initParticles(): void;
  32739. /**
  32740. * This function does nothing. It may be overwritten to recycle a particle.
  32741. * The SPS doesn't call this function, you may have to call it by your own.
  32742. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32743. * @param particle The particle to recycle
  32744. * @returns the recycled particle
  32745. */
  32746. recycleParticle(particle: SolidParticle): SolidParticle;
  32747. /**
  32748. * Updates a particle : this function should be overwritten by the user.
  32749. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32750. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32751. * @example : just set a particle position or velocity and recycle conditions
  32752. * @param particle The particle to update
  32753. * @returns the updated particle
  32754. */
  32755. updateParticle(particle: SolidParticle): SolidParticle;
  32756. /**
  32757. * Updates a vertex of a particle : it can be overwritten by the user.
  32758. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32759. * @param particle the current particle
  32760. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32761. * @param pt the index of the current vertex in the particle shape
  32762. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32763. * @example : just set a vertex particle position or color
  32764. * @returns the sps
  32765. */
  32766. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32767. /**
  32768. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32769. * This does nothing and may be overwritten by the user.
  32770. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32771. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32772. * @param update the boolean update value actually passed to setParticles()
  32773. */
  32774. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32775. /**
  32776. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32777. * This will be passed three parameters.
  32778. * This does nothing and may be overwritten by the user.
  32779. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32780. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32781. * @param update the boolean update value actually passed to setParticles()
  32782. */
  32783. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32784. }
  32785. }
  32786. declare module "babylonjs/Particles/solidParticle" {
  32787. import { Nullable } from "babylonjs/types";
  32788. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32789. import { Color4 } from "babylonjs/Maths/math.color";
  32790. import { Mesh } from "babylonjs/Meshes/mesh";
  32791. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32792. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32793. import { Plane } from "babylonjs/Maths/math.plane";
  32794. import { Material } from "babylonjs/Materials/material";
  32795. /**
  32796. * Represents one particle of a solid particle system.
  32797. */
  32798. export class SolidParticle {
  32799. /**
  32800. * particle global index
  32801. */
  32802. idx: number;
  32803. /**
  32804. * particle identifier
  32805. */
  32806. id: number;
  32807. /**
  32808. * The color of the particle
  32809. */
  32810. color: Nullable<Color4>;
  32811. /**
  32812. * The world space position of the particle.
  32813. */
  32814. position: Vector3;
  32815. /**
  32816. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32817. */
  32818. rotation: Vector3;
  32819. /**
  32820. * The world space rotation quaternion of the particle.
  32821. */
  32822. rotationQuaternion: Nullable<Quaternion>;
  32823. /**
  32824. * The scaling of the particle.
  32825. */
  32826. scaling: Vector3;
  32827. /**
  32828. * The uvs of the particle.
  32829. */
  32830. uvs: Vector4;
  32831. /**
  32832. * The current speed of the particle.
  32833. */
  32834. velocity: Vector3;
  32835. /**
  32836. * The pivot point in the particle local space.
  32837. */
  32838. pivot: Vector3;
  32839. /**
  32840. * Must the particle be translated from its pivot point in its local space ?
  32841. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32842. * Default : false
  32843. */
  32844. translateFromPivot: boolean;
  32845. /**
  32846. * Is the particle active or not ?
  32847. */
  32848. alive: boolean;
  32849. /**
  32850. * Is the particle visible or not ?
  32851. */
  32852. isVisible: boolean;
  32853. /**
  32854. * Index of this particle in the global "positions" array (Internal use)
  32855. * @hidden
  32856. */
  32857. _pos: number;
  32858. /**
  32859. * @hidden Index of this particle in the global "indices" array (Internal use)
  32860. */
  32861. _ind: number;
  32862. /**
  32863. * @hidden ModelShape of this particle (Internal use)
  32864. */
  32865. _model: ModelShape;
  32866. /**
  32867. * ModelShape id of this particle
  32868. */
  32869. shapeId: number;
  32870. /**
  32871. * Index of the particle in its shape id
  32872. */
  32873. idxInShape: number;
  32874. /**
  32875. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32876. */
  32877. _modelBoundingInfo: BoundingInfo;
  32878. /**
  32879. * @hidden Particle BoundingInfo object (Internal use)
  32880. */
  32881. _boundingInfo: BoundingInfo;
  32882. /**
  32883. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32884. */
  32885. _sps: SolidParticleSystem;
  32886. /**
  32887. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32888. */
  32889. _stillInvisible: boolean;
  32890. /**
  32891. * @hidden Last computed particle rotation matrix
  32892. */
  32893. _rotationMatrix: number[];
  32894. /**
  32895. * Parent particle Id, if any.
  32896. * Default null.
  32897. */
  32898. parentId: Nullable<number>;
  32899. /**
  32900. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32901. */
  32902. materialIndex: Nullable<number>;
  32903. /**
  32904. * Custom object or properties.
  32905. */
  32906. props: Nullable<any>;
  32907. /**
  32908. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32909. * The possible values are :
  32910. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32911. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32912. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32913. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32914. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32915. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32916. * */
  32917. cullingStrategy: number;
  32918. /**
  32919. * @hidden Internal global position in the SPS.
  32920. */
  32921. _globalPosition: Vector3;
  32922. /**
  32923. * Creates a Solid Particle object.
  32924. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32925. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32926. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32927. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32928. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32929. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32930. * @param shapeId (integer) is the model shape identifier in the SPS.
  32931. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32932. * @param sps defines the sps it is associated to
  32933. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32934. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32935. */
  32936. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32937. /**
  32938. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32939. * @param target the particle target
  32940. * @returns the current particle
  32941. */
  32942. copyToRef(target: SolidParticle): SolidParticle;
  32943. /**
  32944. * Legacy support, changed scale to scaling
  32945. */
  32946. get scale(): Vector3;
  32947. /**
  32948. * Legacy support, changed scale to scaling
  32949. */
  32950. set scale(scale: Vector3);
  32951. /**
  32952. * Legacy support, changed quaternion to rotationQuaternion
  32953. */
  32954. get quaternion(): Nullable<Quaternion>;
  32955. /**
  32956. * Legacy support, changed quaternion to rotationQuaternion
  32957. */
  32958. set quaternion(q: Nullable<Quaternion>);
  32959. /**
  32960. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32961. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32962. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32963. * @returns true if it intersects
  32964. */
  32965. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32966. /**
  32967. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32968. * A particle is in the frustum if its bounding box intersects the frustum
  32969. * @param frustumPlanes defines the frustum to test
  32970. * @returns true if the particle is in the frustum planes
  32971. */
  32972. isInFrustum(frustumPlanes: Plane[]): boolean;
  32973. /**
  32974. * get the rotation matrix of the particle
  32975. * @hidden
  32976. */
  32977. getRotationMatrix(m: Matrix): void;
  32978. }
  32979. /**
  32980. * Represents the shape of the model used by one particle of a solid particle system.
  32981. * SPS internal tool, don't use it manually.
  32982. */
  32983. export class ModelShape {
  32984. /**
  32985. * The shape id
  32986. * @hidden
  32987. */
  32988. shapeID: number;
  32989. /**
  32990. * flat array of model positions (internal use)
  32991. * @hidden
  32992. */
  32993. _shape: Vector3[];
  32994. /**
  32995. * flat array of model UVs (internal use)
  32996. * @hidden
  32997. */
  32998. _shapeUV: number[];
  32999. /**
  33000. * color array of the model
  33001. * @hidden
  33002. */
  33003. _shapeColors: number[];
  33004. /**
  33005. * indices array of the model
  33006. * @hidden
  33007. */
  33008. _indices: number[];
  33009. /**
  33010. * normals array of the model
  33011. * @hidden
  33012. */
  33013. _normals: number[];
  33014. /**
  33015. * length of the shape in the model indices array (internal use)
  33016. * @hidden
  33017. */
  33018. _indicesLength: number;
  33019. /**
  33020. * Custom position function (internal use)
  33021. * @hidden
  33022. */
  33023. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  33024. /**
  33025. * Custom vertex function (internal use)
  33026. * @hidden
  33027. */
  33028. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  33029. /**
  33030. * Model material (internal use)
  33031. * @hidden
  33032. */
  33033. _material: Nullable<Material>;
  33034. /**
  33035. * 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.
  33036. * SPS internal tool, don't use it manually.
  33037. * @hidden
  33038. */
  33039. 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>);
  33040. }
  33041. /**
  33042. * Represents a Depth Sorted Particle in the solid particle system.
  33043. * @hidden
  33044. */
  33045. export class DepthSortedParticle {
  33046. /**
  33047. * Particle index
  33048. */
  33049. idx: number;
  33050. /**
  33051. * Index of the particle in the "indices" array
  33052. */
  33053. ind: number;
  33054. /**
  33055. * Length of the particle shape in the "indices" array
  33056. */
  33057. indicesLength: number;
  33058. /**
  33059. * Squared distance from the particle to the camera
  33060. */
  33061. sqDistance: number;
  33062. /**
  33063. * Material index when used with MultiMaterials
  33064. */
  33065. materialIndex: number;
  33066. /**
  33067. * Creates a new sorted particle
  33068. * @param materialIndex
  33069. */
  33070. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  33071. }
  33072. /**
  33073. * Represents a solid particle vertex
  33074. */
  33075. export class SolidParticleVertex {
  33076. /**
  33077. * Vertex position
  33078. */
  33079. position: Vector3;
  33080. /**
  33081. * Vertex color
  33082. */
  33083. color: Color4;
  33084. /**
  33085. * Vertex UV
  33086. */
  33087. uv: Vector2;
  33088. /**
  33089. * Creates a new solid particle vertex
  33090. */
  33091. constructor();
  33092. /** Vertex x coordinate */
  33093. get x(): number;
  33094. set x(val: number);
  33095. /** Vertex y coordinate */
  33096. get y(): number;
  33097. set y(val: number);
  33098. /** Vertex z coordinate */
  33099. get z(): number;
  33100. set z(val: number);
  33101. }
  33102. }
  33103. declare module "babylonjs/Collisions/meshCollisionData" {
  33104. import { Collider } from "babylonjs/Collisions/collider";
  33105. import { Vector3 } from "babylonjs/Maths/math.vector";
  33106. import { Nullable } from "babylonjs/types";
  33107. import { Observer } from "babylonjs/Misc/observable";
  33108. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33109. /**
  33110. * @hidden
  33111. */
  33112. export class _MeshCollisionData {
  33113. _checkCollisions: boolean;
  33114. _collisionMask: number;
  33115. _collisionGroup: number;
  33116. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33117. _collider: Nullable<Collider>;
  33118. _oldPositionForCollisions: Vector3;
  33119. _diffPositionForCollisions: Vector3;
  33120. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33121. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33122. _collisionResponse: boolean;
  33123. }
  33124. }
  33125. declare module "babylonjs/Meshes/abstractMesh" {
  33126. import { Observable } from "babylonjs/Misc/observable";
  33127. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33128. import { Camera } from "babylonjs/Cameras/camera";
  33129. import { Scene, IDisposable } from "babylonjs/scene";
  33130. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33131. import { Node } from "babylonjs/node";
  33132. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33133. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33134. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33135. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33136. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33137. import { Material } from "babylonjs/Materials/material";
  33138. import { Light } from "babylonjs/Lights/light";
  33139. import { Skeleton } from "babylonjs/Bones/skeleton";
  33140. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33141. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33142. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33143. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33144. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33145. import { Plane } from "babylonjs/Maths/math.plane";
  33146. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33147. import { Ray } from "babylonjs/Culling/ray";
  33148. import { Collider } from "babylonjs/Collisions/collider";
  33149. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33150. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33151. /** @hidden */
  33152. class _FacetDataStorage {
  33153. facetPositions: Vector3[];
  33154. facetNormals: Vector3[];
  33155. facetPartitioning: number[][];
  33156. facetNb: number;
  33157. partitioningSubdivisions: number;
  33158. partitioningBBoxRatio: number;
  33159. facetDataEnabled: boolean;
  33160. facetParameters: any;
  33161. bbSize: Vector3;
  33162. subDiv: {
  33163. max: number;
  33164. X: number;
  33165. Y: number;
  33166. Z: number;
  33167. };
  33168. facetDepthSort: boolean;
  33169. facetDepthSortEnabled: boolean;
  33170. depthSortedIndices: IndicesArray;
  33171. depthSortedFacets: {
  33172. ind: number;
  33173. sqDistance: number;
  33174. }[];
  33175. facetDepthSortFunction: (f1: {
  33176. ind: number;
  33177. sqDistance: number;
  33178. }, f2: {
  33179. ind: number;
  33180. sqDistance: number;
  33181. }) => number;
  33182. facetDepthSortFrom: Vector3;
  33183. facetDepthSortOrigin: Vector3;
  33184. invertedMatrix: Matrix;
  33185. }
  33186. /**
  33187. * @hidden
  33188. **/
  33189. class _InternalAbstractMeshDataInfo {
  33190. _hasVertexAlpha: boolean;
  33191. _useVertexColors: boolean;
  33192. _numBoneInfluencers: number;
  33193. _applyFog: boolean;
  33194. _receiveShadows: boolean;
  33195. _facetData: _FacetDataStorage;
  33196. _visibility: number;
  33197. _skeleton: Nullable<Skeleton>;
  33198. _layerMask: number;
  33199. _computeBonesUsingShaders: boolean;
  33200. _isActive: boolean;
  33201. _onlyForInstances: boolean;
  33202. _isActiveIntermediate: boolean;
  33203. _onlyForInstancesIntermediate: boolean;
  33204. _actAsRegularMesh: boolean;
  33205. }
  33206. /**
  33207. * Class used to store all common mesh properties
  33208. */
  33209. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33210. /** No occlusion */
  33211. static OCCLUSION_TYPE_NONE: number;
  33212. /** Occlusion set to optimisitic */
  33213. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33214. /** Occlusion set to strict */
  33215. static OCCLUSION_TYPE_STRICT: number;
  33216. /** Use an accurante occlusion algorithm */
  33217. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33218. /** Use a conservative occlusion algorithm */
  33219. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33220. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33221. * Test order :
  33222. * Is the bounding sphere outside the frustum ?
  33223. * If not, are the bounding box vertices outside the frustum ?
  33224. * It not, then the cullable object is in the frustum.
  33225. */
  33226. static readonly CULLINGSTRATEGY_STANDARD: number;
  33227. /** Culling strategy : Bounding Sphere Only.
  33228. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33229. * It's also less accurate than the standard because some not visible objects can still be selected.
  33230. * Test : is the bounding sphere outside the frustum ?
  33231. * If not, then the cullable object is in the frustum.
  33232. */
  33233. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33234. /** Culling strategy : Optimistic Inclusion.
  33235. * This in an inclusion test first, then the standard exclusion test.
  33236. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33237. * 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.
  33238. * Anyway, it's as accurate as the standard strategy.
  33239. * Test :
  33240. * Is the cullable object bounding sphere center in the frustum ?
  33241. * If not, apply the default culling strategy.
  33242. */
  33243. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33244. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33245. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33246. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33247. * 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.
  33248. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33249. * Test :
  33250. * Is the cullable object bounding sphere center in the frustum ?
  33251. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33252. */
  33253. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33254. /**
  33255. * No billboard
  33256. */
  33257. static get BILLBOARDMODE_NONE(): number;
  33258. /** Billboard on X axis */
  33259. static get BILLBOARDMODE_X(): number;
  33260. /** Billboard on Y axis */
  33261. static get BILLBOARDMODE_Y(): number;
  33262. /** Billboard on Z axis */
  33263. static get BILLBOARDMODE_Z(): number;
  33264. /** Billboard on all axes */
  33265. static get BILLBOARDMODE_ALL(): number;
  33266. /** Billboard on using position instead of orientation */
  33267. static get BILLBOARDMODE_USE_POSITION(): number;
  33268. /** @hidden */
  33269. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33270. /**
  33271. * The culling strategy to use to check whether the mesh must be rendered or not.
  33272. * This value can be changed at any time and will be used on the next render mesh selection.
  33273. * The possible values are :
  33274. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33275. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33276. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33277. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33278. * Please read each static variable documentation to get details about the culling process.
  33279. * */
  33280. cullingStrategy: number;
  33281. /**
  33282. * Gets the number of facets in the mesh
  33283. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33284. */
  33285. get facetNb(): number;
  33286. /**
  33287. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33288. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33289. */
  33290. get partitioningSubdivisions(): number;
  33291. set partitioningSubdivisions(nb: number);
  33292. /**
  33293. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33294. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33295. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33296. */
  33297. get partitioningBBoxRatio(): number;
  33298. set partitioningBBoxRatio(ratio: number);
  33299. /**
  33300. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33301. * Works only for updatable meshes.
  33302. * Doesn't work with multi-materials
  33303. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33304. */
  33305. get mustDepthSortFacets(): boolean;
  33306. set mustDepthSortFacets(sort: boolean);
  33307. /**
  33308. * The location (Vector3) where the facet depth sort must be computed from.
  33309. * By default, the active camera position.
  33310. * Used only when facet depth sort is enabled
  33311. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33312. */
  33313. get facetDepthSortFrom(): Vector3;
  33314. set facetDepthSortFrom(location: Vector3);
  33315. /**
  33316. * gets a boolean indicating if facetData is enabled
  33317. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33318. */
  33319. get isFacetDataEnabled(): boolean;
  33320. /** @hidden */
  33321. _updateNonUniformScalingState(value: boolean): boolean;
  33322. /**
  33323. * An event triggered when this mesh collides with another one
  33324. */
  33325. onCollideObservable: Observable<AbstractMesh>;
  33326. /** Set a function to call when this mesh collides with another one */
  33327. set onCollide(callback: () => void);
  33328. /**
  33329. * An event triggered when the collision's position changes
  33330. */
  33331. onCollisionPositionChangeObservable: Observable<Vector3>;
  33332. /** Set a function to call when the collision's position changes */
  33333. set onCollisionPositionChange(callback: () => void);
  33334. /**
  33335. * An event triggered when material is changed
  33336. */
  33337. onMaterialChangedObservable: Observable<AbstractMesh>;
  33338. /**
  33339. * Gets or sets the orientation for POV movement & rotation
  33340. */
  33341. definedFacingForward: boolean;
  33342. /** @hidden */
  33343. _occlusionQuery: Nullable<WebGLQuery>;
  33344. /** @hidden */
  33345. _renderingGroup: Nullable<RenderingGroup>;
  33346. /**
  33347. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33348. */
  33349. get visibility(): number;
  33350. /**
  33351. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33352. */
  33353. set visibility(value: number);
  33354. /** Gets or sets the alpha index used to sort transparent meshes
  33355. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33356. */
  33357. alphaIndex: number;
  33358. /**
  33359. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33360. */
  33361. isVisible: boolean;
  33362. /**
  33363. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33364. */
  33365. isPickable: boolean;
  33366. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33367. showSubMeshesBoundingBox: boolean;
  33368. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33369. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33370. */
  33371. isBlocker: boolean;
  33372. /**
  33373. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33374. */
  33375. enablePointerMoveEvents: boolean;
  33376. private _renderingGroupId;
  33377. /**
  33378. * Specifies the rendering group id for this mesh (0 by default)
  33379. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33380. */
  33381. get renderingGroupId(): number;
  33382. set renderingGroupId(value: number);
  33383. private _material;
  33384. /** Gets or sets current material */
  33385. get material(): Nullable<Material>;
  33386. set material(value: Nullable<Material>);
  33387. /**
  33388. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33389. * @see https://doc.babylonjs.com/babylon101/shadows
  33390. */
  33391. get receiveShadows(): boolean;
  33392. set receiveShadows(value: boolean);
  33393. /** Defines color to use when rendering outline */
  33394. outlineColor: Color3;
  33395. /** Define width to use when rendering outline */
  33396. outlineWidth: number;
  33397. /** Defines color to use when rendering overlay */
  33398. overlayColor: Color3;
  33399. /** Defines alpha to use when rendering overlay */
  33400. overlayAlpha: number;
  33401. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33402. get hasVertexAlpha(): boolean;
  33403. set hasVertexAlpha(value: boolean);
  33404. /** 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) */
  33405. get useVertexColors(): boolean;
  33406. set useVertexColors(value: boolean);
  33407. /**
  33408. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33409. */
  33410. get computeBonesUsingShaders(): boolean;
  33411. set computeBonesUsingShaders(value: boolean);
  33412. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33413. get numBoneInfluencers(): number;
  33414. set numBoneInfluencers(value: number);
  33415. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33416. get applyFog(): boolean;
  33417. set applyFog(value: boolean);
  33418. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33419. useOctreeForRenderingSelection: boolean;
  33420. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33421. useOctreeForPicking: boolean;
  33422. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33423. useOctreeForCollisions: boolean;
  33424. /**
  33425. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33426. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33427. */
  33428. get layerMask(): number;
  33429. set layerMask(value: number);
  33430. /**
  33431. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33432. */
  33433. alwaysSelectAsActiveMesh: boolean;
  33434. /**
  33435. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33436. */
  33437. doNotSyncBoundingInfo: boolean;
  33438. /**
  33439. * Gets or sets the current action manager
  33440. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33441. */
  33442. actionManager: Nullable<AbstractActionManager>;
  33443. private _meshCollisionData;
  33444. /**
  33445. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33446. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33447. */
  33448. ellipsoid: Vector3;
  33449. /**
  33450. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33451. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33452. */
  33453. ellipsoidOffset: Vector3;
  33454. /**
  33455. * Gets or sets a collision mask used to mask collisions (default is -1).
  33456. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33457. */
  33458. get collisionMask(): number;
  33459. set collisionMask(mask: number);
  33460. /**
  33461. * Gets or sets a collision response flag (default is true).
  33462. * when collisionResponse is false, events are still triggered but colliding entity has no response
  33463. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  33464. * to respond to the collision.
  33465. */
  33466. get collisionResponse(): boolean;
  33467. set collisionResponse(response: boolean);
  33468. /**
  33469. * Gets or sets the current collision group mask (-1 by default).
  33470. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33471. */
  33472. get collisionGroup(): number;
  33473. set collisionGroup(mask: number);
  33474. /**
  33475. * Gets or sets current surrounding meshes (null by default).
  33476. *
  33477. * By default collision detection is tested against every mesh in the scene.
  33478. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33479. * meshes will be tested for the collision.
  33480. *
  33481. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33482. */
  33483. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33484. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33485. /**
  33486. * Defines edge width used when edgesRenderer is enabled
  33487. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33488. */
  33489. edgesWidth: number;
  33490. /**
  33491. * Defines edge color used when edgesRenderer is enabled
  33492. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33493. */
  33494. edgesColor: Color4;
  33495. /** @hidden */
  33496. _edgesRenderer: Nullable<IEdgesRenderer>;
  33497. /** @hidden */
  33498. _masterMesh: Nullable<AbstractMesh>;
  33499. /** @hidden */
  33500. _boundingInfo: Nullable<BoundingInfo>;
  33501. /** @hidden */
  33502. _renderId: number;
  33503. /**
  33504. * Gets or sets the list of subMeshes
  33505. * @see https://doc.babylonjs.com/how_to/multi_materials
  33506. */
  33507. subMeshes: SubMesh[];
  33508. /** @hidden */
  33509. _intersectionsInProgress: AbstractMesh[];
  33510. /** @hidden */
  33511. _unIndexed: boolean;
  33512. /** @hidden */
  33513. _lightSources: Light[];
  33514. /** Gets the list of lights affecting that mesh */
  33515. get lightSources(): Light[];
  33516. /** @hidden */
  33517. get _positions(): Nullable<Vector3[]>;
  33518. /** @hidden */
  33519. _waitingData: {
  33520. lods: Nullable<any>;
  33521. actions: Nullable<any>;
  33522. freezeWorldMatrix: Nullable<boolean>;
  33523. };
  33524. /** @hidden */
  33525. _bonesTransformMatrices: Nullable<Float32Array>;
  33526. /** @hidden */
  33527. _transformMatrixTexture: Nullable<RawTexture>;
  33528. /**
  33529. * Gets or sets a skeleton to apply skining transformations
  33530. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33531. */
  33532. set skeleton(value: Nullable<Skeleton>);
  33533. get skeleton(): Nullable<Skeleton>;
  33534. /**
  33535. * An event triggered when the mesh is rebuilt.
  33536. */
  33537. onRebuildObservable: Observable<AbstractMesh>;
  33538. /**
  33539. * Creates a new AbstractMesh
  33540. * @param name defines the name of the mesh
  33541. * @param scene defines the hosting scene
  33542. */
  33543. constructor(name: string, scene?: Nullable<Scene>);
  33544. /**
  33545. * Returns the string "AbstractMesh"
  33546. * @returns "AbstractMesh"
  33547. */
  33548. getClassName(): string;
  33549. /**
  33550. * Gets a string representation of the current mesh
  33551. * @param fullDetails defines a boolean indicating if full details must be included
  33552. * @returns a string representation of the current mesh
  33553. */
  33554. toString(fullDetails?: boolean): string;
  33555. /**
  33556. * @hidden
  33557. */
  33558. protected _getEffectiveParent(): Nullable<Node>;
  33559. /** @hidden */
  33560. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33561. /** @hidden */
  33562. _rebuild(): void;
  33563. /** @hidden */
  33564. _resyncLightSources(): void;
  33565. /** @hidden */
  33566. _resyncLightSource(light: Light): void;
  33567. /** @hidden */
  33568. _unBindEffect(): void;
  33569. /** @hidden */
  33570. _removeLightSource(light: Light, dispose: boolean): void;
  33571. private _markSubMeshesAsDirty;
  33572. /** @hidden */
  33573. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33574. /** @hidden */
  33575. _markSubMeshesAsAttributesDirty(): void;
  33576. /** @hidden */
  33577. _markSubMeshesAsMiscDirty(): void;
  33578. /**
  33579. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33580. */
  33581. get scaling(): Vector3;
  33582. set scaling(newScaling: Vector3);
  33583. /**
  33584. * Returns true if the mesh is blocked. Implemented by child classes
  33585. */
  33586. get isBlocked(): boolean;
  33587. /**
  33588. * Returns the mesh itself by default. Implemented by child classes
  33589. * @param camera defines the camera to use to pick the right LOD level
  33590. * @returns the currentAbstractMesh
  33591. */
  33592. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33593. /**
  33594. * Returns 0 by default. Implemented by child classes
  33595. * @returns an integer
  33596. */
  33597. getTotalVertices(): number;
  33598. /**
  33599. * Returns a positive integer : the total number of indices in this mesh geometry.
  33600. * @returns the numner of indices or zero if the mesh has no geometry.
  33601. */
  33602. getTotalIndices(): number;
  33603. /**
  33604. * Returns null by default. Implemented by child classes
  33605. * @returns null
  33606. */
  33607. getIndices(): Nullable<IndicesArray>;
  33608. /**
  33609. * Returns the array of the requested vertex data kind. Implemented by child classes
  33610. * @param kind defines the vertex data kind to use
  33611. * @returns null
  33612. */
  33613. getVerticesData(kind: string): Nullable<FloatArray>;
  33614. /**
  33615. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33616. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33617. * Note that a new underlying VertexBuffer object is created each call.
  33618. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33619. * @param kind defines vertex data kind:
  33620. * * VertexBuffer.PositionKind
  33621. * * VertexBuffer.UVKind
  33622. * * VertexBuffer.UV2Kind
  33623. * * VertexBuffer.UV3Kind
  33624. * * VertexBuffer.UV4Kind
  33625. * * VertexBuffer.UV5Kind
  33626. * * VertexBuffer.UV6Kind
  33627. * * VertexBuffer.ColorKind
  33628. * * VertexBuffer.MatricesIndicesKind
  33629. * * VertexBuffer.MatricesIndicesExtraKind
  33630. * * VertexBuffer.MatricesWeightsKind
  33631. * * VertexBuffer.MatricesWeightsExtraKind
  33632. * @param data defines the data source
  33633. * @param updatable defines if the data must be flagged as updatable (or static)
  33634. * @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
  33635. * @returns the current mesh
  33636. */
  33637. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33638. /**
  33639. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33640. * If the mesh has no geometry, it is simply returned as it is.
  33641. * @param kind defines vertex data kind:
  33642. * * VertexBuffer.PositionKind
  33643. * * VertexBuffer.UVKind
  33644. * * VertexBuffer.UV2Kind
  33645. * * VertexBuffer.UV3Kind
  33646. * * VertexBuffer.UV4Kind
  33647. * * VertexBuffer.UV5Kind
  33648. * * VertexBuffer.UV6Kind
  33649. * * VertexBuffer.ColorKind
  33650. * * VertexBuffer.MatricesIndicesKind
  33651. * * VertexBuffer.MatricesIndicesExtraKind
  33652. * * VertexBuffer.MatricesWeightsKind
  33653. * * VertexBuffer.MatricesWeightsExtraKind
  33654. * @param data defines the data source
  33655. * @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
  33656. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33657. * @returns the current mesh
  33658. */
  33659. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33660. /**
  33661. * Sets the mesh indices,
  33662. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33663. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33664. * @param totalVertices Defines the total number of vertices
  33665. * @returns the current mesh
  33666. */
  33667. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33668. /**
  33669. * Gets a boolean indicating if specific vertex data is present
  33670. * @param kind defines the vertex data kind to use
  33671. * @returns true is data kind is present
  33672. */
  33673. isVerticesDataPresent(kind: string): boolean;
  33674. /**
  33675. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33676. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33677. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33678. * @returns a BoundingInfo
  33679. */
  33680. getBoundingInfo(): BoundingInfo;
  33681. /**
  33682. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33683. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33684. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33685. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33686. * @returns the current mesh
  33687. */
  33688. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33689. /**
  33690. * Overwrite the current bounding info
  33691. * @param boundingInfo defines the new bounding info
  33692. * @returns the current mesh
  33693. */
  33694. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33695. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33696. get useBones(): boolean;
  33697. /** @hidden */
  33698. _preActivate(): void;
  33699. /** @hidden */
  33700. _preActivateForIntermediateRendering(renderId: number): void;
  33701. /** @hidden */
  33702. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33703. /** @hidden */
  33704. _postActivate(): void;
  33705. /** @hidden */
  33706. _freeze(): void;
  33707. /** @hidden */
  33708. _unFreeze(): void;
  33709. /**
  33710. * Gets the current world matrix
  33711. * @returns a Matrix
  33712. */
  33713. getWorldMatrix(): Matrix;
  33714. /** @hidden */
  33715. _getWorldMatrixDeterminant(): number;
  33716. /**
  33717. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33718. */
  33719. get isAnInstance(): boolean;
  33720. /**
  33721. * Gets a boolean indicating if this mesh has instances
  33722. */
  33723. get hasInstances(): boolean;
  33724. /**
  33725. * Gets a boolean indicating if this mesh has thin instances
  33726. */
  33727. get hasThinInstances(): boolean;
  33728. /**
  33729. * Perform relative position change from the point of view of behind the front of the mesh.
  33730. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33731. * Supports definition of mesh facing forward or backward
  33732. * @param amountRight defines the distance on the right axis
  33733. * @param amountUp defines the distance on the up axis
  33734. * @param amountForward defines the distance on the forward axis
  33735. * @returns the current mesh
  33736. */
  33737. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33738. /**
  33739. * Calculate relative position change from the point of view of behind the front of the mesh.
  33740. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33741. * Supports definition of mesh facing forward or backward
  33742. * @param amountRight defines the distance on the right axis
  33743. * @param amountUp defines the distance on the up axis
  33744. * @param amountForward defines the distance on the forward axis
  33745. * @returns the new displacement vector
  33746. */
  33747. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33748. /**
  33749. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33750. * Supports definition of mesh facing forward or backward
  33751. * @param flipBack defines the flip
  33752. * @param twirlClockwise defines the twirl
  33753. * @param tiltRight defines the tilt
  33754. * @returns the current mesh
  33755. */
  33756. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33757. /**
  33758. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33759. * Supports definition of mesh facing forward or backward.
  33760. * @param flipBack defines the flip
  33761. * @param twirlClockwise defines the twirl
  33762. * @param tiltRight defines the tilt
  33763. * @returns the new rotation vector
  33764. */
  33765. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33766. /**
  33767. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33768. * This means the mesh underlying bounding box and sphere are recomputed.
  33769. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33770. * @returns the current mesh
  33771. */
  33772. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33773. /** @hidden */
  33774. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33775. /** @hidden */
  33776. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33777. /** @hidden */
  33778. _updateBoundingInfo(): AbstractMesh;
  33779. /** @hidden */
  33780. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33781. /** @hidden */
  33782. protected _afterComputeWorldMatrix(): void;
  33783. /** @hidden */
  33784. get _effectiveMesh(): AbstractMesh;
  33785. /**
  33786. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33787. * A mesh is in the frustum if its bounding box intersects the frustum
  33788. * @param frustumPlanes defines the frustum to test
  33789. * @returns true if the mesh is in the frustum planes
  33790. */
  33791. isInFrustum(frustumPlanes: Plane[]): boolean;
  33792. /**
  33793. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33794. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33795. * @param frustumPlanes defines the frustum to test
  33796. * @returns true if the mesh is completely in the frustum planes
  33797. */
  33798. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33799. /**
  33800. * True if the mesh intersects another mesh or a SolidParticle object
  33801. * @param mesh defines a target mesh or SolidParticle to test
  33802. * @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)
  33803. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33804. * @returns true if there is an intersection
  33805. */
  33806. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33807. /**
  33808. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33809. * @param point defines the point to test
  33810. * @returns true if there is an intersection
  33811. */
  33812. intersectsPoint(point: Vector3): boolean;
  33813. /**
  33814. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33815. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33816. */
  33817. get checkCollisions(): boolean;
  33818. set checkCollisions(collisionEnabled: boolean);
  33819. /**
  33820. * Gets Collider object used to compute collisions (not physics)
  33821. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33822. */
  33823. get collider(): Nullable<Collider>;
  33824. /**
  33825. * Move the mesh using collision engine
  33826. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33827. * @param displacement defines the requested displacement vector
  33828. * @returns the current mesh
  33829. */
  33830. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33831. private _onCollisionPositionChange;
  33832. /** @hidden */
  33833. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33834. /** @hidden */
  33835. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33836. /** @hidden */
  33837. _checkCollision(collider: Collider): AbstractMesh;
  33838. /** @hidden */
  33839. _generatePointsArray(): boolean;
  33840. /**
  33841. * Checks if the passed Ray intersects with the mesh
  33842. * @param ray defines the ray to use
  33843. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33844. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33845. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33846. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33847. * @returns the picking info
  33848. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33849. */
  33850. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33851. /**
  33852. * Clones the current mesh
  33853. * @param name defines the mesh name
  33854. * @param newParent defines the new mesh parent
  33855. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33856. * @returns the new mesh
  33857. */
  33858. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33859. /**
  33860. * Disposes all the submeshes of the current meshnp
  33861. * @returns the current mesh
  33862. */
  33863. releaseSubMeshes(): AbstractMesh;
  33864. /**
  33865. * Releases resources associated with this abstract mesh.
  33866. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33867. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33868. */
  33869. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33870. /**
  33871. * Adds the passed mesh as a child to the current mesh
  33872. * @param mesh defines the child mesh
  33873. * @returns the current mesh
  33874. */
  33875. addChild(mesh: AbstractMesh): AbstractMesh;
  33876. /**
  33877. * Removes the passed mesh from the current mesh children list
  33878. * @param mesh defines the child mesh
  33879. * @returns the current mesh
  33880. */
  33881. removeChild(mesh: AbstractMesh): AbstractMesh;
  33882. /** @hidden */
  33883. private _initFacetData;
  33884. /**
  33885. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33886. * This method can be called within the render loop.
  33887. * 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
  33888. * @returns the current mesh
  33889. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33890. */
  33891. updateFacetData(): AbstractMesh;
  33892. /**
  33893. * Returns the facetLocalNormals array.
  33894. * The normals are expressed in the mesh local spac
  33895. * @returns an array of Vector3
  33896. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33897. */
  33898. getFacetLocalNormals(): Vector3[];
  33899. /**
  33900. * Returns the facetLocalPositions array.
  33901. * The facet positions are expressed in the mesh local space
  33902. * @returns an array of Vector3
  33903. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33904. */
  33905. getFacetLocalPositions(): Vector3[];
  33906. /**
  33907. * Returns the facetLocalPartioning array
  33908. * @returns an array of array of numbers
  33909. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33910. */
  33911. getFacetLocalPartitioning(): number[][];
  33912. /**
  33913. * Returns the i-th facet position in the world system.
  33914. * This method allocates a new Vector3 per call
  33915. * @param i defines the facet index
  33916. * @returns a new Vector3
  33917. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33918. */
  33919. getFacetPosition(i: number): Vector3;
  33920. /**
  33921. * Sets the reference Vector3 with the i-th facet position in the world system
  33922. * @param i defines the facet index
  33923. * @param ref defines the target vector
  33924. * @returns the current mesh
  33925. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33926. */
  33927. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33928. /**
  33929. * Returns the i-th facet normal in the world system.
  33930. * This method allocates a new Vector3 per call
  33931. * @param i defines the facet index
  33932. * @returns a new Vector3
  33933. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33934. */
  33935. getFacetNormal(i: number): Vector3;
  33936. /**
  33937. * Sets the reference Vector3 with the i-th facet normal in the world system
  33938. * @param i defines the facet index
  33939. * @param ref defines the target vector
  33940. * @returns the current mesh
  33941. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33942. */
  33943. getFacetNormalToRef(i: number, ref: Vector3): this;
  33944. /**
  33945. * 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)
  33946. * @param x defines x coordinate
  33947. * @param y defines y coordinate
  33948. * @param z defines z coordinate
  33949. * @returns the array of facet indexes
  33950. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33951. */
  33952. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33953. /**
  33954. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33955. * @param projected sets as the (x,y,z) world projection on the facet
  33956. * @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
  33957. * @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
  33958. * @param x defines x coordinate
  33959. * @param y defines y coordinate
  33960. * @param z defines z coordinate
  33961. * @returns the face index if found (or null instead)
  33962. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33963. */
  33964. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33965. /**
  33966. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33967. * @param projected sets as the (x,y,z) local projection on the facet
  33968. * @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
  33969. * @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
  33970. * @param x defines x coordinate
  33971. * @param y defines y coordinate
  33972. * @param z defines z coordinate
  33973. * @returns the face index if found (or null instead)
  33974. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33975. */
  33976. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33977. /**
  33978. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33979. * @returns the parameters
  33980. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33981. */
  33982. getFacetDataParameters(): any;
  33983. /**
  33984. * Disables the feature FacetData and frees the related memory
  33985. * @returns the current mesh
  33986. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33987. */
  33988. disableFacetData(): AbstractMesh;
  33989. /**
  33990. * Updates the AbstractMesh indices array
  33991. * @param indices defines the data source
  33992. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33993. * @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)
  33994. * @returns the current mesh
  33995. */
  33996. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33997. /**
  33998. * Creates new normals data for the mesh
  33999. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  34000. * @returns the current mesh
  34001. */
  34002. createNormals(updatable: boolean): AbstractMesh;
  34003. /**
  34004. * Align the mesh with a normal
  34005. * @param normal defines the normal to use
  34006. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  34007. * @returns the current mesh
  34008. */
  34009. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  34010. /** @hidden */
  34011. _checkOcclusionQuery(): boolean;
  34012. /**
  34013. * Disables the mesh edge rendering mode
  34014. * @returns the currentAbstractMesh
  34015. */
  34016. disableEdgesRendering(): AbstractMesh;
  34017. /**
  34018. * Enables the edge rendering mode on the mesh.
  34019. * This mode makes the mesh edges visible
  34020. * @param epsilon defines the maximal distance between two angles to detect a face
  34021. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  34022. * @returns the currentAbstractMesh
  34023. * @see https://www.babylonjs-playground.com/#19O9TU#0
  34024. */
  34025. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  34026. /**
  34027. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  34028. * @returns an array of particle systems in the scene that use the mesh as an emitter
  34029. */
  34030. getConnectedParticleSystems(): IParticleSystem[];
  34031. }
  34032. }
  34033. declare module "babylonjs/Actions/actionEvent" {
  34034. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34035. import { Nullable } from "babylonjs/types";
  34036. import { Sprite } from "babylonjs/Sprites/sprite";
  34037. import { Scene } from "babylonjs/scene";
  34038. import { Vector2 } from "babylonjs/Maths/math.vector";
  34039. /**
  34040. * Interface used to define ActionEvent
  34041. */
  34042. export interface IActionEvent {
  34043. /** The mesh or sprite that triggered the action */
  34044. source: any;
  34045. /** The X mouse cursor position at the time of the event */
  34046. pointerX: number;
  34047. /** The Y mouse cursor position at the time of the event */
  34048. pointerY: number;
  34049. /** The mesh that is currently pointed at (can be null) */
  34050. meshUnderPointer: Nullable<AbstractMesh>;
  34051. /** the original (browser) event that triggered the ActionEvent */
  34052. sourceEvent?: any;
  34053. /** additional data for the event */
  34054. additionalData?: any;
  34055. }
  34056. /**
  34057. * ActionEvent is the event being sent when an action is triggered.
  34058. */
  34059. export class ActionEvent implements IActionEvent {
  34060. /** The mesh or sprite that triggered the action */
  34061. source: any;
  34062. /** The X mouse cursor position at the time of the event */
  34063. pointerX: number;
  34064. /** The Y mouse cursor position at the time of the event */
  34065. pointerY: number;
  34066. /** The mesh that is currently pointed at (can be null) */
  34067. meshUnderPointer: Nullable<AbstractMesh>;
  34068. /** the original (browser) event that triggered the ActionEvent */
  34069. sourceEvent?: any;
  34070. /** additional data for the event */
  34071. additionalData?: any;
  34072. /**
  34073. * Creates a new ActionEvent
  34074. * @param source The mesh or sprite that triggered the action
  34075. * @param pointerX The X mouse cursor position at the time of the event
  34076. * @param pointerY The Y mouse cursor position at the time of the event
  34077. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  34078. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  34079. * @param additionalData additional data for the event
  34080. */
  34081. constructor(
  34082. /** The mesh or sprite that triggered the action */
  34083. source: any,
  34084. /** The X mouse cursor position at the time of the event */
  34085. pointerX: number,
  34086. /** The Y mouse cursor position at the time of the event */
  34087. pointerY: number,
  34088. /** The mesh that is currently pointed at (can be null) */
  34089. meshUnderPointer: Nullable<AbstractMesh>,
  34090. /** the original (browser) event that triggered the ActionEvent */
  34091. sourceEvent?: any,
  34092. /** additional data for the event */
  34093. additionalData?: any);
  34094. /**
  34095. * Helper function to auto-create an ActionEvent from a source mesh.
  34096. * @param source The source mesh that triggered the event
  34097. * @param evt The original (browser) event
  34098. * @param additionalData additional data for the event
  34099. * @returns the new ActionEvent
  34100. */
  34101. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34102. /**
  34103. * Helper function to auto-create an ActionEvent from a source sprite
  34104. * @param source The source sprite that triggered the event
  34105. * @param scene Scene associated with the sprite
  34106. * @param evt The original (browser) event
  34107. * @param additionalData additional data for the event
  34108. * @returns the new ActionEvent
  34109. */
  34110. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34111. /**
  34112. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34113. * @param scene the scene where the event occurred
  34114. * @param evt The original (browser) event
  34115. * @returns the new ActionEvent
  34116. */
  34117. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34118. /**
  34119. * Helper function to auto-create an ActionEvent from a primitive
  34120. * @param prim defines the target primitive
  34121. * @param pointerPos defines the pointer position
  34122. * @param evt The original (browser) event
  34123. * @param additionalData additional data for the event
  34124. * @returns the new ActionEvent
  34125. */
  34126. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34127. }
  34128. }
  34129. declare module "babylonjs/Actions/abstractActionManager" {
  34130. import { IDisposable } from "babylonjs/scene";
  34131. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34132. import { IAction } from "babylonjs/Actions/action";
  34133. import { Nullable } from "babylonjs/types";
  34134. /**
  34135. * Abstract class used to decouple action Manager from scene and meshes.
  34136. * Do not instantiate.
  34137. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34138. */
  34139. export abstract class AbstractActionManager implements IDisposable {
  34140. /** Gets the list of active triggers */
  34141. static Triggers: {
  34142. [key: string]: number;
  34143. };
  34144. /** Gets the cursor to use when hovering items */
  34145. hoverCursor: string;
  34146. /** Gets the list of actions */
  34147. actions: IAction[];
  34148. /**
  34149. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34150. */
  34151. isRecursive: boolean;
  34152. /**
  34153. * Releases all associated resources
  34154. */
  34155. abstract dispose(): void;
  34156. /**
  34157. * Does this action manager has pointer triggers
  34158. */
  34159. abstract get hasPointerTriggers(): boolean;
  34160. /**
  34161. * Does this action manager has pick triggers
  34162. */
  34163. abstract get hasPickTriggers(): boolean;
  34164. /**
  34165. * Process a specific trigger
  34166. * @param trigger defines the trigger to process
  34167. * @param evt defines the event details to be processed
  34168. */
  34169. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34170. /**
  34171. * Does this action manager handles actions of any of the given triggers
  34172. * @param triggers defines the triggers to be tested
  34173. * @return a boolean indicating whether one (or more) of the triggers is handled
  34174. */
  34175. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34176. /**
  34177. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34178. * speed.
  34179. * @param triggerA defines the trigger to be tested
  34180. * @param triggerB defines the trigger to be tested
  34181. * @return a boolean indicating whether one (or more) of the triggers is handled
  34182. */
  34183. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34184. /**
  34185. * Does this action manager handles actions of a given trigger
  34186. * @param trigger defines the trigger to be tested
  34187. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34188. * @return whether the trigger is handled
  34189. */
  34190. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34191. /**
  34192. * Serialize this manager to a JSON object
  34193. * @param name defines the property name to store this manager
  34194. * @returns a JSON representation of this manager
  34195. */
  34196. abstract serialize(name: string): any;
  34197. /**
  34198. * Registers an action to this action manager
  34199. * @param action defines the action to be registered
  34200. * @return the action amended (prepared) after registration
  34201. */
  34202. abstract registerAction(action: IAction): Nullable<IAction>;
  34203. /**
  34204. * Unregisters an action to this action manager
  34205. * @param action defines the action to be unregistered
  34206. * @return a boolean indicating whether the action has been unregistered
  34207. */
  34208. abstract unregisterAction(action: IAction): Boolean;
  34209. /**
  34210. * Does exist one action manager with at least one trigger
  34211. **/
  34212. static get HasTriggers(): boolean;
  34213. /**
  34214. * Does exist one action manager with at least one pick trigger
  34215. **/
  34216. static get HasPickTriggers(): boolean;
  34217. /**
  34218. * Does exist one action manager that handles actions of a given trigger
  34219. * @param trigger defines the trigger to be tested
  34220. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34221. **/
  34222. static HasSpecificTrigger(trigger: number): boolean;
  34223. }
  34224. }
  34225. declare module "babylonjs/node" {
  34226. import { Scene } from "babylonjs/scene";
  34227. import { Nullable } from "babylonjs/types";
  34228. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34229. import { Engine } from "babylonjs/Engines/engine";
  34230. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34231. import { Observable } from "babylonjs/Misc/observable";
  34232. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34233. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34234. import { Animatable } from "babylonjs/Animations/animatable";
  34235. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34236. import { Animation } from "babylonjs/Animations/animation";
  34237. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34238. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34239. /**
  34240. * Defines how a node can be built from a string name.
  34241. */
  34242. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34243. /**
  34244. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34245. */
  34246. export class Node implements IBehaviorAware<Node> {
  34247. /** @hidden */
  34248. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34249. private static _NodeConstructors;
  34250. /**
  34251. * Add a new node constructor
  34252. * @param type defines the type name of the node to construct
  34253. * @param constructorFunc defines the constructor function
  34254. */
  34255. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34256. /**
  34257. * Returns a node constructor based on type name
  34258. * @param type defines the type name
  34259. * @param name defines the new node name
  34260. * @param scene defines the hosting scene
  34261. * @param options defines optional options to transmit to constructors
  34262. * @returns the new constructor or null
  34263. */
  34264. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34265. /**
  34266. * Gets or sets the name of the node
  34267. */
  34268. name: string;
  34269. /**
  34270. * Gets or sets the id of the node
  34271. */
  34272. id: string;
  34273. /**
  34274. * Gets or sets the unique id of the node
  34275. */
  34276. uniqueId: number;
  34277. /**
  34278. * Gets or sets a string used to store user defined state for the node
  34279. */
  34280. state: string;
  34281. /**
  34282. * Gets or sets an object used to store user defined information for the node
  34283. */
  34284. metadata: any;
  34285. /**
  34286. * For internal use only. Please do not use.
  34287. */
  34288. reservedDataStore: any;
  34289. /**
  34290. * List of inspectable custom properties (used by the Inspector)
  34291. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34292. */
  34293. inspectableCustomProperties: IInspectable[];
  34294. private _doNotSerialize;
  34295. /**
  34296. * Gets or sets a boolean used to define if the node must be serialized
  34297. */
  34298. get doNotSerialize(): boolean;
  34299. set doNotSerialize(value: boolean);
  34300. /** @hidden */
  34301. _isDisposed: boolean;
  34302. /**
  34303. * Gets a list of Animations associated with the node
  34304. */
  34305. animations: import("babylonjs/Animations/animation").Animation[];
  34306. protected _ranges: {
  34307. [name: string]: Nullable<AnimationRange>;
  34308. };
  34309. /**
  34310. * Callback raised when the node is ready to be used
  34311. */
  34312. onReady: Nullable<(node: Node) => void>;
  34313. private _isEnabled;
  34314. private _isParentEnabled;
  34315. private _isReady;
  34316. /** @hidden */
  34317. _currentRenderId: number;
  34318. private _parentUpdateId;
  34319. /** @hidden */
  34320. _childUpdateId: number;
  34321. /** @hidden */
  34322. _waitingParentId: Nullable<string>;
  34323. /** @hidden */
  34324. _scene: Scene;
  34325. /** @hidden */
  34326. _cache: any;
  34327. private _parentNode;
  34328. private _children;
  34329. /** @hidden */
  34330. _worldMatrix: Matrix;
  34331. /** @hidden */
  34332. _worldMatrixDeterminant: number;
  34333. /** @hidden */
  34334. _worldMatrixDeterminantIsDirty: boolean;
  34335. /** @hidden */
  34336. private _sceneRootNodesIndex;
  34337. /**
  34338. * Gets a boolean indicating if the node has been disposed
  34339. * @returns true if the node was disposed
  34340. */
  34341. isDisposed(): boolean;
  34342. /**
  34343. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34344. * @see https://doc.babylonjs.com/how_to/parenting
  34345. */
  34346. set parent(parent: Nullable<Node>);
  34347. get parent(): Nullable<Node>;
  34348. /** @hidden */
  34349. _addToSceneRootNodes(): void;
  34350. /** @hidden */
  34351. _removeFromSceneRootNodes(): void;
  34352. private _animationPropertiesOverride;
  34353. /**
  34354. * Gets or sets the animation properties override
  34355. */
  34356. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34357. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34358. /**
  34359. * Gets a string identifying the name of the class
  34360. * @returns "Node" string
  34361. */
  34362. getClassName(): string;
  34363. /** @hidden */
  34364. readonly _isNode: boolean;
  34365. /**
  34366. * An event triggered when the mesh is disposed
  34367. */
  34368. onDisposeObservable: Observable<Node>;
  34369. private _onDisposeObserver;
  34370. /**
  34371. * Sets a callback that will be raised when the node will be disposed
  34372. */
  34373. set onDispose(callback: () => void);
  34374. /**
  34375. * Creates a new Node
  34376. * @param name the name and id to be given to this node
  34377. * @param scene the scene this node will be added to
  34378. */
  34379. constructor(name: string, scene?: Nullable<Scene>);
  34380. /**
  34381. * Gets the scene of the node
  34382. * @returns a scene
  34383. */
  34384. getScene(): Scene;
  34385. /**
  34386. * Gets the engine of the node
  34387. * @returns a Engine
  34388. */
  34389. getEngine(): Engine;
  34390. private _behaviors;
  34391. /**
  34392. * Attach a behavior to the node
  34393. * @see https://doc.babylonjs.com/features/behaviour
  34394. * @param behavior defines the behavior to attach
  34395. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34396. * @returns the current Node
  34397. */
  34398. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34399. /**
  34400. * Remove an attached behavior
  34401. * @see https://doc.babylonjs.com/features/behaviour
  34402. * @param behavior defines the behavior to attach
  34403. * @returns the current Node
  34404. */
  34405. removeBehavior(behavior: Behavior<Node>): Node;
  34406. /**
  34407. * Gets the list of attached behaviors
  34408. * @see https://doc.babylonjs.com/features/behaviour
  34409. */
  34410. get behaviors(): Behavior<Node>[];
  34411. /**
  34412. * Gets an attached behavior by name
  34413. * @param name defines the name of the behavior to look for
  34414. * @see https://doc.babylonjs.com/features/behaviour
  34415. * @returns null if behavior was not found else the requested behavior
  34416. */
  34417. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34418. /**
  34419. * Returns the latest update of the World matrix
  34420. * @returns a Matrix
  34421. */
  34422. getWorldMatrix(): Matrix;
  34423. /** @hidden */
  34424. _getWorldMatrixDeterminant(): number;
  34425. /**
  34426. * Returns directly the latest state of the mesh World matrix.
  34427. * A Matrix is returned.
  34428. */
  34429. get worldMatrixFromCache(): Matrix;
  34430. /** @hidden */
  34431. _initCache(): void;
  34432. /** @hidden */
  34433. updateCache(force?: boolean): void;
  34434. /** @hidden */
  34435. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34436. /** @hidden */
  34437. _updateCache(ignoreParentClass?: boolean): void;
  34438. /** @hidden */
  34439. _isSynchronized(): boolean;
  34440. /** @hidden */
  34441. _markSyncedWithParent(): void;
  34442. /** @hidden */
  34443. isSynchronizedWithParent(): boolean;
  34444. /** @hidden */
  34445. isSynchronized(): boolean;
  34446. /**
  34447. * Is this node ready to be used/rendered
  34448. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34449. * @return true if the node is ready
  34450. */
  34451. isReady(completeCheck?: boolean): boolean;
  34452. /**
  34453. * Is this node enabled?
  34454. * 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
  34455. * @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
  34456. * @return whether this node (and its parent) is enabled
  34457. */
  34458. isEnabled(checkAncestors?: boolean): boolean;
  34459. /** @hidden */
  34460. protected _syncParentEnabledState(): void;
  34461. /**
  34462. * Set the enabled state of this node
  34463. * @param value defines the new enabled state
  34464. */
  34465. setEnabled(value: boolean): void;
  34466. /**
  34467. * Is this node a descendant of the given node?
  34468. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34469. * @param ancestor defines the parent node to inspect
  34470. * @returns a boolean indicating if this node is a descendant of the given node
  34471. */
  34472. isDescendantOf(ancestor: Node): boolean;
  34473. /** @hidden */
  34474. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34475. /**
  34476. * Will return all nodes that have this node as ascendant
  34477. * @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
  34478. * @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
  34479. * @return all children nodes of all types
  34480. */
  34481. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34482. /**
  34483. * Get all child-meshes of this node
  34484. * @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)
  34485. * @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
  34486. * @returns an array of AbstractMesh
  34487. */
  34488. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34489. /**
  34490. * Get all direct children of this node
  34491. * @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
  34492. * @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)
  34493. * @returns an array of Node
  34494. */
  34495. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34496. /** @hidden */
  34497. _setReady(state: boolean): void;
  34498. /**
  34499. * Get an animation by name
  34500. * @param name defines the name of the animation to look for
  34501. * @returns null if not found else the requested animation
  34502. */
  34503. getAnimationByName(name: string): Nullable<Animation>;
  34504. /**
  34505. * Creates an animation range for this node
  34506. * @param name defines the name of the range
  34507. * @param from defines the starting key
  34508. * @param to defines the end key
  34509. */
  34510. createAnimationRange(name: string, from: number, to: number): void;
  34511. /**
  34512. * Delete a specific animation range
  34513. * @param name defines the name of the range to delete
  34514. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34515. */
  34516. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34517. /**
  34518. * Get an animation range by name
  34519. * @param name defines the name of the animation range to look for
  34520. * @returns null if not found else the requested animation range
  34521. */
  34522. getAnimationRange(name: string): Nullable<AnimationRange>;
  34523. /**
  34524. * Gets the list of all animation ranges defined on this node
  34525. * @returns an array
  34526. */
  34527. getAnimationRanges(): Nullable<AnimationRange>[];
  34528. /**
  34529. * Will start the animation sequence
  34530. * @param name defines the range frames for animation sequence
  34531. * @param loop defines if the animation should loop (false by default)
  34532. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34533. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34534. * @returns the object created for this animation. If range does not exist, it will return null
  34535. */
  34536. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34537. /**
  34538. * Serialize animation ranges into a JSON compatible object
  34539. * @returns serialization object
  34540. */
  34541. serializeAnimationRanges(): any;
  34542. /**
  34543. * Computes the world matrix of the node
  34544. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34545. * @returns the world matrix
  34546. */
  34547. computeWorldMatrix(force?: boolean): Matrix;
  34548. /**
  34549. * Releases resources associated with this node.
  34550. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34551. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34552. */
  34553. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34554. /**
  34555. * Parse animation range data from a serialization object and store them into a given node
  34556. * @param node defines where to store the animation ranges
  34557. * @param parsedNode defines the serialization object to read data from
  34558. * @param scene defines the hosting scene
  34559. */
  34560. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34561. /**
  34562. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34563. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34564. * @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
  34565. * @returns the new bounding vectors
  34566. */
  34567. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34568. min: Vector3;
  34569. max: Vector3;
  34570. };
  34571. }
  34572. }
  34573. declare module "babylonjs/Animations/animation" {
  34574. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34575. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34576. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34577. import { Nullable } from "babylonjs/types";
  34578. import { Scene } from "babylonjs/scene";
  34579. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34580. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34581. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34582. import { Node } from "babylonjs/node";
  34583. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34584. import { Size } from "babylonjs/Maths/math.size";
  34585. import { Animatable } from "babylonjs/Animations/animatable";
  34586. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34587. /**
  34588. * @hidden
  34589. */
  34590. export class _IAnimationState {
  34591. key: number;
  34592. repeatCount: number;
  34593. workValue?: any;
  34594. loopMode?: number;
  34595. offsetValue?: any;
  34596. highLimitValue?: any;
  34597. }
  34598. /**
  34599. * Class used to store any kind of animation
  34600. */
  34601. export class Animation {
  34602. /**Name of the animation */
  34603. name: string;
  34604. /**Property to animate */
  34605. targetProperty: string;
  34606. /**The frames per second of the animation */
  34607. framePerSecond: number;
  34608. /**The data type of the animation */
  34609. dataType: number;
  34610. /**The loop mode of the animation */
  34611. loopMode?: number | undefined;
  34612. /**Specifies if blending should be enabled */
  34613. enableBlending?: boolean | undefined;
  34614. /**
  34615. * Use matrix interpolation instead of using direct key value when animating matrices
  34616. */
  34617. static AllowMatricesInterpolation: boolean;
  34618. /**
  34619. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34620. */
  34621. static AllowMatrixDecomposeForInterpolation: boolean;
  34622. /** Define the Url to load snippets */
  34623. static SnippetUrl: string;
  34624. /** Snippet ID if the animation was created from the snippet server */
  34625. snippetId: string;
  34626. /**
  34627. * Stores the key frames of the animation
  34628. */
  34629. private _keys;
  34630. /**
  34631. * Stores the easing function of the animation
  34632. */
  34633. private _easingFunction;
  34634. /**
  34635. * @hidden Internal use only
  34636. */
  34637. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34638. /**
  34639. * The set of event that will be linked to this animation
  34640. */
  34641. private _events;
  34642. /**
  34643. * Stores an array of target property paths
  34644. */
  34645. targetPropertyPath: string[];
  34646. /**
  34647. * Stores the blending speed of the animation
  34648. */
  34649. blendingSpeed: number;
  34650. /**
  34651. * Stores the animation ranges for the animation
  34652. */
  34653. private _ranges;
  34654. /**
  34655. * @hidden Internal use
  34656. */
  34657. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34658. /**
  34659. * Sets up an animation
  34660. * @param property The property to animate
  34661. * @param animationType The animation type to apply
  34662. * @param framePerSecond The frames per second of the animation
  34663. * @param easingFunction The easing function used in the animation
  34664. * @returns The created animation
  34665. */
  34666. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34667. /**
  34668. * Create and start an animation on a node
  34669. * @param name defines the name of the global animation that will be run on all nodes
  34670. * @param node defines the root node where the animation will take place
  34671. * @param targetProperty defines property to animate
  34672. * @param framePerSecond defines the number of frame per second yo use
  34673. * @param totalFrame defines the number of frames in total
  34674. * @param from defines the initial value
  34675. * @param to defines the final value
  34676. * @param loopMode defines which loop mode you want to use (off by default)
  34677. * @param easingFunction defines the easing function to use (linear by default)
  34678. * @param onAnimationEnd defines the callback to call when animation end
  34679. * @returns the animatable created for this animation
  34680. */
  34681. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34682. /**
  34683. * Create and start an animation on a node and its descendants
  34684. * @param name defines the name of the global animation that will be run on all nodes
  34685. * @param node defines the root node where the animation will take place
  34686. * @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
  34687. * @param targetProperty defines property to animate
  34688. * @param framePerSecond defines the number of frame per second to use
  34689. * @param totalFrame defines the number of frames in total
  34690. * @param from defines the initial value
  34691. * @param to defines the final value
  34692. * @param loopMode defines which loop mode you want to use (off by default)
  34693. * @param easingFunction defines the easing function to use (linear by default)
  34694. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34695. * @returns the list of animatables created for all nodes
  34696. * @example https://www.babylonjs-playground.com/#MH0VLI
  34697. */
  34698. 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[]>;
  34699. /**
  34700. * Creates a new animation, merges it with the existing animations and starts it
  34701. * @param name Name of the animation
  34702. * @param node Node which contains the scene that begins the animations
  34703. * @param targetProperty Specifies which property to animate
  34704. * @param framePerSecond The frames per second of the animation
  34705. * @param totalFrame The total number of frames
  34706. * @param from The frame at the beginning of the animation
  34707. * @param to The frame at the end of the animation
  34708. * @param loopMode Specifies the loop mode of the animation
  34709. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34710. * @param onAnimationEnd Callback to run once the animation is complete
  34711. * @returns Nullable animation
  34712. */
  34713. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34714. /**
  34715. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34716. * @param sourceAnimation defines the Animation containing keyframes to convert
  34717. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34718. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34719. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34720. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34721. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34722. */
  34723. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34724. /**
  34725. * Transition property of an host to the target Value
  34726. * @param property The property to transition
  34727. * @param targetValue The target Value of the property
  34728. * @param host The object where the property to animate belongs
  34729. * @param scene Scene used to run the animation
  34730. * @param frameRate Framerate (in frame/s) to use
  34731. * @param transition The transition type we want to use
  34732. * @param duration The duration of the animation, in milliseconds
  34733. * @param onAnimationEnd Callback trigger at the end of the animation
  34734. * @returns Nullable animation
  34735. */
  34736. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34737. /**
  34738. * Return the array of runtime animations currently using this animation
  34739. */
  34740. get runtimeAnimations(): RuntimeAnimation[];
  34741. /**
  34742. * Specifies if any of the runtime animations are currently running
  34743. */
  34744. get hasRunningRuntimeAnimations(): boolean;
  34745. /**
  34746. * Initializes the animation
  34747. * @param name Name of the animation
  34748. * @param targetProperty Property to animate
  34749. * @param framePerSecond The frames per second of the animation
  34750. * @param dataType The data type of the animation
  34751. * @param loopMode The loop mode of the animation
  34752. * @param enableBlending Specifies if blending should be enabled
  34753. */
  34754. constructor(
  34755. /**Name of the animation */
  34756. name: string,
  34757. /**Property to animate */
  34758. targetProperty: string,
  34759. /**The frames per second of the animation */
  34760. framePerSecond: number,
  34761. /**The data type of the animation */
  34762. dataType: number,
  34763. /**The loop mode of the animation */
  34764. loopMode?: number | undefined,
  34765. /**Specifies if blending should be enabled */
  34766. enableBlending?: boolean | undefined);
  34767. /**
  34768. * Converts the animation to a string
  34769. * @param fullDetails support for multiple levels of logging within scene loading
  34770. * @returns String form of the animation
  34771. */
  34772. toString(fullDetails?: boolean): string;
  34773. /**
  34774. * Add an event to this animation
  34775. * @param event Event to add
  34776. */
  34777. addEvent(event: AnimationEvent): void;
  34778. /**
  34779. * Remove all events found at the given frame
  34780. * @param frame The frame to remove events from
  34781. */
  34782. removeEvents(frame: number): void;
  34783. /**
  34784. * Retrieves all the events from the animation
  34785. * @returns Events from the animation
  34786. */
  34787. getEvents(): AnimationEvent[];
  34788. /**
  34789. * Creates an animation range
  34790. * @param name Name of the animation range
  34791. * @param from Starting frame of the animation range
  34792. * @param to Ending frame of the animation
  34793. */
  34794. createRange(name: string, from: number, to: number): void;
  34795. /**
  34796. * Deletes an animation range by name
  34797. * @param name Name of the animation range to delete
  34798. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34799. */
  34800. deleteRange(name: string, deleteFrames?: boolean): void;
  34801. /**
  34802. * Gets the animation range by name, or null if not defined
  34803. * @param name Name of the animation range
  34804. * @returns Nullable animation range
  34805. */
  34806. getRange(name: string): Nullable<AnimationRange>;
  34807. /**
  34808. * Gets the key frames from the animation
  34809. * @returns The key frames of the animation
  34810. */
  34811. getKeys(): Array<IAnimationKey>;
  34812. /**
  34813. * Gets the highest frame rate of the animation
  34814. * @returns Highest frame rate of the animation
  34815. */
  34816. getHighestFrame(): number;
  34817. /**
  34818. * Gets the easing function of the animation
  34819. * @returns Easing function of the animation
  34820. */
  34821. getEasingFunction(): IEasingFunction;
  34822. /**
  34823. * Sets the easing function of the animation
  34824. * @param easingFunction A custom mathematical formula for animation
  34825. */
  34826. setEasingFunction(easingFunction: EasingFunction): void;
  34827. /**
  34828. * Interpolates a scalar linearly
  34829. * @param startValue Start value of the animation curve
  34830. * @param endValue End value of the animation curve
  34831. * @param gradient Scalar amount to interpolate
  34832. * @returns Interpolated scalar value
  34833. */
  34834. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34835. /**
  34836. * Interpolates a scalar cubically
  34837. * @param startValue Start value of the animation curve
  34838. * @param outTangent End tangent of the animation
  34839. * @param endValue End value of the animation curve
  34840. * @param inTangent Start tangent of the animation curve
  34841. * @param gradient Scalar amount to interpolate
  34842. * @returns Interpolated scalar value
  34843. */
  34844. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34845. /**
  34846. * Interpolates a quaternion using a spherical linear interpolation
  34847. * @param startValue Start value of the animation curve
  34848. * @param endValue End value of the animation curve
  34849. * @param gradient Scalar amount to interpolate
  34850. * @returns Interpolated quaternion value
  34851. */
  34852. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34853. /**
  34854. * Interpolates a quaternion cubically
  34855. * @param startValue Start value of the animation curve
  34856. * @param outTangent End tangent of the animation curve
  34857. * @param endValue End value of the animation curve
  34858. * @param inTangent Start tangent of the animation curve
  34859. * @param gradient Scalar amount to interpolate
  34860. * @returns Interpolated quaternion value
  34861. */
  34862. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34863. /**
  34864. * Interpolates a Vector3 linearl
  34865. * @param startValue Start value of the animation curve
  34866. * @param endValue End value of the animation curve
  34867. * @param gradient Scalar amount to interpolate
  34868. * @returns Interpolated scalar value
  34869. */
  34870. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34871. /**
  34872. * Interpolates a Vector3 cubically
  34873. * @param startValue Start value of the animation curve
  34874. * @param outTangent End tangent of the animation
  34875. * @param endValue End value of the animation curve
  34876. * @param inTangent Start tangent of the animation curve
  34877. * @param gradient Scalar amount to interpolate
  34878. * @returns InterpolatedVector3 value
  34879. */
  34880. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34881. /**
  34882. * Interpolates a Vector2 linearly
  34883. * @param startValue Start value of the animation curve
  34884. * @param endValue End value of the animation curve
  34885. * @param gradient Scalar amount to interpolate
  34886. * @returns Interpolated Vector2 value
  34887. */
  34888. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34889. /**
  34890. * Interpolates a Vector2 cubically
  34891. * @param startValue Start value of the animation curve
  34892. * @param outTangent End tangent of the animation
  34893. * @param endValue End value of the animation curve
  34894. * @param inTangent Start tangent of the animation curve
  34895. * @param gradient Scalar amount to interpolate
  34896. * @returns Interpolated Vector2 value
  34897. */
  34898. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34899. /**
  34900. * Interpolates a size linearly
  34901. * @param startValue Start value of the animation curve
  34902. * @param endValue End value of the animation curve
  34903. * @param gradient Scalar amount to interpolate
  34904. * @returns Interpolated Size value
  34905. */
  34906. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34907. /**
  34908. * Interpolates a Color3 linearly
  34909. * @param startValue Start value of the animation curve
  34910. * @param endValue End value of the animation curve
  34911. * @param gradient Scalar amount to interpolate
  34912. * @returns Interpolated Color3 value
  34913. */
  34914. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34915. /**
  34916. * Interpolates a Color4 linearly
  34917. * @param startValue Start value of the animation curve
  34918. * @param endValue End value of the animation curve
  34919. * @param gradient Scalar amount to interpolate
  34920. * @returns Interpolated Color3 value
  34921. */
  34922. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34923. /**
  34924. * @hidden Internal use only
  34925. */
  34926. _getKeyValue(value: any): any;
  34927. /**
  34928. * @hidden Internal use only
  34929. */
  34930. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34931. /**
  34932. * Defines the function to use to interpolate matrices
  34933. * @param startValue defines the start matrix
  34934. * @param endValue defines the end matrix
  34935. * @param gradient defines the gradient between both matrices
  34936. * @param result defines an optional target matrix where to store the interpolation
  34937. * @returns the interpolated matrix
  34938. */
  34939. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34940. /**
  34941. * Makes a copy of the animation
  34942. * @returns Cloned animation
  34943. */
  34944. clone(): Animation;
  34945. /**
  34946. * Sets the key frames of the animation
  34947. * @param values The animation key frames to set
  34948. */
  34949. setKeys(values: Array<IAnimationKey>): void;
  34950. /**
  34951. * Serializes the animation to an object
  34952. * @returns Serialized object
  34953. */
  34954. serialize(): any;
  34955. /**
  34956. * Float animation type
  34957. */
  34958. static readonly ANIMATIONTYPE_FLOAT: number;
  34959. /**
  34960. * Vector3 animation type
  34961. */
  34962. static readonly ANIMATIONTYPE_VECTOR3: number;
  34963. /**
  34964. * Quaternion animation type
  34965. */
  34966. static readonly ANIMATIONTYPE_QUATERNION: number;
  34967. /**
  34968. * Matrix animation type
  34969. */
  34970. static readonly ANIMATIONTYPE_MATRIX: number;
  34971. /**
  34972. * Color3 animation type
  34973. */
  34974. static readonly ANIMATIONTYPE_COLOR3: number;
  34975. /**
  34976. * Color3 animation type
  34977. */
  34978. static readonly ANIMATIONTYPE_COLOR4: number;
  34979. /**
  34980. * Vector2 animation type
  34981. */
  34982. static readonly ANIMATIONTYPE_VECTOR2: number;
  34983. /**
  34984. * Size animation type
  34985. */
  34986. static readonly ANIMATIONTYPE_SIZE: number;
  34987. /**
  34988. * Relative Loop Mode
  34989. */
  34990. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34991. /**
  34992. * Cycle Loop Mode
  34993. */
  34994. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34995. /**
  34996. * Constant Loop Mode
  34997. */
  34998. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34999. /** @hidden */
  35000. static _UniversalLerp(left: any, right: any, amount: number): any;
  35001. /**
  35002. * Parses an animation object and creates an animation
  35003. * @param parsedAnimation Parsed animation object
  35004. * @returns Animation object
  35005. */
  35006. static Parse(parsedAnimation: any): Animation;
  35007. /**
  35008. * Appends the serialized animations from the source animations
  35009. * @param source Source containing the animations
  35010. * @param destination Target to store the animations
  35011. */
  35012. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  35013. /**
  35014. * Creates a new animation or an array of animations from a snippet saved in a remote file
  35015. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  35016. * @param url defines the url to load from
  35017. * @returns a promise that will resolve to the new animation or an array of animations
  35018. */
  35019. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  35020. /**
  35021. * Creates an animation or an array of animations from a snippet saved by the Inspector
  35022. * @param snippetId defines the snippet to load
  35023. * @returns a promise that will resolve to the new animation or a new array of animations
  35024. */
  35025. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  35026. }
  35027. }
  35028. declare module "babylonjs/Animations/animatable.interface" {
  35029. import { Nullable } from "babylonjs/types";
  35030. import { Animation } from "babylonjs/Animations/animation";
  35031. /**
  35032. * Interface containing an array of animations
  35033. */
  35034. export interface IAnimatable {
  35035. /**
  35036. * Array of animations
  35037. */
  35038. animations: Nullable<Array<Animation>>;
  35039. }
  35040. }
  35041. declare module "babylonjs/Misc/decorators" {
  35042. import { Nullable } from "babylonjs/types";
  35043. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35044. import { Scene } from "babylonjs/scene";
  35045. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  35046. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  35047. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  35048. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35049. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  35050. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35051. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35052. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35053. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35054. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35055. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35056. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35057. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35058. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35059. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35060. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35061. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35062. /**
  35063. * Decorator used to define property that can be serialized as reference to a camera
  35064. * @param sourceName defines the name of the property to decorate
  35065. */
  35066. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35067. /**
  35068. * Class used to help serialization objects
  35069. */
  35070. export class SerializationHelper {
  35071. /** @hidden */
  35072. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  35073. /** @hidden */
  35074. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  35075. /** @hidden */
  35076. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  35077. /** @hidden */
  35078. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  35079. /**
  35080. * Appends the serialized animations from the source animations
  35081. * @param source Source containing the animations
  35082. * @param destination Target to store the animations
  35083. */
  35084. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  35085. /**
  35086. * Static function used to serialized a specific entity
  35087. * @param entity defines the entity to serialize
  35088. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  35089. * @returns a JSON compatible object representing the serialization of the entity
  35090. */
  35091. static Serialize<T>(entity: T, serializationObject?: any): any;
  35092. /**
  35093. * Creates a new entity from a serialization data object
  35094. * @param creationFunction defines a function used to instanciated the new entity
  35095. * @param source defines the source serialization data
  35096. * @param scene defines the hosting scene
  35097. * @param rootUrl defines the root url for resources
  35098. * @returns a new entity
  35099. */
  35100. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35101. /**
  35102. * Clones an object
  35103. * @param creationFunction defines the function used to instanciate the new object
  35104. * @param source defines the source object
  35105. * @returns the cloned object
  35106. */
  35107. static Clone<T>(creationFunction: () => T, source: T): T;
  35108. /**
  35109. * Instanciates a new object based on a source one (some data will be shared between both object)
  35110. * @param creationFunction defines the function used to instanciate the new object
  35111. * @param source defines the source object
  35112. * @returns the new object
  35113. */
  35114. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35115. }
  35116. }
  35117. declare module "babylonjs/Materials/Textures/baseTexture" {
  35118. import { Observable } from "babylonjs/Misc/observable";
  35119. import { Nullable } from "babylonjs/types";
  35120. import { Scene } from "babylonjs/scene";
  35121. import { Matrix } from "babylonjs/Maths/math.vector";
  35122. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35123. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35124. import { ISize } from "babylonjs/Maths/math.size";
  35125. import "babylonjs/Misc/fileTools";
  35126. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35127. /**
  35128. * Base class of all the textures in babylon.
  35129. * It groups all the common properties the materials, post process, lights... might need
  35130. * in order to make a correct use of the texture.
  35131. */
  35132. export class BaseTexture implements IAnimatable {
  35133. /**
  35134. * Default anisotropic filtering level for the application.
  35135. * It is set to 4 as a good tradeoff between perf and quality.
  35136. */
  35137. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35138. /**
  35139. * Gets or sets the unique id of the texture
  35140. */
  35141. uniqueId: number;
  35142. /**
  35143. * Define the name of the texture.
  35144. */
  35145. name: string;
  35146. /**
  35147. * Gets or sets an object used to store user defined information.
  35148. */
  35149. metadata: any;
  35150. /**
  35151. * For internal use only. Please do not use.
  35152. */
  35153. reservedDataStore: any;
  35154. private _hasAlpha;
  35155. /**
  35156. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35157. */
  35158. set hasAlpha(value: boolean);
  35159. get hasAlpha(): boolean;
  35160. /**
  35161. * Defines if the alpha value should be determined via the rgb values.
  35162. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35163. */
  35164. getAlphaFromRGB: boolean;
  35165. /**
  35166. * Intensity or strength of the texture.
  35167. * It is commonly used by materials to fine tune the intensity of the texture
  35168. */
  35169. level: number;
  35170. /**
  35171. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35172. * This is part of the texture as textures usually maps to one uv set.
  35173. */
  35174. coordinatesIndex: number;
  35175. protected _coordinatesMode: number;
  35176. /**
  35177. * How a texture is mapped.
  35178. *
  35179. * | Value | Type | Description |
  35180. * | ----- | ----------------------------------- | ----------- |
  35181. * | 0 | EXPLICIT_MODE | |
  35182. * | 1 | SPHERICAL_MODE | |
  35183. * | 2 | PLANAR_MODE | |
  35184. * | 3 | CUBIC_MODE | |
  35185. * | 4 | PROJECTION_MODE | |
  35186. * | 5 | SKYBOX_MODE | |
  35187. * | 6 | INVCUBIC_MODE | |
  35188. * | 7 | EQUIRECTANGULAR_MODE | |
  35189. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35190. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35191. */
  35192. set coordinatesMode(value: number);
  35193. get coordinatesMode(): number;
  35194. private _wrapU;
  35195. /**
  35196. * | Value | Type | Description |
  35197. * | ----- | ------------------ | ----------- |
  35198. * | 0 | CLAMP_ADDRESSMODE | |
  35199. * | 1 | WRAP_ADDRESSMODE | |
  35200. * | 2 | MIRROR_ADDRESSMODE | |
  35201. */
  35202. get wrapU(): number;
  35203. set wrapU(value: number);
  35204. private _wrapV;
  35205. /**
  35206. * | Value | Type | Description |
  35207. * | ----- | ------------------ | ----------- |
  35208. * | 0 | CLAMP_ADDRESSMODE | |
  35209. * | 1 | WRAP_ADDRESSMODE | |
  35210. * | 2 | MIRROR_ADDRESSMODE | |
  35211. */
  35212. get wrapV(): number;
  35213. set wrapV(value: number);
  35214. /**
  35215. * | Value | Type | Description |
  35216. * | ----- | ------------------ | ----------- |
  35217. * | 0 | CLAMP_ADDRESSMODE | |
  35218. * | 1 | WRAP_ADDRESSMODE | |
  35219. * | 2 | MIRROR_ADDRESSMODE | |
  35220. */
  35221. wrapR: number;
  35222. /**
  35223. * With compliant hardware and browser (supporting anisotropic filtering)
  35224. * this defines the level of anisotropic filtering in the texture.
  35225. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35226. */
  35227. anisotropicFilteringLevel: number;
  35228. /**
  35229. * Define if the texture is a cube texture or if false a 2d texture.
  35230. */
  35231. get isCube(): boolean;
  35232. set isCube(value: boolean);
  35233. /**
  35234. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35235. */
  35236. get is3D(): boolean;
  35237. set is3D(value: boolean);
  35238. /**
  35239. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35240. */
  35241. get is2DArray(): boolean;
  35242. set is2DArray(value: boolean);
  35243. private _gammaSpace;
  35244. /**
  35245. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35246. * HDR texture are usually stored in linear space.
  35247. * This only impacts the PBR and Background materials
  35248. */
  35249. get gammaSpace(): boolean;
  35250. set gammaSpace(gamma: boolean);
  35251. /**
  35252. * Gets or sets whether or not the texture contains RGBD data.
  35253. */
  35254. get isRGBD(): boolean;
  35255. set isRGBD(value: boolean);
  35256. /**
  35257. * Is Z inverted in the texture (useful in a cube texture).
  35258. */
  35259. invertZ: boolean;
  35260. /**
  35261. * Are mip maps generated for this texture or not.
  35262. */
  35263. get noMipmap(): boolean;
  35264. /**
  35265. * @hidden
  35266. */
  35267. lodLevelInAlpha: boolean;
  35268. /**
  35269. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35270. */
  35271. get lodGenerationOffset(): number;
  35272. set lodGenerationOffset(value: number);
  35273. /**
  35274. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35275. */
  35276. get lodGenerationScale(): number;
  35277. set lodGenerationScale(value: number);
  35278. /**
  35279. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35280. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35281. * average roughness values.
  35282. */
  35283. get linearSpecularLOD(): boolean;
  35284. set linearSpecularLOD(value: boolean);
  35285. /**
  35286. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35287. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35288. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35289. */
  35290. get irradianceTexture(): Nullable<BaseTexture>;
  35291. set irradianceTexture(value: Nullable<BaseTexture>);
  35292. /**
  35293. * Define if the texture is a render target.
  35294. */
  35295. isRenderTarget: boolean;
  35296. /**
  35297. * Define the unique id of the texture in the scene.
  35298. */
  35299. get uid(): string;
  35300. /** @hidden */
  35301. _prefiltered: boolean;
  35302. /**
  35303. * Return a string representation of the texture.
  35304. * @returns the texture as a string
  35305. */
  35306. toString(): string;
  35307. /**
  35308. * Get the class name of the texture.
  35309. * @returns "BaseTexture"
  35310. */
  35311. getClassName(): string;
  35312. /**
  35313. * Define the list of animation attached to the texture.
  35314. */
  35315. animations: import("babylonjs/Animations/animation").Animation[];
  35316. /**
  35317. * An event triggered when the texture is disposed.
  35318. */
  35319. onDisposeObservable: Observable<BaseTexture>;
  35320. private _onDisposeObserver;
  35321. /**
  35322. * Callback triggered when the texture has been disposed.
  35323. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35324. */
  35325. set onDispose(callback: () => void);
  35326. /**
  35327. * Define the current state of the loading sequence when in delayed load mode.
  35328. */
  35329. delayLoadState: number;
  35330. protected _scene: Nullable<Scene>;
  35331. protected _engine: Nullable<ThinEngine>;
  35332. /** @hidden */
  35333. _texture: Nullable<InternalTexture>;
  35334. private _uid;
  35335. /**
  35336. * Define if the texture is preventinga material to render or not.
  35337. * If not and the texture is not ready, the engine will use a default black texture instead.
  35338. */
  35339. get isBlocking(): boolean;
  35340. /**
  35341. * Instantiates a new BaseTexture.
  35342. * Base class of all the textures in babylon.
  35343. * It groups all the common properties the materials, post process, lights... might need
  35344. * in order to make a correct use of the texture.
  35345. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35346. */
  35347. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35348. /**
  35349. * Get the scene the texture belongs to.
  35350. * @returns the scene or null if undefined
  35351. */
  35352. getScene(): Nullable<Scene>;
  35353. /** @hidden */
  35354. protected _getEngine(): Nullable<ThinEngine>;
  35355. /**
  35356. * Get the texture transform matrix used to offset tile the texture for istance.
  35357. * @returns the transformation matrix
  35358. */
  35359. getTextureMatrix(): Matrix;
  35360. /**
  35361. * Get the texture reflection matrix used to rotate/transform the reflection.
  35362. * @returns the reflection matrix
  35363. */
  35364. getReflectionTextureMatrix(): Matrix;
  35365. /**
  35366. * Get the underlying lower level texture from Babylon.
  35367. * @returns the insternal texture
  35368. */
  35369. getInternalTexture(): Nullable<InternalTexture>;
  35370. /**
  35371. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35372. * @returns true if ready or not blocking
  35373. */
  35374. isReadyOrNotBlocking(): boolean;
  35375. /**
  35376. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35377. * @returns true if fully ready
  35378. */
  35379. isReady(): boolean;
  35380. private _cachedSize;
  35381. /**
  35382. * Get the size of the texture.
  35383. * @returns the texture size.
  35384. */
  35385. getSize(): ISize;
  35386. /**
  35387. * Get the base size of the texture.
  35388. * It can be different from the size if the texture has been resized for POT for instance
  35389. * @returns the base size
  35390. */
  35391. getBaseSize(): ISize;
  35392. /**
  35393. * Update the sampling mode of the texture.
  35394. * Default is Trilinear mode.
  35395. *
  35396. * | Value | Type | Description |
  35397. * | ----- | ------------------ | ----------- |
  35398. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35399. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35400. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35401. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35402. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35403. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35404. * | 7 | NEAREST_LINEAR | |
  35405. * | 8 | NEAREST_NEAREST | |
  35406. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35407. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35408. * | 11 | LINEAR_LINEAR | |
  35409. * | 12 | LINEAR_NEAREST | |
  35410. *
  35411. * > _mag_: magnification filter (close to the viewer)
  35412. * > _min_: minification filter (far from the viewer)
  35413. * > _mip_: filter used between mip map levels
  35414. *@param samplingMode Define the new sampling mode of the texture
  35415. */
  35416. updateSamplingMode(samplingMode: number): void;
  35417. /**
  35418. * Scales the texture if is `canRescale()`
  35419. * @param ratio the resize factor we want to use to rescale
  35420. */
  35421. scale(ratio: number): void;
  35422. /**
  35423. * Get if the texture can rescale.
  35424. */
  35425. get canRescale(): boolean;
  35426. /** @hidden */
  35427. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35428. /** @hidden */
  35429. _rebuild(): void;
  35430. /**
  35431. * Triggers the load sequence in delayed load mode.
  35432. */
  35433. delayLoad(): void;
  35434. /**
  35435. * Clones the texture.
  35436. * @returns the cloned texture
  35437. */
  35438. clone(): Nullable<BaseTexture>;
  35439. /**
  35440. * Get the texture underlying type (INT, FLOAT...)
  35441. */
  35442. get textureType(): number;
  35443. /**
  35444. * Get the texture underlying format (RGB, RGBA...)
  35445. */
  35446. get textureFormat(): number;
  35447. /**
  35448. * Indicates that textures need to be re-calculated for all materials
  35449. */
  35450. protected _markAllSubMeshesAsTexturesDirty(): void;
  35451. /**
  35452. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35453. * This will returns an RGBA array buffer containing either in values (0-255) or
  35454. * float values (0-1) depending of the underlying buffer type.
  35455. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35456. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35457. * @param buffer defines a user defined buffer to fill with data (can be null)
  35458. * @returns The Array buffer containing the pixels data.
  35459. */
  35460. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35461. /**
  35462. * Release and destroy the underlying lower level texture aka internalTexture.
  35463. */
  35464. releaseInternalTexture(): void;
  35465. /** @hidden */
  35466. get _lodTextureHigh(): Nullable<BaseTexture>;
  35467. /** @hidden */
  35468. get _lodTextureMid(): Nullable<BaseTexture>;
  35469. /** @hidden */
  35470. get _lodTextureLow(): Nullable<BaseTexture>;
  35471. /**
  35472. * Dispose the texture and release its associated resources.
  35473. */
  35474. dispose(): void;
  35475. /**
  35476. * Serialize the texture into a JSON representation that can be parsed later on.
  35477. * @returns the JSON representation of the texture
  35478. */
  35479. serialize(): any;
  35480. /**
  35481. * Helper function to be called back once a list of texture contains only ready textures.
  35482. * @param textures Define the list of textures to wait for
  35483. * @param callback Define the callback triggered once the entire list will be ready
  35484. */
  35485. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35486. private static _isScene;
  35487. }
  35488. }
  35489. declare module "babylonjs/Materials/effect" {
  35490. import { Observable } from "babylonjs/Misc/observable";
  35491. import { Nullable } from "babylonjs/types";
  35492. import { IDisposable } from "babylonjs/scene";
  35493. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35494. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35495. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35496. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35497. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35498. import { Engine } from "babylonjs/Engines/engine";
  35499. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35500. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35501. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35502. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35503. /**
  35504. * Options to be used when creating an effect.
  35505. */
  35506. export interface IEffectCreationOptions {
  35507. /**
  35508. * Atrributes that will be used in the shader.
  35509. */
  35510. attributes: string[];
  35511. /**
  35512. * Uniform varible names that will be set in the shader.
  35513. */
  35514. uniformsNames: string[];
  35515. /**
  35516. * Uniform buffer variable names that will be set in the shader.
  35517. */
  35518. uniformBuffersNames: string[];
  35519. /**
  35520. * Sampler texture variable names that will be set in the shader.
  35521. */
  35522. samplers: string[];
  35523. /**
  35524. * Define statements that will be set in the shader.
  35525. */
  35526. defines: any;
  35527. /**
  35528. * Possible fallbacks for this effect to improve performance when needed.
  35529. */
  35530. fallbacks: Nullable<IEffectFallbacks>;
  35531. /**
  35532. * Callback that will be called when the shader is compiled.
  35533. */
  35534. onCompiled: Nullable<(effect: Effect) => void>;
  35535. /**
  35536. * Callback that will be called if an error occurs during shader compilation.
  35537. */
  35538. onError: Nullable<(effect: Effect, errors: string) => void>;
  35539. /**
  35540. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35541. */
  35542. indexParameters?: any;
  35543. /**
  35544. * Max number of lights that can be used in the shader.
  35545. */
  35546. maxSimultaneousLights?: number;
  35547. /**
  35548. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35549. */
  35550. transformFeedbackVaryings?: Nullable<string[]>;
  35551. /**
  35552. * 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
  35553. */
  35554. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35555. /**
  35556. * Is this effect rendering to several color attachments ?
  35557. */
  35558. multiTarget?: boolean;
  35559. }
  35560. /**
  35561. * Effect containing vertex and fragment shader that can be executed on an object.
  35562. */
  35563. export class Effect implements IDisposable {
  35564. /**
  35565. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35566. */
  35567. static ShadersRepository: string;
  35568. /**
  35569. * Enable logging of the shader code when a compilation error occurs
  35570. */
  35571. static LogShaderCodeOnCompilationError: boolean;
  35572. /**
  35573. * Name of the effect.
  35574. */
  35575. name: any;
  35576. /**
  35577. * String container all the define statements that should be set on the shader.
  35578. */
  35579. defines: string;
  35580. /**
  35581. * Callback that will be called when the shader is compiled.
  35582. */
  35583. onCompiled: Nullable<(effect: Effect) => void>;
  35584. /**
  35585. * Callback that will be called if an error occurs during shader compilation.
  35586. */
  35587. onError: Nullable<(effect: Effect, errors: string) => void>;
  35588. /**
  35589. * Callback that will be called when effect is bound.
  35590. */
  35591. onBind: Nullable<(effect: Effect) => void>;
  35592. /**
  35593. * Unique ID of the effect.
  35594. */
  35595. uniqueId: number;
  35596. /**
  35597. * Observable that will be called when the shader is compiled.
  35598. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35599. */
  35600. onCompileObservable: Observable<Effect>;
  35601. /**
  35602. * Observable that will be called if an error occurs during shader compilation.
  35603. */
  35604. onErrorObservable: Observable<Effect>;
  35605. /** @hidden */
  35606. _onBindObservable: Nullable<Observable<Effect>>;
  35607. /**
  35608. * @hidden
  35609. * Specifies if the effect was previously ready
  35610. */
  35611. _wasPreviouslyReady: boolean;
  35612. /**
  35613. * Observable that will be called when effect is bound.
  35614. */
  35615. get onBindObservable(): Observable<Effect>;
  35616. /** @hidden */
  35617. _bonesComputationForcedToCPU: boolean;
  35618. /** @hidden */
  35619. _multiTarget: boolean;
  35620. private static _uniqueIdSeed;
  35621. private _engine;
  35622. private _uniformBuffersNames;
  35623. private _uniformBuffersNamesList;
  35624. private _uniformsNames;
  35625. private _samplerList;
  35626. private _samplers;
  35627. private _isReady;
  35628. private _compilationError;
  35629. private _allFallbacksProcessed;
  35630. private _attributesNames;
  35631. private _attributes;
  35632. private _attributeLocationByName;
  35633. private _uniforms;
  35634. /**
  35635. * Key for the effect.
  35636. * @hidden
  35637. */
  35638. _key: string;
  35639. private _indexParameters;
  35640. private _fallbacks;
  35641. private _vertexSourceCode;
  35642. private _fragmentSourceCode;
  35643. private _vertexSourceCodeOverride;
  35644. private _fragmentSourceCodeOverride;
  35645. private _transformFeedbackVaryings;
  35646. /**
  35647. * Compiled shader to webGL program.
  35648. * @hidden
  35649. */
  35650. _pipelineContext: Nullable<IPipelineContext>;
  35651. private _valueCache;
  35652. private static _baseCache;
  35653. /**
  35654. * Instantiates an effect.
  35655. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35656. * @param baseName Name of the effect.
  35657. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35658. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35659. * @param samplers List of sampler variables that will be passed to the shader.
  35660. * @param engine Engine to be used to render the effect
  35661. * @param defines Define statements to be added to the shader.
  35662. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35663. * @param onCompiled Callback that will be called when the shader is compiled.
  35664. * @param onError Callback that will be called if an error occurs during shader compilation.
  35665. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35666. */
  35667. 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);
  35668. private _useFinalCode;
  35669. /**
  35670. * Unique key for this effect
  35671. */
  35672. get key(): string;
  35673. /**
  35674. * If the effect has been compiled and prepared.
  35675. * @returns if the effect is compiled and prepared.
  35676. */
  35677. isReady(): boolean;
  35678. private _isReadyInternal;
  35679. /**
  35680. * The engine the effect was initialized with.
  35681. * @returns the engine.
  35682. */
  35683. getEngine(): Engine;
  35684. /**
  35685. * The pipeline context for this effect
  35686. * @returns the associated pipeline context
  35687. */
  35688. getPipelineContext(): Nullable<IPipelineContext>;
  35689. /**
  35690. * The set of names of attribute variables for the shader.
  35691. * @returns An array of attribute names.
  35692. */
  35693. getAttributesNames(): string[];
  35694. /**
  35695. * Returns the attribute at the given index.
  35696. * @param index The index of the attribute.
  35697. * @returns The location of the attribute.
  35698. */
  35699. getAttributeLocation(index: number): number;
  35700. /**
  35701. * Returns the attribute based on the name of the variable.
  35702. * @param name of the attribute to look up.
  35703. * @returns the attribute location.
  35704. */
  35705. getAttributeLocationByName(name: string): number;
  35706. /**
  35707. * The number of attributes.
  35708. * @returns the numnber of attributes.
  35709. */
  35710. getAttributesCount(): number;
  35711. /**
  35712. * Gets the index of a uniform variable.
  35713. * @param uniformName of the uniform to look up.
  35714. * @returns the index.
  35715. */
  35716. getUniformIndex(uniformName: string): number;
  35717. /**
  35718. * Returns the attribute based on the name of the variable.
  35719. * @param uniformName of the uniform to look up.
  35720. * @returns the location of the uniform.
  35721. */
  35722. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35723. /**
  35724. * Returns an array of sampler variable names
  35725. * @returns The array of sampler variable names.
  35726. */
  35727. getSamplers(): string[];
  35728. /**
  35729. * Returns an array of uniform variable names
  35730. * @returns The array of uniform variable names.
  35731. */
  35732. getUniformNames(): string[];
  35733. /**
  35734. * Returns an array of uniform buffer variable names
  35735. * @returns The array of uniform buffer variable names.
  35736. */
  35737. getUniformBuffersNames(): string[];
  35738. /**
  35739. * Returns the index parameters used to create the effect
  35740. * @returns The index parameters object
  35741. */
  35742. getIndexParameters(): any;
  35743. /**
  35744. * The error from the last compilation.
  35745. * @returns the error string.
  35746. */
  35747. getCompilationError(): string;
  35748. /**
  35749. * Gets a boolean indicating that all fallbacks were used during compilation
  35750. * @returns true if all fallbacks were used
  35751. */
  35752. allFallbacksProcessed(): boolean;
  35753. /**
  35754. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35755. * @param func The callback to be used.
  35756. */
  35757. executeWhenCompiled(func: (effect: Effect) => void): void;
  35758. private _checkIsReady;
  35759. private _loadShader;
  35760. /**
  35761. * Gets the vertex shader source code of this effect
  35762. */
  35763. get vertexSourceCode(): string;
  35764. /**
  35765. * Gets the fragment shader source code of this effect
  35766. */
  35767. get fragmentSourceCode(): string;
  35768. /**
  35769. * Recompiles the webGL program
  35770. * @param vertexSourceCode The source code for the vertex shader.
  35771. * @param fragmentSourceCode The source code for the fragment shader.
  35772. * @param onCompiled Callback called when completed.
  35773. * @param onError Callback called on error.
  35774. * @hidden
  35775. */
  35776. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35777. /**
  35778. * Prepares the effect
  35779. * @hidden
  35780. */
  35781. _prepareEffect(): void;
  35782. private _getShaderCodeAndErrorLine;
  35783. private _processCompilationErrors;
  35784. /**
  35785. * Checks if the effect is supported. (Must be called after compilation)
  35786. */
  35787. get isSupported(): boolean;
  35788. /**
  35789. * Binds a texture to the engine to be used as output of the shader.
  35790. * @param channel Name of the output variable.
  35791. * @param texture Texture to bind.
  35792. * @hidden
  35793. */
  35794. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35795. /**
  35796. * Sets a texture on the engine to be used in the shader.
  35797. * @param channel Name of the sampler variable.
  35798. * @param texture Texture to set.
  35799. */
  35800. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35801. /**
  35802. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35803. * @param channel Name of the sampler variable.
  35804. * @param texture Texture to set.
  35805. */
  35806. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35807. /**
  35808. * Sets an array of textures on the engine to be used in the shader.
  35809. * @param channel Name of the variable.
  35810. * @param textures Textures to set.
  35811. */
  35812. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35813. /**
  35814. * 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)
  35815. * @param channel Name of the sampler variable.
  35816. * @param postProcess Post process to get the input texture from.
  35817. */
  35818. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35819. /**
  35820. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35821. * 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)
  35822. * @param channel Name of the sampler variable.
  35823. * @param postProcess Post process to get the output texture from.
  35824. */
  35825. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35826. /** @hidden */
  35827. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35828. /** @hidden */
  35829. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35830. /** @hidden */
  35831. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35832. /** @hidden */
  35833. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35834. /**
  35835. * Binds a buffer to a uniform.
  35836. * @param buffer Buffer to bind.
  35837. * @param name Name of the uniform variable to bind to.
  35838. */
  35839. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35840. /**
  35841. * Binds block to a uniform.
  35842. * @param blockName Name of the block to bind.
  35843. * @param index Index to bind.
  35844. */
  35845. bindUniformBlock(blockName: string, index: number): void;
  35846. /**
  35847. * Sets an interger value on a uniform variable.
  35848. * @param uniformName Name of the variable.
  35849. * @param value Value to be set.
  35850. * @returns this effect.
  35851. */
  35852. setInt(uniformName: string, value: number): Effect;
  35853. /**
  35854. * Sets an int array on a uniform variable.
  35855. * @param uniformName Name of the variable.
  35856. * @param array array to be set.
  35857. * @returns this effect.
  35858. */
  35859. setIntArray(uniformName: string, array: Int32Array): Effect;
  35860. /**
  35861. * 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)
  35862. * @param uniformName Name of the variable.
  35863. * @param array array to be set.
  35864. * @returns this effect.
  35865. */
  35866. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35867. /**
  35868. * 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)
  35869. * @param uniformName Name of the variable.
  35870. * @param array array to be set.
  35871. * @returns this effect.
  35872. */
  35873. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35874. /**
  35875. * 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)
  35876. * @param uniformName Name of the variable.
  35877. * @param array array to be set.
  35878. * @returns this effect.
  35879. */
  35880. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35881. /**
  35882. * Sets an float array on a uniform variable.
  35883. * @param uniformName Name of the variable.
  35884. * @param array array to be set.
  35885. * @returns this effect.
  35886. */
  35887. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35888. /**
  35889. * 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)
  35890. * @param uniformName Name of the variable.
  35891. * @param array array to be set.
  35892. * @returns this effect.
  35893. */
  35894. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35895. /**
  35896. * 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)
  35897. * @param uniformName Name of the variable.
  35898. * @param array array to be set.
  35899. * @returns this effect.
  35900. */
  35901. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35902. /**
  35903. * 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)
  35904. * @param uniformName Name of the variable.
  35905. * @param array array to be set.
  35906. * @returns this effect.
  35907. */
  35908. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35909. /**
  35910. * Sets an array on a uniform variable.
  35911. * @param uniformName Name of the variable.
  35912. * @param array array to be set.
  35913. * @returns this effect.
  35914. */
  35915. setArray(uniformName: string, array: number[]): Effect;
  35916. /**
  35917. * 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)
  35918. * @param uniformName Name of the variable.
  35919. * @param array array to be set.
  35920. * @returns this effect.
  35921. */
  35922. setArray2(uniformName: string, array: number[]): Effect;
  35923. /**
  35924. * 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)
  35925. * @param uniformName Name of the variable.
  35926. * @param array array to be set.
  35927. * @returns this effect.
  35928. */
  35929. setArray3(uniformName: string, array: number[]): Effect;
  35930. /**
  35931. * 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)
  35932. * @param uniformName Name of the variable.
  35933. * @param array array to be set.
  35934. * @returns this effect.
  35935. */
  35936. setArray4(uniformName: string, array: number[]): Effect;
  35937. /**
  35938. * Sets matrices on a uniform variable.
  35939. * @param uniformName Name of the variable.
  35940. * @param matrices matrices to be set.
  35941. * @returns this effect.
  35942. */
  35943. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35944. /**
  35945. * Sets matrix on a uniform variable.
  35946. * @param uniformName Name of the variable.
  35947. * @param matrix matrix to be set.
  35948. * @returns this effect.
  35949. */
  35950. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35951. /**
  35952. * 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)
  35953. * @param uniformName Name of the variable.
  35954. * @param matrix matrix to be set.
  35955. * @returns this effect.
  35956. */
  35957. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35958. /**
  35959. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35960. * @param uniformName Name of the variable.
  35961. * @param matrix matrix to be set.
  35962. * @returns this effect.
  35963. */
  35964. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35965. /**
  35966. * Sets a float on a uniform variable.
  35967. * @param uniformName Name of the variable.
  35968. * @param value value to be set.
  35969. * @returns this effect.
  35970. */
  35971. setFloat(uniformName: string, value: number): Effect;
  35972. /**
  35973. * Sets a boolean on a uniform variable.
  35974. * @param uniformName Name of the variable.
  35975. * @param bool value to be set.
  35976. * @returns this effect.
  35977. */
  35978. setBool(uniformName: string, bool: boolean): Effect;
  35979. /**
  35980. * Sets a Vector2 on a uniform variable.
  35981. * @param uniformName Name of the variable.
  35982. * @param vector2 vector2 to be set.
  35983. * @returns this effect.
  35984. */
  35985. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35986. /**
  35987. * Sets a float2 on a uniform variable.
  35988. * @param uniformName Name of the variable.
  35989. * @param x First float in float2.
  35990. * @param y Second float in float2.
  35991. * @returns this effect.
  35992. */
  35993. setFloat2(uniformName: string, x: number, y: number): Effect;
  35994. /**
  35995. * Sets a Vector3 on a uniform variable.
  35996. * @param uniformName Name of the variable.
  35997. * @param vector3 Value to be set.
  35998. * @returns this effect.
  35999. */
  36000. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  36001. /**
  36002. * Sets a float3 on a uniform variable.
  36003. * @param uniformName Name of the variable.
  36004. * @param x First float in float3.
  36005. * @param y Second float in float3.
  36006. * @param z Third float in float3.
  36007. * @returns this effect.
  36008. */
  36009. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  36010. /**
  36011. * Sets a Vector4 on a uniform variable.
  36012. * @param uniformName Name of the variable.
  36013. * @param vector4 Value to be set.
  36014. * @returns this effect.
  36015. */
  36016. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  36017. /**
  36018. * Sets a float4 on a uniform variable.
  36019. * @param uniformName Name of the variable.
  36020. * @param x First float in float4.
  36021. * @param y Second float in float4.
  36022. * @param z Third float in float4.
  36023. * @param w Fourth float in float4.
  36024. * @returns this effect.
  36025. */
  36026. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  36027. /**
  36028. * Sets a Color3 on a uniform variable.
  36029. * @param uniformName Name of the variable.
  36030. * @param color3 Value to be set.
  36031. * @returns this effect.
  36032. */
  36033. setColor3(uniformName: string, color3: IColor3Like): Effect;
  36034. /**
  36035. * Sets a Color4 on a uniform variable.
  36036. * @param uniformName Name of the variable.
  36037. * @param color3 Value to be set.
  36038. * @param alpha Alpha value to be set.
  36039. * @returns this effect.
  36040. */
  36041. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  36042. /**
  36043. * Sets a Color4 on a uniform variable
  36044. * @param uniformName defines the name of the variable
  36045. * @param color4 defines the value to be set
  36046. * @returns this effect.
  36047. */
  36048. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  36049. /** Release all associated resources */
  36050. dispose(): void;
  36051. /**
  36052. * This function will add a new shader to the shader store
  36053. * @param name the name of the shader
  36054. * @param pixelShader optional pixel shader content
  36055. * @param vertexShader optional vertex shader content
  36056. */
  36057. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  36058. /**
  36059. * Store of each shader (The can be looked up using effect.key)
  36060. */
  36061. static ShadersStore: {
  36062. [key: string]: string;
  36063. };
  36064. /**
  36065. * Store of each included file for a shader (The can be looked up using effect.key)
  36066. */
  36067. static IncludesShadersStore: {
  36068. [key: string]: string;
  36069. };
  36070. /**
  36071. * Resets the cache of effects.
  36072. */
  36073. static ResetCache(): void;
  36074. }
  36075. }
  36076. declare module "babylonjs/Engines/engineCapabilities" {
  36077. /**
  36078. * Interface used to describe the capabilities of the engine relatively to the current browser
  36079. */
  36080. export interface EngineCapabilities {
  36081. /** Maximum textures units per fragment shader */
  36082. maxTexturesImageUnits: number;
  36083. /** Maximum texture units per vertex shader */
  36084. maxVertexTextureImageUnits: number;
  36085. /** Maximum textures units in the entire pipeline */
  36086. maxCombinedTexturesImageUnits: number;
  36087. /** Maximum texture size */
  36088. maxTextureSize: number;
  36089. /** Maximum texture samples */
  36090. maxSamples?: number;
  36091. /** Maximum cube texture size */
  36092. maxCubemapTextureSize: number;
  36093. /** Maximum render texture size */
  36094. maxRenderTextureSize: number;
  36095. /** Maximum number of vertex attributes */
  36096. maxVertexAttribs: number;
  36097. /** Maximum number of varyings */
  36098. maxVaryingVectors: number;
  36099. /** Maximum number of uniforms per vertex shader */
  36100. maxVertexUniformVectors: number;
  36101. /** Maximum number of uniforms per fragment shader */
  36102. maxFragmentUniformVectors: number;
  36103. /** Defines if standard derivates (dx/dy) are supported */
  36104. standardDerivatives: boolean;
  36105. /** Defines if s3tc texture compression is supported */
  36106. s3tc?: WEBGL_compressed_texture_s3tc;
  36107. /** Defines if pvrtc texture compression is supported */
  36108. pvrtc: any;
  36109. /** Defines if etc1 texture compression is supported */
  36110. etc1: any;
  36111. /** Defines if etc2 texture compression is supported */
  36112. etc2: any;
  36113. /** Defines if astc texture compression is supported */
  36114. astc: any;
  36115. /** Defines if bptc texture compression is supported */
  36116. bptc: any;
  36117. /** Defines if float textures are supported */
  36118. textureFloat: boolean;
  36119. /** Defines if vertex array objects are supported */
  36120. vertexArrayObject: boolean;
  36121. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36122. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36123. /** Gets the maximum level of anisotropy supported */
  36124. maxAnisotropy: number;
  36125. /** Defines if instancing is supported */
  36126. instancedArrays: boolean;
  36127. /** Defines if 32 bits indices are supported */
  36128. uintIndices: boolean;
  36129. /** Defines if high precision shaders are supported */
  36130. highPrecisionShaderSupported: boolean;
  36131. /** Defines if depth reading in the fragment shader is supported */
  36132. fragmentDepthSupported: boolean;
  36133. /** Defines if float texture linear filtering is supported*/
  36134. textureFloatLinearFiltering: boolean;
  36135. /** Defines if rendering to float textures is supported */
  36136. textureFloatRender: boolean;
  36137. /** Defines if half float textures are supported*/
  36138. textureHalfFloat: boolean;
  36139. /** Defines if half float texture linear filtering is supported*/
  36140. textureHalfFloatLinearFiltering: boolean;
  36141. /** Defines if rendering to half float textures is supported */
  36142. textureHalfFloatRender: boolean;
  36143. /** Defines if textureLOD shader command is supported */
  36144. textureLOD: boolean;
  36145. /** Defines if draw buffers extension is supported */
  36146. drawBuffersExtension: boolean;
  36147. /** Defines if depth textures are supported */
  36148. depthTextureExtension: boolean;
  36149. /** Defines if float color buffer are supported */
  36150. colorBufferFloat: boolean;
  36151. /** Gets disjoint timer query extension (null if not supported) */
  36152. timerQuery?: EXT_disjoint_timer_query;
  36153. /** Defines if timestamp can be used with timer query */
  36154. canUseTimestampForTimerQuery: boolean;
  36155. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36156. multiview?: any;
  36157. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36158. oculusMultiview?: any;
  36159. /** Function used to let the system compiles shaders in background */
  36160. parallelShaderCompile?: {
  36161. COMPLETION_STATUS_KHR: number;
  36162. };
  36163. /** Max number of texture samples for MSAA */
  36164. maxMSAASamples: number;
  36165. /** Defines if the blend min max extension is supported */
  36166. blendMinMax: boolean;
  36167. }
  36168. }
  36169. declare module "babylonjs/States/depthCullingState" {
  36170. import { Nullable } from "babylonjs/types";
  36171. /**
  36172. * @hidden
  36173. **/
  36174. export class DepthCullingState {
  36175. private _isDepthTestDirty;
  36176. private _isDepthMaskDirty;
  36177. private _isDepthFuncDirty;
  36178. private _isCullFaceDirty;
  36179. private _isCullDirty;
  36180. private _isZOffsetDirty;
  36181. private _isFrontFaceDirty;
  36182. private _depthTest;
  36183. private _depthMask;
  36184. private _depthFunc;
  36185. private _cull;
  36186. private _cullFace;
  36187. private _zOffset;
  36188. private _frontFace;
  36189. /**
  36190. * Initializes the state.
  36191. */
  36192. constructor();
  36193. get isDirty(): boolean;
  36194. get zOffset(): number;
  36195. set zOffset(value: number);
  36196. get cullFace(): Nullable<number>;
  36197. set cullFace(value: Nullable<number>);
  36198. get cull(): Nullable<boolean>;
  36199. set cull(value: Nullable<boolean>);
  36200. get depthFunc(): Nullable<number>;
  36201. set depthFunc(value: Nullable<number>);
  36202. get depthMask(): boolean;
  36203. set depthMask(value: boolean);
  36204. get depthTest(): boolean;
  36205. set depthTest(value: boolean);
  36206. get frontFace(): Nullable<number>;
  36207. set frontFace(value: Nullable<number>);
  36208. reset(): void;
  36209. apply(gl: WebGLRenderingContext): void;
  36210. }
  36211. }
  36212. declare module "babylonjs/States/stencilState" {
  36213. /**
  36214. * @hidden
  36215. **/
  36216. export class StencilState {
  36217. /** 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 */
  36218. static readonly ALWAYS: number;
  36219. /** Passed to stencilOperation to specify that stencil value must be kept */
  36220. static readonly KEEP: number;
  36221. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36222. static readonly REPLACE: number;
  36223. private _isStencilTestDirty;
  36224. private _isStencilMaskDirty;
  36225. private _isStencilFuncDirty;
  36226. private _isStencilOpDirty;
  36227. private _stencilTest;
  36228. private _stencilMask;
  36229. private _stencilFunc;
  36230. private _stencilFuncRef;
  36231. private _stencilFuncMask;
  36232. private _stencilOpStencilFail;
  36233. private _stencilOpDepthFail;
  36234. private _stencilOpStencilDepthPass;
  36235. get isDirty(): boolean;
  36236. get stencilFunc(): number;
  36237. set stencilFunc(value: number);
  36238. get stencilFuncRef(): number;
  36239. set stencilFuncRef(value: number);
  36240. get stencilFuncMask(): number;
  36241. set stencilFuncMask(value: number);
  36242. get stencilOpStencilFail(): number;
  36243. set stencilOpStencilFail(value: number);
  36244. get stencilOpDepthFail(): number;
  36245. set stencilOpDepthFail(value: number);
  36246. get stencilOpStencilDepthPass(): number;
  36247. set stencilOpStencilDepthPass(value: number);
  36248. get stencilMask(): number;
  36249. set stencilMask(value: number);
  36250. get stencilTest(): boolean;
  36251. set stencilTest(value: boolean);
  36252. constructor();
  36253. reset(): void;
  36254. apply(gl: WebGLRenderingContext): void;
  36255. }
  36256. }
  36257. declare module "babylonjs/States/alphaCullingState" {
  36258. /**
  36259. * @hidden
  36260. **/
  36261. export class AlphaState {
  36262. private _isAlphaBlendDirty;
  36263. private _isBlendFunctionParametersDirty;
  36264. private _isBlendEquationParametersDirty;
  36265. private _isBlendConstantsDirty;
  36266. private _alphaBlend;
  36267. private _blendFunctionParameters;
  36268. private _blendEquationParameters;
  36269. private _blendConstants;
  36270. /**
  36271. * Initializes the state.
  36272. */
  36273. constructor();
  36274. get isDirty(): boolean;
  36275. get alphaBlend(): boolean;
  36276. set alphaBlend(value: boolean);
  36277. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36278. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36279. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36280. reset(): void;
  36281. apply(gl: WebGLRenderingContext): void;
  36282. }
  36283. }
  36284. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36285. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36286. /** @hidden */
  36287. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36288. attributeProcessor(attribute: string): string;
  36289. varyingProcessor(varying: string, isFragment: boolean): string;
  36290. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36291. }
  36292. }
  36293. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36294. /**
  36295. * Interface for attribute information associated with buffer instanciation
  36296. */
  36297. export interface InstancingAttributeInfo {
  36298. /**
  36299. * Name of the GLSL attribute
  36300. * if attribute index is not specified, this is used to retrieve the index from the effect
  36301. */
  36302. attributeName: string;
  36303. /**
  36304. * Index/offset of the attribute in the vertex shader
  36305. * if not specified, this will be computes from the name.
  36306. */
  36307. index?: number;
  36308. /**
  36309. * size of the attribute, 1, 2, 3 or 4
  36310. */
  36311. attributeSize: number;
  36312. /**
  36313. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36314. */
  36315. offset: number;
  36316. /**
  36317. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36318. * default to 1
  36319. */
  36320. divisor?: number;
  36321. /**
  36322. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36323. * default is FLOAT
  36324. */
  36325. attributeType?: number;
  36326. /**
  36327. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36328. */
  36329. normalized?: boolean;
  36330. }
  36331. }
  36332. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36333. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36334. import { Nullable } from "babylonjs/types";
  36335. module "babylonjs/Engines/thinEngine" {
  36336. interface ThinEngine {
  36337. /**
  36338. * Update a video texture
  36339. * @param texture defines the texture to update
  36340. * @param video defines the video element to use
  36341. * @param invertY defines if data must be stored with Y axis inverted
  36342. */
  36343. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36344. }
  36345. }
  36346. }
  36347. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36348. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36349. import { Nullable } from "babylonjs/types";
  36350. module "babylonjs/Engines/thinEngine" {
  36351. interface ThinEngine {
  36352. /**
  36353. * Creates a dynamic texture
  36354. * @param width defines the width of the texture
  36355. * @param height defines the height of the texture
  36356. * @param generateMipMaps defines if the engine should generate the mip levels
  36357. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36358. * @returns the dynamic texture inside an InternalTexture
  36359. */
  36360. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36361. /**
  36362. * Update the content of a dynamic texture
  36363. * @param texture defines the texture to update
  36364. * @param canvas defines the canvas containing the source
  36365. * @param invertY defines if data must be stored with Y axis inverted
  36366. * @param premulAlpha defines if alpha is stored as premultiplied
  36367. * @param format defines the format of the data
  36368. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36369. */
  36370. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36371. }
  36372. }
  36373. }
  36374. declare module "babylonjs/Materials/Textures/videoTexture" {
  36375. import { Observable } from "babylonjs/Misc/observable";
  36376. import { Nullable } from "babylonjs/types";
  36377. import { Scene } from "babylonjs/scene";
  36378. import { Texture } from "babylonjs/Materials/Textures/texture";
  36379. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36380. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36381. /**
  36382. * Settings for finer control over video usage
  36383. */
  36384. export interface VideoTextureSettings {
  36385. /**
  36386. * Applies `autoplay` to video, if specified
  36387. */
  36388. autoPlay?: boolean;
  36389. /**
  36390. * Applies `loop` to video, if specified
  36391. */
  36392. loop?: boolean;
  36393. /**
  36394. * Automatically updates internal texture from video at every frame in the render loop
  36395. */
  36396. autoUpdateTexture: boolean;
  36397. /**
  36398. * Image src displayed during the video loading or until the user interacts with the video.
  36399. */
  36400. poster?: string;
  36401. }
  36402. /**
  36403. * If you want to display a video in your scene, this is the special texture for that.
  36404. * This special texture works similar to other textures, with the exception of a few parameters.
  36405. * @see https://doc.babylonjs.com/how_to/video_texture
  36406. */
  36407. export class VideoTexture extends Texture {
  36408. /**
  36409. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36410. */
  36411. readonly autoUpdateTexture: boolean;
  36412. /**
  36413. * The video instance used by the texture internally
  36414. */
  36415. readonly video: HTMLVideoElement;
  36416. private _onUserActionRequestedObservable;
  36417. /**
  36418. * Event triggerd when a dom action is required by the user to play the video.
  36419. * This happens due to recent changes in browser policies preventing video to auto start.
  36420. */
  36421. get onUserActionRequestedObservable(): Observable<Texture>;
  36422. private _generateMipMaps;
  36423. private _stillImageCaptured;
  36424. private _displayingPosterTexture;
  36425. private _settings;
  36426. private _createInternalTextureOnEvent;
  36427. private _frameId;
  36428. private _currentSrc;
  36429. /**
  36430. * Creates a video texture.
  36431. * If you want to display a video in your scene, this is the special texture for that.
  36432. * This special texture works similar to other textures, with the exception of a few parameters.
  36433. * @see https://doc.babylonjs.com/how_to/video_texture
  36434. * @param name optional name, will detect from video source, if not defined
  36435. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36436. * @param scene is obviously the current scene.
  36437. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36438. * @param invertY is false by default but can be used to invert video on Y axis
  36439. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36440. * @param settings allows finer control over video usage
  36441. */
  36442. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36443. private _getName;
  36444. private _getVideo;
  36445. private _createInternalTexture;
  36446. private reset;
  36447. /**
  36448. * @hidden Internal method to initiate `update`.
  36449. */
  36450. _rebuild(): void;
  36451. /**
  36452. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36453. */
  36454. update(): void;
  36455. /**
  36456. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36457. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36458. */
  36459. updateTexture(isVisible: boolean): void;
  36460. protected _updateInternalTexture: () => void;
  36461. /**
  36462. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36463. * @param url New url.
  36464. */
  36465. updateURL(url: string): void;
  36466. /**
  36467. * Clones the texture.
  36468. * @returns the cloned texture
  36469. */
  36470. clone(): VideoTexture;
  36471. /**
  36472. * Dispose the texture and release its associated resources.
  36473. */
  36474. dispose(): void;
  36475. /**
  36476. * Creates a video texture straight from a stream.
  36477. * @param scene Define the scene the texture should be created in
  36478. * @param stream Define the stream the texture should be created from
  36479. * @returns The created video texture as a promise
  36480. */
  36481. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36482. /**
  36483. * Creates a video texture straight from your WebCam video feed.
  36484. * @param scene Define the scene the texture should be created in
  36485. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36486. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36487. * @returns The created video texture as a promise
  36488. */
  36489. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36490. minWidth: number;
  36491. maxWidth: number;
  36492. minHeight: number;
  36493. maxHeight: number;
  36494. deviceId: string;
  36495. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36496. /**
  36497. * Creates a video texture straight from your WebCam video feed.
  36498. * @param scene Define the scene the texture should be created in
  36499. * @param onReady Define a callback to triggered once the texture will be ready
  36500. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36501. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36502. */
  36503. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36504. minWidth: number;
  36505. maxWidth: number;
  36506. minHeight: number;
  36507. maxHeight: number;
  36508. deviceId: string;
  36509. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36510. }
  36511. }
  36512. declare module "babylonjs/Engines/thinEngine" {
  36513. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36514. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36515. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36516. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36517. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36518. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36519. import { Observable } from "babylonjs/Misc/observable";
  36520. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36521. import { StencilState } from "babylonjs/States/stencilState";
  36522. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36523. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36524. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36525. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36526. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36527. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36528. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36529. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36530. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36531. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36532. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36533. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36534. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36535. import { WebRequest } from "babylonjs/Misc/webRequest";
  36536. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36537. /**
  36538. * Defines the interface used by objects working like Scene
  36539. * @hidden
  36540. */
  36541. export interface ISceneLike {
  36542. _addPendingData(data: any): void;
  36543. _removePendingData(data: any): void;
  36544. offlineProvider: IOfflineProvider;
  36545. }
  36546. /**
  36547. * Information about the current host
  36548. */
  36549. export interface HostInformation {
  36550. /**
  36551. * Defines if the current host is a mobile
  36552. */
  36553. isMobile: boolean;
  36554. }
  36555. /** Interface defining initialization parameters for Engine class */
  36556. export interface EngineOptions extends WebGLContextAttributes {
  36557. /**
  36558. * Defines if the engine should no exceed a specified device ratio
  36559. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36560. */
  36561. limitDeviceRatio?: number;
  36562. /**
  36563. * Defines if webvr should be enabled automatically
  36564. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36565. */
  36566. autoEnableWebVR?: boolean;
  36567. /**
  36568. * Defines if webgl2 should be turned off even if supported
  36569. * @see https://doc.babylonjs.com/features/webgl2
  36570. */
  36571. disableWebGL2Support?: boolean;
  36572. /**
  36573. * Defines if webaudio should be initialized as well
  36574. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36575. */
  36576. audioEngine?: boolean;
  36577. /**
  36578. * Defines if animations should run using a deterministic lock step
  36579. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36580. */
  36581. deterministicLockstep?: boolean;
  36582. /** Defines the maximum steps to use with deterministic lock step mode */
  36583. lockstepMaxSteps?: number;
  36584. /** Defines the seconds between each deterministic lock step */
  36585. timeStep?: number;
  36586. /**
  36587. * Defines that engine should ignore context lost events
  36588. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36589. */
  36590. doNotHandleContextLost?: boolean;
  36591. /**
  36592. * Defines that engine should ignore modifying touch action attribute and style
  36593. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36594. */
  36595. doNotHandleTouchAction?: boolean;
  36596. /**
  36597. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36598. */
  36599. useHighPrecisionFloats?: boolean;
  36600. /**
  36601. * Make the canvas XR Compatible for XR sessions
  36602. */
  36603. xrCompatible?: boolean;
  36604. /**
  36605. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36606. */
  36607. useHighPrecisionMatrix?: boolean;
  36608. }
  36609. /**
  36610. * The base engine class (root of all engines)
  36611. */
  36612. export class ThinEngine {
  36613. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36614. static ExceptionList: ({
  36615. key: string;
  36616. capture: string;
  36617. captureConstraint: number;
  36618. targets: string[];
  36619. } | {
  36620. key: string;
  36621. capture: null;
  36622. captureConstraint: null;
  36623. targets: string[];
  36624. })[];
  36625. /** @hidden */
  36626. static _TextureLoaders: IInternalTextureLoader[];
  36627. /**
  36628. * Returns the current npm package of the sdk
  36629. */
  36630. static get NpmPackage(): string;
  36631. /**
  36632. * Returns the current version of the framework
  36633. */
  36634. static get Version(): string;
  36635. /**
  36636. * Returns a string describing the current engine
  36637. */
  36638. get description(): string;
  36639. /**
  36640. * Gets or sets the epsilon value used by collision engine
  36641. */
  36642. static CollisionsEpsilon: number;
  36643. /**
  36644. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36645. */
  36646. static get ShadersRepository(): string;
  36647. static set ShadersRepository(value: string);
  36648. /** @hidden */
  36649. _shaderProcessor: IShaderProcessor;
  36650. /**
  36651. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36652. */
  36653. forcePOTTextures: boolean;
  36654. /**
  36655. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36656. */
  36657. isFullscreen: boolean;
  36658. /**
  36659. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36660. */
  36661. cullBackFaces: boolean;
  36662. /**
  36663. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36664. */
  36665. renderEvenInBackground: boolean;
  36666. /**
  36667. * Gets or sets a boolean indicating that cache can be kept between frames
  36668. */
  36669. preventCacheWipeBetweenFrames: boolean;
  36670. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36671. validateShaderPrograms: boolean;
  36672. /**
  36673. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36674. * This can provide greater z depth for distant objects.
  36675. */
  36676. useReverseDepthBuffer: boolean;
  36677. /**
  36678. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36679. */
  36680. disableUniformBuffers: boolean;
  36681. /** @hidden */
  36682. _uniformBuffers: UniformBuffer[];
  36683. /**
  36684. * Gets a boolean indicating that the engine supports uniform buffers
  36685. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36686. */
  36687. get supportsUniformBuffers(): boolean;
  36688. /** @hidden */
  36689. _gl: WebGLRenderingContext;
  36690. /** @hidden */
  36691. _webGLVersion: number;
  36692. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36693. protected _windowIsBackground: boolean;
  36694. protected _creationOptions: EngineOptions;
  36695. protected _highPrecisionShadersAllowed: boolean;
  36696. /** @hidden */
  36697. get _shouldUseHighPrecisionShader(): boolean;
  36698. /**
  36699. * Gets a boolean indicating that only power of 2 textures are supported
  36700. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36701. */
  36702. get needPOTTextures(): boolean;
  36703. /** @hidden */
  36704. _badOS: boolean;
  36705. /** @hidden */
  36706. _badDesktopOS: boolean;
  36707. private _hardwareScalingLevel;
  36708. /** @hidden */
  36709. _caps: EngineCapabilities;
  36710. private _isStencilEnable;
  36711. private _glVersion;
  36712. private _glRenderer;
  36713. private _glVendor;
  36714. /** @hidden */
  36715. _videoTextureSupported: boolean;
  36716. protected _renderingQueueLaunched: boolean;
  36717. protected _activeRenderLoops: (() => void)[];
  36718. /**
  36719. * Observable signaled when a context lost event is raised
  36720. */
  36721. onContextLostObservable: Observable<ThinEngine>;
  36722. /**
  36723. * Observable signaled when a context restored event is raised
  36724. */
  36725. onContextRestoredObservable: Observable<ThinEngine>;
  36726. private _onContextLost;
  36727. private _onContextRestored;
  36728. protected _contextWasLost: boolean;
  36729. /** @hidden */
  36730. _doNotHandleContextLost: boolean;
  36731. /**
  36732. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36733. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36734. */
  36735. get doNotHandleContextLost(): boolean;
  36736. set doNotHandleContextLost(value: boolean);
  36737. /**
  36738. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36739. */
  36740. disableVertexArrayObjects: boolean;
  36741. /** @hidden */
  36742. protected _colorWrite: boolean;
  36743. /** @hidden */
  36744. protected _colorWriteChanged: boolean;
  36745. /** @hidden */
  36746. protected _depthCullingState: DepthCullingState;
  36747. /** @hidden */
  36748. protected _stencilState: StencilState;
  36749. /** @hidden */
  36750. _alphaState: AlphaState;
  36751. /** @hidden */
  36752. _alphaMode: number;
  36753. /** @hidden */
  36754. _alphaEquation: number;
  36755. /** @hidden */
  36756. _internalTexturesCache: InternalTexture[];
  36757. /** @hidden */
  36758. protected _activeChannel: number;
  36759. private _currentTextureChannel;
  36760. /** @hidden */
  36761. protected _boundTexturesCache: {
  36762. [key: string]: Nullable<InternalTexture>;
  36763. };
  36764. /** @hidden */
  36765. protected _currentEffect: Nullable<Effect>;
  36766. /** @hidden */
  36767. protected _currentProgram: Nullable<WebGLProgram>;
  36768. private _compiledEffects;
  36769. private _vertexAttribArraysEnabled;
  36770. /** @hidden */
  36771. protected _cachedViewport: Nullable<IViewportLike>;
  36772. private _cachedVertexArrayObject;
  36773. /** @hidden */
  36774. protected _cachedVertexBuffers: any;
  36775. /** @hidden */
  36776. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36777. /** @hidden */
  36778. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36779. /** @hidden */
  36780. _currentRenderTarget: Nullable<InternalTexture>;
  36781. private _uintIndicesCurrentlySet;
  36782. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36783. /** @hidden */
  36784. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36785. /** @hidden */
  36786. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36787. private _currentBufferPointers;
  36788. private _currentInstanceLocations;
  36789. private _currentInstanceBuffers;
  36790. private _textureUnits;
  36791. /** @hidden */
  36792. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36793. /** @hidden */
  36794. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36795. /** @hidden */
  36796. _boundRenderFunction: any;
  36797. private _vaoRecordInProgress;
  36798. private _mustWipeVertexAttributes;
  36799. private _emptyTexture;
  36800. private _emptyCubeTexture;
  36801. private _emptyTexture3D;
  36802. private _emptyTexture2DArray;
  36803. /** @hidden */
  36804. _frameHandler: number;
  36805. private _nextFreeTextureSlots;
  36806. private _maxSimultaneousTextures;
  36807. private _activeRequests;
  36808. /** @hidden */
  36809. _transformTextureUrl: Nullable<(url: string) => string>;
  36810. /**
  36811. * Gets information about the current host
  36812. */
  36813. hostInformation: HostInformation;
  36814. protected get _supportsHardwareTextureRescaling(): boolean;
  36815. private _framebufferDimensionsObject;
  36816. /**
  36817. * sets the object from which width and height will be taken from when getting render width and height
  36818. * Will fallback to the gl object
  36819. * @param dimensions the framebuffer width and height that will be used.
  36820. */
  36821. set framebufferDimensionsObject(dimensions: Nullable<{
  36822. framebufferWidth: number;
  36823. framebufferHeight: number;
  36824. }>);
  36825. /**
  36826. * Gets the current viewport
  36827. */
  36828. get currentViewport(): Nullable<IViewportLike>;
  36829. /**
  36830. * Gets the default empty texture
  36831. */
  36832. get emptyTexture(): InternalTexture;
  36833. /**
  36834. * Gets the default empty 3D texture
  36835. */
  36836. get emptyTexture3D(): InternalTexture;
  36837. /**
  36838. * Gets the default empty 2D array texture
  36839. */
  36840. get emptyTexture2DArray(): InternalTexture;
  36841. /**
  36842. * Gets the default empty cube texture
  36843. */
  36844. get emptyCubeTexture(): InternalTexture;
  36845. /**
  36846. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36847. */
  36848. readonly premultipliedAlpha: boolean;
  36849. /**
  36850. * Observable event triggered before each texture is initialized
  36851. */
  36852. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36853. /**
  36854. * Creates a new engine
  36855. * @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
  36856. * @param antialias defines enable antialiasing (default: false)
  36857. * @param options defines further options to be sent to the getContext() function
  36858. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36859. */
  36860. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36861. private _rebuildInternalTextures;
  36862. private _rebuildEffects;
  36863. /**
  36864. * Gets a boolean indicating if all created effects are ready
  36865. * @returns true if all effects are ready
  36866. */
  36867. areAllEffectsReady(): boolean;
  36868. protected _rebuildBuffers(): void;
  36869. protected _initGLContext(): void;
  36870. /**
  36871. * Gets version of the current webGL context
  36872. */
  36873. get webGLVersion(): number;
  36874. /**
  36875. * Gets a string identifying the name of the class
  36876. * @returns "Engine" string
  36877. */
  36878. getClassName(): string;
  36879. /**
  36880. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36881. */
  36882. get isStencilEnable(): boolean;
  36883. /** @hidden */
  36884. _prepareWorkingCanvas(): void;
  36885. /**
  36886. * Reset the texture cache to empty state
  36887. */
  36888. resetTextureCache(): void;
  36889. /**
  36890. * Gets an object containing information about the current webGL context
  36891. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36892. */
  36893. getGlInfo(): {
  36894. vendor: string;
  36895. renderer: string;
  36896. version: string;
  36897. };
  36898. /**
  36899. * Defines the hardware scaling level.
  36900. * By default the hardware scaling level is computed from the window device ratio.
  36901. * 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.
  36902. * @param level defines the level to use
  36903. */
  36904. setHardwareScalingLevel(level: number): void;
  36905. /**
  36906. * Gets the current hardware scaling level.
  36907. * By default the hardware scaling level is computed from the window device ratio.
  36908. * 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.
  36909. * @returns a number indicating the current hardware scaling level
  36910. */
  36911. getHardwareScalingLevel(): number;
  36912. /**
  36913. * Gets the list of loaded textures
  36914. * @returns an array containing all loaded textures
  36915. */
  36916. getLoadedTexturesCache(): InternalTexture[];
  36917. /**
  36918. * Gets the object containing all engine capabilities
  36919. * @returns the EngineCapabilities object
  36920. */
  36921. getCaps(): EngineCapabilities;
  36922. /**
  36923. * stop executing a render loop function and remove it from the execution array
  36924. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36925. */
  36926. stopRenderLoop(renderFunction?: () => void): void;
  36927. /** @hidden */
  36928. _renderLoop(): void;
  36929. /**
  36930. * Gets the HTML canvas attached with the current webGL context
  36931. * @returns a HTML canvas
  36932. */
  36933. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36934. /**
  36935. * Gets host window
  36936. * @returns the host window object
  36937. */
  36938. getHostWindow(): Nullable<Window>;
  36939. /**
  36940. * Gets the current render width
  36941. * @param useScreen defines if screen size must be used (or the current render target if any)
  36942. * @returns a number defining the current render width
  36943. */
  36944. getRenderWidth(useScreen?: boolean): number;
  36945. /**
  36946. * Gets the current render height
  36947. * @param useScreen defines if screen size must be used (or the current render target if any)
  36948. * @returns a number defining the current render height
  36949. */
  36950. getRenderHeight(useScreen?: boolean): number;
  36951. /**
  36952. * Can be used to override the current requestAnimationFrame requester.
  36953. * @hidden
  36954. */
  36955. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36956. /**
  36957. * Register and execute a render loop. The engine can have more than one render function
  36958. * @param renderFunction defines the function to continuously execute
  36959. */
  36960. runRenderLoop(renderFunction: () => void): void;
  36961. /**
  36962. * Clear the current render buffer or the current render target (if any is set up)
  36963. * @param color defines the color to use
  36964. * @param backBuffer defines if the back buffer must be cleared
  36965. * @param depth defines if the depth buffer must be cleared
  36966. * @param stencil defines if the stencil buffer must be cleared
  36967. */
  36968. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36969. private _viewportCached;
  36970. /** @hidden */
  36971. _viewport(x: number, y: number, width: number, height: number): void;
  36972. /**
  36973. * Set the WebGL's viewport
  36974. * @param viewport defines the viewport element to be used
  36975. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36976. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36977. */
  36978. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36979. /**
  36980. * Begin a new frame
  36981. */
  36982. beginFrame(): void;
  36983. /**
  36984. * Enf the current frame
  36985. */
  36986. endFrame(): void;
  36987. /**
  36988. * Resize the view according to the canvas' size
  36989. */
  36990. resize(): void;
  36991. /**
  36992. * Force a specific size of the canvas
  36993. * @param width defines the new canvas' width
  36994. * @param height defines the new canvas' height
  36995. * @returns true if the size was changed
  36996. */
  36997. setSize(width: number, height: number): boolean;
  36998. /**
  36999. * Binds the frame buffer to the specified texture.
  37000. * @param texture The texture to render to or null for the default canvas
  37001. * @param faceIndex The face of the texture to render to in case of cube texture
  37002. * @param requiredWidth The width of the target to render to
  37003. * @param requiredHeight The height of the target to render to
  37004. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  37005. * @param lodLevel defines the lod level to bind to the frame buffer
  37006. * @param layer defines the 2d array index to bind to frame buffer to
  37007. */
  37008. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  37009. /** @hidden */
  37010. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  37011. /**
  37012. * Unbind the current render target texture from the webGL context
  37013. * @param texture defines the render target texture to unbind
  37014. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  37015. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  37016. */
  37017. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  37018. /**
  37019. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  37020. */
  37021. flushFramebuffer(): void;
  37022. /**
  37023. * Unbind the current render target and bind the default framebuffer
  37024. */
  37025. restoreDefaultFramebuffer(): void;
  37026. /** @hidden */
  37027. protected _resetVertexBufferBinding(): void;
  37028. /**
  37029. * Creates a vertex buffer
  37030. * @param data the data for the vertex buffer
  37031. * @returns the new WebGL static buffer
  37032. */
  37033. createVertexBuffer(data: DataArray): DataBuffer;
  37034. private _createVertexBuffer;
  37035. /**
  37036. * Creates a dynamic vertex buffer
  37037. * @param data the data for the dynamic vertex buffer
  37038. * @returns the new WebGL dynamic buffer
  37039. */
  37040. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  37041. protected _resetIndexBufferBinding(): void;
  37042. /**
  37043. * Creates a new index buffer
  37044. * @param indices defines the content of the index buffer
  37045. * @param updatable defines if the index buffer must be updatable
  37046. * @returns a new webGL buffer
  37047. */
  37048. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  37049. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  37050. /**
  37051. * Bind a webGL buffer to the webGL context
  37052. * @param buffer defines the buffer to bind
  37053. */
  37054. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  37055. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  37056. private bindBuffer;
  37057. /**
  37058. * update the bound buffer with the given data
  37059. * @param data defines the data to update
  37060. */
  37061. updateArrayBuffer(data: Float32Array): void;
  37062. private _vertexAttribPointer;
  37063. /** @hidden */
  37064. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  37065. private _bindVertexBuffersAttributes;
  37066. /**
  37067. * Records a vertex array object
  37068. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  37069. * @param vertexBuffers defines the list of vertex buffers to store
  37070. * @param indexBuffer defines the index buffer to store
  37071. * @param effect defines the effect to store
  37072. * @returns the new vertex array object
  37073. */
  37074. recordVertexArrayObject(vertexBuffers: {
  37075. [key: string]: VertexBuffer;
  37076. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  37077. /**
  37078. * Bind a specific vertex array object
  37079. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  37080. * @param vertexArrayObject defines the vertex array object to bind
  37081. * @param indexBuffer defines the index buffer to bind
  37082. */
  37083. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  37084. /**
  37085. * Bind webGl buffers directly to the webGL context
  37086. * @param vertexBuffer defines the vertex buffer to bind
  37087. * @param indexBuffer defines the index buffer to bind
  37088. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  37089. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  37090. * @param effect defines the effect associated with the vertex buffer
  37091. */
  37092. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  37093. private _unbindVertexArrayObject;
  37094. /**
  37095. * Bind a list of vertex buffers to the webGL context
  37096. * @param vertexBuffers defines the list of vertex buffers to bind
  37097. * @param indexBuffer defines the index buffer to bind
  37098. * @param effect defines the effect associated with the vertex buffers
  37099. */
  37100. bindBuffers(vertexBuffers: {
  37101. [key: string]: Nullable<VertexBuffer>;
  37102. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37103. /**
  37104. * Unbind all instance attributes
  37105. */
  37106. unbindInstanceAttributes(): void;
  37107. /**
  37108. * Release and free the memory of a vertex array object
  37109. * @param vao defines the vertex array object to delete
  37110. */
  37111. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37112. /** @hidden */
  37113. _releaseBuffer(buffer: DataBuffer): boolean;
  37114. protected _deleteBuffer(buffer: DataBuffer): void;
  37115. /**
  37116. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37117. * @param instancesBuffer defines the webGL buffer to update and bind
  37118. * @param data defines the data to store in the buffer
  37119. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37120. */
  37121. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37122. /**
  37123. * Bind the content of a webGL buffer used with instantiation
  37124. * @param instancesBuffer defines the webGL buffer to bind
  37125. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37126. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37127. */
  37128. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37129. /**
  37130. * Disable the instance attribute corresponding to the name in parameter
  37131. * @param name defines the name of the attribute to disable
  37132. */
  37133. disableInstanceAttributeByName(name: string): void;
  37134. /**
  37135. * Disable the instance attribute corresponding to the location in parameter
  37136. * @param attributeLocation defines the attribute location of the attribute to disable
  37137. */
  37138. disableInstanceAttribute(attributeLocation: number): void;
  37139. /**
  37140. * Disable the attribute corresponding to the location in parameter
  37141. * @param attributeLocation defines the attribute location of the attribute to disable
  37142. */
  37143. disableAttributeByIndex(attributeLocation: number): void;
  37144. /**
  37145. * Send a draw order
  37146. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37147. * @param indexStart defines the starting index
  37148. * @param indexCount defines the number of index to draw
  37149. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37150. */
  37151. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37152. /**
  37153. * Draw a list of points
  37154. * @param verticesStart defines the index of first vertex to draw
  37155. * @param verticesCount defines the count of vertices to draw
  37156. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37157. */
  37158. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37159. /**
  37160. * Draw a list of unindexed primitives
  37161. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37162. * @param verticesStart defines the index of first vertex to draw
  37163. * @param verticesCount defines the count of vertices to draw
  37164. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37165. */
  37166. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37167. /**
  37168. * Draw a list of indexed primitives
  37169. * @param fillMode defines the primitive to use
  37170. * @param indexStart defines the starting index
  37171. * @param indexCount defines the number of index to draw
  37172. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37173. */
  37174. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37175. /**
  37176. * Draw a list of unindexed primitives
  37177. * @param fillMode defines the primitive to use
  37178. * @param verticesStart defines the index of first vertex to draw
  37179. * @param verticesCount defines the count of vertices to draw
  37180. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37181. */
  37182. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37183. private _drawMode;
  37184. /** @hidden */
  37185. protected _reportDrawCall(): void;
  37186. /** @hidden */
  37187. _releaseEffect(effect: Effect): void;
  37188. /** @hidden */
  37189. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37190. /**
  37191. * Create a new effect (used to store vertex/fragment shaders)
  37192. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37193. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37194. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37195. * @param samplers defines an array of string used to represent textures
  37196. * @param defines defines the string containing the defines to use to compile the shaders
  37197. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37198. * @param onCompiled defines a function to call when the effect creation is successful
  37199. * @param onError defines a function to call when the effect creation has failed
  37200. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37201. * @returns the new Effect
  37202. */
  37203. 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;
  37204. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37205. private _compileShader;
  37206. private _compileRawShader;
  37207. /** @hidden */
  37208. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37209. /**
  37210. * Directly creates a webGL program
  37211. * @param pipelineContext defines the pipeline context to attach to
  37212. * @param vertexCode defines the vertex shader code to use
  37213. * @param fragmentCode defines the fragment shader code to use
  37214. * @param context defines the webGL context to use (if not set, the current one will be used)
  37215. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37216. * @returns the new webGL program
  37217. */
  37218. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37219. /**
  37220. * Creates a webGL program
  37221. * @param pipelineContext defines the pipeline context to attach to
  37222. * @param vertexCode defines the vertex shader code to use
  37223. * @param fragmentCode defines the fragment shader code to use
  37224. * @param defines defines the string containing the defines to use to compile the shaders
  37225. * @param context defines the webGL context to use (if not set, the current one will be used)
  37226. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37227. * @returns the new webGL program
  37228. */
  37229. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37230. /**
  37231. * Creates a new pipeline context
  37232. * @returns the new pipeline
  37233. */
  37234. createPipelineContext(): IPipelineContext;
  37235. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37236. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37237. /** @hidden */
  37238. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37239. /** @hidden */
  37240. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37241. /** @hidden */
  37242. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37243. /**
  37244. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37245. * @param pipelineContext defines the pipeline context to use
  37246. * @param uniformsNames defines the list of uniform names
  37247. * @returns an array of webGL uniform locations
  37248. */
  37249. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37250. /**
  37251. * Gets the lsit of active attributes for a given webGL program
  37252. * @param pipelineContext defines the pipeline context to use
  37253. * @param attributesNames defines the list of attribute names to get
  37254. * @returns an array of indices indicating the offset of each attribute
  37255. */
  37256. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37257. /**
  37258. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37259. * @param effect defines the effect to activate
  37260. */
  37261. enableEffect(effect: Nullable<Effect>): void;
  37262. /**
  37263. * Set the value of an uniform to a number (int)
  37264. * @param uniform defines the webGL uniform location where to store the value
  37265. * @param value defines the int number to store
  37266. * @returns true if the value was set
  37267. */
  37268. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  37269. /**
  37270. * Set the value of an uniform to an array of int32
  37271. * @param uniform defines the webGL uniform location where to store the value
  37272. * @param array defines the array of int32 to store
  37273. * @returns true if the value was set
  37274. */
  37275. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37276. /**
  37277. * Set the value of an uniform to an array of int32 (stored as vec2)
  37278. * @param uniform defines the webGL uniform location where to store the value
  37279. * @param array defines the array of int32 to store
  37280. * @returns true if the value was set
  37281. */
  37282. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37283. /**
  37284. * Set the value of an uniform to an array of int32 (stored as vec3)
  37285. * @param uniform defines the webGL uniform location where to store the value
  37286. * @param array defines the array of int32 to store
  37287. * @returns true if the value was set
  37288. */
  37289. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37290. /**
  37291. * Set the value of an uniform to an array of int32 (stored as vec4)
  37292. * @param uniform defines the webGL uniform location where to store the value
  37293. * @param array defines the array of int32 to store
  37294. * @returns true if the value was set
  37295. */
  37296. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37297. /**
  37298. * Set the value of an uniform to an array of number
  37299. * @param uniform defines the webGL uniform location where to store the value
  37300. * @param array defines the array of number to store
  37301. * @returns true if the value was set
  37302. */
  37303. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37304. /**
  37305. * Set the value of an uniform to an array of number (stored as vec2)
  37306. * @param uniform defines the webGL uniform location where to store the value
  37307. * @param array defines the array of number to store
  37308. * @returns true if the value was set
  37309. */
  37310. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37311. /**
  37312. * Set the value of an uniform to an array of number (stored as vec3)
  37313. * @param uniform defines the webGL uniform location where to store the value
  37314. * @param array defines the array of number to store
  37315. * @returns true if the value was set
  37316. */
  37317. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37318. /**
  37319. * Set the value of an uniform to an array of number (stored as vec4)
  37320. * @param uniform defines the webGL uniform location where to store the value
  37321. * @param array defines the array of number to store
  37322. * @returns true if the value was set
  37323. */
  37324. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37325. /**
  37326. * Set the value of an uniform to an array of float32 (stored as matrices)
  37327. * @param uniform defines the webGL uniform location where to store the value
  37328. * @param matrices defines the array of float32 to store
  37329. * @returns true if the value was set
  37330. */
  37331. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  37332. /**
  37333. * Set the value of an uniform to a matrix (3x3)
  37334. * @param uniform defines the webGL uniform location where to store the value
  37335. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37336. * @returns true if the value was set
  37337. */
  37338. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  37339. /**
  37340. * Set the value of an uniform to a matrix (2x2)
  37341. * @param uniform defines the webGL uniform location where to store the value
  37342. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37343. * @returns true if the value was set
  37344. */
  37345. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  37346. /**
  37347. * Set the value of an uniform to a number (float)
  37348. * @param uniform defines the webGL uniform location where to store the value
  37349. * @param value defines the float number to store
  37350. * @returns true if the value was transfered
  37351. */
  37352. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  37353. /**
  37354. * Set the value of an uniform to a vec2
  37355. * @param uniform defines the webGL uniform location where to store the value
  37356. * @param x defines the 1st component of the value
  37357. * @param y defines the 2nd component of the value
  37358. * @returns true if the value was set
  37359. */
  37360. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  37361. /**
  37362. * Set the value of an uniform to a vec3
  37363. * @param uniform defines the webGL uniform location where to store the value
  37364. * @param x defines the 1st component of the value
  37365. * @param y defines the 2nd component of the value
  37366. * @param z defines the 3rd component of the value
  37367. * @returns true if the value was set
  37368. */
  37369. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  37370. /**
  37371. * Set the value of an uniform to a vec4
  37372. * @param uniform defines the webGL uniform location where to store the value
  37373. * @param x defines the 1st component of the value
  37374. * @param y defines the 2nd component of the value
  37375. * @param z defines the 3rd component of the value
  37376. * @param w defines the 4th component of the value
  37377. * @returns true if the value was set
  37378. */
  37379. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  37380. /**
  37381. * Apply all cached states (depth, culling, stencil and alpha)
  37382. */
  37383. applyStates(): void;
  37384. /**
  37385. * Enable or disable color writing
  37386. * @param enable defines the state to set
  37387. */
  37388. setColorWrite(enable: boolean): void;
  37389. /**
  37390. * Gets a boolean indicating if color writing is enabled
  37391. * @returns the current color writing state
  37392. */
  37393. getColorWrite(): boolean;
  37394. /**
  37395. * Gets the depth culling state manager
  37396. */
  37397. get depthCullingState(): DepthCullingState;
  37398. /**
  37399. * Gets the alpha state manager
  37400. */
  37401. get alphaState(): AlphaState;
  37402. /**
  37403. * Gets the stencil state manager
  37404. */
  37405. get stencilState(): StencilState;
  37406. /**
  37407. * Clears the list of texture accessible through engine.
  37408. * This can help preventing texture load conflict due to name collision.
  37409. */
  37410. clearInternalTexturesCache(): void;
  37411. /**
  37412. * Force the entire cache to be cleared
  37413. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37414. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37415. */
  37416. wipeCaches(bruteForce?: boolean): void;
  37417. /** @hidden */
  37418. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37419. min: number;
  37420. mag: number;
  37421. };
  37422. /** @hidden */
  37423. _createTexture(): WebGLTexture;
  37424. /**
  37425. * Usually called from Texture.ts.
  37426. * Passed information to create a WebGLTexture
  37427. * @param url defines a value which contains one of the following:
  37428. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37429. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37430. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37431. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37432. * @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)
  37433. * @param scene needed for loading to the correct scene
  37434. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37435. * @param onLoad optional callback to be called upon successful completion
  37436. * @param onError optional callback to be called upon failure
  37437. * @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
  37438. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37439. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37440. * @param forcedExtension defines the extension to use to pick the right loader
  37441. * @param mimeType defines an optional mime type
  37442. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37443. */
  37444. 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;
  37445. /**
  37446. * Loads an image as an HTMLImageElement.
  37447. * @param input url string, ArrayBuffer, or Blob to load
  37448. * @param onLoad callback called when the image successfully loads
  37449. * @param onError callback called when the image fails to load
  37450. * @param offlineProvider offline provider for caching
  37451. * @param mimeType optional mime type
  37452. * @returns the HTMLImageElement of the loaded image
  37453. * @hidden
  37454. */
  37455. 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>;
  37456. /**
  37457. * @hidden
  37458. */
  37459. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37460. private _unpackFlipYCached;
  37461. /**
  37462. * In case you are sharing the context with other applications, it might
  37463. * be interested to not cache the unpack flip y state to ensure a consistent
  37464. * value would be set.
  37465. */
  37466. enableUnpackFlipYCached: boolean;
  37467. /** @hidden */
  37468. _unpackFlipY(value: boolean): void;
  37469. /** @hidden */
  37470. _getUnpackAlignement(): number;
  37471. private _getTextureTarget;
  37472. /**
  37473. * Update the sampling mode of a given texture
  37474. * @param samplingMode defines the required sampling mode
  37475. * @param texture defines the texture to update
  37476. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37477. */
  37478. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37479. /**
  37480. * Update the sampling mode of a given texture
  37481. * @param texture defines the texture to update
  37482. * @param wrapU defines the texture wrap mode of the u coordinates
  37483. * @param wrapV defines the texture wrap mode of the v coordinates
  37484. * @param wrapR defines the texture wrap mode of the r coordinates
  37485. */
  37486. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37487. /** @hidden */
  37488. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37489. width: number;
  37490. height: number;
  37491. layers?: number;
  37492. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37493. /** @hidden */
  37494. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37495. /** @hidden */
  37496. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37497. /**
  37498. * Update a portion of an internal texture
  37499. * @param texture defines the texture to update
  37500. * @param imageData defines the data to store into the texture
  37501. * @param xOffset defines the x coordinates of the update rectangle
  37502. * @param yOffset defines the y coordinates of the update rectangle
  37503. * @param width defines the width of the update rectangle
  37504. * @param height defines the height of the update rectangle
  37505. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37506. * @param lod defines the lod level to update (0 by default)
  37507. */
  37508. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37509. /** @hidden */
  37510. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37511. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37512. private _prepareWebGLTexture;
  37513. /** @hidden */
  37514. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37515. private _getDepthStencilBuffer;
  37516. /** @hidden */
  37517. _releaseFramebufferObjects(texture: InternalTexture): void;
  37518. /** @hidden */
  37519. _releaseTexture(texture: InternalTexture): void;
  37520. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37521. protected _setProgram(program: WebGLProgram): void;
  37522. protected _boundUniforms: {
  37523. [key: number]: WebGLUniformLocation;
  37524. };
  37525. /**
  37526. * Binds an effect to the webGL context
  37527. * @param effect defines the effect to bind
  37528. */
  37529. bindSamplers(effect: Effect): void;
  37530. private _activateCurrentTexture;
  37531. /** @hidden */
  37532. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37533. /** @hidden */
  37534. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37535. /**
  37536. * Unbind all textures from the webGL context
  37537. */
  37538. unbindAllTextures(): void;
  37539. /**
  37540. * Sets a texture to the according uniform.
  37541. * @param channel The texture channel
  37542. * @param uniform The uniform to set
  37543. * @param texture The texture to apply
  37544. */
  37545. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37546. private _bindSamplerUniformToChannel;
  37547. private _getTextureWrapMode;
  37548. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37549. /**
  37550. * Sets an array of texture to the webGL context
  37551. * @param channel defines the channel where the texture array must be set
  37552. * @param uniform defines the associated uniform location
  37553. * @param textures defines the array of textures to bind
  37554. */
  37555. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37556. /** @hidden */
  37557. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37558. private _setTextureParameterFloat;
  37559. private _setTextureParameterInteger;
  37560. /**
  37561. * Unbind all vertex attributes from the webGL context
  37562. */
  37563. unbindAllAttributes(): void;
  37564. /**
  37565. * 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
  37566. */
  37567. releaseEffects(): void;
  37568. /**
  37569. * Dispose and release all associated resources
  37570. */
  37571. dispose(): void;
  37572. /**
  37573. * Attach a new callback raised when context lost event is fired
  37574. * @param callback defines the callback to call
  37575. */
  37576. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37577. /**
  37578. * Attach a new callback raised when context restored event is fired
  37579. * @param callback defines the callback to call
  37580. */
  37581. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37582. /**
  37583. * Get the current error code of the webGL context
  37584. * @returns the error code
  37585. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37586. */
  37587. getError(): number;
  37588. private _canRenderToFloatFramebuffer;
  37589. private _canRenderToHalfFloatFramebuffer;
  37590. private _canRenderToFramebuffer;
  37591. /** @hidden */
  37592. _getWebGLTextureType(type: number): number;
  37593. /** @hidden */
  37594. _getInternalFormat(format: number): number;
  37595. /** @hidden */
  37596. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37597. /** @hidden */
  37598. _getRGBAMultiSampleBufferFormat(type: number): number;
  37599. /** @hidden */
  37600. _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;
  37601. /**
  37602. * Loads a file from a url
  37603. * @param url url to load
  37604. * @param onSuccess callback called when the file successfully loads
  37605. * @param onProgress callback called while file is loading (if the server supports this mode)
  37606. * @param offlineProvider defines the offline provider for caching
  37607. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37608. * @param onError callback called when the file fails to load
  37609. * @returns a file request object
  37610. * @hidden
  37611. */
  37612. 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;
  37613. /**
  37614. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37615. * @param x defines the x coordinate of the rectangle where pixels must be read
  37616. * @param y defines the y coordinate of the rectangle where pixels must be read
  37617. * @param width defines the width of the rectangle where pixels must be read
  37618. * @param height defines the height of the rectangle where pixels must be read
  37619. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37620. * @returns a Uint8Array containing RGBA colors
  37621. */
  37622. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37623. private static _isSupported;
  37624. /**
  37625. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37626. * @returns true if the engine can be created
  37627. * @ignorenaming
  37628. */
  37629. static isSupported(): boolean;
  37630. /**
  37631. * Find the next highest power of two.
  37632. * @param x Number to start search from.
  37633. * @return Next highest power of two.
  37634. */
  37635. static CeilingPOT(x: number): number;
  37636. /**
  37637. * Find the next lowest power of two.
  37638. * @param x Number to start search from.
  37639. * @return Next lowest power of two.
  37640. */
  37641. static FloorPOT(x: number): number;
  37642. /**
  37643. * Find the nearest power of two.
  37644. * @param x Number to start search from.
  37645. * @return Next nearest power of two.
  37646. */
  37647. static NearestPOT(x: number): number;
  37648. /**
  37649. * Get the closest exponent of two
  37650. * @param value defines the value to approximate
  37651. * @param max defines the maximum value to return
  37652. * @param mode defines how to define the closest value
  37653. * @returns closest exponent of two of the given value
  37654. */
  37655. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37656. /**
  37657. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37658. * @param func - the function to be called
  37659. * @param requester - the object that will request the next frame. Falls back to window.
  37660. * @returns frame number
  37661. */
  37662. static QueueNewFrame(func: () => void, requester?: any): number;
  37663. /**
  37664. * Gets host document
  37665. * @returns the host document object
  37666. */
  37667. getHostDocument(): Nullable<Document>;
  37668. }
  37669. }
  37670. declare module "babylonjs/Maths/sphericalPolynomial" {
  37671. import { Vector3 } from "babylonjs/Maths/math.vector";
  37672. import { Color3 } from "babylonjs/Maths/math.color";
  37673. /**
  37674. * Class representing spherical harmonics coefficients to the 3rd degree
  37675. */
  37676. export class SphericalHarmonics {
  37677. /**
  37678. * Defines whether or not the harmonics have been prescaled for rendering.
  37679. */
  37680. preScaled: boolean;
  37681. /**
  37682. * The l0,0 coefficients of the spherical harmonics
  37683. */
  37684. l00: Vector3;
  37685. /**
  37686. * The l1,-1 coefficients of the spherical harmonics
  37687. */
  37688. l1_1: Vector3;
  37689. /**
  37690. * The l1,0 coefficients of the spherical harmonics
  37691. */
  37692. l10: Vector3;
  37693. /**
  37694. * The l1,1 coefficients of the spherical harmonics
  37695. */
  37696. l11: Vector3;
  37697. /**
  37698. * The l2,-2 coefficients of the spherical harmonics
  37699. */
  37700. l2_2: Vector3;
  37701. /**
  37702. * The l2,-1 coefficients of the spherical harmonics
  37703. */
  37704. l2_1: Vector3;
  37705. /**
  37706. * The l2,0 coefficients of the spherical harmonics
  37707. */
  37708. l20: Vector3;
  37709. /**
  37710. * The l2,1 coefficients of the spherical harmonics
  37711. */
  37712. l21: Vector3;
  37713. /**
  37714. * The l2,2 coefficients of the spherical harmonics
  37715. */
  37716. l22: Vector3;
  37717. /**
  37718. * Adds a light to the spherical harmonics
  37719. * @param direction the direction of the light
  37720. * @param color the color of the light
  37721. * @param deltaSolidAngle the delta solid angle of the light
  37722. */
  37723. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37724. /**
  37725. * Scales the spherical harmonics by the given amount
  37726. * @param scale the amount to scale
  37727. */
  37728. scaleInPlace(scale: number): void;
  37729. /**
  37730. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37731. *
  37732. * ```
  37733. * E_lm = A_l * L_lm
  37734. * ```
  37735. *
  37736. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37737. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37738. * the scaling factors are given in equation 9.
  37739. */
  37740. convertIncidentRadianceToIrradiance(): void;
  37741. /**
  37742. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37743. *
  37744. * ```
  37745. * L = (1/pi) * E * rho
  37746. * ```
  37747. *
  37748. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37749. */
  37750. convertIrradianceToLambertianRadiance(): void;
  37751. /**
  37752. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37753. * required operations at run time.
  37754. *
  37755. * This is simply done by scaling back the SH with Ylm constants parameter.
  37756. * The trigonometric part being applied by the shader at run time.
  37757. */
  37758. preScaleForRendering(): void;
  37759. /**
  37760. * Constructs a spherical harmonics from an array.
  37761. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37762. * @returns the spherical harmonics
  37763. */
  37764. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37765. /**
  37766. * Gets the spherical harmonics from polynomial
  37767. * @param polynomial the spherical polynomial
  37768. * @returns the spherical harmonics
  37769. */
  37770. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37771. }
  37772. /**
  37773. * Class representing spherical polynomial coefficients to the 3rd degree
  37774. */
  37775. export class SphericalPolynomial {
  37776. private _harmonics;
  37777. /**
  37778. * The spherical harmonics used to create the polynomials.
  37779. */
  37780. get preScaledHarmonics(): SphericalHarmonics;
  37781. /**
  37782. * The x coefficients of the spherical polynomial
  37783. */
  37784. x: Vector3;
  37785. /**
  37786. * The y coefficients of the spherical polynomial
  37787. */
  37788. y: Vector3;
  37789. /**
  37790. * The z coefficients of the spherical polynomial
  37791. */
  37792. z: Vector3;
  37793. /**
  37794. * The xx coefficients of the spherical polynomial
  37795. */
  37796. xx: Vector3;
  37797. /**
  37798. * The yy coefficients of the spherical polynomial
  37799. */
  37800. yy: Vector3;
  37801. /**
  37802. * The zz coefficients of the spherical polynomial
  37803. */
  37804. zz: Vector3;
  37805. /**
  37806. * The xy coefficients of the spherical polynomial
  37807. */
  37808. xy: Vector3;
  37809. /**
  37810. * The yz coefficients of the spherical polynomial
  37811. */
  37812. yz: Vector3;
  37813. /**
  37814. * The zx coefficients of the spherical polynomial
  37815. */
  37816. zx: Vector3;
  37817. /**
  37818. * Adds an ambient color to the spherical polynomial
  37819. * @param color the color to add
  37820. */
  37821. addAmbient(color: Color3): void;
  37822. /**
  37823. * Scales the spherical polynomial by the given amount
  37824. * @param scale the amount to scale
  37825. */
  37826. scaleInPlace(scale: number): void;
  37827. /**
  37828. * Gets the spherical polynomial from harmonics
  37829. * @param harmonics the spherical harmonics
  37830. * @returns the spherical polynomial
  37831. */
  37832. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37833. /**
  37834. * Constructs a spherical polynomial from an array.
  37835. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37836. * @returns the spherical polynomial
  37837. */
  37838. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37839. }
  37840. }
  37841. declare module "babylonjs/Materials/Textures/internalTexture" {
  37842. import { Observable } from "babylonjs/Misc/observable";
  37843. import { Nullable, int } from "babylonjs/types";
  37844. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37845. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37846. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37847. /**
  37848. * Defines the source of the internal texture
  37849. */
  37850. export enum InternalTextureSource {
  37851. /**
  37852. * The source of the texture data is unknown
  37853. */
  37854. Unknown = 0,
  37855. /**
  37856. * Texture data comes from an URL
  37857. */
  37858. Url = 1,
  37859. /**
  37860. * Texture data is only used for temporary storage
  37861. */
  37862. Temp = 2,
  37863. /**
  37864. * Texture data comes from raw data (ArrayBuffer)
  37865. */
  37866. Raw = 3,
  37867. /**
  37868. * Texture content is dynamic (video or dynamic texture)
  37869. */
  37870. Dynamic = 4,
  37871. /**
  37872. * Texture content is generated by rendering to it
  37873. */
  37874. RenderTarget = 5,
  37875. /**
  37876. * Texture content is part of a multi render target process
  37877. */
  37878. MultiRenderTarget = 6,
  37879. /**
  37880. * Texture data comes from a cube data file
  37881. */
  37882. Cube = 7,
  37883. /**
  37884. * Texture data comes from a raw cube data
  37885. */
  37886. CubeRaw = 8,
  37887. /**
  37888. * Texture data come from a prefiltered cube data file
  37889. */
  37890. CubePrefiltered = 9,
  37891. /**
  37892. * Texture content is raw 3D data
  37893. */
  37894. Raw3D = 10,
  37895. /**
  37896. * Texture content is raw 2D array data
  37897. */
  37898. Raw2DArray = 11,
  37899. /**
  37900. * Texture content is a depth texture
  37901. */
  37902. Depth = 12,
  37903. /**
  37904. * Texture data comes from a raw cube data encoded with RGBD
  37905. */
  37906. CubeRawRGBD = 13
  37907. }
  37908. /**
  37909. * Class used to store data associated with WebGL texture data for the engine
  37910. * This class should not be used directly
  37911. */
  37912. export class InternalTexture {
  37913. /** @hidden */
  37914. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37915. /**
  37916. * Defines if the texture is ready
  37917. */
  37918. isReady: boolean;
  37919. /**
  37920. * Defines if the texture is a cube texture
  37921. */
  37922. isCube: boolean;
  37923. /**
  37924. * Defines if the texture contains 3D data
  37925. */
  37926. is3D: boolean;
  37927. /**
  37928. * Defines if the texture contains 2D array data
  37929. */
  37930. is2DArray: boolean;
  37931. /**
  37932. * Defines if the texture contains multiview data
  37933. */
  37934. isMultiview: boolean;
  37935. /**
  37936. * Gets the URL used to load this texture
  37937. */
  37938. url: string;
  37939. /**
  37940. * Gets the sampling mode of the texture
  37941. */
  37942. samplingMode: number;
  37943. /**
  37944. * Gets a boolean indicating if the texture needs mipmaps generation
  37945. */
  37946. generateMipMaps: boolean;
  37947. /**
  37948. * Gets the number of samples used by the texture (WebGL2+ only)
  37949. */
  37950. samples: number;
  37951. /**
  37952. * Gets the type of the texture (int, float...)
  37953. */
  37954. type: number;
  37955. /**
  37956. * Gets the format of the texture (RGB, RGBA...)
  37957. */
  37958. format: number;
  37959. /**
  37960. * Observable called when the texture is loaded
  37961. */
  37962. onLoadedObservable: Observable<InternalTexture>;
  37963. /**
  37964. * Gets the width of the texture
  37965. */
  37966. width: number;
  37967. /**
  37968. * Gets the height of the texture
  37969. */
  37970. height: number;
  37971. /**
  37972. * Gets the depth of the texture
  37973. */
  37974. depth: number;
  37975. /**
  37976. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37977. */
  37978. baseWidth: number;
  37979. /**
  37980. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37981. */
  37982. baseHeight: number;
  37983. /**
  37984. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37985. */
  37986. baseDepth: number;
  37987. /**
  37988. * Gets a boolean indicating if the texture is inverted on Y axis
  37989. */
  37990. invertY: boolean;
  37991. /** @hidden */
  37992. _invertVScale: boolean;
  37993. /** @hidden */
  37994. _associatedChannel: number;
  37995. /** @hidden */
  37996. _source: InternalTextureSource;
  37997. /** @hidden */
  37998. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37999. /** @hidden */
  38000. _bufferView: Nullable<ArrayBufferView>;
  38001. /** @hidden */
  38002. _bufferViewArray: Nullable<ArrayBufferView[]>;
  38003. /** @hidden */
  38004. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  38005. /** @hidden */
  38006. _size: number;
  38007. /** @hidden */
  38008. _extension: string;
  38009. /** @hidden */
  38010. _files: Nullable<string[]>;
  38011. /** @hidden */
  38012. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  38013. /** @hidden */
  38014. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  38015. /** @hidden */
  38016. _framebuffer: Nullable<WebGLFramebuffer>;
  38017. /** @hidden */
  38018. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  38019. /** @hidden */
  38020. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  38021. /** @hidden */
  38022. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  38023. /** @hidden */
  38024. _attachments: Nullable<number[]>;
  38025. /** @hidden */
  38026. _textureArray: Nullable<InternalTexture[]>;
  38027. /** @hidden */
  38028. _cachedCoordinatesMode: Nullable<number>;
  38029. /** @hidden */
  38030. _cachedWrapU: Nullable<number>;
  38031. /** @hidden */
  38032. _cachedWrapV: Nullable<number>;
  38033. /** @hidden */
  38034. _cachedWrapR: Nullable<number>;
  38035. /** @hidden */
  38036. _cachedAnisotropicFilteringLevel: Nullable<number>;
  38037. /** @hidden */
  38038. _isDisabled: boolean;
  38039. /** @hidden */
  38040. _compression: Nullable<string>;
  38041. /** @hidden */
  38042. _generateStencilBuffer: boolean;
  38043. /** @hidden */
  38044. _generateDepthBuffer: boolean;
  38045. /** @hidden */
  38046. _comparisonFunction: number;
  38047. /** @hidden */
  38048. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  38049. /** @hidden */
  38050. _lodGenerationScale: number;
  38051. /** @hidden */
  38052. _lodGenerationOffset: number;
  38053. /** @hidden */
  38054. _depthStencilTexture: Nullable<InternalTexture>;
  38055. /** @hidden */
  38056. _colorTextureArray: Nullable<WebGLTexture>;
  38057. /** @hidden */
  38058. _depthStencilTextureArray: Nullable<WebGLTexture>;
  38059. /** @hidden */
  38060. _lodTextureHigh: Nullable<BaseTexture>;
  38061. /** @hidden */
  38062. _lodTextureMid: Nullable<BaseTexture>;
  38063. /** @hidden */
  38064. _lodTextureLow: Nullable<BaseTexture>;
  38065. /** @hidden */
  38066. _isRGBD: boolean;
  38067. /** @hidden */
  38068. _linearSpecularLOD: boolean;
  38069. /** @hidden */
  38070. _irradianceTexture: Nullable<BaseTexture>;
  38071. /** @hidden */
  38072. _webGLTexture: Nullable<WebGLTexture>;
  38073. /** @hidden */
  38074. _references: number;
  38075. /** @hidden */
  38076. _gammaSpace: Nullable<boolean>;
  38077. private _engine;
  38078. /**
  38079. * Gets the Engine the texture belongs to.
  38080. * @returns The babylon engine
  38081. */
  38082. getEngine(): ThinEngine;
  38083. /**
  38084. * Gets the data source type of the texture
  38085. */
  38086. get source(): InternalTextureSource;
  38087. /**
  38088. * Creates a new InternalTexture
  38089. * @param engine defines the engine to use
  38090. * @param source defines the type of data that will be used
  38091. * @param delayAllocation if the texture allocation should be delayed (default: false)
  38092. */
  38093. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  38094. /**
  38095. * Increments the number of references (ie. the number of Texture that point to it)
  38096. */
  38097. incrementReferences(): void;
  38098. /**
  38099. * Change the size of the texture (not the size of the content)
  38100. * @param width defines the new width
  38101. * @param height defines the new height
  38102. * @param depth defines the new depth (1 by default)
  38103. */
  38104. updateSize(width: int, height: int, depth?: int): void;
  38105. /** @hidden */
  38106. _rebuild(): void;
  38107. /** @hidden */
  38108. _swapAndDie(target: InternalTexture): void;
  38109. /**
  38110. * Dispose the current allocated resources
  38111. */
  38112. dispose(): void;
  38113. }
  38114. }
  38115. declare module "babylonjs/Audio/analyser" {
  38116. import { Scene } from "babylonjs/scene";
  38117. /**
  38118. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38119. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38120. */
  38121. export class Analyser {
  38122. /**
  38123. * Gets or sets the smoothing
  38124. * @ignorenaming
  38125. */
  38126. SMOOTHING: number;
  38127. /**
  38128. * Gets or sets the FFT table size
  38129. * @ignorenaming
  38130. */
  38131. FFT_SIZE: number;
  38132. /**
  38133. * Gets or sets the bar graph amplitude
  38134. * @ignorenaming
  38135. */
  38136. BARGRAPHAMPLITUDE: number;
  38137. /**
  38138. * Gets or sets the position of the debug canvas
  38139. * @ignorenaming
  38140. */
  38141. DEBUGCANVASPOS: {
  38142. x: number;
  38143. y: number;
  38144. };
  38145. /**
  38146. * Gets or sets the debug canvas size
  38147. * @ignorenaming
  38148. */
  38149. DEBUGCANVASSIZE: {
  38150. width: number;
  38151. height: number;
  38152. };
  38153. private _byteFreqs;
  38154. private _byteTime;
  38155. private _floatFreqs;
  38156. private _webAudioAnalyser;
  38157. private _debugCanvas;
  38158. private _debugCanvasContext;
  38159. private _scene;
  38160. private _registerFunc;
  38161. private _audioEngine;
  38162. /**
  38163. * Creates a new analyser
  38164. * @param scene defines hosting scene
  38165. */
  38166. constructor(scene: Scene);
  38167. /**
  38168. * Get the number of data values you will have to play with for the visualization
  38169. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38170. * @returns a number
  38171. */
  38172. getFrequencyBinCount(): number;
  38173. /**
  38174. * Gets the current frequency data as a byte array
  38175. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38176. * @returns a Uint8Array
  38177. */
  38178. getByteFrequencyData(): Uint8Array;
  38179. /**
  38180. * Gets the current waveform as a byte array
  38181. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38182. * @returns a Uint8Array
  38183. */
  38184. getByteTimeDomainData(): Uint8Array;
  38185. /**
  38186. * Gets the current frequency data as a float array
  38187. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38188. * @returns a Float32Array
  38189. */
  38190. getFloatFrequencyData(): Float32Array;
  38191. /**
  38192. * Renders the debug canvas
  38193. */
  38194. drawDebugCanvas(): void;
  38195. /**
  38196. * Stops rendering the debug canvas and removes it
  38197. */
  38198. stopDebugCanvas(): void;
  38199. /**
  38200. * Connects two audio nodes
  38201. * @param inputAudioNode defines first node to connect
  38202. * @param outputAudioNode defines second node to connect
  38203. */
  38204. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38205. /**
  38206. * Releases all associated resources
  38207. */
  38208. dispose(): void;
  38209. }
  38210. }
  38211. declare module "babylonjs/Audio/audioEngine" {
  38212. import { IDisposable } from "babylonjs/scene";
  38213. import { Analyser } from "babylonjs/Audio/analyser";
  38214. import { Nullable } from "babylonjs/types";
  38215. import { Observable } from "babylonjs/Misc/observable";
  38216. /**
  38217. * This represents an audio engine and it is responsible
  38218. * to play, synchronize and analyse sounds throughout the application.
  38219. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38220. */
  38221. export interface IAudioEngine extends IDisposable {
  38222. /**
  38223. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38224. */
  38225. readonly canUseWebAudio: boolean;
  38226. /**
  38227. * Gets the current AudioContext if available.
  38228. */
  38229. readonly audioContext: Nullable<AudioContext>;
  38230. /**
  38231. * The master gain node defines the global audio volume of your audio engine.
  38232. */
  38233. readonly masterGain: GainNode;
  38234. /**
  38235. * Gets whether or not mp3 are supported by your browser.
  38236. */
  38237. readonly isMP3supported: boolean;
  38238. /**
  38239. * Gets whether or not ogg are supported by your browser.
  38240. */
  38241. readonly isOGGsupported: boolean;
  38242. /**
  38243. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38244. * @ignoreNaming
  38245. */
  38246. WarnedWebAudioUnsupported: boolean;
  38247. /**
  38248. * Defines if the audio engine relies on a custom unlocked button.
  38249. * In this case, the embedded button will not be displayed.
  38250. */
  38251. useCustomUnlockedButton: boolean;
  38252. /**
  38253. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38254. */
  38255. readonly unlocked: boolean;
  38256. /**
  38257. * Event raised when audio has been unlocked on the browser.
  38258. */
  38259. onAudioUnlockedObservable: Observable<AudioEngine>;
  38260. /**
  38261. * Event raised when audio has been locked on the browser.
  38262. */
  38263. onAudioLockedObservable: Observable<AudioEngine>;
  38264. /**
  38265. * Flags the audio engine in Locked state.
  38266. * This happens due to new browser policies preventing audio to autoplay.
  38267. */
  38268. lock(): void;
  38269. /**
  38270. * Unlocks the audio engine once a user action has been done on the dom.
  38271. * This is helpful to resume play once browser policies have been satisfied.
  38272. */
  38273. unlock(): void;
  38274. /**
  38275. * Gets the global volume sets on the master gain.
  38276. * @returns the global volume if set or -1 otherwise
  38277. */
  38278. getGlobalVolume(): number;
  38279. /**
  38280. * Sets the global volume of your experience (sets on the master gain).
  38281. * @param newVolume Defines the new global volume of the application
  38282. */
  38283. setGlobalVolume(newVolume: number): void;
  38284. /**
  38285. * Connect the audio engine to an audio analyser allowing some amazing
  38286. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38287. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38288. * @param analyser The analyser to connect to the engine
  38289. */
  38290. connectToAnalyser(analyser: Analyser): void;
  38291. }
  38292. /**
  38293. * This represents the default audio engine used in babylon.
  38294. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38295. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38296. */
  38297. export class AudioEngine implements IAudioEngine {
  38298. private _audioContext;
  38299. private _audioContextInitialized;
  38300. private _muteButton;
  38301. private _hostElement;
  38302. /**
  38303. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38304. */
  38305. canUseWebAudio: boolean;
  38306. /**
  38307. * The master gain node defines the global audio volume of your audio engine.
  38308. */
  38309. masterGain: GainNode;
  38310. /**
  38311. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38312. * @ignoreNaming
  38313. */
  38314. WarnedWebAudioUnsupported: boolean;
  38315. /**
  38316. * Gets whether or not mp3 are supported by your browser.
  38317. */
  38318. isMP3supported: boolean;
  38319. /**
  38320. * Gets whether or not ogg are supported by your browser.
  38321. */
  38322. isOGGsupported: boolean;
  38323. /**
  38324. * Gets whether audio has been unlocked on the device.
  38325. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38326. * a user interaction has happened.
  38327. */
  38328. unlocked: boolean;
  38329. /**
  38330. * Defines if the audio engine relies on a custom unlocked button.
  38331. * In this case, the embedded button will not be displayed.
  38332. */
  38333. useCustomUnlockedButton: boolean;
  38334. /**
  38335. * Event raised when audio has been unlocked on the browser.
  38336. */
  38337. onAudioUnlockedObservable: Observable<AudioEngine>;
  38338. /**
  38339. * Event raised when audio has been locked on the browser.
  38340. */
  38341. onAudioLockedObservable: Observable<AudioEngine>;
  38342. /**
  38343. * Gets the current AudioContext if available.
  38344. */
  38345. get audioContext(): Nullable<AudioContext>;
  38346. private _connectedAnalyser;
  38347. /**
  38348. * Instantiates a new audio engine.
  38349. *
  38350. * There should be only one per page as some browsers restrict the number
  38351. * of audio contexts you can create.
  38352. * @param hostElement defines the host element where to display the mute icon if necessary
  38353. */
  38354. constructor(hostElement?: Nullable<HTMLElement>);
  38355. /**
  38356. * Flags the audio engine in Locked state.
  38357. * This happens due to new browser policies preventing audio to autoplay.
  38358. */
  38359. lock(): void;
  38360. /**
  38361. * Unlocks the audio engine once a user action has been done on the dom.
  38362. * This is helpful to resume play once browser policies have been satisfied.
  38363. */
  38364. unlock(): void;
  38365. private _resumeAudioContext;
  38366. private _initializeAudioContext;
  38367. private _tryToRun;
  38368. private _triggerRunningState;
  38369. private _triggerSuspendedState;
  38370. private _displayMuteButton;
  38371. private _moveButtonToTopLeft;
  38372. private _onResize;
  38373. private _hideMuteButton;
  38374. /**
  38375. * Destroy and release the resources associated with the audio ccontext.
  38376. */
  38377. dispose(): void;
  38378. /**
  38379. * Gets the global volume sets on the master gain.
  38380. * @returns the global volume if set or -1 otherwise
  38381. */
  38382. getGlobalVolume(): number;
  38383. /**
  38384. * Sets the global volume of your experience (sets on the master gain).
  38385. * @param newVolume Defines the new global volume of the application
  38386. */
  38387. setGlobalVolume(newVolume: number): void;
  38388. /**
  38389. * Connect the audio engine to an audio analyser allowing some amazing
  38390. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38391. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38392. * @param analyser The analyser to connect to the engine
  38393. */
  38394. connectToAnalyser(analyser: Analyser): void;
  38395. }
  38396. }
  38397. declare module "babylonjs/Loading/loadingScreen" {
  38398. /**
  38399. * Interface used to present a loading screen while loading a scene
  38400. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38401. */
  38402. export interface ILoadingScreen {
  38403. /**
  38404. * Function called to display the loading screen
  38405. */
  38406. displayLoadingUI: () => void;
  38407. /**
  38408. * Function called to hide the loading screen
  38409. */
  38410. hideLoadingUI: () => void;
  38411. /**
  38412. * Gets or sets the color to use for the background
  38413. */
  38414. loadingUIBackgroundColor: string;
  38415. /**
  38416. * Gets or sets the text to display while loading
  38417. */
  38418. loadingUIText: string;
  38419. }
  38420. /**
  38421. * Class used for the default loading screen
  38422. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38423. */
  38424. export class DefaultLoadingScreen implements ILoadingScreen {
  38425. private _renderingCanvas;
  38426. private _loadingText;
  38427. private _loadingDivBackgroundColor;
  38428. private _loadingDiv;
  38429. private _loadingTextDiv;
  38430. /** Gets or sets the logo url to use for the default loading screen */
  38431. static DefaultLogoUrl: string;
  38432. /** Gets or sets the spinner url to use for the default loading screen */
  38433. static DefaultSpinnerUrl: string;
  38434. /**
  38435. * Creates a new default loading screen
  38436. * @param _renderingCanvas defines the canvas used to render the scene
  38437. * @param _loadingText defines the default text to display
  38438. * @param _loadingDivBackgroundColor defines the default background color
  38439. */
  38440. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38441. /**
  38442. * Function called to display the loading screen
  38443. */
  38444. displayLoadingUI(): void;
  38445. /**
  38446. * Function called to hide the loading screen
  38447. */
  38448. hideLoadingUI(): void;
  38449. /**
  38450. * Gets or sets the text to display while loading
  38451. */
  38452. set loadingUIText(text: string);
  38453. get loadingUIText(): string;
  38454. /**
  38455. * Gets or sets the color to use for the background
  38456. */
  38457. get loadingUIBackgroundColor(): string;
  38458. set loadingUIBackgroundColor(color: string);
  38459. private _resizeLoadingUI;
  38460. }
  38461. }
  38462. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38463. /**
  38464. * Interface for any object that can request an animation frame
  38465. */
  38466. export interface ICustomAnimationFrameRequester {
  38467. /**
  38468. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38469. */
  38470. renderFunction?: Function;
  38471. /**
  38472. * Called to request the next frame to render to
  38473. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38474. */
  38475. requestAnimationFrame: Function;
  38476. /**
  38477. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38478. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38479. */
  38480. requestID?: number;
  38481. }
  38482. }
  38483. declare module "babylonjs/Misc/performanceMonitor" {
  38484. /**
  38485. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38486. */
  38487. export class PerformanceMonitor {
  38488. private _enabled;
  38489. private _rollingFrameTime;
  38490. private _lastFrameTimeMs;
  38491. /**
  38492. * constructor
  38493. * @param frameSampleSize The number of samples required to saturate the sliding window
  38494. */
  38495. constructor(frameSampleSize?: number);
  38496. /**
  38497. * Samples current frame
  38498. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38499. */
  38500. sampleFrame(timeMs?: number): void;
  38501. /**
  38502. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38503. */
  38504. get averageFrameTime(): number;
  38505. /**
  38506. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38507. */
  38508. get averageFrameTimeVariance(): number;
  38509. /**
  38510. * Returns the frame time of the most recent frame
  38511. */
  38512. get instantaneousFrameTime(): number;
  38513. /**
  38514. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38515. */
  38516. get averageFPS(): number;
  38517. /**
  38518. * Returns the average framerate in frames per second using the most recent frame time
  38519. */
  38520. get instantaneousFPS(): number;
  38521. /**
  38522. * Returns true if enough samples have been taken to completely fill the sliding window
  38523. */
  38524. get isSaturated(): boolean;
  38525. /**
  38526. * Enables contributions to the sliding window sample set
  38527. */
  38528. enable(): void;
  38529. /**
  38530. * Disables contributions to the sliding window sample set
  38531. * Samples will not be interpolated over the disabled period
  38532. */
  38533. disable(): void;
  38534. /**
  38535. * Returns true if sampling is enabled
  38536. */
  38537. get isEnabled(): boolean;
  38538. /**
  38539. * Resets performance monitor
  38540. */
  38541. reset(): void;
  38542. }
  38543. /**
  38544. * RollingAverage
  38545. *
  38546. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38547. */
  38548. export class RollingAverage {
  38549. /**
  38550. * Current average
  38551. */
  38552. average: number;
  38553. /**
  38554. * Current variance
  38555. */
  38556. variance: number;
  38557. protected _samples: Array<number>;
  38558. protected _sampleCount: number;
  38559. protected _pos: number;
  38560. protected _m2: number;
  38561. /**
  38562. * constructor
  38563. * @param length The number of samples required to saturate the sliding window
  38564. */
  38565. constructor(length: number);
  38566. /**
  38567. * Adds a sample to the sample set
  38568. * @param v The sample value
  38569. */
  38570. add(v: number): void;
  38571. /**
  38572. * Returns previously added values or null if outside of history or outside the sliding window domain
  38573. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38574. * @return Value previously recorded with add() or null if outside of range
  38575. */
  38576. history(i: number): number;
  38577. /**
  38578. * Returns true if enough samples have been taken to completely fill the sliding window
  38579. * @return true if sample-set saturated
  38580. */
  38581. isSaturated(): boolean;
  38582. /**
  38583. * Resets the rolling average (equivalent to 0 samples taken so far)
  38584. */
  38585. reset(): void;
  38586. /**
  38587. * Wraps a value around the sample range boundaries
  38588. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38589. * @return Wrapped position in sample range
  38590. */
  38591. protected _wrapPosition(i: number): number;
  38592. }
  38593. }
  38594. declare module "babylonjs/Misc/perfCounter" {
  38595. /**
  38596. * This class is used to track a performance counter which is number based.
  38597. * The user has access to many properties which give statistics of different nature.
  38598. *
  38599. * The implementer can track two kinds of Performance Counter: time and count.
  38600. * 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.
  38601. * 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.
  38602. */
  38603. export class PerfCounter {
  38604. /**
  38605. * Gets or sets a global boolean to turn on and off all the counters
  38606. */
  38607. static Enabled: boolean;
  38608. /**
  38609. * Returns the smallest value ever
  38610. */
  38611. get min(): number;
  38612. /**
  38613. * Returns the biggest value ever
  38614. */
  38615. get max(): number;
  38616. /**
  38617. * Returns the average value since the performance counter is running
  38618. */
  38619. get average(): number;
  38620. /**
  38621. * Returns the average value of the last second the counter was monitored
  38622. */
  38623. get lastSecAverage(): number;
  38624. /**
  38625. * Returns the current value
  38626. */
  38627. get current(): number;
  38628. /**
  38629. * Gets the accumulated total
  38630. */
  38631. get total(): number;
  38632. /**
  38633. * Gets the total value count
  38634. */
  38635. get count(): number;
  38636. /**
  38637. * Creates a new counter
  38638. */
  38639. constructor();
  38640. /**
  38641. * Call this method to start monitoring a new frame.
  38642. * 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.
  38643. */
  38644. fetchNewFrame(): void;
  38645. /**
  38646. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38647. * @param newCount the count value to add to the monitored count
  38648. * @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.
  38649. */
  38650. addCount(newCount: number, fetchResult: boolean): void;
  38651. /**
  38652. * Start monitoring this performance counter
  38653. */
  38654. beginMonitoring(): void;
  38655. /**
  38656. * Compute the time lapsed since the previous beginMonitoring() call.
  38657. * @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
  38658. */
  38659. endMonitoring(newFrame?: boolean): void;
  38660. private _fetchResult;
  38661. private _startMonitoringTime;
  38662. private _min;
  38663. private _max;
  38664. private _average;
  38665. private _current;
  38666. private _totalValueCount;
  38667. private _totalAccumulated;
  38668. private _lastSecAverage;
  38669. private _lastSecAccumulated;
  38670. private _lastSecTime;
  38671. private _lastSecValueCount;
  38672. }
  38673. }
  38674. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38675. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38676. import { Nullable } from "babylonjs/types";
  38677. module "babylonjs/Engines/thinEngine" {
  38678. interface ThinEngine {
  38679. /** @hidden */
  38680. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38681. }
  38682. }
  38683. }
  38684. declare module "babylonjs/Engines/engine" {
  38685. import { Observable } from "babylonjs/Misc/observable";
  38686. import { Nullable } from "babylonjs/types";
  38687. import { Scene } from "babylonjs/scene";
  38688. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38689. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38690. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38691. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38692. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38693. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38694. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38695. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38696. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38697. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38698. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38699. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38700. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38701. import "babylonjs/Engines/Extensions/engine.alpha";
  38702. import "babylonjs/Engines/Extensions/engine.readTexture";
  38703. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38704. import { Material } from "babylonjs/Materials/material";
  38705. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38706. /**
  38707. * Defines the interface used by display changed events
  38708. */
  38709. export interface IDisplayChangedEventArgs {
  38710. /** Gets the vrDisplay object (if any) */
  38711. vrDisplay: Nullable<any>;
  38712. /** Gets a boolean indicating if webVR is supported */
  38713. vrSupported: boolean;
  38714. }
  38715. /**
  38716. * Defines the interface used by objects containing a viewport (like a camera)
  38717. */
  38718. interface IViewportOwnerLike {
  38719. /**
  38720. * Gets or sets the viewport
  38721. */
  38722. viewport: IViewportLike;
  38723. }
  38724. /**
  38725. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38726. */
  38727. export class Engine extends ThinEngine {
  38728. /** Defines that alpha blending is disabled */
  38729. static readonly ALPHA_DISABLE: number;
  38730. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38731. static readonly ALPHA_ADD: number;
  38732. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38733. static readonly ALPHA_COMBINE: number;
  38734. /** Defines that alpha blending to DEST - SRC * DEST */
  38735. static readonly ALPHA_SUBTRACT: number;
  38736. /** Defines that alpha blending to SRC * DEST */
  38737. static readonly ALPHA_MULTIPLY: number;
  38738. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38739. static readonly ALPHA_MAXIMIZED: number;
  38740. /** Defines that alpha blending to SRC + DEST */
  38741. static readonly ALPHA_ONEONE: number;
  38742. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38743. static readonly ALPHA_PREMULTIPLIED: number;
  38744. /**
  38745. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38746. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38747. */
  38748. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38749. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38750. static readonly ALPHA_INTERPOLATE: number;
  38751. /**
  38752. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38753. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38754. */
  38755. static readonly ALPHA_SCREENMODE: number;
  38756. /** Defines that the ressource is not delayed*/
  38757. static readonly DELAYLOADSTATE_NONE: number;
  38758. /** Defines that the ressource was successfully delay loaded */
  38759. static readonly DELAYLOADSTATE_LOADED: number;
  38760. /** Defines that the ressource is currently delay loading */
  38761. static readonly DELAYLOADSTATE_LOADING: number;
  38762. /** Defines that the ressource is delayed and has not started loading */
  38763. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38764. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38765. static readonly NEVER: number;
  38766. /** 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 */
  38767. static readonly ALWAYS: number;
  38768. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38769. static readonly LESS: number;
  38770. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38771. static readonly EQUAL: number;
  38772. /** 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 */
  38773. static readonly LEQUAL: number;
  38774. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38775. static readonly GREATER: number;
  38776. /** 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 */
  38777. static readonly GEQUAL: number;
  38778. /** 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 */
  38779. static readonly NOTEQUAL: number;
  38780. /** Passed to stencilOperation to specify that stencil value must be kept */
  38781. static readonly KEEP: number;
  38782. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38783. static readonly REPLACE: number;
  38784. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38785. static readonly INCR: number;
  38786. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38787. static readonly DECR: number;
  38788. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38789. static readonly INVERT: number;
  38790. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38791. static readonly INCR_WRAP: number;
  38792. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38793. static readonly DECR_WRAP: number;
  38794. /** Texture is not repeating outside of 0..1 UVs */
  38795. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38796. /** Texture is repeating outside of 0..1 UVs */
  38797. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38798. /** Texture is repeating and mirrored */
  38799. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38800. /** ALPHA */
  38801. static readonly TEXTUREFORMAT_ALPHA: number;
  38802. /** LUMINANCE */
  38803. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38804. /** LUMINANCE_ALPHA */
  38805. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38806. /** RGB */
  38807. static readonly TEXTUREFORMAT_RGB: number;
  38808. /** RGBA */
  38809. static readonly TEXTUREFORMAT_RGBA: number;
  38810. /** RED */
  38811. static readonly TEXTUREFORMAT_RED: number;
  38812. /** RED (2nd reference) */
  38813. static readonly TEXTUREFORMAT_R: number;
  38814. /** RG */
  38815. static readonly TEXTUREFORMAT_RG: number;
  38816. /** RED_INTEGER */
  38817. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38818. /** RED_INTEGER (2nd reference) */
  38819. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38820. /** RG_INTEGER */
  38821. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38822. /** RGB_INTEGER */
  38823. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38824. /** RGBA_INTEGER */
  38825. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38826. /** UNSIGNED_BYTE */
  38827. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38828. /** UNSIGNED_BYTE (2nd reference) */
  38829. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38830. /** FLOAT */
  38831. static readonly TEXTURETYPE_FLOAT: number;
  38832. /** HALF_FLOAT */
  38833. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38834. /** BYTE */
  38835. static readonly TEXTURETYPE_BYTE: number;
  38836. /** SHORT */
  38837. static readonly TEXTURETYPE_SHORT: number;
  38838. /** UNSIGNED_SHORT */
  38839. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38840. /** INT */
  38841. static readonly TEXTURETYPE_INT: number;
  38842. /** UNSIGNED_INT */
  38843. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38844. /** UNSIGNED_SHORT_4_4_4_4 */
  38845. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38846. /** UNSIGNED_SHORT_5_5_5_1 */
  38847. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38848. /** UNSIGNED_SHORT_5_6_5 */
  38849. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38850. /** UNSIGNED_INT_2_10_10_10_REV */
  38851. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38852. /** UNSIGNED_INT_24_8 */
  38853. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38854. /** UNSIGNED_INT_10F_11F_11F_REV */
  38855. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38856. /** UNSIGNED_INT_5_9_9_9_REV */
  38857. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38858. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38859. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38860. /** nearest is mag = nearest and min = nearest and mip = linear */
  38861. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38862. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38863. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38864. /** Trilinear is mag = linear and min = linear and mip = linear */
  38865. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38866. /** nearest is mag = nearest and min = nearest and mip = linear */
  38867. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38868. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38869. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38870. /** Trilinear is mag = linear and min = linear and mip = linear */
  38871. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38872. /** mag = nearest and min = nearest and mip = nearest */
  38873. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38874. /** mag = nearest and min = linear and mip = nearest */
  38875. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38876. /** mag = nearest and min = linear and mip = linear */
  38877. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38878. /** mag = nearest and min = linear and mip = none */
  38879. static readonly TEXTURE_NEAREST_LINEAR: number;
  38880. /** mag = nearest and min = nearest and mip = none */
  38881. static readonly TEXTURE_NEAREST_NEAREST: number;
  38882. /** mag = linear and min = nearest and mip = nearest */
  38883. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38884. /** mag = linear and min = nearest and mip = linear */
  38885. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38886. /** mag = linear and min = linear and mip = none */
  38887. static readonly TEXTURE_LINEAR_LINEAR: number;
  38888. /** mag = linear and min = nearest and mip = none */
  38889. static readonly TEXTURE_LINEAR_NEAREST: number;
  38890. /** Explicit coordinates mode */
  38891. static readonly TEXTURE_EXPLICIT_MODE: number;
  38892. /** Spherical coordinates mode */
  38893. static readonly TEXTURE_SPHERICAL_MODE: number;
  38894. /** Planar coordinates mode */
  38895. static readonly TEXTURE_PLANAR_MODE: number;
  38896. /** Cubic coordinates mode */
  38897. static readonly TEXTURE_CUBIC_MODE: number;
  38898. /** Projection coordinates mode */
  38899. static readonly TEXTURE_PROJECTION_MODE: number;
  38900. /** Skybox coordinates mode */
  38901. static readonly TEXTURE_SKYBOX_MODE: number;
  38902. /** Inverse Cubic coordinates mode */
  38903. static readonly TEXTURE_INVCUBIC_MODE: number;
  38904. /** Equirectangular coordinates mode */
  38905. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38906. /** Equirectangular Fixed coordinates mode */
  38907. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38908. /** Equirectangular Fixed Mirrored coordinates mode */
  38909. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38910. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38911. static readonly SCALEMODE_FLOOR: number;
  38912. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38913. static readonly SCALEMODE_NEAREST: number;
  38914. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38915. static readonly SCALEMODE_CEILING: number;
  38916. /**
  38917. * Returns the current npm package of the sdk
  38918. */
  38919. static get NpmPackage(): string;
  38920. /**
  38921. * Returns the current version of the framework
  38922. */
  38923. static get Version(): string;
  38924. /** Gets the list of created engines */
  38925. static get Instances(): Engine[];
  38926. /**
  38927. * Gets the latest created engine
  38928. */
  38929. static get LastCreatedEngine(): Nullable<Engine>;
  38930. /**
  38931. * Gets the latest created scene
  38932. */
  38933. static get LastCreatedScene(): Nullable<Scene>;
  38934. /**
  38935. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38936. * @param flag defines which part of the materials must be marked as dirty
  38937. * @param predicate defines a predicate used to filter which materials should be affected
  38938. */
  38939. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38940. /**
  38941. * Method called to create the default loading screen.
  38942. * This can be overriden in your own app.
  38943. * @param canvas The rendering canvas element
  38944. * @returns The loading screen
  38945. */
  38946. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38947. /**
  38948. * Method called to create the default rescale post process on each engine.
  38949. */
  38950. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38951. /**
  38952. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38953. **/
  38954. enableOfflineSupport: boolean;
  38955. /**
  38956. * 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)
  38957. **/
  38958. disableManifestCheck: boolean;
  38959. /**
  38960. * Gets the list of created scenes
  38961. */
  38962. scenes: Scene[];
  38963. /**
  38964. * Event raised when a new scene is created
  38965. */
  38966. onNewSceneAddedObservable: Observable<Scene>;
  38967. /**
  38968. * Gets the list of created postprocesses
  38969. */
  38970. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38971. /**
  38972. * Gets a boolean indicating if the pointer is currently locked
  38973. */
  38974. isPointerLock: boolean;
  38975. /**
  38976. * Observable event triggered each time the rendering canvas is resized
  38977. */
  38978. onResizeObservable: Observable<Engine>;
  38979. /**
  38980. * Observable event triggered each time the canvas loses focus
  38981. */
  38982. onCanvasBlurObservable: Observable<Engine>;
  38983. /**
  38984. * Observable event triggered each time the canvas gains focus
  38985. */
  38986. onCanvasFocusObservable: Observable<Engine>;
  38987. /**
  38988. * Observable event triggered each time the canvas receives pointerout event
  38989. */
  38990. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38991. /**
  38992. * Observable raised when the engine begins a new frame
  38993. */
  38994. onBeginFrameObservable: Observable<Engine>;
  38995. /**
  38996. * If set, will be used to request the next animation frame for the render loop
  38997. */
  38998. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38999. /**
  39000. * Observable raised when the engine ends the current frame
  39001. */
  39002. onEndFrameObservable: Observable<Engine>;
  39003. /**
  39004. * Observable raised when the engine is about to compile a shader
  39005. */
  39006. onBeforeShaderCompilationObservable: Observable<Engine>;
  39007. /**
  39008. * Observable raised when the engine has jsut compiled a shader
  39009. */
  39010. onAfterShaderCompilationObservable: Observable<Engine>;
  39011. /**
  39012. * Gets the audio engine
  39013. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  39014. * @ignorenaming
  39015. */
  39016. static audioEngine: IAudioEngine;
  39017. /**
  39018. * Default AudioEngine factory responsible of creating the Audio Engine.
  39019. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  39020. */
  39021. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  39022. /**
  39023. * Default offline support factory responsible of creating a tool used to store data locally.
  39024. * By default, this will create a Database object if the workload has been embedded.
  39025. */
  39026. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  39027. private _loadingScreen;
  39028. private _pointerLockRequested;
  39029. private _rescalePostProcess;
  39030. private _deterministicLockstep;
  39031. private _lockstepMaxSteps;
  39032. private _timeStep;
  39033. protected get _supportsHardwareTextureRescaling(): boolean;
  39034. private _fps;
  39035. private _deltaTime;
  39036. /** @hidden */
  39037. _drawCalls: PerfCounter;
  39038. /** 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 */
  39039. canvasTabIndex: number;
  39040. /**
  39041. * Turn this value on if you want to pause FPS computation when in background
  39042. */
  39043. disablePerformanceMonitorInBackground: boolean;
  39044. private _performanceMonitor;
  39045. /**
  39046. * Gets the performance monitor attached to this engine
  39047. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  39048. */
  39049. get performanceMonitor(): PerformanceMonitor;
  39050. private _onFocus;
  39051. private _onBlur;
  39052. private _onCanvasPointerOut;
  39053. private _onCanvasBlur;
  39054. private _onCanvasFocus;
  39055. private _onFullscreenChange;
  39056. private _onPointerLockChange;
  39057. /**
  39058. * Gets the HTML element used to attach event listeners
  39059. * @returns a HTML element
  39060. */
  39061. getInputElement(): Nullable<HTMLElement>;
  39062. /**
  39063. * Creates a new engine
  39064. * @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
  39065. * @param antialias defines enable antialiasing (default: false)
  39066. * @param options defines further options to be sent to the getContext() function
  39067. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  39068. */
  39069. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  39070. /**
  39071. * Gets current aspect ratio
  39072. * @param viewportOwner defines the camera to use to get the aspect ratio
  39073. * @param useScreen defines if screen size must be used (or the current render target if any)
  39074. * @returns a number defining the aspect ratio
  39075. */
  39076. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  39077. /**
  39078. * Gets current screen aspect ratio
  39079. * @returns a number defining the aspect ratio
  39080. */
  39081. getScreenAspectRatio(): number;
  39082. /**
  39083. * Gets the client rect of the HTML canvas attached with the current webGL context
  39084. * @returns a client rectanglee
  39085. */
  39086. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  39087. /**
  39088. * Gets the client rect of the HTML element used for events
  39089. * @returns a client rectanglee
  39090. */
  39091. getInputElementClientRect(): Nullable<ClientRect>;
  39092. /**
  39093. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  39094. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39095. * @returns true if engine is in deterministic lock step mode
  39096. */
  39097. isDeterministicLockStep(): boolean;
  39098. /**
  39099. * Gets the max steps when engine is running in deterministic lock step
  39100. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39101. * @returns the max steps
  39102. */
  39103. getLockstepMaxSteps(): number;
  39104. /**
  39105. * Returns the time in ms between steps when using deterministic lock step.
  39106. * @returns time step in (ms)
  39107. */
  39108. getTimeStep(): number;
  39109. /**
  39110. * Force the mipmap generation for the given render target texture
  39111. * @param texture defines the render target texture to use
  39112. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  39113. */
  39114. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  39115. /** States */
  39116. /**
  39117. * Set various states to the webGL context
  39118. * @param culling defines backface culling state
  39119. * @param zOffset defines the value to apply to zOffset (0 by default)
  39120. * @param force defines if states must be applied even if cache is up to date
  39121. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39122. */
  39123. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39124. /**
  39125. * Set the z offset to apply to current rendering
  39126. * @param value defines the offset to apply
  39127. */
  39128. setZOffset(value: number): void;
  39129. /**
  39130. * Gets the current value of the zOffset
  39131. * @returns the current zOffset state
  39132. */
  39133. getZOffset(): number;
  39134. /**
  39135. * Enable or disable depth buffering
  39136. * @param enable defines the state to set
  39137. */
  39138. setDepthBuffer(enable: boolean): void;
  39139. /**
  39140. * Gets a boolean indicating if depth writing is enabled
  39141. * @returns the current depth writing state
  39142. */
  39143. getDepthWrite(): boolean;
  39144. /**
  39145. * Enable or disable depth writing
  39146. * @param enable defines the state to set
  39147. */
  39148. setDepthWrite(enable: boolean): void;
  39149. /**
  39150. * Gets a boolean indicating if stencil buffer is enabled
  39151. * @returns the current stencil buffer state
  39152. */
  39153. getStencilBuffer(): boolean;
  39154. /**
  39155. * Enable or disable the stencil buffer
  39156. * @param enable defines if the stencil buffer must be enabled or disabled
  39157. */
  39158. setStencilBuffer(enable: boolean): void;
  39159. /**
  39160. * Gets the current stencil mask
  39161. * @returns a number defining the new stencil mask to use
  39162. */
  39163. getStencilMask(): number;
  39164. /**
  39165. * Sets the current stencil mask
  39166. * @param mask defines the new stencil mask to use
  39167. */
  39168. setStencilMask(mask: number): void;
  39169. /**
  39170. * Gets the current stencil function
  39171. * @returns a number defining the stencil function to use
  39172. */
  39173. getStencilFunction(): number;
  39174. /**
  39175. * Gets the current stencil reference value
  39176. * @returns a number defining the stencil reference value to use
  39177. */
  39178. getStencilFunctionReference(): number;
  39179. /**
  39180. * Gets the current stencil mask
  39181. * @returns a number defining the stencil mask to use
  39182. */
  39183. getStencilFunctionMask(): number;
  39184. /**
  39185. * Sets the current stencil function
  39186. * @param stencilFunc defines the new stencil function to use
  39187. */
  39188. setStencilFunction(stencilFunc: number): void;
  39189. /**
  39190. * Sets the current stencil reference
  39191. * @param reference defines the new stencil reference to use
  39192. */
  39193. setStencilFunctionReference(reference: number): void;
  39194. /**
  39195. * Sets the current stencil mask
  39196. * @param mask defines the new stencil mask to use
  39197. */
  39198. setStencilFunctionMask(mask: number): void;
  39199. /**
  39200. * Gets the current stencil operation when stencil fails
  39201. * @returns a number defining stencil operation to use when stencil fails
  39202. */
  39203. getStencilOperationFail(): number;
  39204. /**
  39205. * Gets the current stencil operation when depth fails
  39206. * @returns a number defining stencil operation to use when depth fails
  39207. */
  39208. getStencilOperationDepthFail(): number;
  39209. /**
  39210. * Gets the current stencil operation when stencil passes
  39211. * @returns a number defining stencil operation to use when stencil passes
  39212. */
  39213. getStencilOperationPass(): number;
  39214. /**
  39215. * Sets the stencil operation to use when stencil fails
  39216. * @param operation defines the stencil operation to use when stencil fails
  39217. */
  39218. setStencilOperationFail(operation: number): void;
  39219. /**
  39220. * Sets the stencil operation to use when depth fails
  39221. * @param operation defines the stencil operation to use when depth fails
  39222. */
  39223. setStencilOperationDepthFail(operation: number): void;
  39224. /**
  39225. * Sets the stencil operation to use when stencil passes
  39226. * @param operation defines the stencil operation to use when stencil passes
  39227. */
  39228. setStencilOperationPass(operation: number): void;
  39229. /**
  39230. * Sets a boolean indicating if the dithering state is enabled or disabled
  39231. * @param value defines the dithering state
  39232. */
  39233. setDitheringState(value: boolean): void;
  39234. /**
  39235. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39236. * @param value defines the rasterizer state
  39237. */
  39238. setRasterizerState(value: boolean): void;
  39239. /**
  39240. * Gets the current depth function
  39241. * @returns a number defining the depth function
  39242. */
  39243. getDepthFunction(): Nullable<number>;
  39244. /**
  39245. * Sets the current depth function
  39246. * @param depthFunc defines the function to use
  39247. */
  39248. setDepthFunction(depthFunc: number): void;
  39249. /**
  39250. * Sets the current depth function to GREATER
  39251. */
  39252. setDepthFunctionToGreater(): void;
  39253. /**
  39254. * Sets the current depth function to GEQUAL
  39255. */
  39256. setDepthFunctionToGreaterOrEqual(): void;
  39257. /**
  39258. * Sets the current depth function to LESS
  39259. */
  39260. setDepthFunctionToLess(): void;
  39261. /**
  39262. * Sets the current depth function to LEQUAL
  39263. */
  39264. setDepthFunctionToLessOrEqual(): void;
  39265. private _cachedStencilBuffer;
  39266. private _cachedStencilFunction;
  39267. private _cachedStencilMask;
  39268. private _cachedStencilOperationPass;
  39269. private _cachedStencilOperationFail;
  39270. private _cachedStencilOperationDepthFail;
  39271. private _cachedStencilReference;
  39272. /**
  39273. * Caches the the state of the stencil buffer
  39274. */
  39275. cacheStencilState(): void;
  39276. /**
  39277. * Restores the state of the stencil buffer
  39278. */
  39279. restoreStencilState(): void;
  39280. /**
  39281. * Directly set the WebGL Viewport
  39282. * @param x defines the x coordinate of the viewport (in screen space)
  39283. * @param y defines the y coordinate of the viewport (in screen space)
  39284. * @param width defines the width of the viewport (in screen space)
  39285. * @param height defines the height of the viewport (in screen space)
  39286. * @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
  39287. */
  39288. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39289. /**
  39290. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39291. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39292. * @param y defines the y-coordinate of the corner of the clear rectangle
  39293. * @param width defines the width of the clear rectangle
  39294. * @param height defines the height of the clear rectangle
  39295. * @param clearColor defines the clear color
  39296. */
  39297. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39298. /**
  39299. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39300. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39301. * @param y defines the y-coordinate of the corner of the clear rectangle
  39302. * @param width defines the width of the clear rectangle
  39303. * @param height defines the height of the clear rectangle
  39304. */
  39305. enableScissor(x: number, y: number, width: number, height: number): void;
  39306. /**
  39307. * Disable previously set scissor test rectangle
  39308. */
  39309. disableScissor(): void;
  39310. protected _reportDrawCall(): void;
  39311. /**
  39312. * Initializes a webVR display and starts listening to display change events
  39313. * The onVRDisplayChangedObservable will be notified upon these changes
  39314. * @returns The onVRDisplayChangedObservable
  39315. */
  39316. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39317. /** @hidden */
  39318. _prepareVRComponent(): void;
  39319. /** @hidden */
  39320. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39321. /** @hidden */
  39322. _submitVRFrame(): void;
  39323. /**
  39324. * Call this function to leave webVR mode
  39325. * Will do nothing if webVR is not supported or if there is no webVR device
  39326. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39327. */
  39328. disableVR(): void;
  39329. /**
  39330. * Gets a boolean indicating that the system is in VR mode and is presenting
  39331. * @returns true if VR mode is engaged
  39332. */
  39333. isVRPresenting(): boolean;
  39334. /** @hidden */
  39335. _requestVRFrame(): void;
  39336. /** @hidden */
  39337. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39338. /**
  39339. * Gets the source code of the vertex shader associated with a specific webGL program
  39340. * @param program defines the program to use
  39341. * @returns a string containing the source code of the vertex shader associated with the program
  39342. */
  39343. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39344. /**
  39345. * Gets the source code of the fragment shader associated with a specific webGL program
  39346. * @param program defines the program to use
  39347. * @returns a string containing the source code of the fragment shader associated with the program
  39348. */
  39349. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39350. /**
  39351. * Sets a depth stencil texture from a render target to the according uniform.
  39352. * @param channel The texture channel
  39353. * @param uniform The uniform to set
  39354. * @param texture The render target texture containing the depth stencil texture to apply
  39355. */
  39356. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39357. /**
  39358. * Sets a texture to the webGL context from a postprocess
  39359. * @param channel defines the channel to use
  39360. * @param postProcess defines the source postprocess
  39361. */
  39362. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39363. /**
  39364. * Binds the output of the passed in post process to the texture channel specified
  39365. * @param channel The channel the texture should be bound to
  39366. * @param postProcess The post process which's output should be bound
  39367. */
  39368. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39369. protected _rebuildBuffers(): void;
  39370. /** @hidden */
  39371. _renderFrame(): void;
  39372. _renderLoop(): void;
  39373. /** @hidden */
  39374. _renderViews(): boolean;
  39375. /**
  39376. * Toggle full screen mode
  39377. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39378. */
  39379. switchFullscreen(requestPointerLock: boolean): void;
  39380. /**
  39381. * Enters full screen mode
  39382. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39383. */
  39384. enterFullscreen(requestPointerLock: boolean): void;
  39385. /**
  39386. * Exits full screen mode
  39387. */
  39388. exitFullscreen(): void;
  39389. /**
  39390. * Enters Pointerlock mode
  39391. */
  39392. enterPointerlock(): void;
  39393. /**
  39394. * Exits Pointerlock mode
  39395. */
  39396. exitPointerlock(): void;
  39397. /**
  39398. * Begin a new frame
  39399. */
  39400. beginFrame(): void;
  39401. /**
  39402. * Enf the current frame
  39403. */
  39404. endFrame(): void;
  39405. resize(): void;
  39406. /**
  39407. * Force a specific size of the canvas
  39408. * @param width defines the new canvas' width
  39409. * @param height defines the new canvas' height
  39410. * @returns true if the size was changed
  39411. */
  39412. setSize(width: number, height: number): boolean;
  39413. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39414. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39415. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39416. _releaseTexture(texture: InternalTexture): void;
  39417. /**
  39418. * @hidden
  39419. * Rescales a texture
  39420. * @param source input texutre
  39421. * @param destination destination texture
  39422. * @param scene scene to use to render the resize
  39423. * @param internalFormat format to use when resizing
  39424. * @param onComplete callback to be called when resize has completed
  39425. */
  39426. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39427. /**
  39428. * Gets the current framerate
  39429. * @returns a number representing the framerate
  39430. */
  39431. getFps(): number;
  39432. /**
  39433. * Gets the time spent between current and previous frame
  39434. * @returns a number representing the delta time in ms
  39435. */
  39436. getDeltaTime(): number;
  39437. private _measureFps;
  39438. /** @hidden */
  39439. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39440. /**
  39441. * Updates the sample count of a render target texture
  39442. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39443. * @param texture defines the texture to update
  39444. * @param samples defines the sample count to set
  39445. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39446. */
  39447. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39448. /**
  39449. * Updates a depth texture Comparison Mode and Function.
  39450. * If the comparison Function is equal to 0, the mode will be set to none.
  39451. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39452. * @param texture The texture to set the comparison function for
  39453. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39454. */
  39455. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39456. /**
  39457. * Creates a webGL buffer to use with instanciation
  39458. * @param capacity defines the size of the buffer
  39459. * @returns the webGL buffer
  39460. */
  39461. createInstancesBuffer(capacity: number): DataBuffer;
  39462. /**
  39463. * Delete a webGL buffer used with instanciation
  39464. * @param buffer defines the webGL buffer to delete
  39465. */
  39466. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39467. private _clientWaitAsync;
  39468. /** @hidden */
  39469. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39470. dispose(): void;
  39471. private _disableTouchAction;
  39472. /**
  39473. * Display the loading screen
  39474. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39475. */
  39476. displayLoadingUI(): void;
  39477. /**
  39478. * Hide the loading screen
  39479. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39480. */
  39481. hideLoadingUI(): void;
  39482. /**
  39483. * Gets the current loading screen object
  39484. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39485. */
  39486. get loadingScreen(): ILoadingScreen;
  39487. /**
  39488. * Sets the current loading screen object
  39489. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39490. */
  39491. set loadingScreen(loadingScreen: ILoadingScreen);
  39492. /**
  39493. * Sets the current loading screen text
  39494. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39495. */
  39496. set loadingUIText(text: string);
  39497. /**
  39498. * Sets the current loading screen background color
  39499. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39500. */
  39501. set loadingUIBackgroundColor(color: string);
  39502. /** Pointerlock and fullscreen */
  39503. /**
  39504. * Ask the browser to promote the current element to pointerlock mode
  39505. * @param element defines the DOM element to promote
  39506. */
  39507. static _RequestPointerlock(element: HTMLElement): void;
  39508. /**
  39509. * Asks the browser to exit pointerlock mode
  39510. */
  39511. static _ExitPointerlock(): void;
  39512. /**
  39513. * Ask the browser to promote the current element to fullscreen rendering mode
  39514. * @param element defines the DOM element to promote
  39515. */
  39516. static _RequestFullscreen(element: HTMLElement): void;
  39517. /**
  39518. * Asks the browser to exit fullscreen mode
  39519. */
  39520. static _ExitFullscreen(): void;
  39521. }
  39522. }
  39523. declare module "babylonjs/Engines/engineStore" {
  39524. import { Nullable } from "babylonjs/types";
  39525. import { Engine } from "babylonjs/Engines/engine";
  39526. import { Scene } from "babylonjs/scene";
  39527. /**
  39528. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39529. * during the life time of the application.
  39530. */
  39531. export class EngineStore {
  39532. /** Gets the list of created engines */
  39533. static Instances: import("babylonjs/Engines/engine").Engine[];
  39534. /** @hidden */
  39535. static _LastCreatedScene: Nullable<Scene>;
  39536. /**
  39537. * Gets the latest created engine
  39538. */
  39539. static get LastCreatedEngine(): Nullable<Engine>;
  39540. /**
  39541. * Gets the latest created scene
  39542. */
  39543. static get LastCreatedScene(): Nullable<Scene>;
  39544. /**
  39545. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39546. * @ignorenaming
  39547. */
  39548. static UseFallbackTexture: boolean;
  39549. /**
  39550. * Texture content used if a texture cannot loaded
  39551. * @ignorenaming
  39552. */
  39553. static FallbackTexture: string;
  39554. }
  39555. }
  39556. declare module "babylonjs/Misc/promise" {
  39557. /**
  39558. * Helper class that provides a small promise polyfill
  39559. */
  39560. export class PromisePolyfill {
  39561. /**
  39562. * Static function used to check if the polyfill is required
  39563. * If this is the case then the function will inject the polyfill to window.Promise
  39564. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39565. */
  39566. static Apply(force?: boolean): void;
  39567. }
  39568. }
  39569. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39570. /**
  39571. * Interface for screenshot methods with describe argument called `size` as object with options
  39572. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39573. */
  39574. export interface IScreenshotSize {
  39575. /**
  39576. * number in pixels for canvas height
  39577. */
  39578. height?: number;
  39579. /**
  39580. * multiplier allowing render at a higher or lower resolution
  39581. * If value is defined then height and width will be ignored and taken from camera
  39582. */
  39583. precision?: number;
  39584. /**
  39585. * number in pixels for canvas width
  39586. */
  39587. width?: number;
  39588. }
  39589. }
  39590. declare module "babylonjs/Misc/tools" {
  39591. import { Nullable, float } from "babylonjs/types";
  39592. import { DomManagement } from "babylonjs/Misc/domManagement";
  39593. import { WebRequest } from "babylonjs/Misc/webRequest";
  39594. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39595. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39596. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39597. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39598. import { Camera } from "babylonjs/Cameras/camera";
  39599. import { Engine } from "babylonjs/Engines/engine";
  39600. interface IColor4Like {
  39601. r: float;
  39602. g: float;
  39603. b: float;
  39604. a: float;
  39605. }
  39606. /**
  39607. * Class containing a set of static utilities functions
  39608. */
  39609. export class Tools {
  39610. /**
  39611. * Gets or sets the base URL to use to load assets
  39612. */
  39613. static get BaseUrl(): string;
  39614. static set BaseUrl(value: string);
  39615. /**
  39616. * Enable/Disable Custom HTTP Request Headers globally.
  39617. * default = false
  39618. * @see CustomRequestHeaders
  39619. */
  39620. static UseCustomRequestHeaders: boolean;
  39621. /**
  39622. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39623. * i.e. when loading files, where the server/service expects an Authorization header
  39624. */
  39625. static CustomRequestHeaders: {
  39626. [key: string]: string;
  39627. };
  39628. /**
  39629. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39630. */
  39631. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39632. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39633. /**
  39634. * Default behaviour for cors in the application.
  39635. * It can be a string if the expected behavior is identical in the entire app.
  39636. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39637. */
  39638. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39639. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39640. /**
  39641. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39642. * @ignorenaming
  39643. */
  39644. static get UseFallbackTexture(): boolean;
  39645. static set UseFallbackTexture(value: boolean);
  39646. /**
  39647. * Use this object to register external classes like custom textures or material
  39648. * to allow the laoders to instantiate them
  39649. */
  39650. static get RegisteredExternalClasses(): {
  39651. [key: string]: Object;
  39652. };
  39653. static set RegisteredExternalClasses(classes: {
  39654. [key: string]: Object;
  39655. });
  39656. /**
  39657. * Texture content used if a texture cannot loaded
  39658. * @ignorenaming
  39659. */
  39660. static get fallbackTexture(): string;
  39661. static set fallbackTexture(value: string);
  39662. /**
  39663. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39664. * @param u defines the coordinate on X axis
  39665. * @param v defines the coordinate on Y axis
  39666. * @param width defines the width of the source data
  39667. * @param height defines the height of the source data
  39668. * @param pixels defines the source byte array
  39669. * @param color defines the output color
  39670. */
  39671. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39672. /**
  39673. * Interpolates between a and b via alpha
  39674. * @param a The lower value (returned when alpha = 0)
  39675. * @param b The upper value (returned when alpha = 1)
  39676. * @param alpha The interpolation-factor
  39677. * @return The mixed value
  39678. */
  39679. static Mix(a: number, b: number, alpha: number): number;
  39680. /**
  39681. * Tries to instantiate a new object from a given class name
  39682. * @param className defines the class name to instantiate
  39683. * @returns the new object or null if the system was not able to do the instantiation
  39684. */
  39685. static Instantiate(className: string): any;
  39686. /**
  39687. * Provides a slice function that will work even on IE
  39688. * @param data defines the array to slice
  39689. * @param start defines the start of the data (optional)
  39690. * @param end defines the end of the data (optional)
  39691. * @returns the new sliced array
  39692. */
  39693. static Slice<T>(data: T, start?: number, end?: number): T;
  39694. /**
  39695. * Polyfill for setImmediate
  39696. * @param action defines the action to execute after the current execution block
  39697. */
  39698. static SetImmediate(action: () => void): void;
  39699. /**
  39700. * Function indicating if a number is an exponent of 2
  39701. * @param value defines the value to test
  39702. * @returns true if the value is an exponent of 2
  39703. */
  39704. static IsExponentOfTwo(value: number): boolean;
  39705. private static _tmpFloatArray;
  39706. /**
  39707. * Returns the nearest 32-bit single precision float representation of a Number
  39708. * @param value A Number. If the parameter is of a different type, it will get converted
  39709. * to a number or to NaN if it cannot be converted
  39710. * @returns number
  39711. */
  39712. static FloatRound(value: number): number;
  39713. /**
  39714. * Extracts the filename from a path
  39715. * @param path defines the path to use
  39716. * @returns the filename
  39717. */
  39718. static GetFilename(path: string): string;
  39719. /**
  39720. * Extracts the "folder" part of a path (everything before the filename).
  39721. * @param uri The URI to extract the info from
  39722. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39723. * @returns The "folder" part of the path
  39724. */
  39725. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39726. /**
  39727. * Extracts text content from a DOM element hierarchy
  39728. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39729. */
  39730. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39731. /**
  39732. * Convert an angle in radians to degrees
  39733. * @param angle defines the angle to convert
  39734. * @returns the angle in degrees
  39735. */
  39736. static ToDegrees(angle: number): number;
  39737. /**
  39738. * Convert an angle in degrees to radians
  39739. * @param angle defines the angle to convert
  39740. * @returns the angle in radians
  39741. */
  39742. static ToRadians(angle: number): number;
  39743. /**
  39744. * Returns an array if obj is not an array
  39745. * @param obj defines the object to evaluate as an array
  39746. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39747. * @returns either obj directly if obj is an array or a new array containing obj
  39748. */
  39749. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39750. /**
  39751. * Gets the pointer prefix to use
  39752. * @param engine defines the engine we are finding the prefix for
  39753. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39754. */
  39755. static GetPointerPrefix(engine: Engine): string;
  39756. /**
  39757. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39758. * @param url define the url we are trying
  39759. * @param element define the dom element where to configure the cors policy
  39760. */
  39761. static SetCorsBehavior(url: string | string[], element: {
  39762. crossOrigin: string | null;
  39763. }): void;
  39764. /**
  39765. * Removes unwanted characters from an url
  39766. * @param url defines the url to clean
  39767. * @returns the cleaned url
  39768. */
  39769. static CleanUrl(url: string): string;
  39770. /**
  39771. * Gets or sets a function used to pre-process url before using them to load assets
  39772. */
  39773. static get PreprocessUrl(): (url: string) => string;
  39774. static set PreprocessUrl(processor: (url: string) => string);
  39775. /**
  39776. * Loads an image as an HTMLImageElement.
  39777. * @param input url string, ArrayBuffer, or Blob to load
  39778. * @param onLoad callback called when the image successfully loads
  39779. * @param onError callback called when the image fails to load
  39780. * @param offlineProvider offline provider for caching
  39781. * @param mimeType optional mime type
  39782. * @returns the HTMLImageElement of the loaded image
  39783. */
  39784. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39785. /**
  39786. * Loads a file from a url
  39787. * @param url url string, ArrayBuffer, or Blob to load
  39788. * @param onSuccess callback called when the file successfully loads
  39789. * @param onProgress callback called while file is loading (if the server supports this mode)
  39790. * @param offlineProvider defines the offline provider for caching
  39791. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39792. * @param onError callback called when the file fails to load
  39793. * @returns a file request object
  39794. */
  39795. 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;
  39796. /**
  39797. * Loads a file from a url
  39798. * @param url the file url to load
  39799. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39800. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39801. */
  39802. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39803. /**
  39804. * Load a script (identified by an url). When the url returns, the
  39805. * content of this file is added into a new script element, attached to the DOM (body element)
  39806. * @param scriptUrl defines the url of the script to laod
  39807. * @param onSuccess defines the callback called when the script is loaded
  39808. * @param onError defines the callback to call if an error occurs
  39809. * @param scriptId defines the id of the script element
  39810. */
  39811. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39812. /**
  39813. * Load an asynchronous script (identified by an url). When the url returns, the
  39814. * content of this file is added into a new script element, attached to the DOM (body element)
  39815. * @param scriptUrl defines the url of the script to laod
  39816. * @param scriptId defines the id of the script element
  39817. * @returns a promise request object
  39818. */
  39819. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39820. /**
  39821. * Loads a file from a blob
  39822. * @param fileToLoad defines the blob to use
  39823. * @param callback defines the callback to call when data is loaded
  39824. * @param progressCallback defines the callback to call during loading process
  39825. * @returns a file request object
  39826. */
  39827. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39828. /**
  39829. * Reads a file from a File object
  39830. * @param file defines the file to load
  39831. * @param onSuccess defines the callback to call when data is loaded
  39832. * @param onProgress defines the callback to call during loading process
  39833. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39834. * @param onError defines the callback to call when an error occurs
  39835. * @returns a file request object
  39836. */
  39837. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39838. /**
  39839. * Creates a data url from a given string content
  39840. * @param content defines the content to convert
  39841. * @returns the new data url link
  39842. */
  39843. static FileAsURL(content: string): string;
  39844. /**
  39845. * Format the given number to a specific decimal format
  39846. * @param value defines the number to format
  39847. * @param decimals defines the number of decimals to use
  39848. * @returns the formatted string
  39849. */
  39850. static Format(value: number, decimals?: number): string;
  39851. /**
  39852. * Tries to copy an object by duplicating every property
  39853. * @param source defines the source object
  39854. * @param destination defines the target object
  39855. * @param doNotCopyList defines a list of properties to avoid
  39856. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39857. */
  39858. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39859. /**
  39860. * Gets a boolean indicating if the given object has no own property
  39861. * @param obj defines the object to test
  39862. * @returns true if object has no own property
  39863. */
  39864. static IsEmpty(obj: any): boolean;
  39865. /**
  39866. * Function used to register events at window level
  39867. * @param windowElement defines the Window object to use
  39868. * @param events defines the events to register
  39869. */
  39870. static RegisterTopRootEvents(windowElement: Window, events: {
  39871. name: string;
  39872. handler: Nullable<(e: FocusEvent) => any>;
  39873. }[]): void;
  39874. /**
  39875. * Function used to unregister events from window level
  39876. * @param windowElement defines the Window object to use
  39877. * @param events defines the events to unregister
  39878. */
  39879. static UnregisterTopRootEvents(windowElement: Window, events: {
  39880. name: string;
  39881. handler: Nullable<(e: FocusEvent) => any>;
  39882. }[]): void;
  39883. /**
  39884. * @ignore
  39885. */
  39886. static _ScreenshotCanvas: HTMLCanvasElement;
  39887. /**
  39888. * Dumps the current bound framebuffer
  39889. * @param width defines the rendering width
  39890. * @param height defines the rendering height
  39891. * @param engine defines the hosting engine
  39892. * @param successCallback defines the callback triggered once the data are available
  39893. * @param mimeType defines the mime type of the result
  39894. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39895. */
  39896. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39897. /**
  39898. * Converts the canvas data to blob.
  39899. * This acts as a polyfill for browsers not supporting the to blob function.
  39900. * @param canvas Defines the canvas to extract the data from
  39901. * @param successCallback Defines the callback triggered once the data are available
  39902. * @param mimeType Defines the mime type of the result
  39903. */
  39904. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39905. /**
  39906. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39907. * @param successCallback defines the callback triggered once the data are available
  39908. * @param mimeType defines the mime type of the result
  39909. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39910. */
  39911. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39912. /**
  39913. * Downloads a blob in the browser
  39914. * @param blob defines the blob to download
  39915. * @param fileName defines the name of the downloaded file
  39916. */
  39917. static Download(blob: Blob, fileName: string): void;
  39918. /**
  39919. * Captures a screenshot of the current rendering
  39920. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39921. * @param engine defines the rendering engine
  39922. * @param camera defines the source camera
  39923. * @param size This parameter can be set to a single number or to an object with the
  39924. * following (optional) properties: precision, width, height. If a single number is passed,
  39925. * it will be used for both width and height. If an object is passed, the screenshot size
  39926. * will be derived from the parameters. The precision property is a multiplier allowing
  39927. * rendering at a higher or lower resolution
  39928. * @param successCallback defines the callback receives a single parameter which contains the
  39929. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39930. * src parameter of an <img> to display it
  39931. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39932. * Check your browser for supported MIME types
  39933. */
  39934. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39935. /**
  39936. * Captures a screenshot of the current rendering
  39937. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39938. * @param engine defines the rendering engine
  39939. * @param camera defines the source camera
  39940. * @param size This parameter can be set to a single number or to an object with the
  39941. * following (optional) properties: precision, width, height. If a single number is passed,
  39942. * it will be used for both width and height. If an object is passed, the screenshot size
  39943. * will be derived from the parameters. The precision property is a multiplier allowing
  39944. * rendering at a higher or lower resolution
  39945. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39946. * Check your browser for supported MIME types
  39947. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39948. * to the src parameter of an <img> to display it
  39949. */
  39950. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39951. /**
  39952. * Generates an image screenshot from the specified camera.
  39953. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39954. * @param engine The engine to use for rendering
  39955. * @param camera The camera to use for rendering
  39956. * @param size This parameter can be set to a single number or to an object with the
  39957. * following (optional) properties: precision, width, height. If a single number is passed,
  39958. * it will be used for both width and height. If an object is passed, the screenshot size
  39959. * will be derived from the parameters. The precision property is a multiplier allowing
  39960. * rendering at a higher or lower resolution
  39961. * @param successCallback The callback receives a single parameter which contains the
  39962. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39963. * src parameter of an <img> to display it
  39964. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39965. * Check your browser for supported MIME types
  39966. * @param samples Texture samples (default: 1)
  39967. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39968. * @param fileName A name for for the downloaded file.
  39969. */
  39970. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39971. /**
  39972. * Generates an image screenshot from the specified camera.
  39973. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39974. * @param engine The engine to use for rendering
  39975. * @param camera The camera to use for rendering
  39976. * @param size This parameter can be set to a single number or to an object with the
  39977. * following (optional) properties: precision, width, height. If a single number is passed,
  39978. * it will be used for both width and height. If an object is passed, the screenshot size
  39979. * will be derived from the parameters. The precision property is a multiplier allowing
  39980. * rendering at a higher or lower resolution
  39981. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39982. * Check your browser for supported MIME types
  39983. * @param samples Texture samples (default: 1)
  39984. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39985. * @param fileName A name for for the downloaded file.
  39986. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39987. * to the src parameter of an <img> to display it
  39988. */
  39989. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39990. /**
  39991. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39992. * Be aware Math.random() could cause collisions, but:
  39993. * "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"
  39994. * @returns a pseudo random id
  39995. */
  39996. static RandomId(): string;
  39997. /**
  39998. * Test if the given uri is a base64 string
  39999. * @param uri The uri to test
  40000. * @return True if the uri is a base64 string or false otherwise
  40001. */
  40002. static IsBase64(uri: string): boolean;
  40003. /**
  40004. * Decode the given base64 uri.
  40005. * @param uri The uri to decode
  40006. * @return The decoded base64 data.
  40007. */
  40008. static DecodeBase64(uri: string): ArrayBuffer;
  40009. /**
  40010. * Gets the absolute url.
  40011. * @param url the input url
  40012. * @return the absolute url
  40013. */
  40014. static GetAbsoluteUrl(url: string): string;
  40015. /**
  40016. * No log
  40017. */
  40018. static readonly NoneLogLevel: number;
  40019. /**
  40020. * Only message logs
  40021. */
  40022. static readonly MessageLogLevel: number;
  40023. /**
  40024. * Only warning logs
  40025. */
  40026. static readonly WarningLogLevel: number;
  40027. /**
  40028. * Only error logs
  40029. */
  40030. static readonly ErrorLogLevel: number;
  40031. /**
  40032. * All logs
  40033. */
  40034. static readonly AllLogLevel: number;
  40035. /**
  40036. * Gets a value indicating the number of loading errors
  40037. * @ignorenaming
  40038. */
  40039. static get errorsCount(): number;
  40040. /**
  40041. * Callback called when a new log is added
  40042. */
  40043. static OnNewCacheEntry: (entry: string) => void;
  40044. /**
  40045. * Log a message to the console
  40046. * @param message defines the message to log
  40047. */
  40048. static Log(message: string): void;
  40049. /**
  40050. * Write a warning message to the console
  40051. * @param message defines the message to log
  40052. */
  40053. static Warn(message: string): void;
  40054. /**
  40055. * Write an error message to the console
  40056. * @param message defines the message to log
  40057. */
  40058. static Error(message: string): void;
  40059. /**
  40060. * Gets current log cache (list of logs)
  40061. */
  40062. static get LogCache(): string;
  40063. /**
  40064. * Clears the log cache
  40065. */
  40066. static ClearLogCache(): void;
  40067. /**
  40068. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  40069. */
  40070. static set LogLevels(level: number);
  40071. /**
  40072. * Checks if the window object exists
  40073. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  40074. */
  40075. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  40076. /**
  40077. * No performance log
  40078. */
  40079. static readonly PerformanceNoneLogLevel: number;
  40080. /**
  40081. * Use user marks to log performance
  40082. */
  40083. static readonly PerformanceUserMarkLogLevel: number;
  40084. /**
  40085. * Log performance to the console
  40086. */
  40087. static readonly PerformanceConsoleLogLevel: number;
  40088. private static _performance;
  40089. /**
  40090. * Sets the current performance log level
  40091. */
  40092. static set PerformanceLogLevel(level: number);
  40093. private static _StartPerformanceCounterDisabled;
  40094. private static _EndPerformanceCounterDisabled;
  40095. private static _StartUserMark;
  40096. private static _EndUserMark;
  40097. private static _StartPerformanceConsole;
  40098. private static _EndPerformanceConsole;
  40099. /**
  40100. * Starts a performance counter
  40101. */
  40102. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  40103. /**
  40104. * Ends a specific performance coutner
  40105. */
  40106. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  40107. /**
  40108. * Gets either window.performance.now() if supported or Date.now() else
  40109. */
  40110. static get Now(): number;
  40111. /**
  40112. * This method will return the name of the class used to create the instance of the given object.
  40113. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  40114. * @param object the object to get the class name from
  40115. * @param isType defines if the object is actually a type
  40116. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  40117. */
  40118. static GetClassName(object: any, isType?: boolean): string;
  40119. /**
  40120. * Gets the first element of an array satisfying a given predicate
  40121. * @param array defines the array to browse
  40122. * @param predicate defines the predicate to use
  40123. * @returns null if not found or the element
  40124. */
  40125. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40126. /**
  40127. * This method will return the name of the full name of the class, including its owning module (if any).
  40128. * 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).
  40129. * @param object the object to get the class name from
  40130. * @param isType defines if the object is actually a type
  40131. * @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.
  40132. * @ignorenaming
  40133. */
  40134. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40135. /**
  40136. * Returns a promise that resolves after the given amount of time.
  40137. * @param delay Number of milliseconds to delay
  40138. * @returns Promise that resolves after the given amount of time
  40139. */
  40140. static DelayAsync(delay: number): Promise<void>;
  40141. /**
  40142. * Utility function to detect if the current user agent is Safari
  40143. * @returns whether or not the current user agent is safari
  40144. */
  40145. static IsSafari(): boolean;
  40146. }
  40147. /**
  40148. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40149. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40150. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40151. * @param name The name of the class, case should be preserved
  40152. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40153. */
  40154. export function className(name: string, module?: string): (target: Object) => void;
  40155. /**
  40156. * An implementation of a loop for asynchronous functions.
  40157. */
  40158. export class AsyncLoop {
  40159. /**
  40160. * Defines the number of iterations for the loop
  40161. */
  40162. iterations: number;
  40163. /**
  40164. * Defines the current index of the loop.
  40165. */
  40166. index: number;
  40167. private _done;
  40168. private _fn;
  40169. private _successCallback;
  40170. /**
  40171. * Constructor.
  40172. * @param iterations the number of iterations.
  40173. * @param func the function to run each iteration
  40174. * @param successCallback the callback that will be called upon succesful execution
  40175. * @param offset starting offset.
  40176. */
  40177. constructor(
  40178. /**
  40179. * Defines the number of iterations for the loop
  40180. */
  40181. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40182. /**
  40183. * Execute the next iteration. Must be called after the last iteration was finished.
  40184. */
  40185. executeNext(): void;
  40186. /**
  40187. * Break the loop and run the success callback.
  40188. */
  40189. breakLoop(): void;
  40190. /**
  40191. * Create and run an async loop.
  40192. * @param iterations the number of iterations.
  40193. * @param fn the function to run each iteration
  40194. * @param successCallback the callback that will be called upon succesful execution
  40195. * @param offset starting offset.
  40196. * @returns the created async loop object
  40197. */
  40198. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40199. /**
  40200. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40201. * @param iterations total number of iterations
  40202. * @param syncedIterations number of synchronous iterations in each async iteration.
  40203. * @param fn the function to call each iteration.
  40204. * @param callback a success call back that will be called when iterating stops.
  40205. * @param breakFunction a break condition (optional)
  40206. * @param timeout timeout settings for the setTimeout function. default - 0.
  40207. * @returns the created async loop object
  40208. */
  40209. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40210. }
  40211. }
  40212. declare module "babylonjs/Misc/stringDictionary" {
  40213. import { Nullable } from "babylonjs/types";
  40214. /**
  40215. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40216. * The underlying implementation relies on an associative array to ensure the best performances.
  40217. * The value can be anything including 'null' but except 'undefined'
  40218. */
  40219. export class StringDictionary<T> {
  40220. /**
  40221. * This will clear this dictionary and copy the content from the 'source' one.
  40222. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40223. * @param source the dictionary to take the content from and copy to this dictionary
  40224. */
  40225. copyFrom(source: StringDictionary<T>): void;
  40226. /**
  40227. * Get a value based from its key
  40228. * @param key the given key to get the matching value from
  40229. * @return the value if found, otherwise undefined is returned
  40230. */
  40231. get(key: string): T | undefined;
  40232. /**
  40233. * Get a value from its key or add it if it doesn't exist.
  40234. * This method will ensure you that a given key/data will be present in the dictionary.
  40235. * @param key the given key to get the matching value from
  40236. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40237. * The factory will only be invoked if there's no data for the given key.
  40238. * @return the value corresponding to the key.
  40239. */
  40240. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40241. /**
  40242. * Get a value from its key if present in the dictionary otherwise add it
  40243. * @param key the key to get the value from
  40244. * @param val if there's no such key/value pair in the dictionary add it with this value
  40245. * @return the value corresponding to the key
  40246. */
  40247. getOrAdd(key: string, val: T): T;
  40248. /**
  40249. * Check if there's a given key in the dictionary
  40250. * @param key the key to check for
  40251. * @return true if the key is present, false otherwise
  40252. */
  40253. contains(key: string): boolean;
  40254. /**
  40255. * Add a new key and its corresponding value
  40256. * @param key the key to add
  40257. * @param value the value corresponding to the key
  40258. * @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
  40259. */
  40260. add(key: string, value: T): boolean;
  40261. /**
  40262. * Update a specific value associated to a key
  40263. * @param key defines the key to use
  40264. * @param value defines the value to store
  40265. * @returns true if the value was updated (or false if the key was not found)
  40266. */
  40267. set(key: string, value: T): boolean;
  40268. /**
  40269. * Get the element of the given key and remove it from the dictionary
  40270. * @param key defines the key to search
  40271. * @returns the value associated with the key or null if not found
  40272. */
  40273. getAndRemove(key: string): Nullable<T>;
  40274. /**
  40275. * Remove a key/value from the dictionary.
  40276. * @param key the key to remove
  40277. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40278. */
  40279. remove(key: string): boolean;
  40280. /**
  40281. * Clear the whole content of the dictionary
  40282. */
  40283. clear(): void;
  40284. /**
  40285. * Gets the current count
  40286. */
  40287. get count(): number;
  40288. /**
  40289. * Execute a callback on each key/val of the dictionary.
  40290. * Note that you can remove any element in this dictionary in the callback implementation
  40291. * @param callback the callback to execute on a given key/value pair
  40292. */
  40293. forEach(callback: (key: string, val: T) => void): void;
  40294. /**
  40295. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40296. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40297. * Note that you can remove any element in this dictionary in the callback implementation
  40298. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40299. * @returns the first item
  40300. */
  40301. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40302. private _count;
  40303. private _data;
  40304. }
  40305. }
  40306. declare module "babylonjs/Collisions/collisionCoordinator" {
  40307. import { Nullable } from "babylonjs/types";
  40308. import { Scene } from "babylonjs/scene";
  40309. import { Vector3 } from "babylonjs/Maths/math.vector";
  40310. import { Collider } from "babylonjs/Collisions/collider";
  40311. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40312. /** @hidden */
  40313. export interface ICollisionCoordinator {
  40314. createCollider(): Collider;
  40315. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40316. init(scene: Scene): void;
  40317. }
  40318. /** @hidden */
  40319. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40320. private _scene;
  40321. private _scaledPosition;
  40322. private _scaledVelocity;
  40323. private _finalPosition;
  40324. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40325. createCollider(): Collider;
  40326. init(scene: Scene): void;
  40327. private _collideWithWorld;
  40328. }
  40329. }
  40330. declare module "babylonjs/Inputs/scene.inputManager" {
  40331. import { Nullable } from "babylonjs/types";
  40332. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40333. import { Vector2 } from "babylonjs/Maths/math.vector";
  40334. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40335. import { Scene } from "babylonjs/scene";
  40336. /**
  40337. * Class used to manage all inputs for the scene.
  40338. */
  40339. export class InputManager {
  40340. /** The distance in pixel that you have to move to prevent some events */
  40341. static DragMovementThreshold: number;
  40342. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40343. static LongPressDelay: number;
  40344. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40345. static DoubleClickDelay: number;
  40346. /** If you need to check double click without raising a single click at first click, enable this flag */
  40347. static ExclusiveDoubleClickMode: boolean;
  40348. /** 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. */
  40349. private _alreadyAttached;
  40350. private _wheelEventName;
  40351. private _onPointerMove;
  40352. private _onPointerDown;
  40353. private _onPointerUp;
  40354. private _initClickEvent;
  40355. private _initActionManager;
  40356. private _delayedSimpleClick;
  40357. private _delayedSimpleClickTimeout;
  40358. private _previousDelayedSimpleClickTimeout;
  40359. private _meshPickProceed;
  40360. private _previousButtonPressed;
  40361. private _currentPickResult;
  40362. private _previousPickResult;
  40363. private _totalPointersPressed;
  40364. private _doubleClickOccured;
  40365. private _pointerOverMesh;
  40366. private _pickedDownMesh;
  40367. private _pickedUpMesh;
  40368. private _pointerX;
  40369. private _pointerY;
  40370. private _unTranslatedPointerX;
  40371. private _unTranslatedPointerY;
  40372. private _startingPointerPosition;
  40373. private _previousStartingPointerPosition;
  40374. private _startingPointerTime;
  40375. private _previousStartingPointerTime;
  40376. private _pointerCaptures;
  40377. private _meshUnderPointerId;
  40378. private _onKeyDown;
  40379. private _onKeyUp;
  40380. private _onCanvasFocusObserver;
  40381. private _onCanvasBlurObserver;
  40382. private _scene;
  40383. /**
  40384. * Creates a new InputManager
  40385. * @param scene defines the hosting scene
  40386. */
  40387. constructor(scene: Scene);
  40388. /**
  40389. * Gets the mesh that is currently under the pointer
  40390. */
  40391. get meshUnderPointer(): Nullable<AbstractMesh>;
  40392. /**
  40393. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  40394. * @param pointerId the pointer id to use
  40395. * @returns The mesh under this pointer id or null if not found
  40396. */
  40397. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  40398. /**
  40399. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40400. */
  40401. get unTranslatedPointer(): Vector2;
  40402. /**
  40403. * Gets or sets the current on-screen X position of the pointer
  40404. */
  40405. get pointerX(): number;
  40406. set pointerX(value: number);
  40407. /**
  40408. * Gets or sets the current on-screen Y position of the pointer
  40409. */
  40410. get pointerY(): number;
  40411. set pointerY(value: number);
  40412. private _updatePointerPosition;
  40413. private _processPointerMove;
  40414. private _setRayOnPointerInfo;
  40415. private _checkPrePointerObservable;
  40416. /**
  40417. * Use this method to simulate a pointer move on a mesh
  40418. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40419. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40420. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40421. */
  40422. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40423. /**
  40424. * Use this method to simulate a pointer down on a mesh
  40425. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40426. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40427. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40428. */
  40429. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40430. private _processPointerDown;
  40431. /** @hidden */
  40432. _isPointerSwiping(): boolean;
  40433. /**
  40434. * Use this method to simulate a pointer up on a mesh
  40435. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40436. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40437. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40438. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40439. */
  40440. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40441. private _processPointerUp;
  40442. /**
  40443. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40444. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40445. * @returns true if the pointer was captured
  40446. */
  40447. isPointerCaptured(pointerId?: number): boolean;
  40448. /**
  40449. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40450. * @param attachUp defines if you want to attach events to pointerup
  40451. * @param attachDown defines if you want to attach events to pointerdown
  40452. * @param attachMove defines if you want to attach events to pointermove
  40453. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40454. */
  40455. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40456. /**
  40457. * Detaches all event handlers
  40458. */
  40459. detachControl(): void;
  40460. /**
  40461. * Force the value of meshUnderPointer
  40462. * @param mesh defines the mesh to use
  40463. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  40464. */
  40465. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  40466. /**
  40467. * Gets the mesh under the pointer
  40468. * @returns a Mesh or null if no mesh is under the pointer
  40469. */
  40470. getPointerOverMesh(): Nullable<AbstractMesh>;
  40471. }
  40472. }
  40473. declare module "babylonjs/Animations/animationGroup" {
  40474. import { Animatable } from "babylonjs/Animations/animatable";
  40475. import { Animation } from "babylonjs/Animations/animation";
  40476. import { Scene, IDisposable } from "babylonjs/scene";
  40477. import { Observable } from "babylonjs/Misc/observable";
  40478. import { Nullable } from "babylonjs/types";
  40479. import "babylonjs/Animations/animatable";
  40480. /**
  40481. * This class defines the direct association between an animation and a target
  40482. */
  40483. export class TargetedAnimation {
  40484. /**
  40485. * Animation to perform
  40486. */
  40487. animation: Animation;
  40488. /**
  40489. * Target to animate
  40490. */
  40491. target: any;
  40492. /**
  40493. * Returns the string "TargetedAnimation"
  40494. * @returns "TargetedAnimation"
  40495. */
  40496. getClassName(): string;
  40497. /**
  40498. * Serialize the object
  40499. * @returns the JSON object representing the current entity
  40500. */
  40501. serialize(): any;
  40502. }
  40503. /**
  40504. * Use this class to create coordinated animations on multiple targets
  40505. */
  40506. export class AnimationGroup implements IDisposable {
  40507. /** The name of the animation group */
  40508. name: string;
  40509. private _scene;
  40510. private _targetedAnimations;
  40511. private _animatables;
  40512. private _from;
  40513. private _to;
  40514. private _isStarted;
  40515. private _isPaused;
  40516. private _speedRatio;
  40517. private _loopAnimation;
  40518. private _isAdditive;
  40519. /**
  40520. * Gets or sets the unique id of the node
  40521. */
  40522. uniqueId: number;
  40523. /**
  40524. * This observable will notify when one animation have ended
  40525. */
  40526. onAnimationEndObservable: Observable<TargetedAnimation>;
  40527. /**
  40528. * Observer raised when one animation loops
  40529. */
  40530. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40531. /**
  40532. * Observer raised when all animations have looped
  40533. */
  40534. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40535. /**
  40536. * This observable will notify when all animations have ended.
  40537. */
  40538. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40539. /**
  40540. * This observable will notify when all animations have paused.
  40541. */
  40542. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40543. /**
  40544. * This observable will notify when all animations are playing.
  40545. */
  40546. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40547. /**
  40548. * Gets the first frame
  40549. */
  40550. get from(): number;
  40551. /**
  40552. * Gets the last frame
  40553. */
  40554. get to(): number;
  40555. /**
  40556. * Define if the animations are started
  40557. */
  40558. get isStarted(): boolean;
  40559. /**
  40560. * Gets a value indicating that the current group is playing
  40561. */
  40562. get isPlaying(): boolean;
  40563. /**
  40564. * Gets or sets the speed ratio to use for all animations
  40565. */
  40566. get speedRatio(): number;
  40567. /**
  40568. * Gets or sets the speed ratio to use for all animations
  40569. */
  40570. set speedRatio(value: number);
  40571. /**
  40572. * Gets or sets if all animations should loop or not
  40573. */
  40574. get loopAnimation(): boolean;
  40575. set loopAnimation(value: boolean);
  40576. /**
  40577. * Gets or sets if all animations should be evaluated additively
  40578. */
  40579. get isAdditive(): boolean;
  40580. set isAdditive(value: boolean);
  40581. /**
  40582. * Gets the targeted animations for this animation group
  40583. */
  40584. get targetedAnimations(): Array<TargetedAnimation>;
  40585. /**
  40586. * returning the list of animatables controlled by this animation group.
  40587. */
  40588. get animatables(): Array<Animatable>;
  40589. /**
  40590. * Gets the list of target animations
  40591. */
  40592. get children(): TargetedAnimation[];
  40593. /**
  40594. * Instantiates a new Animation Group.
  40595. * This helps managing several animations at once.
  40596. * @see https://doc.babylonjs.com/how_to/group
  40597. * @param name Defines the name of the group
  40598. * @param scene Defines the scene the group belongs to
  40599. */
  40600. constructor(
  40601. /** The name of the animation group */
  40602. name: string, scene?: Nullable<Scene>);
  40603. /**
  40604. * Add an animation (with its target) in the group
  40605. * @param animation defines the animation we want to add
  40606. * @param target defines the target of the animation
  40607. * @returns the TargetedAnimation object
  40608. */
  40609. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40610. /**
  40611. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40612. * It can add constant keys at begin or end
  40613. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40614. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40615. * @returns the animation group
  40616. */
  40617. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40618. private _animationLoopCount;
  40619. private _animationLoopFlags;
  40620. private _processLoop;
  40621. /**
  40622. * Start all animations on given targets
  40623. * @param loop defines if animations must loop
  40624. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40625. * @param from defines the from key (optional)
  40626. * @param to defines the to key (optional)
  40627. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40628. * @returns the current animation group
  40629. */
  40630. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40631. /**
  40632. * Pause all animations
  40633. * @returns the animation group
  40634. */
  40635. pause(): AnimationGroup;
  40636. /**
  40637. * Play all animations to initial state
  40638. * This function will start() the animations if they were not started or will restart() them if they were paused
  40639. * @param loop defines if animations must loop
  40640. * @returns the animation group
  40641. */
  40642. play(loop?: boolean): AnimationGroup;
  40643. /**
  40644. * Reset all animations to initial state
  40645. * @returns the animation group
  40646. */
  40647. reset(): AnimationGroup;
  40648. /**
  40649. * Restart animations from key 0
  40650. * @returns the animation group
  40651. */
  40652. restart(): AnimationGroup;
  40653. /**
  40654. * Stop all animations
  40655. * @returns the animation group
  40656. */
  40657. stop(): AnimationGroup;
  40658. /**
  40659. * Set animation weight for all animatables
  40660. * @param weight defines the weight to use
  40661. * @return the animationGroup
  40662. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40663. */
  40664. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40665. /**
  40666. * Synchronize and normalize all animatables with a source animatable
  40667. * @param root defines the root animatable to synchronize with
  40668. * @return the animationGroup
  40669. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40670. */
  40671. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40672. /**
  40673. * Goes to a specific frame in this animation group
  40674. * @param frame the frame number to go to
  40675. * @return the animationGroup
  40676. */
  40677. goToFrame(frame: number): AnimationGroup;
  40678. /**
  40679. * Dispose all associated resources
  40680. */
  40681. dispose(): void;
  40682. private _checkAnimationGroupEnded;
  40683. /**
  40684. * Clone the current animation group and returns a copy
  40685. * @param newName defines the name of the new group
  40686. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40687. * @returns the new aniamtion group
  40688. */
  40689. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40690. /**
  40691. * Serializes the animationGroup to an object
  40692. * @returns Serialized object
  40693. */
  40694. serialize(): any;
  40695. /**
  40696. * Returns a new AnimationGroup object parsed from the source provided.
  40697. * @param parsedAnimationGroup defines the source
  40698. * @param scene defines the scene that will receive the animationGroup
  40699. * @returns a new AnimationGroup
  40700. */
  40701. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40702. /**
  40703. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40704. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40705. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40706. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40707. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40708. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40709. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40710. */
  40711. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40712. /**
  40713. * Returns the string "AnimationGroup"
  40714. * @returns "AnimationGroup"
  40715. */
  40716. getClassName(): string;
  40717. /**
  40718. * Creates a detailled string about the object
  40719. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40720. * @returns a string representing the object
  40721. */
  40722. toString(fullDetails?: boolean): string;
  40723. }
  40724. }
  40725. declare module "babylonjs/scene" {
  40726. import { Nullable } from "babylonjs/types";
  40727. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40728. import { Observable } from "babylonjs/Misc/observable";
  40729. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40730. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40731. import { Geometry } from "babylonjs/Meshes/geometry";
  40732. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40733. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40735. import { Mesh } from "babylonjs/Meshes/mesh";
  40736. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40737. import { Bone } from "babylonjs/Bones/bone";
  40738. import { Skeleton } from "babylonjs/Bones/skeleton";
  40739. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40740. import { Camera } from "babylonjs/Cameras/camera";
  40741. import { AbstractScene } from "babylonjs/abstractScene";
  40742. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40743. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40744. import { Material } from "babylonjs/Materials/material";
  40745. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40746. import { Effect } from "babylonjs/Materials/effect";
  40747. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40748. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40749. import { Light } from "babylonjs/Lights/light";
  40750. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40751. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40752. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40753. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40754. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40755. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40756. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40757. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40758. import { Engine } from "babylonjs/Engines/engine";
  40759. import { Node } from "babylonjs/node";
  40760. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40761. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40762. import { WebRequest } from "babylonjs/Misc/webRequest";
  40763. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40764. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40765. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40766. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40767. import { Plane } from "babylonjs/Maths/math.plane";
  40768. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40769. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40770. import { Ray } from "babylonjs/Culling/ray";
  40771. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40772. import { Animation } from "babylonjs/Animations/animation";
  40773. import { Animatable } from "babylonjs/Animations/animatable";
  40774. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40775. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40776. import { Collider } from "babylonjs/Collisions/collider";
  40777. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40778. /**
  40779. * Define an interface for all classes that will hold resources
  40780. */
  40781. export interface IDisposable {
  40782. /**
  40783. * Releases all held resources
  40784. */
  40785. dispose(): void;
  40786. }
  40787. /** Interface defining initialization parameters for Scene class */
  40788. export interface SceneOptions {
  40789. /**
  40790. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40791. * It will improve performance when the number of geometries becomes important.
  40792. */
  40793. useGeometryUniqueIdsMap?: boolean;
  40794. /**
  40795. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40796. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40797. */
  40798. useMaterialMeshMap?: boolean;
  40799. /**
  40800. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40801. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40802. */
  40803. useClonedMeshMap?: boolean;
  40804. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40805. virtual?: boolean;
  40806. }
  40807. /**
  40808. * Represents a scene to be rendered by the engine.
  40809. * @see https://doc.babylonjs.com/features/scene
  40810. */
  40811. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40812. /** The fog is deactivated */
  40813. static readonly FOGMODE_NONE: number;
  40814. /** The fog density is following an exponential function */
  40815. static readonly FOGMODE_EXP: number;
  40816. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40817. static readonly FOGMODE_EXP2: number;
  40818. /** The fog density is following a linear function. */
  40819. static readonly FOGMODE_LINEAR: number;
  40820. /**
  40821. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40822. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40823. */
  40824. static MinDeltaTime: number;
  40825. /**
  40826. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40827. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40828. */
  40829. static MaxDeltaTime: number;
  40830. /**
  40831. * Factory used to create the default material.
  40832. * @param name The name of the material to create
  40833. * @param scene The scene to create the material for
  40834. * @returns The default material
  40835. */
  40836. static DefaultMaterialFactory(scene: Scene): Material;
  40837. /**
  40838. * Factory used to create the a collision coordinator.
  40839. * @returns The collision coordinator
  40840. */
  40841. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40842. /** @hidden */
  40843. _inputManager: InputManager;
  40844. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40845. cameraToUseForPointers: Nullable<Camera>;
  40846. /** @hidden */
  40847. readonly _isScene: boolean;
  40848. /** @hidden */
  40849. _blockEntityCollection: boolean;
  40850. /**
  40851. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40852. */
  40853. autoClear: boolean;
  40854. /**
  40855. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40856. */
  40857. autoClearDepthAndStencil: boolean;
  40858. /**
  40859. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40860. */
  40861. clearColor: Color4;
  40862. /**
  40863. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40864. */
  40865. ambientColor: Color3;
  40866. /**
  40867. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40868. * It should only be one of the following (if not the default embedded one):
  40869. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40870. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40871. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40872. * The material properties need to be setup according to the type of texture in use.
  40873. */
  40874. environmentBRDFTexture: BaseTexture;
  40875. /**
  40876. * Texture used in all pbr material as the reflection texture.
  40877. * As in the majority of the scene they are the same (exception for multi room and so on),
  40878. * this is easier to reference from here than from all the materials.
  40879. */
  40880. get environmentTexture(): Nullable<BaseTexture>;
  40881. /**
  40882. * Texture used in all pbr material as the reflection texture.
  40883. * As in the majority of the scene they are the same (exception for multi room and so on),
  40884. * this is easier to set here than in all the materials.
  40885. */
  40886. set environmentTexture(value: Nullable<BaseTexture>);
  40887. /** @hidden */
  40888. protected _environmentIntensity: number;
  40889. /**
  40890. * Intensity of the environment in all pbr material.
  40891. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40892. * As in the majority of the scene they are the same (exception for multi room and so on),
  40893. * this is easier to reference from here than from all the materials.
  40894. */
  40895. get environmentIntensity(): number;
  40896. /**
  40897. * Intensity of the environment in all pbr material.
  40898. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40899. * As in the majority of the scene they are the same (exception for multi room and so on),
  40900. * this is easier to set here than in all the materials.
  40901. */
  40902. set environmentIntensity(value: number);
  40903. /** @hidden */
  40904. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40905. /**
  40906. * Default image processing configuration used either in the rendering
  40907. * Forward main pass or through the imageProcessingPostProcess if present.
  40908. * As in the majority of the scene they are the same (exception for multi camera),
  40909. * this is easier to reference from here than from all the materials and post process.
  40910. *
  40911. * No setter as we it is a shared configuration, you can set the values instead.
  40912. */
  40913. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40914. private _forceWireframe;
  40915. /**
  40916. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40917. */
  40918. set forceWireframe(value: boolean);
  40919. get forceWireframe(): boolean;
  40920. private _skipFrustumClipping;
  40921. /**
  40922. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40923. */
  40924. set skipFrustumClipping(value: boolean);
  40925. get skipFrustumClipping(): boolean;
  40926. private _forcePointsCloud;
  40927. /**
  40928. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40929. */
  40930. set forcePointsCloud(value: boolean);
  40931. get forcePointsCloud(): boolean;
  40932. /**
  40933. * Gets or sets the active clipplane 1
  40934. */
  40935. clipPlane: Nullable<Plane>;
  40936. /**
  40937. * Gets or sets the active clipplane 2
  40938. */
  40939. clipPlane2: Nullable<Plane>;
  40940. /**
  40941. * Gets or sets the active clipplane 3
  40942. */
  40943. clipPlane3: Nullable<Plane>;
  40944. /**
  40945. * Gets or sets the active clipplane 4
  40946. */
  40947. clipPlane4: Nullable<Plane>;
  40948. /**
  40949. * Gets or sets the active clipplane 5
  40950. */
  40951. clipPlane5: Nullable<Plane>;
  40952. /**
  40953. * Gets or sets the active clipplane 6
  40954. */
  40955. clipPlane6: Nullable<Plane>;
  40956. /**
  40957. * Gets or sets a boolean indicating if animations are enabled
  40958. */
  40959. animationsEnabled: boolean;
  40960. private _animationPropertiesOverride;
  40961. /**
  40962. * Gets or sets the animation properties override
  40963. */
  40964. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40965. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40966. /**
  40967. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40968. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40969. */
  40970. useConstantAnimationDeltaTime: boolean;
  40971. /**
  40972. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40973. * Please note that it requires to run a ray cast through the scene on every frame
  40974. */
  40975. constantlyUpdateMeshUnderPointer: boolean;
  40976. /**
  40977. * Defines the HTML cursor to use when hovering over interactive elements
  40978. */
  40979. hoverCursor: string;
  40980. /**
  40981. * Defines the HTML default cursor to use (empty by default)
  40982. */
  40983. defaultCursor: string;
  40984. /**
  40985. * Defines whether cursors are handled by the scene.
  40986. */
  40987. doNotHandleCursors: boolean;
  40988. /**
  40989. * This is used to call preventDefault() on pointer down
  40990. * in order to block unwanted artifacts like system double clicks
  40991. */
  40992. preventDefaultOnPointerDown: boolean;
  40993. /**
  40994. * This is used to call preventDefault() on pointer up
  40995. * in order to block unwanted artifacts like system double clicks
  40996. */
  40997. preventDefaultOnPointerUp: boolean;
  40998. /**
  40999. * Gets or sets user defined metadata
  41000. */
  41001. metadata: any;
  41002. /**
  41003. * For internal use only. Please do not use.
  41004. */
  41005. reservedDataStore: any;
  41006. /**
  41007. * Gets the name of the plugin used to load this scene (null by default)
  41008. */
  41009. loadingPluginName: string;
  41010. /**
  41011. * Use this array to add regular expressions used to disable offline support for specific urls
  41012. */
  41013. disableOfflineSupportExceptionRules: RegExp[];
  41014. /**
  41015. * An event triggered when the scene is disposed.
  41016. */
  41017. onDisposeObservable: Observable<Scene>;
  41018. private _onDisposeObserver;
  41019. /** Sets a function to be executed when this scene is disposed. */
  41020. set onDispose(callback: () => void);
  41021. /**
  41022. * An event triggered before rendering the scene (right after animations and physics)
  41023. */
  41024. onBeforeRenderObservable: Observable<Scene>;
  41025. private _onBeforeRenderObserver;
  41026. /** Sets a function to be executed before rendering this scene */
  41027. set beforeRender(callback: Nullable<() => void>);
  41028. /**
  41029. * An event triggered after rendering the scene
  41030. */
  41031. onAfterRenderObservable: Observable<Scene>;
  41032. /**
  41033. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  41034. */
  41035. onAfterRenderCameraObservable: Observable<Camera>;
  41036. private _onAfterRenderObserver;
  41037. /** Sets a function to be executed after rendering this scene */
  41038. set afterRender(callback: Nullable<() => void>);
  41039. /**
  41040. * An event triggered before animating the scene
  41041. */
  41042. onBeforeAnimationsObservable: Observable<Scene>;
  41043. /**
  41044. * An event triggered after animations processing
  41045. */
  41046. onAfterAnimationsObservable: Observable<Scene>;
  41047. /**
  41048. * An event triggered before draw calls are ready to be sent
  41049. */
  41050. onBeforeDrawPhaseObservable: Observable<Scene>;
  41051. /**
  41052. * An event triggered after draw calls have been sent
  41053. */
  41054. onAfterDrawPhaseObservable: Observable<Scene>;
  41055. /**
  41056. * An event triggered when the scene is ready
  41057. */
  41058. onReadyObservable: Observable<Scene>;
  41059. /**
  41060. * An event triggered before rendering a camera
  41061. */
  41062. onBeforeCameraRenderObservable: Observable<Camera>;
  41063. private _onBeforeCameraRenderObserver;
  41064. /** Sets a function to be executed before rendering a camera*/
  41065. set beforeCameraRender(callback: () => void);
  41066. /**
  41067. * An event triggered after rendering a camera
  41068. */
  41069. onAfterCameraRenderObservable: Observable<Camera>;
  41070. private _onAfterCameraRenderObserver;
  41071. /** Sets a function to be executed after rendering a camera*/
  41072. set afterCameraRender(callback: () => void);
  41073. /**
  41074. * An event triggered when active meshes evaluation is about to start
  41075. */
  41076. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  41077. /**
  41078. * An event triggered when active meshes evaluation is done
  41079. */
  41080. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  41081. /**
  41082. * An event triggered when particles rendering is about to start
  41083. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  41084. */
  41085. onBeforeParticlesRenderingObservable: Observable<Scene>;
  41086. /**
  41087. * An event triggered when particles rendering is done
  41088. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  41089. */
  41090. onAfterParticlesRenderingObservable: Observable<Scene>;
  41091. /**
  41092. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  41093. */
  41094. onDataLoadedObservable: Observable<Scene>;
  41095. /**
  41096. * An event triggered when a camera is created
  41097. */
  41098. onNewCameraAddedObservable: Observable<Camera>;
  41099. /**
  41100. * An event triggered when a camera is removed
  41101. */
  41102. onCameraRemovedObservable: Observable<Camera>;
  41103. /**
  41104. * An event triggered when a light is created
  41105. */
  41106. onNewLightAddedObservable: Observable<Light>;
  41107. /**
  41108. * An event triggered when a light is removed
  41109. */
  41110. onLightRemovedObservable: Observable<Light>;
  41111. /**
  41112. * An event triggered when a geometry is created
  41113. */
  41114. onNewGeometryAddedObservable: Observable<Geometry>;
  41115. /**
  41116. * An event triggered when a geometry is removed
  41117. */
  41118. onGeometryRemovedObservable: Observable<Geometry>;
  41119. /**
  41120. * An event triggered when a transform node is created
  41121. */
  41122. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  41123. /**
  41124. * An event triggered when a transform node is removed
  41125. */
  41126. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41127. /**
  41128. * An event triggered when a mesh is created
  41129. */
  41130. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41131. /**
  41132. * An event triggered when a mesh is removed
  41133. */
  41134. onMeshRemovedObservable: Observable<AbstractMesh>;
  41135. /**
  41136. * An event triggered when a skeleton is created
  41137. */
  41138. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41139. /**
  41140. * An event triggered when a skeleton is removed
  41141. */
  41142. onSkeletonRemovedObservable: Observable<Skeleton>;
  41143. /**
  41144. * An event triggered when a material is created
  41145. */
  41146. onNewMaterialAddedObservable: Observable<Material>;
  41147. /**
  41148. * An event triggered when a material is removed
  41149. */
  41150. onMaterialRemovedObservable: Observable<Material>;
  41151. /**
  41152. * An event triggered when a texture is created
  41153. */
  41154. onNewTextureAddedObservable: Observable<BaseTexture>;
  41155. /**
  41156. * An event triggered when a texture is removed
  41157. */
  41158. onTextureRemovedObservable: Observable<BaseTexture>;
  41159. /**
  41160. * An event triggered when render targets are about to be rendered
  41161. * Can happen multiple times per frame.
  41162. */
  41163. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41164. /**
  41165. * An event triggered when render targets were rendered.
  41166. * Can happen multiple times per frame.
  41167. */
  41168. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41169. /**
  41170. * An event triggered before calculating deterministic simulation step
  41171. */
  41172. onBeforeStepObservable: Observable<Scene>;
  41173. /**
  41174. * An event triggered after calculating deterministic simulation step
  41175. */
  41176. onAfterStepObservable: Observable<Scene>;
  41177. /**
  41178. * An event triggered when the activeCamera property is updated
  41179. */
  41180. onActiveCameraChanged: Observable<Scene>;
  41181. /**
  41182. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41183. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41184. * 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)
  41185. */
  41186. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41187. /**
  41188. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41189. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41190. * 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)
  41191. */
  41192. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41193. /**
  41194. * This Observable will when a mesh has been imported into the scene.
  41195. */
  41196. onMeshImportedObservable: Observable<AbstractMesh>;
  41197. /**
  41198. * This Observable will when an animation file has been imported into the scene.
  41199. */
  41200. onAnimationFileImportedObservable: Observable<Scene>;
  41201. /**
  41202. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41203. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41204. */
  41205. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41206. /** @hidden */
  41207. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41208. /**
  41209. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41210. */
  41211. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41212. /**
  41213. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41214. */
  41215. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41216. /**
  41217. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41218. */
  41219. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41220. /** Callback called when a pointer move is detected */
  41221. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41222. /** Callback called when a pointer down is detected */
  41223. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41224. /** Callback called when a pointer up is detected */
  41225. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41226. /** Callback called when a pointer pick is detected */
  41227. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41228. /**
  41229. * 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).
  41230. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41231. */
  41232. onPrePointerObservable: Observable<PointerInfoPre>;
  41233. /**
  41234. * Observable event triggered each time an input event is received from the rendering canvas
  41235. */
  41236. onPointerObservable: Observable<PointerInfo>;
  41237. /**
  41238. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41239. */
  41240. get unTranslatedPointer(): Vector2;
  41241. /**
  41242. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41243. */
  41244. static get DragMovementThreshold(): number;
  41245. static set DragMovementThreshold(value: number);
  41246. /**
  41247. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41248. */
  41249. static get LongPressDelay(): number;
  41250. static set LongPressDelay(value: number);
  41251. /**
  41252. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41253. */
  41254. static get DoubleClickDelay(): number;
  41255. static set DoubleClickDelay(value: number);
  41256. /** If you need to check double click without raising a single click at first click, enable this flag */
  41257. static get ExclusiveDoubleClickMode(): boolean;
  41258. static set ExclusiveDoubleClickMode(value: boolean);
  41259. /** @hidden */
  41260. _mirroredCameraPosition: Nullable<Vector3>;
  41261. /**
  41262. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41263. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41264. */
  41265. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41266. /**
  41267. * Observable event triggered each time an keyboard event is received from the hosting window
  41268. */
  41269. onKeyboardObservable: Observable<KeyboardInfo>;
  41270. private _useRightHandedSystem;
  41271. /**
  41272. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41273. */
  41274. set useRightHandedSystem(value: boolean);
  41275. get useRightHandedSystem(): boolean;
  41276. private _timeAccumulator;
  41277. private _currentStepId;
  41278. private _currentInternalStep;
  41279. /**
  41280. * Sets the step Id used by deterministic lock step
  41281. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41282. * @param newStepId defines the step Id
  41283. */
  41284. setStepId(newStepId: number): void;
  41285. /**
  41286. * Gets the step Id used by deterministic lock step
  41287. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41288. * @returns the step Id
  41289. */
  41290. getStepId(): number;
  41291. /**
  41292. * Gets the internal step used by deterministic lock step
  41293. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41294. * @returns the internal step
  41295. */
  41296. getInternalStep(): number;
  41297. private _fogEnabled;
  41298. /**
  41299. * Gets or sets a boolean indicating if fog is enabled on this scene
  41300. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41301. * (Default is true)
  41302. */
  41303. set fogEnabled(value: boolean);
  41304. get fogEnabled(): boolean;
  41305. private _fogMode;
  41306. /**
  41307. * Gets or sets the fog mode to use
  41308. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41309. * | mode | value |
  41310. * | --- | --- |
  41311. * | FOGMODE_NONE | 0 |
  41312. * | FOGMODE_EXP | 1 |
  41313. * | FOGMODE_EXP2 | 2 |
  41314. * | FOGMODE_LINEAR | 3 |
  41315. */
  41316. set fogMode(value: number);
  41317. get fogMode(): number;
  41318. /**
  41319. * Gets or sets the fog color to use
  41320. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41321. * (Default is Color3(0.2, 0.2, 0.3))
  41322. */
  41323. fogColor: Color3;
  41324. /**
  41325. * Gets or sets the fog density to use
  41326. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41327. * (Default is 0.1)
  41328. */
  41329. fogDensity: number;
  41330. /**
  41331. * Gets or sets the fog start distance to use
  41332. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41333. * (Default is 0)
  41334. */
  41335. fogStart: number;
  41336. /**
  41337. * Gets or sets the fog end distance to use
  41338. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41339. * (Default is 1000)
  41340. */
  41341. fogEnd: number;
  41342. /**
  41343. * Flag indicating that the frame buffer binding is handled by another component
  41344. */
  41345. prePass: boolean;
  41346. private _shadowsEnabled;
  41347. /**
  41348. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41349. */
  41350. set shadowsEnabled(value: boolean);
  41351. get shadowsEnabled(): boolean;
  41352. private _lightsEnabled;
  41353. /**
  41354. * Gets or sets a boolean indicating if lights are enabled on this scene
  41355. */
  41356. set lightsEnabled(value: boolean);
  41357. get lightsEnabled(): boolean;
  41358. /** All of the active cameras added to this scene. */
  41359. activeCameras: Camera[];
  41360. /** @hidden */
  41361. _activeCamera: Nullable<Camera>;
  41362. /** Gets or sets the current active camera */
  41363. get activeCamera(): Nullable<Camera>;
  41364. set activeCamera(value: Nullable<Camera>);
  41365. private _defaultMaterial;
  41366. /** The default material used on meshes when no material is affected */
  41367. get defaultMaterial(): Material;
  41368. /** The default material used on meshes when no material is affected */
  41369. set defaultMaterial(value: Material);
  41370. private _texturesEnabled;
  41371. /**
  41372. * Gets or sets a boolean indicating if textures are enabled on this scene
  41373. */
  41374. set texturesEnabled(value: boolean);
  41375. get texturesEnabled(): boolean;
  41376. /**
  41377. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41378. */
  41379. physicsEnabled: boolean;
  41380. /**
  41381. * Gets or sets a boolean indicating if particles are enabled on this scene
  41382. */
  41383. particlesEnabled: boolean;
  41384. /**
  41385. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41386. */
  41387. spritesEnabled: boolean;
  41388. private _skeletonsEnabled;
  41389. /**
  41390. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41391. */
  41392. set skeletonsEnabled(value: boolean);
  41393. get skeletonsEnabled(): boolean;
  41394. /**
  41395. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41396. */
  41397. lensFlaresEnabled: boolean;
  41398. /**
  41399. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41400. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41401. */
  41402. collisionsEnabled: boolean;
  41403. private _collisionCoordinator;
  41404. /** @hidden */
  41405. get collisionCoordinator(): ICollisionCoordinator;
  41406. /**
  41407. * Defines the gravity applied to this scene (used only for collisions)
  41408. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41409. */
  41410. gravity: Vector3;
  41411. /**
  41412. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41413. */
  41414. postProcessesEnabled: boolean;
  41415. /**
  41416. * Gets the current postprocess manager
  41417. */
  41418. postProcessManager: PostProcessManager;
  41419. /**
  41420. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41421. */
  41422. renderTargetsEnabled: boolean;
  41423. /**
  41424. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41425. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41426. */
  41427. dumpNextRenderTargets: boolean;
  41428. /**
  41429. * The list of user defined render targets added to the scene
  41430. */
  41431. customRenderTargets: RenderTargetTexture[];
  41432. /**
  41433. * Defines if texture loading must be delayed
  41434. * If true, textures will only be loaded when they need to be rendered
  41435. */
  41436. useDelayedTextureLoading: boolean;
  41437. /**
  41438. * Gets the list of meshes imported to the scene through SceneLoader
  41439. */
  41440. importedMeshesFiles: String[];
  41441. /**
  41442. * Gets or sets a boolean indicating if probes are enabled on this scene
  41443. */
  41444. probesEnabled: boolean;
  41445. /**
  41446. * Gets or sets the current offline provider to use to store scene data
  41447. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41448. */
  41449. offlineProvider: IOfflineProvider;
  41450. /**
  41451. * Gets or sets the action manager associated with the scene
  41452. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41453. */
  41454. actionManager: AbstractActionManager;
  41455. private _meshesForIntersections;
  41456. /**
  41457. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41458. */
  41459. proceduralTexturesEnabled: boolean;
  41460. private _engine;
  41461. private _totalVertices;
  41462. /** @hidden */
  41463. _activeIndices: PerfCounter;
  41464. /** @hidden */
  41465. _activeParticles: PerfCounter;
  41466. /** @hidden */
  41467. _activeBones: PerfCounter;
  41468. private _animationRatio;
  41469. /** @hidden */
  41470. _animationTimeLast: number;
  41471. /** @hidden */
  41472. _animationTime: number;
  41473. /**
  41474. * Gets or sets a general scale for animation speed
  41475. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41476. */
  41477. animationTimeScale: number;
  41478. /** @hidden */
  41479. _cachedMaterial: Nullable<Material>;
  41480. /** @hidden */
  41481. _cachedEffect: Nullable<Effect>;
  41482. /** @hidden */
  41483. _cachedVisibility: Nullable<number>;
  41484. private _renderId;
  41485. private _frameId;
  41486. private _executeWhenReadyTimeoutId;
  41487. private _intermediateRendering;
  41488. private _viewUpdateFlag;
  41489. private _projectionUpdateFlag;
  41490. /** @hidden */
  41491. _toBeDisposed: Nullable<IDisposable>[];
  41492. private _activeRequests;
  41493. /** @hidden */
  41494. _pendingData: any[];
  41495. private _isDisposed;
  41496. /**
  41497. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41498. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41499. */
  41500. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41501. private _activeMeshes;
  41502. private _processedMaterials;
  41503. private _renderTargets;
  41504. /** @hidden */
  41505. _activeParticleSystems: SmartArray<IParticleSystem>;
  41506. private _activeSkeletons;
  41507. private _softwareSkinnedMeshes;
  41508. private _renderingManager;
  41509. /** @hidden */
  41510. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41511. private _transformMatrix;
  41512. private _sceneUbo;
  41513. /** @hidden */
  41514. _viewMatrix: Matrix;
  41515. private _projectionMatrix;
  41516. /** @hidden */
  41517. _forcedViewPosition: Nullable<Vector3>;
  41518. /** @hidden */
  41519. _frustumPlanes: Plane[];
  41520. /**
  41521. * Gets the list of frustum planes (built from the active camera)
  41522. */
  41523. get frustumPlanes(): Plane[];
  41524. /**
  41525. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41526. * This is useful if there are more lights that the maximum simulteanous authorized
  41527. */
  41528. requireLightSorting: boolean;
  41529. /** @hidden */
  41530. readonly useMaterialMeshMap: boolean;
  41531. /** @hidden */
  41532. readonly useClonedMeshMap: boolean;
  41533. private _externalData;
  41534. private _uid;
  41535. /**
  41536. * @hidden
  41537. * Backing store of defined scene components.
  41538. */
  41539. _components: ISceneComponent[];
  41540. /**
  41541. * @hidden
  41542. * Backing store of defined scene components.
  41543. */
  41544. _serializableComponents: ISceneSerializableComponent[];
  41545. /**
  41546. * List of components to register on the next registration step.
  41547. */
  41548. private _transientComponents;
  41549. /**
  41550. * Registers the transient components if needed.
  41551. */
  41552. private _registerTransientComponents;
  41553. /**
  41554. * @hidden
  41555. * Add a component to the scene.
  41556. * Note that the ccomponent could be registered on th next frame if this is called after
  41557. * the register component stage.
  41558. * @param component Defines the component to add to the scene
  41559. */
  41560. _addComponent(component: ISceneComponent): void;
  41561. /**
  41562. * @hidden
  41563. * Gets a component from the scene.
  41564. * @param name defines the name of the component to retrieve
  41565. * @returns the component or null if not present
  41566. */
  41567. _getComponent(name: string): Nullable<ISceneComponent>;
  41568. /**
  41569. * @hidden
  41570. * Defines the actions happening before camera updates.
  41571. */
  41572. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41573. /**
  41574. * @hidden
  41575. * Defines the actions happening before clear the canvas.
  41576. */
  41577. _beforeClearStage: Stage<SimpleStageAction>;
  41578. /**
  41579. * @hidden
  41580. * Defines the actions when collecting render targets for the frame.
  41581. */
  41582. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41583. /**
  41584. * @hidden
  41585. * Defines the actions happening for one camera in the frame.
  41586. */
  41587. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41588. /**
  41589. * @hidden
  41590. * Defines the actions happening during the per mesh ready checks.
  41591. */
  41592. _isReadyForMeshStage: Stage<MeshStageAction>;
  41593. /**
  41594. * @hidden
  41595. * Defines the actions happening before evaluate active mesh checks.
  41596. */
  41597. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41598. /**
  41599. * @hidden
  41600. * Defines the actions happening during the evaluate sub mesh checks.
  41601. */
  41602. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41603. /**
  41604. * @hidden
  41605. * Defines the actions happening during the active mesh stage.
  41606. */
  41607. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41608. /**
  41609. * @hidden
  41610. * Defines the actions happening during the per camera render target step.
  41611. */
  41612. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41613. /**
  41614. * @hidden
  41615. * Defines the actions happening just before the active camera is drawing.
  41616. */
  41617. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41618. /**
  41619. * @hidden
  41620. * Defines the actions happening just before a render target is drawing.
  41621. */
  41622. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41623. /**
  41624. * @hidden
  41625. * Defines the actions happening just before a rendering group is drawing.
  41626. */
  41627. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41628. /**
  41629. * @hidden
  41630. * Defines the actions happening just before a mesh is drawing.
  41631. */
  41632. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41633. /**
  41634. * @hidden
  41635. * Defines the actions happening just after a mesh has been drawn.
  41636. */
  41637. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41638. /**
  41639. * @hidden
  41640. * Defines the actions happening just after a rendering group has been drawn.
  41641. */
  41642. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41643. /**
  41644. * @hidden
  41645. * Defines the actions happening just after the active camera has been drawn.
  41646. */
  41647. _afterCameraDrawStage: Stage<CameraStageAction>;
  41648. /**
  41649. * @hidden
  41650. * Defines the actions happening just after a render target has been drawn.
  41651. */
  41652. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41653. /**
  41654. * @hidden
  41655. * Defines the actions happening just after rendering all cameras and computing intersections.
  41656. */
  41657. _afterRenderStage: Stage<SimpleStageAction>;
  41658. /**
  41659. * @hidden
  41660. * Defines the actions happening when a pointer move event happens.
  41661. */
  41662. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41663. /**
  41664. * @hidden
  41665. * Defines the actions happening when a pointer down event happens.
  41666. */
  41667. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41668. /**
  41669. * @hidden
  41670. * Defines the actions happening when a pointer up event happens.
  41671. */
  41672. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41673. /**
  41674. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41675. */
  41676. private geometriesByUniqueId;
  41677. /**
  41678. * Creates a new Scene
  41679. * @param engine defines the engine to use to render this scene
  41680. * @param options defines the scene options
  41681. */
  41682. constructor(engine: Engine, options?: SceneOptions);
  41683. /**
  41684. * Gets a string identifying the name of the class
  41685. * @returns "Scene" string
  41686. */
  41687. getClassName(): string;
  41688. private _defaultMeshCandidates;
  41689. /**
  41690. * @hidden
  41691. */
  41692. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41693. private _defaultSubMeshCandidates;
  41694. /**
  41695. * @hidden
  41696. */
  41697. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41698. /**
  41699. * Sets the default candidate providers for the scene.
  41700. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41701. * and getCollidingSubMeshCandidates to their default function
  41702. */
  41703. setDefaultCandidateProviders(): void;
  41704. /**
  41705. * Gets the mesh that is currently under the pointer
  41706. */
  41707. get meshUnderPointer(): Nullable<AbstractMesh>;
  41708. /**
  41709. * Gets or sets the current on-screen X position of the pointer
  41710. */
  41711. get pointerX(): number;
  41712. set pointerX(value: number);
  41713. /**
  41714. * Gets or sets the current on-screen Y position of the pointer
  41715. */
  41716. get pointerY(): number;
  41717. set pointerY(value: number);
  41718. /**
  41719. * Gets the cached material (ie. the latest rendered one)
  41720. * @returns the cached material
  41721. */
  41722. getCachedMaterial(): Nullable<Material>;
  41723. /**
  41724. * Gets the cached effect (ie. the latest rendered one)
  41725. * @returns the cached effect
  41726. */
  41727. getCachedEffect(): Nullable<Effect>;
  41728. /**
  41729. * Gets the cached visibility state (ie. the latest rendered one)
  41730. * @returns the cached visibility state
  41731. */
  41732. getCachedVisibility(): Nullable<number>;
  41733. /**
  41734. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41735. * @param material defines the current material
  41736. * @param effect defines the current effect
  41737. * @param visibility defines the current visibility state
  41738. * @returns true if one parameter is not cached
  41739. */
  41740. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41741. /**
  41742. * Gets the engine associated with the scene
  41743. * @returns an Engine
  41744. */
  41745. getEngine(): Engine;
  41746. /**
  41747. * Gets the total number of vertices rendered per frame
  41748. * @returns the total number of vertices rendered per frame
  41749. */
  41750. getTotalVertices(): number;
  41751. /**
  41752. * Gets the performance counter for total vertices
  41753. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41754. */
  41755. get totalVerticesPerfCounter(): PerfCounter;
  41756. /**
  41757. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41758. * @returns the total number of active indices rendered per frame
  41759. */
  41760. getActiveIndices(): number;
  41761. /**
  41762. * Gets the performance counter for active indices
  41763. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41764. */
  41765. get totalActiveIndicesPerfCounter(): PerfCounter;
  41766. /**
  41767. * Gets the total number of active particles rendered per frame
  41768. * @returns the total number of active particles rendered per frame
  41769. */
  41770. getActiveParticles(): number;
  41771. /**
  41772. * Gets the performance counter for active particles
  41773. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41774. */
  41775. get activeParticlesPerfCounter(): PerfCounter;
  41776. /**
  41777. * Gets the total number of active bones rendered per frame
  41778. * @returns the total number of active bones rendered per frame
  41779. */
  41780. getActiveBones(): number;
  41781. /**
  41782. * Gets the performance counter for active bones
  41783. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41784. */
  41785. get activeBonesPerfCounter(): PerfCounter;
  41786. /**
  41787. * Gets the array of active meshes
  41788. * @returns an array of AbstractMesh
  41789. */
  41790. getActiveMeshes(): SmartArray<AbstractMesh>;
  41791. /**
  41792. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41793. * @returns a number
  41794. */
  41795. getAnimationRatio(): number;
  41796. /**
  41797. * Gets an unique Id for the current render phase
  41798. * @returns a number
  41799. */
  41800. getRenderId(): number;
  41801. /**
  41802. * Gets an unique Id for the current frame
  41803. * @returns a number
  41804. */
  41805. getFrameId(): number;
  41806. /** Call this function if you want to manually increment the render Id*/
  41807. incrementRenderId(): void;
  41808. private _createUbo;
  41809. /**
  41810. * Use this method to simulate a pointer move on a mesh
  41811. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41812. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41813. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41814. * @returns the current scene
  41815. */
  41816. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41817. /**
  41818. * Use this method to simulate a pointer down on a mesh
  41819. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41820. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41821. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41822. * @returns the current scene
  41823. */
  41824. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41825. /**
  41826. * Use this method to simulate a pointer up on a mesh
  41827. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41828. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41829. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41830. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41831. * @returns the current scene
  41832. */
  41833. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41834. /**
  41835. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41836. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41837. * @returns true if the pointer was captured
  41838. */
  41839. isPointerCaptured(pointerId?: number): boolean;
  41840. /**
  41841. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41842. * @param attachUp defines if you want to attach events to pointerup
  41843. * @param attachDown defines if you want to attach events to pointerdown
  41844. * @param attachMove defines if you want to attach events to pointermove
  41845. */
  41846. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41847. /** Detaches all event handlers*/
  41848. detachControl(): void;
  41849. /**
  41850. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41851. * Delay loaded resources are not taking in account
  41852. * @return true if all required resources are ready
  41853. */
  41854. isReady(): boolean;
  41855. /** Resets all cached information relative to material (including effect and visibility) */
  41856. resetCachedMaterial(): void;
  41857. /**
  41858. * Registers a function to be called before every frame render
  41859. * @param func defines the function to register
  41860. */
  41861. registerBeforeRender(func: () => void): void;
  41862. /**
  41863. * Unregisters a function called before every frame render
  41864. * @param func defines the function to unregister
  41865. */
  41866. unregisterBeforeRender(func: () => void): void;
  41867. /**
  41868. * Registers a function to be called after every frame render
  41869. * @param func defines the function to register
  41870. */
  41871. registerAfterRender(func: () => void): void;
  41872. /**
  41873. * Unregisters a function called after every frame render
  41874. * @param func defines the function to unregister
  41875. */
  41876. unregisterAfterRender(func: () => void): void;
  41877. private _executeOnceBeforeRender;
  41878. /**
  41879. * The provided function will run before render once and will be disposed afterwards.
  41880. * A timeout delay can be provided so that the function will be executed in N ms.
  41881. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41882. * @param func The function to be executed.
  41883. * @param timeout optional delay in ms
  41884. */
  41885. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41886. /** @hidden */
  41887. _addPendingData(data: any): void;
  41888. /** @hidden */
  41889. _removePendingData(data: any): void;
  41890. /**
  41891. * Returns the number of items waiting to be loaded
  41892. * @returns the number of items waiting to be loaded
  41893. */
  41894. getWaitingItemsCount(): number;
  41895. /**
  41896. * Returns a boolean indicating if the scene is still loading data
  41897. */
  41898. get isLoading(): boolean;
  41899. /**
  41900. * Registers a function to be executed when the scene is ready
  41901. * @param {Function} func - the function to be executed
  41902. */
  41903. executeWhenReady(func: () => void): void;
  41904. /**
  41905. * Returns a promise that resolves when the scene is ready
  41906. * @returns A promise that resolves when the scene is ready
  41907. */
  41908. whenReadyAsync(): Promise<void>;
  41909. /** @hidden */
  41910. _checkIsReady(): void;
  41911. /**
  41912. * Gets all animatable attached to the scene
  41913. */
  41914. get animatables(): Animatable[];
  41915. /**
  41916. * Resets the last animation time frame.
  41917. * Useful to override when animations start running when loading a scene for the first time.
  41918. */
  41919. resetLastAnimationTimeFrame(): void;
  41920. /**
  41921. * Gets the current view matrix
  41922. * @returns a Matrix
  41923. */
  41924. getViewMatrix(): Matrix;
  41925. /**
  41926. * Gets the current projection matrix
  41927. * @returns a Matrix
  41928. */
  41929. getProjectionMatrix(): Matrix;
  41930. /**
  41931. * Gets the current transform matrix
  41932. * @returns a Matrix made of View * Projection
  41933. */
  41934. getTransformMatrix(): Matrix;
  41935. /**
  41936. * Sets the current transform matrix
  41937. * @param viewL defines the View matrix to use
  41938. * @param projectionL defines the Projection matrix to use
  41939. * @param viewR defines the right View matrix to use (if provided)
  41940. * @param projectionR defines the right Projection matrix to use (if provided)
  41941. */
  41942. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41943. /**
  41944. * Gets the uniform buffer used to store scene data
  41945. * @returns a UniformBuffer
  41946. */
  41947. getSceneUniformBuffer(): UniformBuffer;
  41948. /**
  41949. * Gets an unique (relatively to the current scene) Id
  41950. * @returns an unique number for the scene
  41951. */
  41952. getUniqueId(): number;
  41953. /**
  41954. * Add a mesh to the list of scene's meshes
  41955. * @param newMesh defines the mesh to add
  41956. * @param recursive if all child meshes should also be added to the scene
  41957. */
  41958. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41959. /**
  41960. * Remove a mesh for the list of scene's meshes
  41961. * @param toRemove defines the mesh to remove
  41962. * @param recursive if all child meshes should also be removed from the scene
  41963. * @returns the index where the mesh was in the mesh list
  41964. */
  41965. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41966. /**
  41967. * Add a transform node to the list of scene's transform nodes
  41968. * @param newTransformNode defines the transform node to add
  41969. */
  41970. addTransformNode(newTransformNode: TransformNode): void;
  41971. /**
  41972. * Remove a transform node for the list of scene's transform nodes
  41973. * @param toRemove defines the transform node to remove
  41974. * @returns the index where the transform node was in the transform node list
  41975. */
  41976. removeTransformNode(toRemove: TransformNode): number;
  41977. /**
  41978. * Remove a skeleton for the list of scene's skeletons
  41979. * @param toRemove defines the skeleton to remove
  41980. * @returns the index where the skeleton was in the skeleton list
  41981. */
  41982. removeSkeleton(toRemove: Skeleton): number;
  41983. /**
  41984. * Remove a morph target for the list of scene's morph targets
  41985. * @param toRemove defines the morph target to remove
  41986. * @returns the index where the morph target was in the morph target list
  41987. */
  41988. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41989. /**
  41990. * Remove a light for the list of scene's lights
  41991. * @param toRemove defines the light to remove
  41992. * @returns the index where the light was in the light list
  41993. */
  41994. removeLight(toRemove: Light): number;
  41995. /**
  41996. * Remove a camera for the list of scene's cameras
  41997. * @param toRemove defines the camera to remove
  41998. * @returns the index where the camera was in the camera list
  41999. */
  42000. removeCamera(toRemove: Camera): number;
  42001. /**
  42002. * Remove a particle system for the list of scene's particle systems
  42003. * @param toRemove defines the particle system to remove
  42004. * @returns the index where the particle system was in the particle system list
  42005. */
  42006. removeParticleSystem(toRemove: IParticleSystem): number;
  42007. /**
  42008. * Remove a animation for the list of scene's animations
  42009. * @param toRemove defines the animation to remove
  42010. * @returns the index where the animation was in the animation list
  42011. */
  42012. removeAnimation(toRemove: Animation): number;
  42013. /**
  42014. * Will stop the animation of the given target
  42015. * @param target - the target
  42016. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  42017. * @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)
  42018. */
  42019. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  42020. /**
  42021. * Removes the given animation group from this scene.
  42022. * @param toRemove The animation group to remove
  42023. * @returns The index of the removed animation group
  42024. */
  42025. removeAnimationGroup(toRemove: AnimationGroup): number;
  42026. /**
  42027. * Removes the given multi-material from this scene.
  42028. * @param toRemove The multi-material to remove
  42029. * @returns The index of the removed multi-material
  42030. */
  42031. removeMultiMaterial(toRemove: MultiMaterial): number;
  42032. /**
  42033. * Removes the given material from this scene.
  42034. * @param toRemove The material to remove
  42035. * @returns The index of the removed material
  42036. */
  42037. removeMaterial(toRemove: Material): number;
  42038. /**
  42039. * Removes the given action manager from this scene.
  42040. * @param toRemove The action manager to remove
  42041. * @returns The index of the removed action manager
  42042. */
  42043. removeActionManager(toRemove: AbstractActionManager): number;
  42044. /**
  42045. * Removes the given texture from this scene.
  42046. * @param toRemove The texture to remove
  42047. * @returns The index of the removed texture
  42048. */
  42049. removeTexture(toRemove: BaseTexture): number;
  42050. /**
  42051. * Adds the given light to this scene
  42052. * @param newLight The light to add
  42053. */
  42054. addLight(newLight: Light): void;
  42055. /**
  42056. * Sorts the list list based on light priorities
  42057. */
  42058. sortLightsByPriority(): void;
  42059. /**
  42060. * Adds the given camera to this scene
  42061. * @param newCamera The camera to add
  42062. */
  42063. addCamera(newCamera: Camera): void;
  42064. /**
  42065. * Adds the given skeleton to this scene
  42066. * @param newSkeleton The skeleton to add
  42067. */
  42068. addSkeleton(newSkeleton: Skeleton): void;
  42069. /**
  42070. * Adds the given particle system to this scene
  42071. * @param newParticleSystem The particle system to add
  42072. */
  42073. addParticleSystem(newParticleSystem: IParticleSystem): void;
  42074. /**
  42075. * Adds the given animation to this scene
  42076. * @param newAnimation The animation to add
  42077. */
  42078. addAnimation(newAnimation: Animation): void;
  42079. /**
  42080. * Adds the given animation group to this scene.
  42081. * @param newAnimationGroup The animation group to add
  42082. */
  42083. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  42084. /**
  42085. * Adds the given multi-material to this scene
  42086. * @param newMultiMaterial The multi-material to add
  42087. */
  42088. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  42089. /**
  42090. * Adds the given material to this scene
  42091. * @param newMaterial The material to add
  42092. */
  42093. addMaterial(newMaterial: Material): void;
  42094. /**
  42095. * Adds the given morph target to this scene
  42096. * @param newMorphTargetManager The morph target to add
  42097. */
  42098. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  42099. /**
  42100. * Adds the given geometry to this scene
  42101. * @param newGeometry The geometry to add
  42102. */
  42103. addGeometry(newGeometry: Geometry): void;
  42104. /**
  42105. * Adds the given action manager to this scene
  42106. * @param newActionManager The action manager to add
  42107. */
  42108. addActionManager(newActionManager: AbstractActionManager): void;
  42109. /**
  42110. * Adds the given texture to this scene.
  42111. * @param newTexture The texture to add
  42112. */
  42113. addTexture(newTexture: BaseTexture): void;
  42114. /**
  42115. * Switch active camera
  42116. * @param newCamera defines the new active camera
  42117. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  42118. */
  42119. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  42120. /**
  42121. * sets the active camera of the scene using its ID
  42122. * @param id defines the camera's ID
  42123. * @return the new active camera or null if none found.
  42124. */
  42125. setActiveCameraByID(id: string): Nullable<Camera>;
  42126. /**
  42127. * sets the active camera of the scene using its name
  42128. * @param name defines the camera's name
  42129. * @returns the new active camera or null if none found.
  42130. */
  42131. setActiveCameraByName(name: string): Nullable<Camera>;
  42132. /**
  42133. * get an animation group using its name
  42134. * @param name defines the material's name
  42135. * @return the animation group or null if none found.
  42136. */
  42137. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42138. /**
  42139. * Get a material using its unique id
  42140. * @param uniqueId defines the material's unique id
  42141. * @return the material or null if none found.
  42142. */
  42143. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42144. /**
  42145. * get a material using its id
  42146. * @param id defines the material's ID
  42147. * @return the material or null if none found.
  42148. */
  42149. getMaterialByID(id: string): Nullable<Material>;
  42150. /**
  42151. * Gets a the last added material using a given id
  42152. * @param id defines the material's ID
  42153. * @return the last material with the given id or null if none found.
  42154. */
  42155. getLastMaterialByID(id: string): Nullable<Material>;
  42156. /**
  42157. * Gets a material using its name
  42158. * @param name defines the material's name
  42159. * @return the material or null if none found.
  42160. */
  42161. getMaterialByName(name: string): Nullable<Material>;
  42162. /**
  42163. * Get a texture using its unique id
  42164. * @param uniqueId defines the texture's unique id
  42165. * @return the texture or null if none found.
  42166. */
  42167. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42168. /**
  42169. * Gets a camera using its id
  42170. * @param id defines the id to look for
  42171. * @returns the camera or null if not found
  42172. */
  42173. getCameraByID(id: string): Nullable<Camera>;
  42174. /**
  42175. * Gets a camera using its unique id
  42176. * @param uniqueId defines the unique id to look for
  42177. * @returns the camera or null if not found
  42178. */
  42179. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42180. /**
  42181. * Gets a camera using its name
  42182. * @param name defines the camera's name
  42183. * @return the camera or null if none found.
  42184. */
  42185. getCameraByName(name: string): Nullable<Camera>;
  42186. /**
  42187. * Gets a bone using its id
  42188. * @param id defines the bone's id
  42189. * @return the bone or null if not found
  42190. */
  42191. getBoneByID(id: string): Nullable<Bone>;
  42192. /**
  42193. * Gets a bone using its id
  42194. * @param name defines the bone's name
  42195. * @return the bone or null if not found
  42196. */
  42197. getBoneByName(name: string): Nullable<Bone>;
  42198. /**
  42199. * Gets a light node using its name
  42200. * @param name defines the the light's name
  42201. * @return the light or null if none found.
  42202. */
  42203. getLightByName(name: string): Nullable<Light>;
  42204. /**
  42205. * Gets a light node using its id
  42206. * @param id defines the light's id
  42207. * @return the light or null if none found.
  42208. */
  42209. getLightByID(id: string): Nullable<Light>;
  42210. /**
  42211. * Gets a light node using its scene-generated unique ID
  42212. * @param uniqueId defines the light's unique id
  42213. * @return the light or null if none found.
  42214. */
  42215. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42216. /**
  42217. * Gets a particle system by id
  42218. * @param id defines the particle system id
  42219. * @return the corresponding system or null if none found
  42220. */
  42221. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42222. /**
  42223. * Gets a geometry using its ID
  42224. * @param id defines the geometry's id
  42225. * @return the geometry or null if none found.
  42226. */
  42227. getGeometryByID(id: string): Nullable<Geometry>;
  42228. private _getGeometryByUniqueID;
  42229. /**
  42230. * Add a new geometry to this scene
  42231. * @param geometry defines the geometry to be added to the scene.
  42232. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42233. * @return a boolean defining if the geometry was added or not
  42234. */
  42235. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42236. /**
  42237. * Removes an existing geometry
  42238. * @param geometry defines the geometry to be removed from the scene
  42239. * @return a boolean defining if the geometry was removed or not
  42240. */
  42241. removeGeometry(geometry: Geometry): boolean;
  42242. /**
  42243. * Gets the list of geometries attached to the scene
  42244. * @returns an array of Geometry
  42245. */
  42246. getGeometries(): Geometry[];
  42247. /**
  42248. * Gets the first added mesh found of a given ID
  42249. * @param id defines the id to search for
  42250. * @return the mesh found or null if not found at all
  42251. */
  42252. getMeshByID(id: string): Nullable<AbstractMesh>;
  42253. /**
  42254. * Gets a list of meshes using their id
  42255. * @param id defines the id to search for
  42256. * @returns a list of meshes
  42257. */
  42258. getMeshesByID(id: string): Array<AbstractMesh>;
  42259. /**
  42260. * Gets the first added transform node found of a given ID
  42261. * @param id defines the id to search for
  42262. * @return the found transform node or null if not found at all.
  42263. */
  42264. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42265. /**
  42266. * Gets a transform node with its auto-generated unique id
  42267. * @param uniqueId efines the unique id to search for
  42268. * @return the found transform node or null if not found at all.
  42269. */
  42270. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42271. /**
  42272. * Gets a list of transform nodes using their id
  42273. * @param id defines the id to search for
  42274. * @returns a list of transform nodes
  42275. */
  42276. getTransformNodesByID(id: string): Array<TransformNode>;
  42277. /**
  42278. * Gets a mesh with its auto-generated unique id
  42279. * @param uniqueId defines the unique id to search for
  42280. * @return the found mesh or null if not found at all.
  42281. */
  42282. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42283. /**
  42284. * Gets a the last added mesh using a given id
  42285. * @param id defines the id to search for
  42286. * @return the found mesh or null if not found at all.
  42287. */
  42288. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42289. /**
  42290. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42291. * @param id defines the id to search for
  42292. * @return the found node or null if not found at all
  42293. */
  42294. getLastEntryByID(id: string): Nullable<Node>;
  42295. /**
  42296. * Gets a node (Mesh, Camera, Light) using a given id
  42297. * @param id defines the id to search for
  42298. * @return the found node or null if not found at all
  42299. */
  42300. getNodeByID(id: string): Nullable<Node>;
  42301. /**
  42302. * Gets a node (Mesh, Camera, Light) using a given name
  42303. * @param name defines the name to search for
  42304. * @return the found node or null if not found at all.
  42305. */
  42306. getNodeByName(name: string): Nullable<Node>;
  42307. /**
  42308. * Gets a mesh using a given name
  42309. * @param name defines the name to search for
  42310. * @return the found mesh or null if not found at all.
  42311. */
  42312. getMeshByName(name: string): Nullable<AbstractMesh>;
  42313. /**
  42314. * Gets a transform node using a given name
  42315. * @param name defines the name to search for
  42316. * @return the found transform node or null if not found at all.
  42317. */
  42318. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42319. /**
  42320. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42321. * @param id defines the id to search for
  42322. * @return the found skeleton or null if not found at all.
  42323. */
  42324. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42325. /**
  42326. * Gets a skeleton using a given auto generated unique id
  42327. * @param uniqueId defines the unique id to search for
  42328. * @return the found skeleton or null if not found at all.
  42329. */
  42330. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42331. /**
  42332. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42333. * @param id defines the id to search for
  42334. * @return the found skeleton or null if not found at all.
  42335. */
  42336. getSkeletonById(id: string): Nullable<Skeleton>;
  42337. /**
  42338. * Gets a skeleton using a given name
  42339. * @param name defines the name to search for
  42340. * @return the found skeleton or null if not found at all.
  42341. */
  42342. getSkeletonByName(name: string): Nullable<Skeleton>;
  42343. /**
  42344. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42345. * @param id defines the id to search for
  42346. * @return the found morph target manager or null if not found at all.
  42347. */
  42348. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42349. /**
  42350. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42351. * @param id defines the id to search for
  42352. * @return the found morph target or null if not found at all.
  42353. */
  42354. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42355. /**
  42356. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42357. * @param name defines the name to search for
  42358. * @return the found morph target or null if not found at all.
  42359. */
  42360. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42361. /**
  42362. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42363. * @param name defines the name to search for
  42364. * @return the found post process or null if not found at all.
  42365. */
  42366. getPostProcessByName(name: string): Nullable<PostProcess>;
  42367. /**
  42368. * Gets a boolean indicating if the given mesh is active
  42369. * @param mesh defines the mesh to look for
  42370. * @returns true if the mesh is in the active list
  42371. */
  42372. isActiveMesh(mesh: AbstractMesh): boolean;
  42373. /**
  42374. * Return a unique id as a string which can serve as an identifier for the scene
  42375. */
  42376. get uid(): string;
  42377. /**
  42378. * Add an externaly attached data from its key.
  42379. * This method call will fail and return false, if such key already exists.
  42380. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42381. * @param key the unique key that identifies the data
  42382. * @param data the data object to associate to the key for this Engine instance
  42383. * @return true if no such key were already present and the data was added successfully, false otherwise
  42384. */
  42385. addExternalData<T>(key: string, data: T): boolean;
  42386. /**
  42387. * Get an externaly attached data from its key
  42388. * @param key the unique key that identifies the data
  42389. * @return the associated data, if present (can be null), or undefined if not present
  42390. */
  42391. getExternalData<T>(key: string): Nullable<T>;
  42392. /**
  42393. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42394. * @param key the unique key that identifies the data
  42395. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42396. * @return the associated data, can be null if the factory returned null.
  42397. */
  42398. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42399. /**
  42400. * Remove an externaly attached data from the Engine instance
  42401. * @param key the unique key that identifies the data
  42402. * @return true if the data was successfully removed, false if it doesn't exist
  42403. */
  42404. removeExternalData(key: string): boolean;
  42405. private _evaluateSubMesh;
  42406. /**
  42407. * Clear the processed materials smart array preventing retention point in material dispose.
  42408. */
  42409. freeProcessedMaterials(): void;
  42410. private _preventFreeActiveMeshesAndRenderingGroups;
  42411. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42412. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42413. * when disposing several meshes in a row or a hierarchy of meshes.
  42414. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42415. */
  42416. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42417. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42418. /**
  42419. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42420. */
  42421. freeActiveMeshes(): void;
  42422. /**
  42423. * Clear the info related to rendering groups preventing retention points during dispose.
  42424. */
  42425. freeRenderingGroups(): void;
  42426. /** @hidden */
  42427. _isInIntermediateRendering(): boolean;
  42428. /**
  42429. * Lambda returning the list of potentially active meshes.
  42430. */
  42431. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42432. /**
  42433. * Lambda returning the list of potentially active sub meshes.
  42434. */
  42435. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42436. /**
  42437. * Lambda returning the list of potentially intersecting sub meshes.
  42438. */
  42439. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42440. /**
  42441. * Lambda returning the list of potentially colliding sub meshes.
  42442. */
  42443. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42444. private _activeMeshesFrozen;
  42445. private _skipEvaluateActiveMeshesCompletely;
  42446. /**
  42447. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42448. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42449. * @returns the current scene
  42450. */
  42451. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42452. /**
  42453. * Use this function to restart evaluating active meshes on every frame
  42454. * @returns the current scene
  42455. */
  42456. unfreezeActiveMeshes(): Scene;
  42457. private _evaluateActiveMeshes;
  42458. private _activeMesh;
  42459. /**
  42460. * Update the transform matrix to update from the current active camera
  42461. * @param force defines a boolean used to force the update even if cache is up to date
  42462. */
  42463. updateTransformMatrix(force?: boolean): void;
  42464. private _bindFrameBuffer;
  42465. /** @hidden */
  42466. _allowPostProcessClearColor: boolean;
  42467. /** @hidden */
  42468. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42469. private _processSubCameras;
  42470. private _checkIntersections;
  42471. /** @hidden */
  42472. _advancePhysicsEngineStep(step: number): void;
  42473. /**
  42474. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42475. */
  42476. getDeterministicFrameTime: () => number;
  42477. /** @hidden */
  42478. _animate(): void;
  42479. /** Execute all animations (for a frame) */
  42480. animate(): void;
  42481. /**
  42482. * Render the scene
  42483. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42484. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42485. */
  42486. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42487. /**
  42488. * Freeze all materials
  42489. * A frozen material will not be updatable but should be faster to render
  42490. */
  42491. freezeMaterials(): void;
  42492. /**
  42493. * Unfreeze all materials
  42494. * A frozen material will not be updatable but should be faster to render
  42495. */
  42496. unfreezeMaterials(): void;
  42497. /**
  42498. * Releases all held ressources
  42499. */
  42500. dispose(): void;
  42501. /**
  42502. * Gets if the scene is already disposed
  42503. */
  42504. get isDisposed(): boolean;
  42505. /**
  42506. * Call this function to reduce memory footprint of the scene.
  42507. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42508. */
  42509. clearCachedVertexData(): void;
  42510. /**
  42511. * This function will remove the local cached buffer data from texture.
  42512. * It will save memory but will prevent the texture from being rebuilt
  42513. */
  42514. cleanCachedTextureBuffer(): void;
  42515. /**
  42516. * Get the world extend vectors with an optional filter
  42517. *
  42518. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42519. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42520. */
  42521. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42522. min: Vector3;
  42523. max: Vector3;
  42524. };
  42525. /**
  42526. * Creates a ray that can be used to pick in the scene
  42527. * @param x defines the x coordinate of the origin (on-screen)
  42528. * @param y defines the y coordinate of the origin (on-screen)
  42529. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42530. * @param camera defines the camera to use for the picking
  42531. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42532. * @returns a Ray
  42533. */
  42534. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42535. /**
  42536. * Creates a ray that can be used to pick in the scene
  42537. * @param x defines the x coordinate of the origin (on-screen)
  42538. * @param y defines the y coordinate of the origin (on-screen)
  42539. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42540. * @param result defines the ray where to store the picking ray
  42541. * @param camera defines the camera to use for the picking
  42542. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42543. * @returns the current scene
  42544. */
  42545. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42546. /**
  42547. * Creates a ray that can be used to pick in the scene
  42548. * @param x defines the x coordinate of the origin (on-screen)
  42549. * @param y defines the y coordinate of the origin (on-screen)
  42550. * @param camera defines the camera to use for the picking
  42551. * @returns a Ray
  42552. */
  42553. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42554. /**
  42555. * Creates a ray that can be used to pick in the scene
  42556. * @param x defines the x coordinate of the origin (on-screen)
  42557. * @param y defines the y coordinate of the origin (on-screen)
  42558. * @param result defines the ray where to store the picking ray
  42559. * @param camera defines the camera to use for the picking
  42560. * @returns the current scene
  42561. */
  42562. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42563. /** Launch a ray to try to pick a mesh in the scene
  42564. * @param x position on screen
  42565. * @param y position on screen
  42566. * @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
  42567. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42568. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42569. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42570. * @returns a PickingInfo
  42571. */
  42572. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42573. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42574. * @param x position on screen
  42575. * @param y position on screen
  42576. * @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
  42577. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42578. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42579. * @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)
  42580. */
  42581. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42582. /** Use the given ray to pick a mesh in the scene
  42583. * @param ray The ray to use to pick meshes
  42584. * @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
  42585. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42586. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42587. * @returns a PickingInfo
  42588. */
  42589. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42590. /**
  42591. * Launch a ray to try to pick a mesh in the scene
  42592. * @param x X position on screen
  42593. * @param y Y position on screen
  42594. * @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
  42595. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42596. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42597. * @returns an array of PickingInfo
  42598. */
  42599. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42600. /**
  42601. * Launch a ray to try to pick a mesh in the scene
  42602. * @param ray Ray to use
  42603. * @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
  42604. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42605. * @returns an array of PickingInfo
  42606. */
  42607. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42608. /**
  42609. * Force the value of meshUnderPointer
  42610. * @param mesh defines the mesh to use
  42611. * @param pointerId optional pointer id when using more than one pointer
  42612. */
  42613. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42614. /**
  42615. * Gets the mesh under the pointer
  42616. * @returns a Mesh or null if no mesh is under the pointer
  42617. */
  42618. getPointerOverMesh(): Nullable<AbstractMesh>;
  42619. /** @hidden */
  42620. _rebuildGeometries(): void;
  42621. /** @hidden */
  42622. _rebuildTextures(): void;
  42623. private _getByTags;
  42624. /**
  42625. * Get a list of meshes by tags
  42626. * @param tagsQuery defines the tags query to use
  42627. * @param forEach defines a predicate used to filter results
  42628. * @returns an array of Mesh
  42629. */
  42630. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42631. /**
  42632. * Get a list of cameras by tags
  42633. * @param tagsQuery defines the tags query to use
  42634. * @param forEach defines a predicate used to filter results
  42635. * @returns an array of Camera
  42636. */
  42637. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42638. /**
  42639. * Get a list of lights by tags
  42640. * @param tagsQuery defines the tags query to use
  42641. * @param forEach defines a predicate used to filter results
  42642. * @returns an array of Light
  42643. */
  42644. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42645. /**
  42646. * Get a list of materials by tags
  42647. * @param tagsQuery defines the tags query to use
  42648. * @param forEach defines a predicate used to filter results
  42649. * @returns an array of Material
  42650. */
  42651. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42652. /**
  42653. * Get a list of transform nodes by tags
  42654. * @param tagsQuery defines the tags query to use
  42655. * @param forEach defines a predicate used to filter results
  42656. * @returns an array of TransformNode
  42657. */
  42658. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42659. /**
  42660. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42661. * This allowed control for front to back rendering or reversly depending of the special needs.
  42662. *
  42663. * @param renderingGroupId The rendering group id corresponding to its index
  42664. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42665. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42666. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42667. */
  42668. 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;
  42669. /**
  42670. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42671. *
  42672. * @param renderingGroupId The rendering group id corresponding to its index
  42673. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42674. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42675. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42676. */
  42677. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42678. /**
  42679. * Gets the current auto clear configuration for one rendering group of the rendering
  42680. * manager.
  42681. * @param index the rendering group index to get the information for
  42682. * @returns The auto clear setup for the requested rendering group
  42683. */
  42684. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42685. private _blockMaterialDirtyMechanism;
  42686. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42687. get blockMaterialDirtyMechanism(): boolean;
  42688. set blockMaterialDirtyMechanism(value: boolean);
  42689. /**
  42690. * Will flag all materials as dirty to trigger new shader compilation
  42691. * @param flag defines the flag used to specify which material part must be marked as dirty
  42692. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42693. */
  42694. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42695. /** @hidden */
  42696. _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;
  42697. /** @hidden */
  42698. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42699. /** @hidden */
  42700. _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;
  42701. /** @hidden */
  42702. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42703. /** @hidden */
  42704. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42705. /** @hidden */
  42706. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42707. }
  42708. }
  42709. declare module "babylonjs/assetContainer" {
  42710. import { AbstractScene } from "babylonjs/abstractScene";
  42711. import { Scene } from "babylonjs/scene";
  42712. import { Mesh } from "babylonjs/Meshes/mesh";
  42713. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42714. import { Skeleton } from "babylonjs/Bones/skeleton";
  42715. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42716. import { Animatable } from "babylonjs/Animations/animatable";
  42717. import { Nullable } from "babylonjs/types";
  42718. import { Node } from "babylonjs/node";
  42719. /**
  42720. * Set of assets to keep when moving a scene into an asset container.
  42721. */
  42722. export class KeepAssets extends AbstractScene {
  42723. }
  42724. /**
  42725. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42726. */
  42727. export class InstantiatedEntries {
  42728. /**
  42729. * List of new root nodes (eg. nodes with no parent)
  42730. */
  42731. rootNodes: TransformNode[];
  42732. /**
  42733. * List of new skeletons
  42734. */
  42735. skeletons: Skeleton[];
  42736. /**
  42737. * List of new animation groups
  42738. */
  42739. animationGroups: AnimationGroup[];
  42740. }
  42741. /**
  42742. * Container with a set of assets that can be added or removed from a scene.
  42743. */
  42744. export class AssetContainer extends AbstractScene {
  42745. private _wasAddedToScene;
  42746. /**
  42747. * The scene the AssetContainer belongs to.
  42748. */
  42749. scene: Scene;
  42750. /**
  42751. * Instantiates an AssetContainer.
  42752. * @param scene The scene the AssetContainer belongs to.
  42753. */
  42754. constructor(scene: Scene);
  42755. /**
  42756. * Instantiate or clone all meshes and add the new ones to the scene.
  42757. * Skeletons and animation groups will all be cloned
  42758. * @param nameFunction defines an optional function used to get new names for clones
  42759. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42760. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42761. */
  42762. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42763. /**
  42764. * Adds all the assets from the container to the scene.
  42765. */
  42766. addAllToScene(): void;
  42767. /**
  42768. * Removes all the assets in the container from the scene
  42769. */
  42770. removeAllFromScene(): void;
  42771. /**
  42772. * Disposes all the assets in the container
  42773. */
  42774. dispose(): void;
  42775. private _moveAssets;
  42776. /**
  42777. * Removes all the assets contained in the scene and adds them to the container.
  42778. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42779. */
  42780. moveAllFromScene(keepAssets?: KeepAssets): void;
  42781. /**
  42782. * 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.
  42783. * @returns the root mesh
  42784. */
  42785. createRootMesh(): Mesh;
  42786. /**
  42787. * Merge animations (direct and animation groups) from this asset container into a scene
  42788. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42789. * @param animatables set of animatables to retarget to a node from the scene
  42790. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42791. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42792. */
  42793. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42794. }
  42795. }
  42796. declare module "babylonjs/abstractScene" {
  42797. import { Scene } from "babylonjs/scene";
  42798. import { Nullable } from "babylonjs/types";
  42799. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42800. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42801. import { Geometry } from "babylonjs/Meshes/geometry";
  42802. import { Skeleton } from "babylonjs/Bones/skeleton";
  42803. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42804. import { AssetContainer } from "babylonjs/assetContainer";
  42805. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42806. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42807. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42808. import { Material } from "babylonjs/Materials/material";
  42809. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42810. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42811. import { Camera } from "babylonjs/Cameras/camera";
  42812. import { Light } from "babylonjs/Lights/light";
  42813. import { Node } from "babylonjs/node";
  42814. import { Animation } from "babylonjs/Animations/animation";
  42815. /**
  42816. * Defines how the parser contract is defined.
  42817. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42818. */
  42819. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42820. /**
  42821. * Defines how the individual parser contract is defined.
  42822. * These parser can parse an individual asset
  42823. */
  42824. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42825. /**
  42826. * Base class of the scene acting as a container for the different elements composing a scene.
  42827. * This class is dynamically extended by the different components of the scene increasing
  42828. * flexibility and reducing coupling
  42829. */
  42830. export abstract class AbstractScene {
  42831. /**
  42832. * Stores the list of available parsers in the application.
  42833. */
  42834. private static _BabylonFileParsers;
  42835. /**
  42836. * Stores the list of available individual parsers in the application.
  42837. */
  42838. private static _IndividualBabylonFileParsers;
  42839. /**
  42840. * Adds a parser in the list of available ones
  42841. * @param name Defines the name of the parser
  42842. * @param parser Defines the parser to add
  42843. */
  42844. static AddParser(name: string, parser: BabylonFileParser): void;
  42845. /**
  42846. * Gets a general parser from the list of avaialble ones
  42847. * @param name Defines the name of the parser
  42848. * @returns the requested parser or null
  42849. */
  42850. static GetParser(name: string): Nullable<BabylonFileParser>;
  42851. /**
  42852. * Adds n individual parser in the list of available ones
  42853. * @param name Defines the name of the parser
  42854. * @param parser Defines the parser to add
  42855. */
  42856. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42857. /**
  42858. * Gets an individual parser from the list of avaialble ones
  42859. * @param name Defines the name of the parser
  42860. * @returns the requested parser or null
  42861. */
  42862. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42863. /**
  42864. * Parser json data and populate both a scene and its associated container object
  42865. * @param jsonData Defines the data to parse
  42866. * @param scene Defines the scene to parse the data for
  42867. * @param container Defines the container attached to the parsing sequence
  42868. * @param rootUrl Defines the root url of the data
  42869. */
  42870. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42871. /**
  42872. * Gets the list of root nodes (ie. nodes with no parent)
  42873. */
  42874. rootNodes: Node[];
  42875. /** All of the cameras added to this scene
  42876. * @see https://doc.babylonjs.com/babylon101/cameras
  42877. */
  42878. cameras: Camera[];
  42879. /**
  42880. * All of the lights added to this scene
  42881. * @see https://doc.babylonjs.com/babylon101/lights
  42882. */
  42883. lights: Light[];
  42884. /**
  42885. * All of the (abstract) meshes added to this scene
  42886. */
  42887. meshes: AbstractMesh[];
  42888. /**
  42889. * The list of skeletons added to the scene
  42890. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42891. */
  42892. skeletons: Skeleton[];
  42893. /**
  42894. * All of the particle systems added to this scene
  42895. * @see https://doc.babylonjs.com/babylon101/particles
  42896. */
  42897. particleSystems: IParticleSystem[];
  42898. /**
  42899. * Gets a list of Animations associated with the scene
  42900. */
  42901. animations: Animation[];
  42902. /**
  42903. * All of the animation groups added to this scene
  42904. * @see https://doc.babylonjs.com/how_to/group
  42905. */
  42906. animationGroups: AnimationGroup[];
  42907. /**
  42908. * All of the multi-materials added to this scene
  42909. * @see https://doc.babylonjs.com/how_to/multi_materials
  42910. */
  42911. multiMaterials: MultiMaterial[];
  42912. /**
  42913. * All of the materials added to this scene
  42914. * In the context of a Scene, it is not supposed to be modified manually.
  42915. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42916. * Note also that the order of the Material within the array is not significant and might change.
  42917. * @see https://doc.babylonjs.com/babylon101/materials
  42918. */
  42919. materials: Material[];
  42920. /**
  42921. * The list of morph target managers added to the scene
  42922. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42923. */
  42924. morphTargetManagers: MorphTargetManager[];
  42925. /**
  42926. * The list of geometries used in the scene.
  42927. */
  42928. geometries: Geometry[];
  42929. /**
  42930. * All of the tranform nodes added to this scene
  42931. * In the context of a Scene, it is not supposed to be modified manually.
  42932. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42933. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42934. * @see https://doc.babylonjs.com/how_to/transformnode
  42935. */
  42936. transformNodes: TransformNode[];
  42937. /**
  42938. * ActionManagers available on the scene.
  42939. */
  42940. actionManagers: AbstractActionManager[];
  42941. /**
  42942. * Textures to keep.
  42943. */
  42944. textures: BaseTexture[];
  42945. /** @hidden */
  42946. protected _environmentTexture: Nullable<BaseTexture>;
  42947. /**
  42948. * Texture used in all pbr material as the reflection texture.
  42949. * As in the majority of the scene they are the same (exception for multi room and so on),
  42950. * this is easier to reference from here than from all the materials.
  42951. */
  42952. get environmentTexture(): Nullable<BaseTexture>;
  42953. set environmentTexture(value: Nullable<BaseTexture>);
  42954. /**
  42955. * The list of postprocesses added to the scene
  42956. */
  42957. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42958. /**
  42959. * @returns all meshes, lights, cameras, transformNodes and bones
  42960. */
  42961. getNodes(): Array<Node>;
  42962. }
  42963. }
  42964. declare module "babylonjs/Audio/sound" {
  42965. import { Observable } from "babylonjs/Misc/observable";
  42966. import { Vector3 } from "babylonjs/Maths/math.vector";
  42967. import { Nullable } from "babylonjs/types";
  42968. import { Scene } from "babylonjs/scene";
  42969. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42970. /**
  42971. * Interface used to define options for Sound class
  42972. */
  42973. export interface ISoundOptions {
  42974. /**
  42975. * Does the sound autoplay once loaded.
  42976. */
  42977. autoplay?: boolean;
  42978. /**
  42979. * Does the sound loop after it finishes playing once.
  42980. */
  42981. loop?: boolean;
  42982. /**
  42983. * Sound's volume
  42984. */
  42985. volume?: number;
  42986. /**
  42987. * Is it a spatial sound?
  42988. */
  42989. spatialSound?: boolean;
  42990. /**
  42991. * Maximum distance to hear that sound
  42992. */
  42993. maxDistance?: number;
  42994. /**
  42995. * Uses user defined attenuation function
  42996. */
  42997. useCustomAttenuation?: boolean;
  42998. /**
  42999. * Define the roll off factor of spatial sounds.
  43000. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43001. */
  43002. rolloffFactor?: number;
  43003. /**
  43004. * Define the reference distance the sound should be heard perfectly.
  43005. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43006. */
  43007. refDistance?: number;
  43008. /**
  43009. * Define the distance attenuation model the sound will follow.
  43010. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43011. */
  43012. distanceModel?: string;
  43013. /**
  43014. * Defines the playback speed (1 by default)
  43015. */
  43016. playbackRate?: number;
  43017. /**
  43018. * Defines if the sound is from a streaming source
  43019. */
  43020. streaming?: boolean;
  43021. /**
  43022. * Defines an optional length (in seconds) inside the sound file
  43023. */
  43024. length?: number;
  43025. /**
  43026. * Defines an optional offset (in seconds) inside the sound file
  43027. */
  43028. offset?: number;
  43029. /**
  43030. * If true, URLs will not be required to state the audio file codec to use.
  43031. */
  43032. skipCodecCheck?: boolean;
  43033. }
  43034. /**
  43035. * Defines a sound that can be played in the application.
  43036. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  43037. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43038. */
  43039. export class Sound {
  43040. /**
  43041. * The name of the sound in the scene.
  43042. */
  43043. name: string;
  43044. /**
  43045. * Does the sound autoplay once loaded.
  43046. */
  43047. autoplay: boolean;
  43048. /**
  43049. * Does the sound loop after it finishes playing once.
  43050. */
  43051. loop: boolean;
  43052. /**
  43053. * Does the sound use a custom attenuation curve to simulate the falloff
  43054. * happening when the source gets further away from the camera.
  43055. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43056. */
  43057. useCustomAttenuation: boolean;
  43058. /**
  43059. * The sound track id this sound belongs to.
  43060. */
  43061. soundTrackId: number;
  43062. /**
  43063. * Is this sound currently played.
  43064. */
  43065. isPlaying: boolean;
  43066. /**
  43067. * Is this sound currently paused.
  43068. */
  43069. isPaused: boolean;
  43070. /**
  43071. * Does this sound enables spatial sound.
  43072. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43073. */
  43074. spatialSound: boolean;
  43075. /**
  43076. * Define the reference distance the sound should be heard perfectly.
  43077. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43078. */
  43079. refDistance: number;
  43080. /**
  43081. * Define the roll off factor of spatial sounds.
  43082. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43083. */
  43084. rolloffFactor: number;
  43085. /**
  43086. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  43087. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43088. */
  43089. maxDistance: number;
  43090. /**
  43091. * Define the distance attenuation model the sound will follow.
  43092. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43093. */
  43094. distanceModel: string;
  43095. /**
  43096. * @hidden
  43097. * Back Compat
  43098. **/
  43099. onended: () => any;
  43100. /**
  43101. * Gets or sets an object used to store user defined information for the sound.
  43102. */
  43103. metadata: any;
  43104. /**
  43105. * Observable event when the current playing sound finishes.
  43106. */
  43107. onEndedObservable: Observable<Sound>;
  43108. private _panningModel;
  43109. private _playbackRate;
  43110. private _streaming;
  43111. private _startTime;
  43112. private _startOffset;
  43113. private _position;
  43114. /** @hidden */
  43115. _positionInEmitterSpace: boolean;
  43116. private _localDirection;
  43117. private _volume;
  43118. private _isReadyToPlay;
  43119. private _isDirectional;
  43120. private _readyToPlayCallback;
  43121. private _audioBuffer;
  43122. private _soundSource;
  43123. private _streamingSource;
  43124. private _soundPanner;
  43125. private _soundGain;
  43126. private _inputAudioNode;
  43127. private _outputAudioNode;
  43128. private _coneInnerAngle;
  43129. private _coneOuterAngle;
  43130. private _coneOuterGain;
  43131. private _scene;
  43132. private _connectedTransformNode;
  43133. private _customAttenuationFunction;
  43134. private _registerFunc;
  43135. private _isOutputConnected;
  43136. private _htmlAudioElement;
  43137. private _urlType;
  43138. private _length?;
  43139. private _offset?;
  43140. /** @hidden */
  43141. static _SceneComponentInitialization: (scene: Scene) => void;
  43142. /**
  43143. * Create a sound and attach it to a scene
  43144. * @param name Name of your sound
  43145. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43146. * @param scene defines the scene the sound belongs to
  43147. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43148. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43149. */
  43150. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43151. /**
  43152. * Release the sound and its associated resources
  43153. */
  43154. dispose(): void;
  43155. /**
  43156. * Gets if the sounds is ready to be played or not.
  43157. * @returns true if ready, otherwise false
  43158. */
  43159. isReady(): boolean;
  43160. private _soundLoaded;
  43161. /**
  43162. * Sets the data of the sound from an audiobuffer
  43163. * @param audioBuffer The audioBuffer containing the data
  43164. */
  43165. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43166. /**
  43167. * Updates the current sounds options such as maxdistance, loop...
  43168. * @param options A JSON object containing values named as the object properties
  43169. */
  43170. updateOptions(options: ISoundOptions): void;
  43171. private _createSpatialParameters;
  43172. private _updateSpatialParameters;
  43173. /**
  43174. * Switch the panning model to HRTF:
  43175. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43176. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43177. */
  43178. switchPanningModelToHRTF(): void;
  43179. /**
  43180. * Switch the panning model to Equal Power:
  43181. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43182. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43183. */
  43184. switchPanningModelToEqualPower(): void;
  43185. private _switchPanningModel;
  43186. /**
  43187. * Connect this sound to a sound track audio node like gain...
  43188. * @param soundTrackAudioNode the sound track audio node to connect to
  43189. */
  43190. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43191. /**
  43192. * Transform this sound into a directional source
  43193. * @param coneInnerAngle Size of the inner cone in degree
  43194. * @param coneOuterAngle Size of the outer cone in degree
  43195. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43196. */
  43197. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43198. /**
  43199. * Gets or sets the inner angle for the directional cone.
  43200. */
  43201. get directionalConeInnerAngle(): number;
  43202. /**
  43203. * Gets or sets the inner angle for the directional cone.
  43204. */
  43205. set directionalConeInnerAngle(value: number);
  43206. /**
  43207. * Gets or sets the outer angle for the directional cone.
  43208. */
  43209. get directionalConeOuterAngle(): number;
  43210. /**
  43211. * Gets or sets the outer angle for the directional cone.
  43212. */
  43213. set directionalConeOuterAngle(value: number);
  43214. /**
  43215. * Sets the position of the emitter if spatial sound is enabled
  43216. * @param newPosition Defines the new posisiton
  43217. */
  43218. setPosition(newPosition: Vector3): void;
  43219. /**
  43220. * Sets the local direction of the emitter if spatial sound is enabled
  43221. * @param newLocalDirection Defines the new local direction
  43222. */
  43223. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43224. private _updateDirection;
  43225. /** @hidden */
  43226. updateDistanceFromListener(): void;
  43227. /**
  43228. * Sets a new custom attenuation function for the sound.
  43229. * @param callback Defines the function used for the attenuation
  43230. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43231. */
  43232. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43233. /**
  43234. * Play the sound
  43235. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43236. * @param offset (optional) Start the sound at a specific time in seconds
  43237. * @param length (optional) Sound duration (in seconds)
  43238. */
  43239. play(time?: number, offset?: number, length?: number): void;
  43240. private _onended;
  43241. /**
  43242. * Stop the sound
  43243. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43244. */
  43245. stop(time?: number): void;
  43246. /**
  43247. * Put the sound in pause
  43248. */
  43249. pause(): void;
  43250. /**
  43251. * Sets a dedicated volume for this sounds
  43252. * @param newVolume Define the new volume of the sound
  43253. * @param time Define time for gradual change to new volume
  43254. */
  43255. setVolume(newVolume: number, time?: number): void;
  43256. /**
  43257. * Set the sound play back rate
  43258. * @param newPlaybackRate Define the playback rate the sound should be played at
  43259. */
  43260. setPlaybackRate(newPlaybackRate: number): void;
  43261. /**
  43262. * Gets the volume of the sound.
  43263. * @returns the volume of the sound
  43264. */
  43265. getVolume(): number;
  43266. /**
  43267. * Attach the sound to a dedicated mesh
  43268. * @param transformNode The transform node to connect the sound with
  43269. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43270. */
  43271. attachToMesh(transformNode: TransformNode): void;
  43272. /**
  43273. * Detach the sound from the previously attached mesh
  43274. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43275. */
  43276. detachFromMesh(): void;
  43277. private _onRegisterAfterWorldMatrixUpdate;
  43278. /**
  43279. * Clone the current sound in the scene.
  43280. * @returns the new sound clone
  43281. */
  43282. clone(): Nullable<Sound>;
  43283. /**
  43284. * Gets the current underlying audio buffer containing the data
  43285. * @returns the audio buffer
  43286. */
  43287. getAudioBuffer(): Nullable<AudioBuffer>;
  43288. /**
  43289. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43290. * @returns the source node
  43291. */
  43292. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43293. /**
  43294. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43295. * @returns the gain node
  43296. */
  43297. getSoundGain(): Nullable<GainNode>;
  43298. /**
  43299. * Serializes the Sound in a JSON representation
  43300. * @returns the JSON representation of the sound
  43301. */
  43302. serialize(): any;
  43303. /**
  43304. * Parse a JSON representation of a sound to innstantiate in a given scene
  43305. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43306. * @param scene Define the scene the new parsed sound should be created in
  43307. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43308. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43309. * @returns the newly parsed sound
  43310. */
  43311. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43312. }
  43313. }
  43314. declare module "babylonjs/Actions/directAudioActions" {
  43315. import { Action } from "babylonjs/Actions/action";
  43316. import { Condition } from "babylonjs/Actions/condition";
  43317. import { Sound } from "babylonjs/Audio/sound";
  43318. /**
  43319. * This defines an action helpful to play a defined sound on a triggered action.
  43320. */
  43321. export class PlaySoundAction extends Action {
  43322. private _sound;
  43323. /**
  43324. * Instantiate the action
  43325. * @param triggerOptions defines the trigger options
  43326. * @param sound defines the sound to play
  43327. * @param condition defines the trigger related conditions
  43328. */
  43329. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43330. /** @hidden */
  43331. _prepare(): void;
  43332. /**
  43333. * Execute the action and play the sound.
  43334. */
  43335. execute(): void;
  43336. /**
  43337. * Serializes the actions and its related information.
  43338. * @param parent defines the object to serialize in
  43339. * @returns the serialized object
  43340. */
  43341. serialize(parent: any): any;
  43342. }
  43343. /**
  43344. * This defines an action helpful to stop a defined sound on a triggered action.
  43345. */
  43346. export class StopSoundAction extends Action {
  43347. private _sound;
  43348. /**
  43349. * Instantiate the action
  43350. * @param triggerOptions defines the trigger options
  43351. * @param sound defines the sound to stop
  43352. * @param condition defines the trigger related conditions
  43353. */
  43354. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43355. /** @hidden */
  43356. _prepare(): void;
  43357. /**
  43358. * Execute the action and stop the sound.
  43359. */
  43360. execute(): void;
  43361. /**
  43362. * Serializes the actions and its related information.
  43363. * @param parent defines the object to serialize in
  43364. * @returns the serialized object
  43365. */
  43366. serialize(parent: any): any;
  43367. }
  43368. }
  43369. declare module "babylonjs/Actions/interpolateValueAction" {
  43370. import { Action } from "babylonjs/Actions/action";
  43371. import { Condition } from "babylonjs/Actions/condition";
  43372. import { Observable } from "babylonjs/Misc/observable";
  43373. /**
  43374. * This defines an action responsible to change the value of a property
  43375. * by interpolating between its current value and the newly set one once triggered.
  43376. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43377. */
  43378. export class InterpolateValueAction extends Action {
  43379. /**
  43380. * Defines the path of the property where the value should be interpolated
  43381. */
  43382. propertyPath: string;
  43383. /**
  43384. * Defines the target value at the end of the interpolation.
  43385. */
  43386. value: any;
  43387. /**
  43388. * Defines the time it will take for the property to interpolate to the value.
  43389. */
  43390. duration: number;
  43391. /**
  43392. * Defines if the other scene animations should be stopped when the action has been triggered
  43393. */
  43394. stopOtherAnimations?: boolean;
  43395. /**
  43396. * Defines a callback raised once the interpolation animation has been done.
  43397. */
  43398. onInterpolationDone?: () => void;
  43399. /**
  43400. * Observable triggered once the interpolation animation has been done.
  43401. */
  43402. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43403. private _target;
  43404. private _effectiveTarget;
  43405. private _property;
  43406. /**
  43407. * Instantiate the action
  43408. * @param triggerOptions defines the trigger options
  43409. * @param target defines the object containing the value to interpolate
  43410. * @param propertyPath defines the path to the property in the target object
  43411. * @param value defines the target value at the end of the interpolation
  43412. * @param duration deines the time it will take for the property to interpolate to the value.
  43413. * @param condition defines the trigger related conditions
  43414. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43415. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43416. */
  43417. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43418. /** @hidden */
  43419. _prepare(): void;
  43420. /**
  43421. * Execute the action starts the value interpolation.
  43422. */
  43423. execute(): void;
  43424. /**
  43425. * Serializes the actions and its related information.
  43426. * @param parent defines the object to serialize in
  43427. * @returns the serialized object
  43428. */
  43429. serialize(parent: any): any;
  43430. }
  43431. }
  43432. declare module "babylonjs/Actions/index" {
  43433. export * from "babylonjs/Actions/abstractActionManager";
  43434. export * from "babylonjs/Actions/action";
  43435. export * from "babylonjs/Actions/actionEvent";
  43436. export * from "babylonjs/Actions/actionManager";
  43437. export * from "babylonjs/Actions/condition";
  43438. export * from "babylonjs/Actions/directActions";
  43439. export * from "babylonjs/Actions/directAudioActions";
  43440. export * from "babylonjs/Actions/interpolateValueAction";
  43441. }
  43442. declare module "babylonjs/Animations/index" {
  43443. export * from "babylonjs/Animations/animatable";
  43444. export * from "babylonjs/Animations/animation";
  43445. export * from "babylonjs/Animations/animationGroup";
  43446. export * from "babylonjs/Animations/animationPropertiesOverride";
  43447. export * from "babylonjs/Animations/easing";
  43448. export * from "babylonjs/Animations/runtimeAnimation";
  43449. export * from "babylonjs/Animations/animationEvent";
  43450. export * from "babylonjs/Animations/animationGroup";
  43451. export * from "babylonjs/Animations/animationKey";
  43452. export * from "babylonjs/Animations/animationRange";
  43453. export * from "babylonjs/Animations/animatable.interface";
  43454. }
  43455. declare module "babylonjs/Audio/soundTrack" {
  43456. import { Sound } from "babylonjs/Audio/sound";
  43457. import { Analyser } from "babylonjs/Audio/analyser";
  43458. import { Scene } from "babylonjs/scene";
  43459. /**
  43460. * Options allowed during the creation of a sound track.
  43461. */
  43462. export interface ISoundTrackOptions {
  43463. /**
  43464. * The volume the sound track should take during creation
  43465. */
  43466. volume?: number;
  43467. /**
  43468. * Define if the sound track is the main sound track of the scene
  43469. */
  43470. mainTrack?: boolean;
  43471. }
  43472. /**
  43473. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43474. * It will be also used in a future release to apply effects on a specific track.
  43475. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43476. */
  43477. export class SoundTrack {
  43478. /**
  43479. * The unique identifier of the sound track in the scene.
  43480. */
  43481. id: number;
  43482. /**
  43483. * The list of sounds included in the sound track.
  43484. */
  43485. soundCollection: Array<Sound>;
  43486. private _outputAudioNode;
  43487. private _scene;
  43488. private _connectedAnalyser;
  43489. private _options;
  43490. private _isInitialized;
  43491. /**
  43492. * Creates a new sound track.
  43493. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43494. * @param scene Define the scene the sound track belongs to
  43495. * @param options
  43496. */
  43497. constructor(scene: Scene, options?: ISoundTrackOptions);
  43498. private _initializeSoundTrackAudioGraph;
  43499. /**
  43500. * Release the sound track and its associated resources
  43501. */
  43502. dispose(): void;
  43503. /**
  43504. * Adds a sound to this sound track
  43505. * @param sound define the cound to add
  43506. * @ignoreNaming
  43507. */
  43508. AddSound(sound: Sound): void;
  43509. /**
  43510. * Removes a sound to this sound track
  43511. * @param sound define the cound to remove
  43512. * @ignoreNaming
  43513. */
  43514. RemoveSound(sound: Sound): void;
  43515. /**
  43516. * Set a global volume for the full sound track.
  43517. * @param newVolume Define the new volume of the sound track
  43518. */
  43519. setVolume(newVolume: number): void;
  43520. /**
  43521. * Switch the panning model to HRTF:
  43522. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43523. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43524. */
  43525. switchPanningModelToHRTF(): void;
  43526. /**
  43527. * Switch the panning model to Equal Power:
  43528. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43529. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43530. */
  43531. switchPanningModelToEqualPower(): void;
  43532. /**
  43533. * Connect the sound track to an audio analyser allowing some amazing
  43534. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43535. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43536. * @param analyser The analyser to connect to the engine
  43537. */
  43538. connectToAnalyser(analyser: Analyser): void;
  43539. }
  43540. }
  43541. declare module "babylonjs/Audio/audioSceneComponent" {
  43542. import { Sound } from "babylonjs/Audio/sound";
  43543. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43544. import { Nullable } from "babylonjs/types";
  43545. import { Vector3 } from "babylonjs/Maths/math.vector";
  43546. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43547. import { Scene } from "babylonjs/scene";
  43548. import { AbstractScene } from "babylonjs/abstractScene";
  43549. import "babylonjs/Audio/audioEngine";
  43550. module "babylonjs/abstractScene" {
  43551. interface AbstractScene {
  43552. /**
  43553. * The list of sounds used in the scene.
  43554. */
  43555. sounds: Nullable<Array<Sound>>;
  43556. }
  43557. }
  43558. module "babylonjs/scene" {
  43559. interface Scene {
  43560. /**
  43561. * @hidden
  43562. * Backing field
  43563. */
  43564. _mainSoundTrack: SoundTrack;
  43565. /**
  43566. * The main sound track played by the scene.
  43567. * It cotains your primary collection of sounds.
  43568. */
  43569. mainSoundTrack: SoundTrack;
  43570. /**
  43571. * The list of sound tracks added to the scene
  43572. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43573. */
  43574. soundTracks: Nullable<Array<SoundTrack>>;
  43575. /**
  43576. * Gets a sound using a given name
  43577. * @param name defines the name to search for
  43578. * @return the found sound or null if not found at all.
  43579. */
  43580. getSoundByName(name: string): Nullable<Sound>;
  43581. /**
  43582. * Gets or sets if audio support is enabled
  43583. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43584. */
  43585. audioEnabled: boolean;
  43586. /**
  43587. * Gets or sets if audio will be output to headphones
  43588. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43589. */
  43590. headphone: boolean;
  43591. /**
  43592. * Gets or sets custom audio listener position provider
  43593. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43594. */
  43595. audioListenerPositionProvider: Nullable<() => Vector3>;
  43596. /**
  43597. * Gets or sets a refresh rate when using 3D audio positioning
  43598. */
  43599. audioPositioningRefreshRate: number;
  43600. }
  43601. }
  43602. /**
  43603. * Defines the sound scene component responsible to manage any sounds
  43604. * in a given scene.
  43605. */
  43606. export class AudioSceneComponent implements ISceneSerializableComponent {
  43607. private static _CameraDirectionLH;
  43608. private static _CameraDirectionRH;
  43609. /**
  43610. * The component name helpfull to identify the component in the list of scene components.
  43611. */
  43612. readonly name: string;
  43613. /**
  43614. * The scene the component belongs to.
  43615. */
  43616. scene: Scene;
  43617. private _audioEnabled;
  43618. /**
  43619. * Gets whether audio is enabled or not.
  43620. * Please use related enable/disable method to switch state.
  43621. */
  43622. get audioEnabled(): boolean;
  43623. private _headphone;
  43624. /**
  43625. * Gets whether audio is outputing to headphone or not.
  43626. * Please use the according Switch methods to change output.
  43627. */
  43628. get headphone(): boolean;
  43629. /**
  43630. * Gets or sets a refresh rate when using 3D audio positioning
  43631. */
  43632. audioPositioningRefreshRate: number;
  43633. private _audioListenerPositionProvider;
  43634. /**
  43635. * Gets the current audio listener position provider
  43636. */
  43637. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43638. /**
  43639. * Sets a custom listener position for all sounds in the scene
  43640. * By default, this is the position of the first active camera
  43641. */
  43642. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43643. /**
  43644. * Creates a new instance of the component for the given scene
  43645. * @param scene Defines the scene to register the component in
  43646. */
  43647. constructor(scene: Scene);
  43648. /**
  43649. * Registers the component in a given scene
  43650. */
  43651. register(): void;
  43652. /**
  43653. * Rebuilds the elements related to this component in case of
  43654. * context lost for instance.
  43655. */
  43656. rebuild(): void;
  43657. /**
  43658. * Serializes the component data to the specified json object
  43659. * @param serializationObject The object to serialize to
  43660. */
  43661. serialize(serializationObject: any): void;
  43662. /**
  43663. * Adds all the elements from the container to the scene
  43664. * @param container the container holding the elements
  43665. */
  43666. addFromContainer(container: AbstractScene): void;
  43667. /**
  43668. * Removes all the elements in the container from the scene
  43669. * @param container contains the elements to remove
  43670. * @param dispose if the removed element should be disposed (default: false)
  43671. */
  43672. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43673. /**
  43674. * Disposes the component and the associated ressources.
  43675. */
  43676. dispose(): void;
  43677. /**
  43678. * Disables audio in the associated scene.
  43679. */
  43680. disableAudio(): void;
  43681. /**
  43682. * Enables audio in the associated scene.
  43683. */
  43684. enableAudio(): void;
  43685. /**
  43686. * Switch audio to headphone output.
  43687. */
  43688. switchAudioModeForHeadphones(): void;
  43689. /**
  43690. * Switch audio to normal speakers.
  43691. */
  43692. switchAudioModeForNormalSpeakers(): void;
  43693. private _cachedCameraDirection;
  43694. private _cachedCameraPosition;
  43695. private _lastCheck;
  43696. private _afterRender;
  43697. }
  43698. }
  43699. declare module "babylonjs/Audio/weightedsound" {
  43700. import { Sound } from "babylonjs/Audio/sound";
  43701. /**
  43702. * Wraps one or more Sound objects and selects one with random weight for playback.
  43703. */
  43704. export class WeightedSound {
  43705. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43706. loop: boolean;
  43707. private _coneInnerAngle;
  43708. private _coneOuterAngle;
  43709. private _volume;
  43710. /** A Sound is currently playing. */
  43711. isPlaying: boolean;
  43712. /** A Sound is currently paused. */
  43713. isPaused: boolean;
  43714. private _sounds;
  43715. private _weights;
  43716. private _currentIndex?;
  43717. /**
  43718. * Creates a new WeightedSound from the list of sounds given.
  43719. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43720. * @param sounds Array of Sounds that will be selected from.
  43721. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43722. */
  43723. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43724. /**
  43725. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43726. */
  43727. get directionalConeInnerAngle(): number;
  43728. /**
  43729. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43730. */
  43731. set directionalConeInnerAngle(value: number);
  43732. /**
  43733. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43734. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43735. */
  43736. get directionalConeOuterAngle(): number;
  43737. /**
  43738. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43739. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43740. */
  43741. set directionalConeOuterAngle(value: number);
  43742. /**
  43743. * Playback volume.
  43744. */
  43745. get volume(): number;
  43746. /**
  43747. * Playback volume.
  43748. */
  43749. set volume(value: number);
  43750. private _onended;
  43751. /**
  43752. * Suspend playback
  43753. */
  43754. pause(): void;
  43755. /**
  43756. * Stop playback
  43757. */
  43758. stop(): void;
  43759. /**
  43760. * Start playback.
  43761. * @param startOffset Position the clip head at a specific time in seconds.
  43762. */
  43763. play(startOffset?: number): void;
  43764. }
  43765. }
  43766. declare module "babylonjs/Audio/index" {
  43767. export * from "babylonjs/Audio/analyser";
  43768. export * from "babylonjs/Audio/audioEngine";
  43769. export * from "babylonjs/Audio/audioSceneComponent";
  43770. export * from "babylonjs/Audio/sound";
  43771. export * from "babylonjs/Audio/soundTrack";
  43772. export * from "babylonjs/Audio/weightedsound";
  43773. }
  43774. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43775. import { Behavior } from "babylonjs/Behaviors/behavior";
  43776. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43777. import { BackEase } from "babylonjs/Animations/easing";
  43778. /**
  43779. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43780. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43781. */
  43782. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43783. /**
  43784. * Gets the name of the behavior.
  43785. */
  43786. get name(): string;
  43787. /**
  43788. * The easing function used by animations
  43789. */
  43790. static EasingFunction: BackEase;
  43791. /**
  43792. * The easing mode used by animations
  43793. */
  43794. static EasingMode: number;
  43795. /**
  43796. * The duration of the animation, in milliseconds
  43797. */
  43798. transitionDuration: number;
  43799. /**
  43800. * Length of the distance animated by the transition when lower radius is reached
  43801. */
  43802. lowerRadiusTransitionRange: number;
  43803. /**
  43804. * Length of the distance animated by the transition when upper radius is reached
  43805. */
  43806. upperRadiusTransitionRange: number;
  43807. private _autoTransitionRange;
  43808. /**
  43809. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43810. */
  43811. get autoTransitionRange(): boolean;
  43812. /**
  43813. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43814. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43815. */
  43816. set autoTransitionRange(value: boolean);
  43817. private _attachedCamera;
  43818. private _onAfterCheckInputsObserver;
  43819. private _onMeshTargetChangedObserver;
  43820. /**
  43821. * Initializes the behavior.
  43822. */
  43823. init(): void;
  43824. /**
  43825. * Attaches the behavior to its arc rotate camera.
  43826. * @param camera Defines the camera to attach the behavior to
  43827. */
  43828. attach(camera: ArcRotateCamera): void;
  43829. /**
  43830. * Detaches the behavior from its current arc rotate camera.
  43831. */
  43832. detach(): void;
  43833. private _radiusIsAnimating;
  43834. private _radiusBounceTransition;
  43835. private _animatables;
  43836. private _cachedWheelPrecision;
  43837. /**
  43838. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43839. * @param radiusLimit The limit to check against.
  43840. * @return Bool to indicate if at limit.
  43841. */
  43842. private _isRadiusAtLimit;
  43843. /**
  43844. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43845. * @param radiusDelta The delta by which to animate to. Can be negative.
  43846. */
  43847. private _applyBoundRadiusAnimation;
  43848. /**
  43849. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43850. */
  43851. protected _clearAnimationLocks(): void;
  43852. /**
  43853. * Stops and removes all animations that have been applied to the camera
  43854. */
  43855. stopAllAnimations(): void;
  43856. }
  43857. }
  43858. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43859. import { Behavior } from "babylonjs/Behaviors/behavior";
  43860. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43861. import { ExponentialEase } from "babylonjs/Animations/easing";
  43862. import { Nullable } from "babylonjs/types";
  43863. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43864. import { Vector3 } from "babylonjs/Maths/math.vector";
  43865. /**
  43866. * 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.
  43867. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43868. */
  43869. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43870. /**
  43871. * Gets the name of the behavior.
  43872. */
  43873. get name(): string;
  43874. private _mode;
  43875. private _radiusScale;
  43876. private _positionScale;
  43877. private _defaultElevation;
  43878. private _elevationReturnTime;
  43879. private _elevationReturnWaitTime;
  43880. private _zoomStopsAnimation;
  43881. private _framingTime;
  43882. /**
  43883. * The easing function used by animations
  43884. */
  43885. static EasingFunction: ExponentialEase;
  43886. /**
  43887. * The easing mode used by animations
  43888. */
  43889. static EasingMode: number;
  43890. /**
  43891. * Sets the current mode used by the behavior
  43892. */
  43893. set mode(mode: number);
  43894. /**
  43895. * Gets current mode used by the behavior.
  43896. */
  43897. get mode(): number;
  43898. /**
  43899. * Sets the scale applied to the radius (1 by default)
  43900. */
  43901. set radiusScale(radius: number);
  43902. /**
  43903. * Gets the scale applied to the radius
  43904. */
  43905. get radiusScale(): number;
  43906. /**
  43907. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43908. */
  43909. set positionScale(scale: number);
  43910. /**
  43911. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43912. */
  43913. get positionScale(): number;
  43914. /**
  43915. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43916. * behaviour is triggered, in radians.
  43917. */
  43918. set defaultElevation(elevation: number);
  43919. /**
  43920. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43921. * behaviour is triggered, in radians.
  43922. */
  43923. get defaultElevation(): number;
  43924. /**
  43925. * Sets the time (in milliseconds) taken to return to the default beta position.
  43926. * Negative value indicates camera should not return to default.
  43927. */
  43928. set elevationReturnTime(speed: number);
  43929. /**
  43930. * Gets the time (in milliseconds) taken to return to the default beta position.
  43931. * Negative value indicates camera should not return to default.
  43932. */
  43933. get elevationReturnTime(): number;
  43934. /**
  43935. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43936. */
  43937. set elevationReturnWaitTime(time: number);
  43938. /**
  43939. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43940. */
  43941. get elevationReturnWaitTime(): number;
  43942. /**
  43943. * Sets the flag that indicates if user zooming should stop animation.
  43944. */
  43945. set zoomStopsAnimation(flag: boolean);
  43946. /**
  43947. * Gets the flag that indicates if user zooming should stop animation.
  43948. */
  43949. get zoomStopsAnimation(): boolean;
  43950. /**
  43951. * Sets the transition time when framing the mesh, in milliseconds
  43952. */
  43953. set framingTime(time: number);
  43954. /**
  43955. * Gets the transition time when framing the mesh, in milliseconds
  43956. */
  43957. get framingTime(): number;
  43958. /**
  43959. * Define if the behavior should automatically change the configured
  43960. * camera limits and sensibilities.
  43961. */
  43962. autoCorrectCameraLimitsAndSensibility: boolean;
  43963. private _onPrePointerObservableObserver;
  43964. private _onAfterCheckInputsObserver;
  43965. private _onMeshTargetChangedObserver;
  43966. private _attachedCamera;
  43967. private _isPointerDown;
  43968. private _lastInteractionTime;
  43969. /**
  43970. * Initializes the behavior.
  43971. */
  43972. init(): void;
  43973. /**
  43974. * Attaches the behavior to its arc rotate camera.
  43975. * @param camera Defines the camera to attach the behavior to
  43976. */
  43977. attach(camera: ArcRotateCamera): void;
  43978. /**
  43979. * Detaches the behavior from its current arc rotate camera.
  43980. */
  43981. detach(): void;
  43982. private _animatables;
  43983. private _betaIsAnimating;
  43984. private _betaTransition;
  43985. private _radiusTransition;
  43986. private _vectorTransition;
  43987. /**
  43988. * Targets the given mesh and updates zoom level accordingly.
  43989. * @param mesh The mesh to target.
  43990. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43991. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43992. */
  43993. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43994. /**
  43995. * Targets the given mesh with its children and updates zoom level accordingly.
  43996. * @param mesh The mesh to target.
  43997. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43998. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43999. */
  44000. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  44001. /**
  44002. * Targets the given meshes with their children and updates zoom level accordingly.
  44003. * @param meshes The mesh to target.
  44004. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  44005. * @param onAnimationEnd Callback triggered at the end of the framing animation
  44006. */
  44007. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  44008. /**
  44009. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  44010. * @param minimumWorld Determines the smaller position of the bounding box extend
  44011. * @param maximumWorld Determines the bigger position of the bounding box extend
  44012. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  44013. * @param onAnimationEnd Callback triggered at the end of the framing animation
  44014. */
  44015. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  44016. /**
  44017. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  44018. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  44019. * frustum width.
  44020. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  44021. * to fully enclose the mesh in the viewing frustum.
  44022. */
  44023. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  44024. /**
  44025. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  44026. * is automatically returned to its default position (expected to be above ground plane).
  44027. */
  44028. private _maintainCameraAboveGround;
  44029. /**
  44030. * Returns the frustum slope based on the canvas ratio and camera FOV
  44031. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  44032. */
  44033. private _getFrustumSlope;
  44034. /**
  44035. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  44036. */
  44037. private _clearAnimationLocks;
  44038. /**
  44039. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44040. */
  44041. private _applyUserInteraction;
  44042. /**
  44043. * Stops and removes all animations that have been applied to the camera
  44044. */
  44045. stopAllAnimations(): void;
  44046. /**
  44047. * Gets a value indicating if the user is moving the camera
  44048. */
  44049. get isUserIsMoving(): boolean;
  44050. /**
  44051. * The camera can move all the way towards the mesh.
  44052. */
  44053. static IgnoreBoundsSizeMode: number;
  44054. /**
  44055. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  44056. */
  44057. static FitFrustumSidesMode: number;
  44058. }
  44059. }
  44060. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  44061. import { Nullable } from "babylonjs/types";
  44062. import { Camera } from "babylonjs/Cameras/camera";
  44063. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44064. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44065. /**
  44066. * Base class for Camera Pointer Inputs.
  44067. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  44068. * for example usage.
  44069. */
  44070. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  44071. /**
  44072. * Defines the camera the input is attached to.
  44073. */
  44074. abstract camera: Camera;
  44075. /**
  44076. * Whether keyboard modifier keys are pressed at time of last mouse event.
  44077. */
  44078. protected _altKey: boolean;
  44079. protected _ctrlKey: boolean;
  44080. protected _metaKey: boolean;
  44081. protected _shiftKey: boolean;
  44082. /**
  44083. * Which mouse buttons were pressed at time of last mouse event.
  44084. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  44085. */
  44086. protected _buttonsPressed: number;
  44087. /**
  44088. * Defines the buttons associated with the input to handle camera move.
  44089. */
  44090. buttons: number[];
  44091. /**
  44092. * Attach the input controls to a specific dom element to get the input from.
  44093. * @param element Defines the element the controls should be listened from
  44094. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44095. */
  44096. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44097. /**
  44098. * Detach the current controls from the specified dom element.
  44099. * @param element Defines the element to stop listening the inputs from
  44100. */
  44101. detachControl(element: Nullable<HTMLElement>): void;
  44102. /**
  44103. * Gets the class name of the current input.
  44104. * @returns the class name
  44105. */
  44106. getClassName(): string;
  44107. /**
  44108. * Get the friendly name associated with the input class.
  44109. * @returns the input friendly name
  44110. */
  44111. getSimpleName(): string;
  44112. /**
  44113. * Called on pointer POINTERDOUBLETAP event.
  44114. * Override this method to provide functionality on POINTERDOUBLETAP event.
  44115. */
  44116. protected onDoubleTap(type: string): void;
  44117. /**
  44118. * Called on pointer POINTERMOVE event if only a single touch is active.
  44119. * Override this method to provide functionality.
  44120. */
  44121. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44122. /**
  44123. * Called on pointer POINTERMOVE event if multiple touches are active.
  44124. * Override this method to provide functionality.
  44125. */
  44126. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44127. /**
  44128. * Called on JS contextmenu event.
  44129. * Override this method to provide functionality.
  44130. */
  44131. protected onContextMenu(evt: PointerEvent): void;
  44132. /**
  44133. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44134. * press.
  44135. * Override this method to provide functionality.
  44136. */
  44137. protected onButtonDown(evt: PointerEvent): void;
  44138. /**
  44139. * Called each time a new POINTERUP event occurs. Ie, for each button
  44140. * release.
  44141. * Override this method to provide functionality.
  44142. */
  44143. protected onButtonUp(evt: PointerEvent): void;
  44144. /**
  44145. * Called when window becomes inactive.
  44146. * Override this method to provide functionality.
  44147. */
  44148. protected onLostFocus(): void;
  44149. private _pointerInput;
  44150. private _observer;
  44151. private _onLostFocus;
  44152. private pointA;
  44153. private pointB;
  44154. }
  44155. }
  44156. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44157. import { Nullable } from "babylonjs/types";
  44158. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44159. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44160. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44161. /**
  44162. * Manage the pointers inputs to control an arc rotate camera.
  44163. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44164. */
  44165. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44166. /**
  44167. * Defines the camera the input is attached to.
  44168. */
  44169. camera: ArcRotateCamera;
  44170. /**
  44171. * Gets the class name of the current input.
  44172. * @returns the class name
  44173. */
  44174. getClassName(): string;
  44175. /**
  44176. * Defines the buttons associated with the input to handle camera move.
  44177. */
  44178. buttons: number[];
  44179. /**
  44180. * Defines the pointer angular sensibility along the X axis or how fast is
  44181. * the camera rotating.
  44182. */
  44183. angularSensibilityX: number;
  44184. /**
  44185. * Defines the pointer angular sensibility along the Y axis or how fast is
  44186. * the camera rotating.
  44187. */
  44188. angularSensibilityY: number;
  44189. /**
  44190. * Defines the pointer pinch precision or how fast is the camera zooming.
  44191. */
  44192. pinchPrecision: number;
  44193. /**
  44194. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44195. * from 0.
  44196. * It defines the percentage of current camera.radius to use as delta when
  44197. * pinch zoom is used.
  44198. */
  44199. pinchDeltaPercentage: number;
  44200. /**
  44201. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44202. * that any object in the plane at the camera's target point will scale
  44203. * perfectly with finger motion.
  44204. * Overrides pinchDeltaPercentage and pinchPrecision.
  44205. */
  44206. useNaturalPinchZoom: boolean;
  44207. /**
  44208. * Defines the pointer panning sensibility or how fast is the camera moving.
  44209. */
  44210. panningSensibility: number;
  44211. /**
  44212. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44213. */
  44214. multiTouchPanning: boolean;
  44215. /**
  44216. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44217. * zoom (pinch) through multitouch.
  44218. */
  44219. multiTouchPanAndZoom: boolean;
  44220. /**
  44221. * Revers pinch action direction.
  44222. */
  44223. pinchInwards: boolean;
  44224. private _isPanClick;
  44225. private _twoFingerActivityCount;
  44226. private _isPinching;
  44227. /**
  44228. * Called on pointer POINTERMOVE event if only a single touch is active.
  44229. */
  44230. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44231. /**
  44232. * Called on pointer POINTERDOUBLETAP event.
  44233. */
  44234. protected onDoubleTap(type: string): void;
  44235. /**
  44236. * Called on pointer POINTERMOVE event if multiple touches are active.
  44237. */
  44238. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44239. /**
  44240. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44241. * press.
  44242. */
  44243. protected onButtonDown(evt: PointerEvent): void;
  44244. /**
  44245. * Called each time a new POINTERUP event occurs. Ie, for each button
  44246. * release.
  44247. */
  44248. protected onButtonUp(evt: PointerEvent): void;
  44249. /**
  44250. * Called when window becomes inactive.
  44251. */
  44252. protected onLostFocus(): void;
  44253. }
  44254. }
  44255. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44256. import { Nullable } from "babylonjs/types";
  44257. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44258. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44259. /**
  44260. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44261. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44262. */
  44263. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44264. /**
  44265. * Defines the camera the input is attached to.
  44266. */
  44267. camera: ArcRotateCamera;
  44268. /**
  44269. * Defines the list of key codes associated with the up action (increase alpha)
  44270. */
  44271. keysUp: number[];
  44272. /**
  44273. * Defines the list of key codes associated with the down action (decrease alpha)
  44274. */
  44275. keysDown: number[];
  44276. /**
  44277. * Defines the list of key codes associated with the left action (increase beta)
  44278. */
  44279. keysLeft: number[];
  44280. /**
  44281. * Defines the list of key codes associated with the right action (decrease beta)
  44282. */
  44283. keysRight: number[];
  44284. /**
  44285. * Defines the list of key codes associated with the reset action.
  44286. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44287. */
  44288. keysReset: number[];
  44289. /**
  44290. * Defines the panning sensibility of the inputs.
  44291. * (How fast is the camera panning)
  44292. */
  44293. panningSensibility: number;
  44294. /**
  44295. * Defines the zooming sensibility of the inputs.
  44296. * (How fast is the camera zooming)
  44297. */
  44298. zoomingSensibility: number;
  44299. /**
  44300. * Defines whether maintaining the alt key down switch the movement mode from
  44301. * orientation to zoom.
  44302. */
  44303. useAltToZoom: boolean;
  44304. /**
  44305. * Rotation speed of the camera
  44306. */
  44307. angularSpeed: number;
  44308. private _keys;
  44309. private _ctrlPressed;
  44310. private _altPressed;
  44311. private _onCanvasBlurObserver;
  44312. private _onKeyboardObserver;
  44313. private _engine;
  44314. private _scene;
  44315. /**
  44316. * Attach the input controls to a specific dom element to get the input from.
  44317. * @param element Defines the element the controls should be listened from
  44318. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44319. */
  44320. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44321. /**
  44322. * Detach the current controls from the specified dom element.
  44323. * @param element Defines the element to stop listening the inputs from
  44324. */
  44325. detachControl(element: Nullable<HTMLElement>): void;
  44326. /**
  44327. * Update the current camera state depending on the inputs that have been used this frame.
  44328. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44329. */
  44330. checkInputs(): void;
  44331. /**
  44332. * Gets the class name of the current intput.
  44333. * @returns the class name
  44334. */
  44335. getClassName(): string;
  44336. /**
  44337. * Get the friendly name associated with the input class.
  44338. * @returns the input friendly name
  44339. */
  44340. getSimpleName(): string;
  44341. }
  44342. }
  44343. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44344. import { Nullable } from "babylonjs/types";
  44345. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44346. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44347. /**
  44348. * Manage the mouse wheel inputs to control an arc rotate camera.
  44349. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44350. */
  44351. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44352. /**
  44353. * Defines the camera the input is attached to.
  44354. */
  44355. camera: ArcRotateCamera;
  44356. /**
  44357. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44358. */
  44359. wheelPrecision: number;
  44360. /**
  44361. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44362. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44363. */
  44364. wheelDeltaPercentage: number;
  44365. private _wheel;
  44366. private _observer;
  44367. private computeDeltaFromMouseWheelLegacyEvent;
  44368. /**
  44369. * Attach the input controls to a specific dom element to get the input from.
  44370. * @param element Defines the element the controls should be listened from
  44371. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44372. */
  44373. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44374. /**
  44375. * Detach the current controls from the specified dom element.
  44376. * @param element Defines the element to stop listening the inputs from
  44377. */
  44378. detachControl(element: Nullable<HTMLElement>): void;
  44379. /**
  44380. * Gets the class name of the current intput.
  44381. * @returns the class name
  44382. */
  44383. getClassName(): string;
  44384. /**
  44385. * Get the friendly name associated with the input class.
  44386. * @returns the input friendly name
  44387. */
  44388. getSimpleName(): string;
  44389. }
  44390. }
  44391. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44392. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44393. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44394. /**
  44395. * Default Inputs manager for the ArcRotateCamera.
  44396. * It groups all the default supported inputs for ease of use.
  44397. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44398. */
  44399. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44400. /**
  44401. * Instantiates a new ArcRotateCameraInputsManager.
  44402. * @param camera Defines the camera the inputs belong to
  44403. */
  44404. constructor(camera: ArcRotateCamera);
  44405. /**
  44406. * Add mouse wheel input support to the input manager.
  44407. * @returns the current input manager
  44408. */
  44409. addMouseWheel(): ArcRotateCameraInputsManager;
  44410. /**
  44411. * Add pointers input support to the input manager.
  44412. * @returns the current input manager
  44413. */
  44414. addPointers(): ArcRotateCameraInputsManager;
  44415. /**
  44416. * Add keyboard input support to the input manager.
  44417. * @returns the current input manager
  44418. */
  44419. addKeyboard(): ArcRotateCameraInputsManager;
  44420. }
  44421. }
  44422. declare module "babylonjs/Cameras/arcRotateCamera" {
  44423. import { Observable } from "babylonjs/Misc/observable";
  44424. import { Nullable } from "babylonjs/types";
  44425. import { Scene } from "babylonjs/scene";
  44426. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44427. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44428. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44429. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44430. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44431. import { Camera } from "babylonjs/Cameras/camera";
  44432. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44433. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44434. import { Collider } from "babylonjs/Collisions/collider";
  44435. /**
  44436. * This represents an orbital type of camera.
  44437. *
  44438. * 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.
  44439. * 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.
  44440. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44441. */
  44442. export class ArcRotateCamera extends TargetCamera {
  44443. /**
  44444. * Defines the rotation angle of the camera along the longitudinal axis.
  44445. */
  44446. alpha: number;
  44447. /**
  44448. * Defines the rotation angle of the camera along the latitudinal axis.
  44449. */
  44450. beta: number;
  44451. /**
  44452. * Defines the radius of the camera from it s target point.
  44453. */
  44454. radius: number;
  44455. protected _target: Vector3;
  44456. protected _targetHost: Nullable<AbstractMesh>;
  44457. /**
  44458. * Defines the target point of the camera.
  44459. * The camera looks towards it form the radius distance.
  44460. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44461. */
  44462. get target(): Vector3;
  44463. set target(value: Vector3);
  44464. /**
  44465. * Define the current local position of the camera in the scene
  44466. */
  44467. get position(): Vector3;
  44468. set position(newPosition: Vector3);
  44469. protected _upToYMatrix: Matrix;
  44470. protected _YToUpMatrix: Matrix;
  44471. /**
  44472. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44473. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44474. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44475. */
  44476. set upVector(vec: Vector3);
  44477. get upVector(): Vector3;
  44478. /**
  44479. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44480. */
  44481. setMatUp(): void;
  44482. /**
  44483. * Current inertia value on the longitudinal axis.
  44484. * The bigger this number the longer it will take for the camera to stop.
  44485. */
  44486. inertialAlphaOffset: number;
  44487. /**
  44488. * Current inertia value on the latitudinal axis.
  44489. * The bigger this number the longer it will take for the camera to stop.
  44490. */
  44491. inertialBetaOffset: number;
  44492. /**
  44493. * Current inertia value on the radius axis.
  44494. * The bigger this number the longer it will take for the camera to stop.
  44495. */
  44496. inertialRadiusOffset: number;
  44497. /**
  44498. * Minimum allowed angle on the longitudinal axis.
  44499. * This can help limiting how the Camera is able to move in the scene.
  44500. */
  44501. lowerAlphaLimit: Nullable<number>;
  44502. /**
  44503. * Maximum allowed angle on the longitudinal axis.
  44504. * This can help limiting how the Camera is able to move in the scene.
  44505. */
  44506. upperAlphaLimit: Nullable<number>;
  44507. /**
  44508. * Minimum allowed angle on the latitudinal axis.
  44509. * This can help limiting how the Camera is able to move in the scene.
  44510. */
  44511. lowerBetaLimit: number;
  44512. /**
  44513. * Maximum allowed angle on the latitudinal axis.
  44514. * This can help limiting how the Camera is able to move in the scene.
  44515. */
  44516. upperBetaLimit: number;
  44517. /**
  44518. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44519. * This can help limiting how the Camera is able to move in the scene.
  44520. */
  44521. lowerRadiusLimit: Nullable<number>;
  44522. /**
  44523. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44524. * This can help limiting how the Camera is able to move in the scene.
  44525. */
  44526. upperRadiusLimit: Nullable<number>;
  44527. /**
  44528. * Defines the current inertia value used during panning of the camera along the X axis.
  44529. */
  44530. inertialPanningX: number;
  44531. /**
  44532. * Defines the current inertia value used during panning of the camera along the Y axis.
  44533. */
  44534. inertialPanningY: number;
  44535. /**
  44536. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44537. * Basically if your fingers moves away from more than this distance you will be considered
  44538. * in pinch mode.
  44539. */
  44540. pinchToPanMaxDistance: number;
  44541. /**
  44542. * Defines the maximum distance the camera can pan.
  44543. * This could help keeping the cammera always in your scene.
  44544. */
  44545. panningDistanceLimit: Nullable<number>;
  44546. /**
  44547. * Defines the target of the camera before paning.
  44548. */
  44549. panningOriginTarget: Vector3;
  44550. /**
  44551. * Defines the value of the inertia used during panning.
  44552. * 0 would mean stop inertia and one would mean no decelleration at all.
  44553. */
  44554. panningInertia: number;
  44555. /**
  44556. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44557. */
  44558. get angularSensibilityX(): number;
  44559. set angularSensibilityX(value: number);
  44560. /**
  44561. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44562. */
  44563. get angularSensibilityY(): number;
  44564. set angularSensibilityY(value: number);
  44565. /**
  44566. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44567. */
  44568. get pinchPrecision(): number;
  44569. set pinchPrecision(value: number);
  44570. /**
  44571. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44572. * It will be used instead of pinchDeltaPrecision if different from 0.
  44573. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44574. */
  44575. get pinchDeltaPercentage(): number;
  44576. set pinchDeltaPercentage(value: number);
  44577. /**
  44578. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44579. * and pinch delta percentage.
  44580. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44581. * that any object in the plane at the camera's target point will scale
  44582. * perfectly with finger motion.
  44583. */
  44584. get useNaturalPinchZoom(): boolean;
  44585. set useNaturalPinchZoom(value: boolean);
  44586. /**
  44587. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44588. */
  44589. get panningSensibility(): number;
  44590. set panningSensibility(value: number);
  44591. /**
  44592. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44593. */
  44594. get keysUp(): number[];
  44595. set keysUp(value: number[]);
  44596. /**
  44597. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44598. */
  44599. get keysDown(): number[];
  44600. set keysDown(value: number[]);
  44601. /**
  44602. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44603. */
  44604. get keysLeft(): number[];
  44605. set keysLeft(value: number[]);
  44606. /**
  44607. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44608. */
  44609. get keysRight(): number[];
  44610. set keysRight(value: number[]);
  44611. /**
  44612. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44613. */
  44614. get wheelPrecision(): number;
  44615. set wheelPrecision(value: number);
  44616. /**
  44617. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44618. * It will be used instead of pinchDeltaPrecision if different from 0.
  44619. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44620. */
  44621. get wheelDeltaPercentage(): number;
  44622. set wheelDeltaPercentage(value: number);
  44623. /**
  44624. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44625. */
  44626. zoomOnFactor: number;
  44627. /**
  44628. * Defines a screen offset for the camera position.
  44629. */
  44630. targetScreenOffset: Vector2;
  44631. /**
  44632. * Allows the camera to be completely reversed.
  44633. * If false the camera can not arrive upside down.
  44634. */
  44635. allowUpsideDown: boolean;
  44636. /**
  44637. * Define if double tap/click is used to restore the previously saved state of the camera.
  44638. */
  44639. useInputToRestoreState: boolean;
  44640. /** @hidden */
  44641. _viewMatrix: Matrix;
  44642. /** @hidden */
  44643. _useCtrlForPanning: boolean;
  44644. /** @hidden */
  44645. _panningMouseButton: number;
  44646. /**
  44647. * Defines the input associated to the camera.
  44648. */
  44649. inputs: ArcRotateCameraInputsManager;
  44650. /** @hidden */
  44651. _reset: () => void;
  44652. /**
  44653. * Defines the allowed panning axis.
  44654. */
  44655. panningAxis: Vector3;
  44656. protected _localDirection: Vector3;
  44657. protected _transformedDirection: Vector3;
  44658. private _bouncingBehavior;
  44659. /**
  44660. * Gets the bouncing behavior of the camera if it has been enabled.
  44661. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44662. */
  44663. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44664. /**
  44665. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44666. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44667. */
  44668. get useBouncingBehavior(): boolean;
  44669. set useBouncingBehavior(value: boolean);
  44670. private _framingBehavior;
  44671. /**
  44672. * Gets the framing behavior of the camera if it has been enabled.
  44673. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44674. */
  44675. get framingBehavior(): Nullable<FramingBehavior>;
  44676. /**
  44677. * Defines if the framing behavior of the camera is enabled on the camera.
  44678. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44679. */
  44680. get useFramingBehavior(): boolean;
  44681. set useFramingBehavior(value: boolean);
  44682. private _autoRotationBehavior;
  44683. /**
  44684. * Gets the auto rotation behavior of the camera if it has been enabled.
  44685. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44686. */
  44687. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44688. /**
  44689. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44690. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44691. */
  44692. get useAutoRotationBehavior(): boolean;
  44693. set useAutoRotationBehavior(value: boolean);
  44694. /**
  44695. * Observable triggered when the mesh target has been changed on the camera.
  44696. */
  44697. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44698. /**
  44699. * Event raised when the camera is colliding with a mesh.
  44700. */
  44701. onCollide: (collidedMesh: AbstractMesh) => void;
  44702. /**
  44703. * Defines whether the camera should check collision with the objects oh the scene.
  44704. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44705. */
  44706. checkCollisions: boolean;
  44707. /**
  44708. * Defines the collision radius of the camera.
  44709. * This simulates a sphere around the camera.
  44710. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44711. */
  44712. collisionRadius: Vector3;
  44713. protected _collider: Collider;
  44714. protected _previousPosition: Vector3;
  44715. protected _collisionVelocity: Vector3;
  44716. protected _newPosition: Vector3;
  44717. protected _previousAlpha: number;
  44718. protected _previousBeta: number;
  44719. protected _previousRadius: number;
  44720. protected _collisionTriggered: boolean;
  44721. protected _targetBoundingCenter: Nullable<Vector3>;
  44722. private _computationVector;
  44723. /**
  44724. * Instantiates a new ArcRotateCamera in a given scene
  44725. * @param name Defines the name of the camera
  44726. * @param alpha Defines the camera rotation along the logitudinal axis
  44727. * @param beta Defines the camera rotation along the latitudinal axis
  44728. * @param radius Defines the camera distance from its target
  44729. * @param target Defines the camera target
  44730. * @param scene Defines the scene the camera belongs to
  44731. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44732. */
  44733. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44734. /** @hidden */
  44735. _initCache(): void;
  44736. /** @hidden */
  44737. _updateCache(ignoreParentClass?: boolean): void;
  44738. protected _getTargetPosition(): Vector3;
  44739. private _storedAlpha;
  44740. private _storedBeta;
  44741. private _storedRadius;
  44742. private _storedTarget;
  44743. private _storedTargetScreenOffset;
  44744. /**
  44745. * Stores the current state of the camera (alpha, beta, radius and target)
  44746. * @returns the camera itself
  44747. */
  44748. storeState(): Camera;
  44749. /**
  44750. * @hidden
  44751. * Restored camera state. You must call storeState() first
  44752. */
  44753. _restoreStateValues(): boolean;
  44754. /** @hidden */
  44755. _isSynchronizedViewMatrix(): boolean;
  44756. /**
  44757. * Attached controls to the current camera.
  44758. * @param element Defines the element the controls should be listened from
  44759. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44760. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44761. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44762. */
  44763. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44764. /**
  44765. * Detach the current controls from the camera.
  44766. * The camera will stop reacting to inputs.
  44767. * @param element Defines the element to stop listening the inputs from
  44768. */
  44769. detachControl(element: HTMLElement): void;
  44770. /** @hidden */
  44771. _checkInputs(): void;
  44772. protected _checkLimits(): void;
  44773. /**
  44774. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44775. */
  44776. rebuildAnglesAndRadius(): void;
  44777. /**
  44778. * Use a position to define the current camera related information like alpha, beta and radius
  44779. * @param position Defines the position to set the camera at
  44780. */
  44781. setPosition(position: Vector3): void;
  44782. /**
  44783. * Defines the target the camera should look at.
  44784. * This will automatically adapt alpha beta and radius to fit within the new target.
  44785. * @param target Defines the new target as a Vector or a mesh
  44786. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44787. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44788. */
  44789. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44790. /** @hidden */
  44791. _getViewMatrix(): Matrix;
  44792. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44793. /**
  44794. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44795. * @param meshes Defines the mesh to zoom on
  44796. * @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)
  44797. */
  44798. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44799. /**
  44800. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44801. * The target will be changed but the radius
  44802. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44803. * @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)
  44804. */
  44805. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44806. min: Vector3;
  44807. max: Vector3;
  44808. distance: number;
  44809. }, doNotUpdateMaxZ?: boolean): void;
  44810. /**
  44811. * @override
  44812. * Override Camera.createRigCamera
  44813. */
  44814. createRigCamera(name: string, cameraIndex: number): Camera;
  44815. /**
  44816. * @hidden
  44817. * @override
  44818. * Override Camera._updateRigCameras
  44819. */
  44820. _updateRigCameras(): void;
  44821. /**
  44822. * Destroy the camera and release the current resources hold by it.
  44823. */
  44824. dispose(): void;
  44825. /**
  44826. * Gets the current object class name.
  44827. * @return the class name
  44828. */
  44829. getClassName(): string;
  44830. }
  44831. }
  44832. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44833. import { Behavior } from "babylonjs/Behaviors/behavior";
  44834. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44835. /**
  44836. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44837. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44838. */
  44839. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44840. /**
  44841. * Gets the name of the behavior.
  44842. */
  44843. get name(): string;
  44844. private _zoomStopsAnimation;
  44845. private _idleRotationSpeed;
  44846. private _idleRotationWaitTime;
  44847. private _idleRotationSpinupTime;
  44848. /**
  44849. * Sets the flag that indicates if user zooming should stop animation.
  44850. */
  44851. set zoomStopsAnimation(flag: boolean);
  44852. /**
  44853. * Gets the flag that indicates if user zooming should stop animation.
  44854. */
  44855. get zoomStopsAnimation(): boolean;
  44856. /**
  44857. * Sets the default speed at which the camera rotates around the model.
  44858. */
  44859. set idleRotationSpeed(speed: number);
  44860. /**
  44861. * Gets the default speed at which the camera rotates around the model.
  44862. */
  44863. get idleRotationSpeed(): number;
  44864. /**
  44865. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44866. */
  44867. set idleRotationWaitTime(time: number);
  44868. /**
  44869. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44870. */
  44871. get idleRotationWaitTime(): number;
  44872. /**
  44873. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44874. */
  44875. set idleRotationSpinupTime(time: number);
  44876. /**
  44877. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44878. */
  44879. get idleRotationSpinupTime(): number;
  44880. /**
  44881. * Gets a value indicating if the camera is currently rotating because of this behavior
  44882. */
  44883. get rotationInProgress(): boolean;
  44884. private _onPrePointerObservableObserver;
  44885. private _onAfterCheckInputsObserver;
  44886. private _attachedCamera;
  44887. private _isPointerDown;
  44888. private _lastFrameTime;
  44889. private _lastInteractionTime;
  44890. private _cameraRotationSpeed;
  44891. /**
  44892. * Initializes the behavior.
  44893. */
  44894. init(): void;
  44895. /**
  44896. * Attaches the behavior to its arc rotate camera.
  44897. * @param camera Defines the camera to attach the behavior to
  44898. */
  44899. attach(camera: ArcRotateCamera): void;
  44900. /**
  44901. * Detaches the behavior from its current arc rotate camera.
  44902. */
  44903. detach(): void;
  44904. /**
  44905. * Returns true if user is scrolling.
  44906. * @return true if user is scrolling.
  44907. */
  44908. private _userIsZooming;
  44909. private _lastFrameRadius;
  44910. private _shouldAnimationStopForInteraction;
  44911. /**
  44912. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44913. */
  44914. private _applyUserInteraction;
  44915. private _userIsMoving;
  44916. }
  44917. }
  44918. declare module "babylonjs/Behaviors/Cameras/index" {
  44919. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44920. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44921. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44922. }
  44923. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44924. import { Mesh } from "babylonjs/Meshes/mesh";
  44925. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44926. import { Behavior } from "babylonjs/Behaviors/behavior";
  44927. /**
  44928. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44929. */
  44930. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44931. private ui;
  44932. /**
  44933. * The name of the behavior
  44934. */
  44935. name: string;
  44936. /**
  44937. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44938. */
  44939. distanceAwayFromFace: number;
  44940. /**
  44941. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44942. */
  44943. distanceAwayFromBottomOfFace: number;
  44944. private _faceVectors;
  44945. private _target;
  44946. private _scene;
  44947. private _onRenderObserver;
  44948. private _tmpMatrix;
  44949. private _tmpVector;
  44950. /**
  44951. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44952. * @param ui The transform node that should be attched to the mesh
  44953. */
  44954. constructor(ui: TransformNode);
  44955. /**
  44956. * Initializes the behavior
  44957. */
  44958. init(): void;
  44959. private _closestFace;
  44960. private _zeroVector;
  44961. private _lookAtTmpMatrix;
  44962. private _lookAtToRef;
  44963. /**
  44964. * Attaches the AttachToBoxBehavior to the passed in mesh
  44965. * @param target The mesh that the specified node will be attached to
  44966. */
  44967. attach(target: Mesh): void;
  44968. /**
  44969. * Detaches the behavior from the mesh
  44970. */
  44971. detach(): void;
  44972. }
  44973. }
  44974. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44975. import { Behavior } from "babylonjs/Behaviors/behavior";
  44976. import { Mesh } from "babylonjs/Meshes/mesh";
  44977. /**
  44978. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44979. */
  44980. export class FadeInOutBehavior implements Behavior<Mesh> {
  44981. /**
  44982. * Time in milliseconds to delay before fading in (Default: 0)
  44983. */
  44984. delay: number;
  44985. /**
  44986. * Time in milliseconds for the mesh to fade in (Default: 300)
  44987. */
  44988. fadeInTime: number;
  44989. private _millisecondsPerFrame;
  44990. private _hovered;
  44991. private _hoverValue;
  44992. private _ownerNode;
  44993. /**
  44994. * Instatiates the FadeInOutBehavior
  44995. */
  44996. constructor();
  44997. /**
  44998. * The name of the behavior
  44999. */
  45000. get name(): string;
  45001. /**
  45002. * Initializes the behavior
  45003. */
  45004. init(): void;
  45005. /**
  45006. * Attaches the fade behavior on the passed in mesh
  45007. * @param ownerNode The mesh that will be faded in/out once attached
  45008. */
  45009. attach(ownerNode: Mesh): void;
  45010. /**
  45011. * Detaches the behavior from the mesh
  45012. */
  45013. detach(): void;
  45014. /**
  45015. * Triggers the mesh to begin fading in or out
  45016. * @param value if the object should fade in or out (true to fade in)
  45017. */
  45018. fadeIn(value: boolean): void;
  45019. private _update;
  45020. private _setAllVisibility;
  45021. }
  45022. }
  45023. declare module "babylonjs/Misc/pivotTools" {
  45024. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45025. /**
  45026. * Class containing a set of static utilities functions for managing Pivots
  45027. * @hidden
  45028. */
  45029. export class PivotTools {
  45030. private static _PivotCached;
  45031. private static _OldPivotPoint;
  45032. private static _PivotTranslation;
  45033. private static _PivotTmpVector;
  45034. private static _PivotPostMultiplyPivotMatrix;
  45035. /** @hidden */
  45036. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  45037. /** @hidden */
  45038. static _RestorePivotPoint(mesh: AbstractMesh): void;
  45039. }
  45040. }
  45041. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  45042. import { Scene } from "babylonjs/scene";
  45043. import { Vector4 } from "babylonjs/Maths/math.vector";
  45044. import { Mesh } from "babylonjs/Meshes/mesh";
  45045. import { Nullable } from "babylonjs/types";
  45046. import { Plane } from "babylonjs/Maths/math.plane";
  45047. /**
  45048. * Class containing static functions to help procedurally build meshes
  45049. */
  45050. export class PlaneBuilder {
  45051. /**
  45052. * Creates a plane mesh
  45053. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  45054. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  45055. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  45056. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45057. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45058. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45059. * @param name defines the name of the mesh
  45060. * @param options defines the options used to create the mesh
  45061. * @param scene defines the hosting scene
  45062. * @returns the plane mesh
  45063. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  45064. */
  45065. static CreatePlane(name: string, options: {
  45066. size?: number;
  45067. width?: number;
  45068. height?: number;
  45069. sideOrientation?: number;
  45070. frontUVs?: Vector4;
  45071. backUVs?: Vector4;
  45072. updatable?: boolean;
  45073. sourcePlane?: Plane;
  45074. }, scene?: Nullable<Scene>): Mesh;
  45075. }
  45076. }
  45077. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  45078. import { Behavior } from "babylonjs/Behaviors/behavior";
  45079. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45080. import { Observable } from "babylonjs/Misc/observable";
  45081. import { Vector3 } from "babylonjs/Maths/math.vector";
  45082. import { Ray } from "babylonjs/Culling/ray";
  45083. import "babylonjs/Meshes/Builders/planeBuilder";
  45084. /**
  45085. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  45086. */
  45087. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  45088. private static _AnyMouseID;
  45089. /**
  45090. * Abstract mesh the behavior is set on
  45091. */
  45092. attachedNode: AbstractMesh;
  45093. private _dragPlane;
  45094. private _scene;
  45095. private _pointerObserver;
  45096. private _beforeRenderObserver;
  45097. private static _planeScene;
  45098. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  45099. /**
  45100. * 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)
  45101. */
  45102. maxDragAngle: number;
  45103. /**
  45104. * @hidden
  45105. */
  45106. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  45107. /**
  45108. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45109. */
  45110. currentDraggingPointerID: number;
  45111. /**
  45112. * The last position where the pointer hit the drag plane in world space
  45113. */
  45114. lastDragPosition: Vector3;
  45115. /**
  45116. * If the behavior is currently in a dragging state
  45117. */
  45118. dragging: boolean;
  45119. /**
  45120. * 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)
  45121. */
  45122. dragDeltaRatio: number;
  45123. /**
  45124. * If the drag plane orientation should be updated during the dragging (Default: true)
  45125. */
  45126. updateDragPlane: boolean;
  45127. private _debugMode;
  45128. private _moving;
  45129. /**
  45130. * Fires each time the attached mesh is dragged with the pointer
  45131. * * delta between last drag position and current drag position in world space
  45132. * * dragDistance along the drag axis
  45133. * * dragPlaneNormal normal of the current drag plane used during the drag
  45134. * * dragPlanePoint in world space where the drag intersects the drag plane
  45135. */
  45136. onDragObservable: Observable<{
  45137. delta: Vector3;
  45138. dragPlanePoint: Vector3;
  45139. dragPlaneNormal: Vector3;
  45140. dragDistance: number;
  45141. pointerId: number;
  45142. }>;
  45143. /**
  45144. * Fires each time a drag begins (eg. mouse down on mesh)
  45145. */
  45146. onDragStartObservable: Observable<{
  45147. dragPlanePoint: Vector3;
  45148. pointerId: number;
  45149. }>;
  45150. /**
  45151. * Fires each time a drag ends (eg. mouse release after drag)
  45152. */
  45153. onDragEndObservable: Observable<{
  45154. dragPlanePoint: Vector3;
  45155. pointerId: number;
  45156. }>;
  45157. /**
  45158. * If the attached mesh should be moved when dragged
  45159. */
  45160. moveAttached: boolean;
  45161. /**
  45162. * If the drag behavior will react to drag events (Default: true)
  45163. */
  45164. enabled: boolean;
  45165. /**
  45166. * If pointer events should start and release the drag (Default: true)
  45167. */
  45168. startAndReleaseDragOnPointerEvents: boolean;
  45169. /**
  45170. * If camera controls should be detached during the drag
  45171. */
  45172. detachCameraControls: boolean;
  45173. /**
  45174. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45175. */
  45176. useObjectOrientationForDragging: boolean;
  45177. private _options;
  45178. /**
  45179. * Gets the options used by the behavior
  45180. */
  45181. get options(): {
  45182. dragAxis?: Vector3;
  45183. dragPlaneNormal?: Vector3;
  45184. };
  45185. /**
  45186. * Sets the options used by the behavior
  45187. */
  45188. set options(options: {
  45189. dragAxis?: Vector3;
  45190. dragPlaneNormal?: Vector3;
  45191. });
  45192. /**
  45193. * Creates a pointer drag behavior that can be attached to a mesh
  45194. * @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)
  45195. */
  45196. constructor(options?: {
  45197. dragAxis?: Vector3;
  45198. dragPlaneNormal?: Vector3;
  45199. });
  45200. /**
  45201. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45202. */
  45203. validateDrag: (targetPosition: Vector3) => boolean;
  45204. /**
  45205. * The name of the behavior
  45206. */
  45207. get name(): string;
  45208. /**
  45209. * Initializes the behavior
  45210. */
  45211. init(): void;
  45212. private _tmpVector;
  45213. private _alternatePickedPoint;
  45214. private _worldDragAxis;
  45215. private _targetPosition;
  45216. private _attachedElement;
  45217. /**
  45218. * Attaches the drag behavior the passed in mesh
  45219. * @param ownerNode The mesh that will be dragged around once attached
  45220. * @param predicate Predicate to use for pick filtering
  45221. */
  45222. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45223. /**
  45224. * Force relase the drag action by code.
  45225. */
  45226. releaseDrag(): void;
  45227. private _startDragRay;
  45228. private _lastPointerRay;
  45229. /**
  45230. * Simulates the start of a pointer drag event on the behavior
  45231. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45232. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45233. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45234. */
  45235. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45236. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45237. private _dragDelta;
  45238. protected _moveDrag(ray: Ray): void;
  45239. private _pickWithRayOnDragPlane;
  45240. private _pointA;
  45241. private _pointC;
  45242. private _localAxis;
  45243. private _lookAt;
  45244. private _updateDragPlanePosition;
  45245. /**
  45246. * Detaches the behavior from the mesh
  45247. */
  45248. detach(): void;
  45249. }
  45250. }
  45251. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45252. import { Mesh } from "babylonjs/Meshes/mesh";
  45253. import { Behavior } from "babylonjs/Behaviors/behavior";
  45254. /**
  45255. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45256. */
  45257. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45258. private _dragBehaviorA;
  45259. private _dragBehaviorB;
  45260. private _startDistance;
  45261. private _initialScale;
  45262. private _targetScale;
  45263. private _ownerNode;
  45264. private _sceneRenderObserver;
  45265. /**
  45266. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45267. */
  45268. constructor();
  45269. /**
  45270. * The name of the behavior
  45271. */
  45272. get name(): string;
  45273. /**
  45274. * Initializes the behavior
  45275. */
  45276. init(): void;
  45277. private _getCurrentDistance;
  45278. /**
  45279. * Attaches the scale behavior the passed in mesh
  45280. * @param ownerNode The mesh that will be scaled around once attached
  45281. */
  45282. attach(ownerNode: Mesh): void;
  45283. /**
  45284. * Detaches the behavior from the mesh
  45285. */
  45286. detach(): void;
  45287. }
  45288. }
  45289. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45290. import { Behavior } from "babylonjs/Behaviors/behavior";
  45291. import { Mesh } from "babylonjs/Meshes/mesh";
  45292. import { Observable } from "babylonjs/Misc/observable";
  45293. /**
  45294. * 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
  45295. */
  45296. export class SixDofDragBehavior implements Behavior<Mesh> {
  45297. private static _virtualScene;
  45298. private _ownerNode;
  45299. private _sceneRenderObserver;
  45300. private _scene;
  45301. private _targetPosition;
  45302. private _virtualOriginMesh;
  45303. private _virtualDragMesh;
  45304. private _pointerObserver;
  45305. private _moving;
  45306. private _startingOrientation;
  45307. private _attachedElement;
  45308. /**
  45309. * 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)
  45310. */
  45311. private zDragFactor;
  45312. /**
  45313. * If the object should rotate to face the drag origin
  45314. */
  45315. rotateDraggedObject: boolean;
  45316. /**
  45317. * If the behavior is currently in a dragging state
  45318. */
  45319. dragging: boolean;
  45320. /**
  45321. * 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)
  45322. */
  45323. dragDeltaRatio: number;
  45324. /**
  45325. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45326. */
  45327. currentDraggingPointerID: number;
  45328. /**
  45329. * If camera controls should be detached during the drag
  45330. */
  45331. detachCameraControls: boolean;
  45332. /**
  45333. * Fires each time a drag starts
  45334. */
  45335. onDragStartObservable: Observable<{}>;
  45336. /**
  45337. * Fires each time a drag ends (eg. mouse release after drag)
  45338. */
  45339. onDragEndObservable: Observable<{}>;
  45340. /**
  45341. * 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
  45342. */
  45343. constructor();
  45344. /**
  45345. * The name of the behavior
  45346. */
  45347. get name(): string;
  45348. /**
  45349. * Initializes the behavior
  45350. */
  45351. init(): void;
  45352. /**
  45353. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45354. */
  45355. private get _pointerCamera();
  45356. /**
  45357. * Attaches the scale behavior the passed in mesh
  45358. * @param ownerNode The mesh that will be scaled around once attached
  45359. */
  45360. attach(ownerNode: Mesh): void;
  45361. /**
  45362. * Detaches the behavior from the mesh
  45363. */
  45364. detach(): void;
  45365. }
  45366. }
  45367. declare module "babylonjs/Behaviors/Meshes/index" {
  45368. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45369. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45370. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45371. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45372. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45373. }
  45374. declare module "babylonjs/Behaviors/index" {
  45375. export * from "babylonjs/Behaviors/behavior";
  45376. export * from "babylonjs/Behaviors/Cameras/index";
  45377. export * from "babylonjs/Behaviors/Meshes/index";
  45378. }
  45379. declare module "babylonjs/Bones/boneIKController" {
  45380. import { Bone } from "babylonjs/Bones/bone";
  45381. import { Vector3 } from "babylonjs/Maths/math.vector";
  45382. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45383. import { Nullable } from "babylonjs/types";
  45384. /**
  45385. * Class used to apply inverse kinematics to bones
  45386. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45387. */
  45388. export class BoneIKController {
  45389. private static _tmpVecs;
  45390. private static _tmpQuat;
  45391. private static _tmpMats;
  45392. /**
  45393. * Gets or sets the target mesh
  45394. */
  45395. targetMesh: AbstractMesh;
  45396. /** Gets or sets the mesh used as pole */
  45397. poleTargetMesh: AbstractMesh;
  45398. /**
  45399. * Gets or sets the bone used as pole
  45400. */
  45401. poleTargetBone: Nullable<Bone>;
  45402. /**
  45403. * Gets or sets the target position
  45404. */
  45405. targetPosition: Vector3;
  45406. /**
  45407. * Gets or sets the pole target position
  45408. */
  45409. poleTargetPosition: Vector3;
  45410. /**
  45411. * Gets or sets the pole target local offset
  45412. */
  45413. poleTargetLocalOffset: Vector3;
  45414. /**
  45415. * Gets or sets the pole angle
  45416. */
  45417. poleAngle: number;
  45418. /**
  45419. * Gets or sets the mesh associated with the controller
  45420. */
  45421. mesh: AbstractMesh;
  45422. /**
  45423. * 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)
  45424. */
  45425. slerpAmount: number;
  45426. private _bone1Quat;
  45427. private _bone1Mat;
  45428. private _bone2Ang;
  45429. private _bone1;
  45430. private _bone2;
  45431. private _bone1Length;
  45432. private _bone2Length;
  45433. private _maxAngle;
  45434. private _maxReach;
  45435. private _rightHandedSystem;
  45436. private _bendAxis;
  45437. private _slerping;
  45438. private _adjustRoll;
  45439. /**
  45440. * Gets or sets maximum allowed angle
  45441. */
  45442. get maxAngle(): number;
  45443. set maxAngle(value: number);
  45444. /**
  45445. * Creates a new BoneIKController
  45446. * @param mesh defines the mesh to control
  45447. * @param bone defines the bone to control
  45448. * @param options defines options to set up the controller
  45449. */
  45450. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45451. targetMesh?: AbstractMesh;
  45452. poleTargetMesh?: AbstractMesh;
  45453. poleTargetBone?: Bone;
  45454. poleTargetLocalOffset?: Vector3;
  45455. poleAngle?: number;
  45456. bendAxis?: Vector3;
  45457. maxAngle?: number;
  45458. slerpAmount?: number;
  45459. });
  45460. private _setMaxAngle;
  45461. /**
  45462. * Force the controller to update the bones
  45463. */
  45464. update(): void;
  45465. }
  45466. }
  45467. declare module "babylonjs/Bones/boneLookController" {
  45468. import { Vector3 } from "babylonjs/Maths/math.vector";
  45469. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45470. import { Bone } from "babylonjs/Bones/bone";
  45471. import { Space } from "babylonjs/Maths/math.axis";
  45472. /**
  45473. * Class used to make a bone look toward a point in space
  45474. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45475. */
  45476. export class BoneLookController {
  45477. private static _tmpVecs;
  45478. private static _tmpQuat;
  45479. private static _tmpMats;
  45480. /**
  45481. * The target Vector3 that the bone will look at
  45482. */
  45483. target: Vector3;
  45484. /**
  45485. * The mesh that the bone is attached to
  45486. */
  45487. mesh: AbstractMesh;
  45488. /**
  45489. * The bone that will be looking to the target
  45490. */
  45491. bone: Bone;
  45492. /**
  45493. * The up axis of the coordinate system that is used when the bone is rotated
  45494. */
  45495. upAxis: Vector3;
  45496. /**
  45497. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45498. */
  45499. upAxisSpace: Space;
  45500. /**
  45501. * Used to make an adjustment to the yaw of the bone
  45502. */
  45503. adjustYaw: number;
  45504. /**
  45505. * Used to make an adjustment to the pitch of the bone
  45506. */
  45507. adjustPitch: number;
  45508. /**
  45509. * Used to make an adjustment to the roll of the bone
  45510. */
  45511. adjustRoll: number;
  45512. /**
  45513. * 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)
  45514. */
  45515. slerpAmount: number;
  45516. private _minYaw;
  45517. private _maxYaw;
  45518. private _minPitch;
  45519. private _maxPitch;
  45520. private _minYawSin;
  45521. private _minYawCos;
  45522. private _maxYawSin;
  45523. private _maxYawCos;
  45524. private _midYawConstraint;
  45525. private _minPitchTan;
  45526. private _maxPitchTan;
  45527. private _boneQuat;
  45528. private _slerping;
  45529. private _transformYawPitch;
  45530. private _transformYawPitchInv;
  45531. private _firstFrameSkipped;
  45532. private _yawRange;
  45533. private _fowardAxis;
  45534. /**
  45535. * Gets or sets the minimum yaw angle that the bone can look to
  45536. */
  45537. get minYaw(): number;
  45538. set minYaw(value: number);
  45539. /**
  45540. * Gets or sets the maximum yaw angle that the bone can look to
  45541. */
  45542. get maxYaw(): number;
  45543. set maxYaw(value: number);
  45544. /**
  45545. * Gets or sets the minimum pitch angle that the bone can look to
  45546. */
  45547. get minPitch(): number;
  45548. set minPitch(value: number);
  45549. /**
  45550. * Gets or sets the maximum pitch angle that the bone can look to
  45551. */
  45552. get maxPitch(): number;
  45553. set maxPitch(value: number);
  45554. /**
  45555. * Create a BoneLookController
  45556. * @param mesh the mesh that the bone belongs to
  45557. * @param bone the bone that will be looking to the target
  45558. * @param target the target Vector3 to look at
  45559. * @param options optional settings:
  45560. * * maxYaw: the maximum angle the bone will yaw to
  45561. * * minYaw: the minimum angle the bone will yaw to
  45562. * * maxPitch: the maximum angle the bone will pitch to
  45563. * * minPitch: the minimum angle the bone will yaw to
  45564. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45565. * * upAxis: the up axis of the coordinate system
  45566. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45567. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45568. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45569. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45570. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45571. * * adjustRoll: used to make an adjustment to the roll of the bone
  45572. **/
  45573. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45574. maxYaw?: number;
  45575. minYaw?: number;
  45576. maxPitch?: number;
  45577. minPitch?: number;
  45578. slerpAmount?: number;
  45579. upAxis?: Vector3;
  45580. upAxisSpace?: Space;
  45581. yawAxis?: Vector3;
  45582. pitchAxis?: Vector3;
  45583. adjustYaw?: number;
  45584. adjustPitch?: number;
  45585. adjustRoll?: number;
  45586. });
  45587. /**
  45588. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45589. */
  45590. update(): void;
  45591. private _getAngleDiff;
  45592. private _getAngleBetween;
  45593. private _isAngleBetween;
  45594. }
  45595. }
  45596. declare module "babylonjs/Bones/index" {
  45597. export * from "babylonjs/Bones/bone";
  45598. export * from "babylonjs/Bones/boneIKController";
  45599. export * from "babylonjs/Bones/boneLookController";
  45600. export * from "babylonjs/Bones/skeleton";
  45601. }
  45602. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45603. import { Nullable } from "babylonjs/types";
  45604. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45605. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45606. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45607. /**
  45608. * Manage the gamepad inputs to control an arc rotate camera.
  45609. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45610. */
  45611. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45612. /**
  45613. * Defines the camera the input is attached to.
  45614. */
  45615. camera: ArcRotateCamera;
  45616. /**
  45617. * Defines the gamepad the input is gathering event from.
  45618. */
  45619. gamepad: Nullable<Gamepad>;
  45620. /**
  45621. * Defines the gamepad rotation sensiblity.
  45622. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45623. */
  45624. gamepadRotationSensibility: number;
  45625. /**
  45626. * Defines the gamepad move sensiblity.
  45627. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45628. */
  45629. gamepadMoveSensibility: number;
  45630. private _yAxisScale;
  45631. /**
  45632. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45633. */
  45634. get invertYAxis(): boolean;
  45635. set invertYAxis(value: boolean);
  45636. private _onGamepadConnectedObserver;
  45637. private _onGamepadDisconnectedObserver;
  45638. /**
  45639. * Attach the input controls to a specific dom element to get the input from.
  45640. * @param element Defines the element the controls should be listened from
  45641. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45642. */
  45643. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45644. /**
  45645. * Detach the current controls from the specified dom element.
  45646. * @param element Defines the element to stop listening the inputs from
  45647. */
  45648. detachControl(element: Nullable<HTMLElement>): void;
  45649. /**
  45650. * Update the current camera state depending on the inputs that have been used this frame.
  45651. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45652. */
  45653. checkInputs(): void;
  45654. /**
  45655. * Gets the class name of the current intput.
  45656. * @returns the class name
  45657. */
  45658. getClassName(): string;
  45659. /**
  45660. * Get the friendly name associated with the input class.
  45661. * @returns the input friendly name
  45662. */
  45663. getSimpleName(): string;
  45664. }
  45665. }
  45666. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45667. import { Nullable } from "babylonjs/types";
  45668. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45669. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45670. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45671. interface ArcRotateCameraInputsManager {
  45672. /**
  45673. * Add orientation input support to the input manager.
  45674. * @returns the current input manager
  45675. */
  45676. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45677. }
  45678. }
  45679. /**
  45680. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45681. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45682. */
  45683. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45684. /**
  45685. * Defines the camera the input is attached to.
  45686. */
  45687. camera: ArcRotateCamera;
  45688. /**
  45689. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45690. */
  45691. alphaCorrection: number;
  45692. /**
  45693. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45694. */
  45695. gammaCorrection: number;
  45696. private _alpha;
  45697. private _gamma;
  45698. private _dirty;
  45699. private _deviceOrientationHandler;
  45700. /**
  45701. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45702. */
  45703. constructor();
  45704. /**
  45705. * Attach the input controls to a specific dom element to get the input from.
  45706. * @param element Defines the element the controls should be listened from
  45707. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45708. */
  45709. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45710. /** @hidden */
  45711. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45712. /**
  45713. * Update the current camera state depending on the inputs that have been used this frame.
  45714. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45715. */
  45716. checkInputs(): void;
  45717. /**
  45718. * Detach the current controls from the specified dom element.
  45719. * @param element Defines the element to stop listening the inputs from
  45720. */
  45721. detachControl(element: Nullable<HTMLElement>): void;
  45722. /**
  45723. * Gets the class name of the current intput.
  45724. * @returns the class name
  45725. */
  45726. getClassName(): string;
  45727. /**
  45728. * Get the friendly name associated with the input class.
  45729. * @returns the input friendly name
  45730. */
  45731. getSimpleName(): string;
  45732. }
  45733. }
  45734. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45735. import { Nullable } from "babylonjs/types";
  45736. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45737. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45738. /**
  45739. * Listen to mouse events to control the camera.
  45740. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45741. */
  45742. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45743. /**
  45744. * Defines the camera the input is attached to.
  45745. */
  45746. camera: FlyCamera;
  45747. /**
  45748. * Defines if touch is enabled. (Default is true.)
  45749. */
  45750. touchEnabled: boolean;
  45751. /**
  45752. * Defines the buttons associated with the input to handle camera rotation.
  45753. */
  45754. buttons: number[];
  45755. /**
  45756. * Assign buttons for Yaw control.
  45757. */
  45758. buttonsYaw: number[];
  45759. /**
  45760. * Assign buttons for Pitch control.
  45761. */
  45762. buttonsPitch: number[];
  45763. /**
  45764. * Assign buttons for Roll control.
  45765. */
  45766. buttonsRoll: number[];
  45767. /**
  45768. * Detect if any button is being pressed while mouse is moved.
  45769. * -1 = Mouse locked.
  45770. * 0 = Left button.
  45771. * 1 = Middle Button.
  45772. * 2 = Right Button.
  45773. */
  45774. activeButton: number;
  45775. /**
  45776. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45777. * Higher values reduce its sensitivity.
  45778. */
  45779. angularSensibility: number;
  45780. private _mousemoveCallback;
  45781. private _observer;
  45782. private _rollObserver;
  45783. private previousPosition;
  45784. private noPreventDefault;
  45785. private element;
  45786. /**
  45787. * Listen to mouse events to control the camera.
  45788. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45789. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45790. */
  45791. constructor(touchEnabled?: boolean);
  45792. /**
  45793. * Attach the mouse control to the HTML DOM element.
  45794. * @param element Defines the element that listens to the input events.
  45795. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45796. */
  45797. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45798. /**
  45799. * Detach the current controls from the specified dom element.
  45800. * @param element Defines the element to stop listening the inputs from
  45801. */
  45802. detachControl(element: Nullable<HTMLElement>): void;
  45803. /**
  45804. * Gets the class name of the current input.
  45805. * @returns the class name.
  45806. */
  45807. getClassName(): string;
  45808. /**
  45809. * Get the friendly name associated with the input class.
  45810. * @returns the input's friendly name.
  45811. */
  45812. getSimpleName(): string;
  45813. private _pointerInput;
  45814. private _onMouseMove;
  45815. /**
  45816. * Rotate camera by mouse offset.
  45817. */
  45818. private rotateCamera;
  45819. }
  45820. }
  45821. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45822. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45823. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45824. /**
  45825. * Default Inputs manager for the FlyCamera.
  45826. * It groups all the default supported inputs for ease of use.
  45827. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45828. */
  45829. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45830. /**
  45831. * Instantiates a new FlyCameraInputsManager.
  45832. * @param camera Defines the camera the inputs belong to.
  45833. */
  45834. constructor(camera: FlyCamera);
  45835. /**
  45836. * Add keyboard input support to the input manager.
  45837. * @returns the new FlyCameraKeyboardMoveInput().
  45838. */
  45839. addKeyboard(): FlyCameraInputsManager;
  45840. /**
  45841. * Add mouse input support to the input manager.
  45842. * @param touchEnabled Enable touch screen support.
  45843. * @returns the new FlyCameraMouseInput().
  45844. */
  45845. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45846. }
  45847. }
  45848. declare module "babylonjs/Cameras/flyCamera" {
  45849. import { Scene } from "babylonjs/scene";
  45850. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45851. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45852. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45853. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45854. /**
  45855. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45856. * such as in a 3D Space Shooter or a Flight Simulator.
  45857. */
  45858. export class FlyCamera extends TargetCamera {
  45859. /**
  45860. * Define the collision ellipsoid of the camera.
  45861. * This is helpful for simulating a camera body, like a player's body.
  45862. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45863. */
  45864. ellipsoid: Vector3;
  45865. /**
  45866. * Define an offset for the position of the ellipsoid around the camera.
  45867. * This can be helpful if the camera is attached away from the player's body center,
  45868. * such as at its head.
  45869. */
  45870. ellipsoidOffset: Vector3;
  45871. /**
  45872. * Enable or disable collisions of the camera with the rest of the scene objects.
  45873. */
  45874. checkCollisions: boolean;
  45875. /**
  45876. * Enable or disable gravity on the camera.
  45877. */
  45878. applyGravity: boolean;
  45879. /**
  45880. * Define the current direction the camera is moving to.
  45881. */
  45882. cameraDirection: Vector3;
  45883. /**
  45884. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45885. * This overrides and empties cameraRotation.
  45886. */
  45887. rotationQuaternion: Quaternion;
  45888. /**
  45889. * Track Roll to maintain the wanted Rolling when looking around.
  45890. */
  45891. _trackRoll: number;
  45892. /**
  45893. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45894. */
  45895. rollCorrect: number;
  45896. /**
  45897. * Mimic a banked turn, Rolling the camera when Yawing.
  45898. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45899. */
  45900. bankedTurn: boolean;
  45901. /**
  45902. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45903. */
  45904. bankedTurnLimit: number;
  45905. /**
  45906. * Value of 0 disables the banked Roll.
  45907. * Value of 1 is equal to the Yaw angle in radians.
  45908. */
  45909. bankedTurnMultiplier: number;
  45910. /**
  45911. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45912. */
  45913. inputs: FlyCameraInputsManager;
  45914. /**
  45915. * Gets the input sensibility for mouse input.
  45916. * Higher values reduce sensitivity.
  45917. */
  45918. get angularSensibility(): number;
  45919. /**
  45920. * Sets the input sensibility for a mouse input.
  45921. * Higher values reduce sensitivity.
  45922. */
  45923. set angularSensibility(value: number);
  45924. /**
  45925. * Get the keys for camera movement forward.
  45926. */
  45927. get keysForward(): number[];
  45928. /**
  45929. * Set the keys for camera movement forward.
  45930. */
  45931. set keysForward(value: number[]);
  45932. /**
  45933. * Get the keys for camera movement backward.
  45934. */
  45935. get keysBackward(): number[];
  45936. set keysBackward(value: number[]);
  45937. /**
  45938. * Get the keys for camera movement up.
  45939. */
  45940. get keysUp(): number[];
  45941. /**
  45942. * Set the keys for camera movement up.
  45943. */
  45944. set keysUp(value: number[]);
  45945. /**
  45946. * Get the keys for camera movement down.
  45947. */
  45948. get keysDown(): number[];
  45949. /**
  45950. * Set the keys for camera movement down.
  45951. */
  45952. set keysDown(value: number[]);
  45953. /**
  45954. * Get the keys for camera movement left.
  45955. */
  45956. get keysLeft(): number[];
  45957. /**
  45958. * Set the keys for camera movement left.
  45959. */
  45960. set keysLeft(value: number[]);
  45961. /**
  45962. * Set the keys for camera movement right.
  45963. */
  45964. get keysRight(): number[];
  45965. /**
  45966. * Set the keys for camera movement right.
  45967. */
  45968. set keysRight(value: number[]);
  45969. /**
  45970. * Event raised when the camera collides with a mesh in the scene.
  45971. */
  45972. onCollide: (collidedMesh: AbstractMesh) => void;
  45973. private _collider;
  45974. private _needMoveForGravity;
  45975. private _oldPosition;
  45976. private _diffPosition;
  45977. private _newPosition;
  45978. /** @hidden */
  45979. _localDirection: Vector3;
  45980. /** @hidden */
  45981. _transformedDirection: Vector3;
  45982. /**
  45983. * Instantiates a FlyCamera.
  45984. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45985. * such as in a 3D Space Shooter or a Flight Simulator.
  45986. * @param name Define the name of the camera in the scene.
  45987. * @param position Define the starting position of the camera in the scene.
  45988. * @param scene Define the scene the camera belongs to.
  45989. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45990. */
  45991. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45992. /**
  45993. * Attach a control to the HTML DOM element.
  45994. * @param element Defines the element that listens to the input events.
  45995. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45996. */
  45997. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45998. /**
  45999. * Detach a control from the HTML DOM element.
  46000. * The camera will stop reacting to that input.
  46001. * @param element Defines the element that listens to the input events.
  46002. */
  46003. detachControl(element: HTMLElement): void;
  46004. private _collisionMask;
  46005. /**
  46006. * Get the mask that the camera ignores in collision events.
  46007. */
  46008. get collisionMask(): number;
  46009. /**
  46010. * Set the mask that the camera ignores in collision events.
  46011. */
  46012. set collisionMask(mask: number);
  46013. /** @hidden */
  46014. _collideWithWorld(displacement: Vector3): void;
  46015. /** @hidden */
  46016. private _onCollisionPositionChange;
  46017. /** @hidden */
  46018. _checkInputs(): void;
  46019. /** @hidden */
  46020. _decideIfNeedsToMove(): boolean;
  46021. /** @hidden */
  46022. _updatePosition(): void;
  46023. /**
  46024. * Restore the Roll to its target value at the rate specified.
  46025. * @param rate - Higher means slower restoring.
  46026. * @hidden
  46027. */
  46028. restoreRoll(rate: number): void;
  46029. /**
  46030. * Destroy the camera and release the current resources held by it.
  46031. */
  46032. dispose(): void;
  46033. /**
  46034. * Get the current object class name.
  46035. * @returns the class name.
  46036. */
  46037. getClassName(): string;
  46038. }
  46039. }
  46040. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  46041. import { Nullable } from "babylonjs/types";
  46042. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46043. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  46044. /**
  46045. * Listen to keyboard events to control the camera.
  46046. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46047. */
  46048. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  46049. /**
  46050. * Defines the camera the input is attached to.
  46051. */
  46052. camera: FlyCamera;
  46053. /**
  46054. * The list of keyboard keys used to control the forward move of the camera.
  46055. */
  46056. keysForward: number[];
  46057. /**
  46058. * The list of keyboard keys used to control the backward move of the camera.
  46059. */
  46060. keysBackward: number[];
  46061. /**
  46062. * The list of keyboard keys used to control the forward move of the camera.
  46063. */
  46064. keysUp: number[];
  46065. /**
  46066. * The list of keyboard keys used to control the backward move of the camera.
  46067. */
  46068. keysDown: number[];
  46069. /**
  46070. * The list of keyboard keys used to control the right strafe move of the camera.
  46071. */
  46072. keysRight: number[];
  46073. /**
  46074. * The list of keyboard keys used to control the left strafe move of the camera.
  46075. */
  46076. keysLeft: number[];
  46077. private _keys;
  46078. private _onCanvasBlurObserver;
  46079. private _onKeyboardObserver;
  46080. private _engine;
  46081. private _scene;
  46082. /**
  46083. * Attach the input controls to a specific dom element to get the input from.
  46084. * @param element Defines the element the controls should be listened from
  46085. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46086. */
  46087. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46088. /**
  46089. * Detach the current controls from the specified dom element.
  46090. * @param element Defines the element to stop listening the inputs from
  46091. */
  46092. detachControl(element: Nullable<HTMLElement>): void;
  46093. /**
  46094. * Gets the class name of the current intput.
  46095. * @returns the class name
  46096. */
  46097. getClassName(): string;
  46098. /** @hidden */
  46099. _onLostFocus(e: FocusEvent): void;
  46100. /**
  46101. * Get the friendly name associated with the input class.
  46102. * @returns the input friendly name
  46103. */
  46104. getSimpleName(): string;
  46105. /**
  46106. * Update the current camera state depending on the inputs that have been used this frame.
  46107. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46108. */
  46109. checkInputs(): void;
  46110. }
  46111. }
  46112. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  46113. import { Nullable } from "babylonjs/types";
  46114. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46115. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46116. /**
  46117. * Manage the mouse wheel inputs to control a follow camera.
  46118. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46119. */
  46120. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  46121. /**
  46122. * Defines the camera the input is attached to.
  46123. */
  46124. camera: FollowCamera;
  46125. /**
  46126. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  46127. */
  46128. axisControlRadius: boolean;
  46129. /**
  46130. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46131. */
  46132. axisControlHeight: boolean;
  46133. /**
  46134. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46135. */
  46136. axisControlRotation: boolean;
  46137. /**
  46138. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46139. * relation to mouseWheel events.
  46140. */
  46141. wheelPrecision: number;
  46142. /**
  46143. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46144. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46145. */
  46146. wheelDeltaPercentage: number;
  46147. private _wheel;
  46148. private _observer;
  46149. /**
  46150. * Attach the input controls to a specific dom element to get the input from.
  46151. * @param element Defines the element the controls should be listened from
  46152. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46153. */
  46154. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46155. /**
  46156. * Detach the current controls from the specified dom element.
  46157. * @param element Defines the element to stop listening the inputs from
  46158. */
  46159. detachControl(element: Nullable<HTMLElement>): void;
  46160. /**
  46161. * Gets the class name of the current intput.
  46162. * @returns the class name
  46163. */
  46164. getClassName(): string;
  46165. /**
  46166. * Get the friendly name associated with the input class.
  46167. * @returns the input friendly name
  46168. */
  46169. getSimpleName(): string;
  46170. }
  46171. }
  46172. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46173. import { Nullable } from "babylonjs/types";
  46174. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46175. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46176. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46177. /**
  46178. * Manage the pointers inputs to control an follow camera.
  46179. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46180. */
  46181. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46182. /**
  46183. * Defines the camera the input is attached to.
  46184. */
  46185. camera: FollowCamera;
  46186. /**
  46187. * Gets the class name of the current input.
  46188. * @returns the class name
  46189. */
  46190. getClassName(): string;
  46191. /**
  46192. * Defines the pointer angular sensibility along the X axis or how fast is
  46193. * the camera rotating.
  46194. * A negative number will reverse the axis direction.
  46195. */
  46196. angularSensibilityX: number;
  46197. /**
  46198. * Defines the pointer angular sensibility along the Y axis or how fast is
  46199. * the camera rotating.
  46200. * A negative number will reverse the axis direction.
  46201. */
  46202. angularSensibilityY: number;
  46203. /**
  46204. * Defines the pointer pinch precision or how fast is the camera zooming.
  46205. * A negative number will reverse the axis direction.
  46206. */
  46207. pinchPrecision: number;
  46208. /**
  46209. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46210. * from 0.
  46211. * It defines the percentage of current camera.radius to use as delta when
  46212. * pinch zoom is used.
  46213. */
  46214. pinchDeltaPercentage: number;
  46215. /**
  46216. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46217. */
  46218. axisXControlRadius: boolean;
  46219. /**
  46220. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46221. */
  46222. axisXControlHeight: boolean;
  46223. /**
  46224. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46225. */
  46226. axisXControlRotation: boolean;
  46227. /**
  46228. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46229. */
  46230. axisYControlRadius: boolean;
  46231. /**
  46232. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46233. */
  46234. axisYControlHeight: boolean;
  46235. /**
  46236. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46237. */
  46238. axisYControlRotation: boolean;
  46239. /**
  46240. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46241. */
  46242. axisPinchControlRadius: boolean;
  46243. /**
  46244. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46245. */
  46246. axisPinchControlHeight: boolean;
  46247. /**
  46248. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46249. */
  46250. axisPinchControlRotation: boolean;
  46251. /**
  46252. * Log error messages if basic misconfiguration has occurred.
  46253. */
  46254. warningEnable: boolean;
  46255. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46256. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46257. private _warningCounter;
  46258. private _warning;
  46259. }
  46260. }
  46261. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46262. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46263. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46264. /**
  46265. * Default Inputs manager for the FollowCamera.
  46266. * It groups all the default supported inputs for ease of use.
  46267. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46268. */
  46269. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46270. /**
  46271. * Instantiates a new FollowCameraInputsManager.
  46272. * @param camera Defines the camera the inputs belong to
  46273. */
  46274. constructor(camera: FollowCamera);
  46275. /**
  46276. * Add keyboard input support to the input manager.
  46277. * @returns the current input manager
  46278. */
  46279. addKeyboard(): FollowCameraInputsManager;
  46280. /**
  46281. * Add mouse wheel input support to the input manager.
  46282. * @returns the current input manager
  46283. */
  46284. addMouseWheel(): FollowCameraInputsManager;
  46285. /**
  46286. * Add pointers input support to the input manager.
  46287. * @returns the current input manager
  46288. */
  46289. addPointers(): FollowCameraInputsManager;
  46290. /**
  46291. * Add orientation input support to the input manager.
  46292. * @returns the current input manager
  46293. */
  46294. addVRDeviceOrientation(): FollowCameraInputsManager;
  46295. }
  46296. }
  46297. declare module "babylonjs/Cameras/followCamera" {
  46298. import { Nullable } from "babylonjs/types";
  46299. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46300. import { Scene } from "babylonjs/scene";
  46301. import { Vector3 } from "babylonjs/Maths/math.vector";
  46302. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46303. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46304. /**
  46305. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46306. * an arc rotate version arcFollowCamera are available.
  46307. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46308. */
  46309. export class FollowCamera extends TargetCamera {
  46310. /**
  46311. * Distance the follow camera should follow an object at
  46312. */
  46313. radius: number;
  46314. /**
  46315. * Minimum allowed distance of the camera to the axis of rotation
  46316. * (The camera can not get closer).
  46317. * This can help limiting how the Camera is able to move in the scene.
  46318. */
  46319. lowerRadiusLimit: Nullable<number>;
  46320. /**
  46321. * Maximum allowed distance of the camera to the axis of rotation
  46322. * (The camera can not get further).
  46323. * This can help limiting how the Camera is able to move in the scene.
  46324. */
  46325. upperRadiusLimit: Nullable<number>;
  46326. /**
  46327. * Define a rotation offset between the camera and the object it follows
  46328. */
  46329. rotationOffset: number;
  46330. /**
  46331. * Minimum allowed angle to camera position relative to target object.
  46332. * This can help limiting how the Camera is able to move in the scene.
  46333. */
  46334. lowerRotationOffsetLimit: Nullable<number>;
  46335. /**
  46336. * Maximum allowed angle to camera position relative to target object.
  46337. * This can help limiting how the Camera is able to move in the scene.
  46338. */
  46339. upperRotationOffsetLimit: Nullable<number>;
  46340. /**
  46341. * Define a height offset between the camera and the object it follows.
  46342. * It can help following an object from the top (like a car chaing a plane)
  46343. */
  46344. heightOffset: number;
  46345. /**
  46346. * Minimum allowed height of camera position relative to target object.
  46347. * This can help limiting how the Camera is able to move in the scene.
  46348. */
  46349. lowerHeightOffsetLimit: Nullable<number>;
  46350. /**
  46351. * Maximum allowed height of camera position relative to target object.
  46352. * This can help limiting how the Camera is able to move in the scene.
  46353. */
  46354. upperHeightOffsetLimit: Nullable<number>;
  46355. /**
  46356. * Define how fast the camera can accelerate to follow it s target.
  46357. */
  46358. cameraAcceleration: number;
  46359. /**
  46360. * Define the speed limit of the camera following an object.
  46361. */
  46362. maxCameraSpeed: number;
  46363. /**
  46364. * Define the target of the camera.
  46365. */
  46366. lockedTarget: Nullable<AbstractMesh>;
  46367. /**
  46368. * Defines the input associated with the camera.
  46369. */
  46370. inputs: FollowCameraInputsManager;
  46371. /**
  46372. * Instantiates the follow camera.
  46373. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46374. * @param name Define the name of the camera in the scene
  46375. * @param position Define the position of the camera
  46376. * @param scene Define the scene the camera belong to
  46377. * @param lockedTarget Define the target of the camera
  46378. */
  46379. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46380. private _follow;
  46381. /**
  46382. * Attached controls to the current camera.
  46383. * @param element Defines the element the controls should be listened from
  46384. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46385. */
  46386. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46387. /**
  46388. * Detach the current controls from the camera.
  46389. * The camera will stop reacting to inputs.
  46390. * @param element Defines the element to stop listening the inputs from
  46391. */
  46392. detachControl(element: HTMLElement): void;
  46393. /** @hidden */
  46394. _checkInputs(): void;
  46395. private _checkLimits;
  46396. /**
  46397. * Gets the camera class name.
  46398. * @returns the class name
  46399. */
  46400. getClassName(): string;
  46401. }
  46402. /**
  46403. * Arc Rotate version of the follow camera.
  46404. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46405. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46406. */
  46407. export class ArcFollowCamera extends TargetCamera {
  46408. /** The longitudinal angle of the camera */
  46409. alpha: number;
  46410. /** The latitudinal angle of the camera */
  46411. beta: number;
  46412. /** The radius of the camera from its target */
  46413. radius: number;
  46414. private _cartesianCoordinates;
  46415. /** Define the camera target (the mesh it should follow) */
  46416. private _meshTarget;
  46417. /**
  46418. * Instantiates a new ArcFollowCamera
  46419. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46420. * @param name Define the name of the camera
  46421. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46422. * @param beta Define the rotation angle of the camera around the elevation axis
  46423. * @param radius Define the radius of the camera from its target point
  46424. * @param target Define the target of the camera
  46425. * @param scene Define the scene the camera belongs to
  46426. */
  46427. constructor(name: string,
  46428. /** The longitudinal angle of the camera */
  46429. alpha: number,
  46430. /** The latitudinal angle of the camera */
  46431. beta: number,
  46432. /** The radius of the camera from its target */
  46433. radius: number,
  46434. /** Define the camera target (the mesh it should follow) */
  46435. target: Nullable<AbstractMesh>, scene: Scene);
  46436. private _follow;
  46437. /** @hidden */
  46438. _checkInputs(): void;
  46439. /**
  46440. * Returns the class name of the object.
  46441. * It is mostly used internally for serialization purposes.
  46442. */
  46443. getClassName(): string;
  46444. }
  46445. }
  46446. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46447. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46448. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46449. import { Nullable } from "babylonjs/types";
  46450. /**
  46451. * Manage the keyboard inputs to control the movement of a follow camera.
  46452. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46453. */
  46454. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46455. /**
  46456. * Defines the camera the input is attached to.
  46457. */
  46458. camera: FollowCamera;
  46459. /**
  46460. * Defines the list of key codes associated with the up action (increase heightOffset)
  46461. */
  46462. keysHeightOffsetIncr: number[];
  46463. /**
  46464. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46465. */
  46466. keysHeightOffsetDecr: number[];
  46467. /**
  46468. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46469. */
  46470. keysHeightOffsetModifierAlt: boolean;
  46471. /**
  46472. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46473. */
  46474. keysHeightOffsetModifierCtrl: boolean;
  46475. /**
  46476. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46477. */
  46478. keysHeightOffsetModifierShift: boolean;
  46479. /**
  46480. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46481. */
  46482. keysRotationOffsetIncr: number[];
  46483. /**
  46484. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46485. */
  46486. keysRotationOffsetDecr: number[];
  46487. /**
  46488. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46489. */
  46490. keysRotationOffsetModifierAlt: boolean;
  46491. /**
  46492. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46493. */
  46494. keysRotationOffsetModifierCtrl: boolean;
  46495. /**
  46496. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46497. */
  46498. keysRotationOffsetModifierShift: boolean;
  46499. /**
  46500. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46501. */
  46502. keysRadiusIncr: number[];
  46503. /**
  46504. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46505. */
  46506. keysRadiusDecr: number[];
  46507. /**
  46508. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46509. */
  46510. keysRadiusModifierAlt: boolean;
  46511. /**
  46512. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46513. */
  46514. keysRadiusModifierCtrl: boolean;
  46515. /**
  46516. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46517. */
  46518. keysRadiusModifierShift: boolean;
  46519. /**
  46520. * Defines the rate of change of heightOffset.
  46521. */
  46522. heightSensibility: number;
  46523. /**
  46524. * Defines the rate of change of rotationOffset.
  46525. */
  46526. rotationSensibility: number;
  46527. /**
  46528. * Defines the rate of change of radius.
  46529. */
  46530. radiusSensibility: number;
  46531. private _keys;
  46532. private _ctrlPressed;
  46533. private _altPressed;
  46534. private _shiftPressed;
  46535. private _onCanvasBlurObserver;
  46536. private _onKeyboardObserver;
  46537. private _engine;
  46538. private _scene;
  46539. /**
  46540. * Attach the input controls to a specific dom element to get the input from.
  46541. * @param element Defines the element the controls should be listened from
  46542. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46543. */
  46544. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46545. /**
  46546. * Detach the current controls from the specified dom element.
  46547. * @param element Defines the element to stop listening the inputs from
  46548. */
  46549. detachControl(element: Nullable<HTMLElement>): void;
  46550. /**
  46551. * Update the current camera state depending on the inputs that have been used this frame.
  46552. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46553. */
  46554. checkInputs(): void;
  46555. /**
  46556. * Gets the class name of the current input.
  46557. * @returns the class name
  46558. */
  46559. getClassName(): string;
  46560. /**
  46561. * Get the friendly name associated with the input class.
  46562. * @returns the input friendly name
  46563. */
  46564. getSimpleName(): string;
  46565. /**
  46566. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46567. * allow modification of the heightOffset value.
  46568. */
  46569. private _modifierHeightOffset;
  46570. /**
  46571. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46572. * allow modification of the rotationOffset value.
  46573. */
  46574. private _modifierRotationOffset;
  46575. /**
  46576. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46577. * allow modification of the radius value.
  46578. */
  46579. private _modifierRadius;
  46580. }
  46581. }
  46582. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46583. import { Nullable } from "babylonjs/types";
  46584. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46585. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46586. import { Observable } from "babylonjs/Misc/observable";
  46587. module "babylonjs/Cameras/freeCameraInputsManager" {
  46588. interface FreeCameraInputsManager {
  46589. /**
  46590. * @hidden
  46591. */
  46592. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46593. /**
  46594. * Add orientation input support to the input manager.
  46595. * @returns the current input manager
  46596. */
  46597. addDeviceOrientation(): FreeCameraInputsManager;
  46598. }
  46599. }
  46600. /**
  46601. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46602. * Screen rotation is taken into account.
  46603. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46604. */
  46605. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46606. private _camera;
  46607. private _screenOrientationAngle;
  46608. private _constantTranform;
  46609. private _screenQuaternion;
  46610. private _alpha;
  46611. private _beta;
  46612. private _gamma;
  46613. /**
  46614. * Can be used to detect if a device orientation sensor is available on a device
  46615. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46616. * @returns a promise that will resolve on orientation change
  46617. */
  46618. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46619. /**
  46620. * @hidden
  46621. */
  46622. _onDeviceOrientationChangedObservable: Observable<void>;
  46623. /**
  46624. * Instantiates a new input
  46625. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46626. */
  46627. constructor();
  46628. /**
  46629. * Define the camera controlled by the input.
  46630. */
  46631. get camera(): FreeCamera;
  46632. set camera(camera: FreeCamera);
  46633. /**
  46634. * Attach the input controls to a specific dom element to get the input from.
  46635. * @param element Defines the element the controls should be listened from
  46636. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46637. */
  46638. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46639. private _orientationChanged;
  46640. private _deviceOrientation;
  46641. /**
  46642. * Detach the current controls from the specified dom element.
  46643. * @param element Defines the element to stop listening the inputs from
  46644. */
  46645. detachControl(element: Nullable<HTMLElement>): void;
  46646. /**
  46647. * Update the current camera state depending on the inputs that have been used this frame.
  46648. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46649. */
  46650. checkInputs(): void;
  46651. /**
  46652. * Gets the class name of the current intput.
  46653. * @returns the class name
  46654. */
  46655. getClassName(): string;
  46656. /**
  46657. * Get the friendly name associated with the input class.
  46658. * @returns the input friendly name
  46659. */
  46660. getSimpleName(): string;
  46661. }
  46662. }
  46663. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46664. import { Nullable } from "babylonjs/types";
  46665. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46666. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46667. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46668. /**
  46669. * Manage the gamepad inputs to control a free camera.
  46670. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46671. */
  46672. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46673. /**
  46674. * Define the camera the input is attached to.
  46675. */
  46676. camera: FreeCamera;
  46677. /**
  46678. * Define the Gamepad controlling the input
  46679. */
  46680. gamepad: Nullable<Gamepad>;
  46681. /**
  46682. * Defines the gamepad rotation sensiblity.
  46683. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46684. */
  46685. gamepadAngularSensibility: number;
  46686. /**
  46687. * Defines the gamepad move sensiblity.
  46688. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46689. */
  46690. gamepadMoveSensibility: number;
  46691. private _yAxisScale;
  46692. /**
  46693. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46694. */
  46695. get invertYAxis(): boolean;
  46696. set invertYAxis(value: boolean);
  46697. private _onGamepadConnectedObserver;
  46698. private _onGamepadDisconnectedObserver;
  46699. private _cameraTransform;
  46700. private _deltaTransform;
  46701. private _vector3;
  46702. private _vector2;
  46703. /**
  46704. * Attach the input controls to a specific dom element to get the input from.
  46705. * @param element Defines the element the controls should be listened from
  46706. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46707. */
  46708. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46709. /**
  46710. * Detach the current controls from the specified dom element.
  46711. * @param element Defines the element to stop listening the inputs from
  46712. */
  46713. detachControl(element: Nullable<HTMLElement>): void;
  46714. /**
  46715. * Update the current camera state depending on the inputs that have been used this frame.
  46716. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46717. */
  46718. checkInputs(): void;
  46719. /**
  46720. * Gets the class name of the current intput.
  46721. * @returns the class name
  46722. */
  46723. getClassName(): string;
  46724. /**
  46725. * Get the friendly name associated with the input class.
  46726. * @returns the input friendly name
  46727. */
  46728. getSimpleName(): string;
  46729. }
  46730. }
  46731. declare module "babylonjs/Misc/virtualJoystick" {
  46732. import { Nullable } from "babylonjs/types";
  46733. import { Vector3 } from "babylonjs/Maths/math.vector";
  46734. /**
  46735. * Defines the potential axis of a Joystick
  46736. */
  46737. export enum JoystickAxis {
  46738. /** X axis */
  46739. X = 0,
  46740. /** Y axis */
  46741. Y = 1,
  46742. /** Z axis */
  46743. Z = 2
  46744. }
  46745. /**
  46746. * Represents the different customization options available
  46747. * for VirtualJoystick
  46748. */
  46749. interface VirtualJoystickCustomizations {
  46750. /**
  46751. * Size of the joystick's puck
  46752. */
  46753. puckSize: number;
  46754. /**
  46755. * Size of the joystick's container
  46756. */
  46757. containerSize: number;
  46758. /**
  46759. * Color of the joystick && puck
  46760. */
  46761. color: string;
  46762. /**
  46763. * Image URL for the joystick's puck
  46764. */
  46765. puckImage?: string;
  46766. /**
  46767. * Image URL for the joystick's container
  46768. */
  46769. containerImage?: string;
  46770. /**
  46771. * Defines the unmoving position of the joystick container
  46772. */
  46773. position?: {
  46774. x: number;
  46775. y: number;
  46776. };
  46777. /**
  46778. * Defines whether or not the joystick container is always visible
  46779. */
  46780. alwaysVisible: boolean;
  46781. /**
  46782. * Defines whether or not to limit the movement of the puck to the joystick's container
  46783. */
  46784. limitToContainer: boolean;
  46785. }
  46786. /**
  46787. * Class used to define virtual joystick (used in touch mode)
  46788. */
  46789. export class VirtualJoystick {
  46790. /**
  46791. * Gets or sets a boolean indicating that left and right values must be inverted
  46792. */
  46793. reverseLeftRight: boolean;
  46794. /**
  46795. * Gets or sets a boolean indicating that up and down values must be inverted
  46796. */
  46797. reverseUpDown: boolean;
  46798. /**
  46799. * Gets the offset value for the position (ie. the change of the position value)
  46800. */
  46801. deltaPosition: Vector3;
  46802. /**
  46803. * Gets a boolean indicating if the virtual joystick was pressed
  46804. */
  46805. pressed: boolean;
  46806. /**
  46807. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46808. */
  46809. static Canvas: Nullable<HTMLCanvasElement>;
  46810. /**
  46811. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46812. */
  46813. limitToContainer: boolean;
  46814. private static _globalJoystickIndex;
  46815. private static _alwaysVisibleSticks;
  46816. private static vjCanvasContext;
  46817. private static vjCanvasWidth;
  46818. private static vjCanvasHeight;
  46819. private static halfWidth;
  46820. private static _GetDefaultOptions;
  46821. private _action;
  46822. private _axisTargetedByLeftAndRight;
  46823. private _axisTargetedByUpAndDown;
  46824. private _joystickSensibility;
  46825. private _inversedSensibility;
  46826. private _joystickPointerID;
  46827. private _joystickColor;
  46828. private _joystickPointerPos;
  46829. private _joystickPreviousPointerPos;
  46830. private _joystickPointerStartPos;
  46831. private _deltaJoystickVector;
  46832. private _leftJoystick;
  46833. private _touches;
  46834. private _joystickPosition;
  46835. private _alwaysVisible;
  46836. private _puckImage;
  46837. private _containerImage;
  46838. private _joystickPuckSize;
  46839. private _joystickContainerSize;
  46840. private _clearPuckSize;
  46841. private _clearContainerSize;
  46842. private _clearPuckSizeOffset;
  46843. private _clearContainerSizeOffset;
  46844. private _onPointerDownHandlerRef;
  46845. private _onPointerMoveHandlerRef;
  46846. private _onPointerUpHandlerRef;
  46847. private _onResize;
  46848. /**
  46849. * Creates a new virtual joystick
  46850. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46851. * @param customizations Defines the options we want to customize the VirtualJoystick
  46852. */
  46853. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46854. /**
  46855. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46856. * @param newJoystickSensibility defines the new sensibility
  46857. */
  46858. setJoystickSensibility(newJoystickSensibility: number): void;
  46859. private _onPointerDown;
  46860. private _onPointerMove;
  46861. private _onPointerUp;
  46862. /**
  46863. * Change the color of the virtual joystick
  46864. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46865. */
  46866. setJoystickColor(newColor: string): void;
  46867. /**
  46868. * Size of the joystick's container
  46869. */
  46870. set containerSize(newSize: number);
  46871. get containerSize(): number;
  46872. /**
  46873. * Size of the joystick's puck
  46874. */
  46875. set puckSize(newSize: number);
  46876. get puckSize(): number;
  46877. /**
  46878. * Clears the set position of the joystick
  46879. */
  46880. clearPosition(): void;
  46881. /**
  46882. * Defines whether or not the joystick container is always visible
  46883. */
  46884. set alwaysVisible(value: boolean);
  46885. get alwaysVisible(): boolean;
  46886. /**
  46887. * Sets the constant position of the Joystick container
  46888. * @param x X axis coordinate
  46889. * @param y Y axis coordinate
  46890. */
  46891. setPosition(x: number, y: number): void;
  46892. /**
  46893. * Defines a callback to call when the joystick is touched
  46894. * @param action defines the callback
  46895. */
  46896. setActionOnTouch(action: () => any): void;
  46897. /**
  46898. * Defines which axis you'd like to control for left & right
  46899. * @param axis defines the axis to use
  46900. */
  46901. setAxisForLeftRight(axis: JoystickAxis): void;
  46902. /**
  46903. * Defines which axis you'd like to control for up & down
  46904. * @param axis defines the axis to use
  46905. */
  46906. setAxisForUpDown(axis: JoystickAxis): void;
  46907. /**
  46908. * Clears the canvas from the previous puck / container draw
  46909. */
  46910. private _clearPreviousDraw;
  46911. /**
  46912. * Loads `urlPath` to be used for the container's image
  46913. * @param urlPath defines the urlPath of an image to use
  46914. */
  46915. setContainerImage(urlPath: string): void;
  46916. /**
  46917. * Loads `urlPath` to be used for the puck's image
  46918. * @param urlPath defines the urlPath of an image to use
  46919. */
  46920. setPuckImage(urlPath: string): void;
  46921. /**
  46922. * Draws the Virtual Joystick's container
  46923. */
  46924. private _drawContainer;
  46925. /**
  46926. * Draws the Virtual Joystick's puck
  46927. */
  46928. private _drawPuck;
  46929. private _drawVirtualJoystick;
  46930. /**
  46931. * Release internal HTML canvas
  46932. */
  46933. releaseCanvas(): void;
  46934. }
  46935. }
  46936. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46937. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46938. import { Nullable } from "babylonjs/types";
  46939. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46940. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46941. module "babylonjs/Cameras/freeCameraInputsManager" {
  46942. interface FreeCameraInputsManager {
  46943. /**
  46944. * Add virtual joystick input support to the input manager.
  46945. * @returns the current input manager
  46946. */
  46947. addVirtualJoystick(): FreeCameraInputsManager;
  46948. }
  46949. }
  46950. /**
  46951. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46952. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46953. */
  46954. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46955. /**
  46956. * Defines the camera the input is attached to.
  46957. */
  46958. camera: FreeCamera;
  46959. private _leftjoystick;
  46960. private _rightjoystick;
  46961. /**
  46962. * Gets the left stick of the virtual joystick.
  46963. * @returns The virtual Joystick
  46964. */
  46965. getLeftJoystick(): VirtualJoystick;
  46966. /**
  46967. * Gets the right stick of the virtual joystick.
  46968. * @returns The virtual Joystick
  46969. */
  46970. getRightJoystick(): VirtualJoystick;
  46971. /**
  46972. * Update the current camera state depending on the inputs that have been used this frame.
  46973. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46974. */
  46975. checkInputs(): void;
  46976. /**
  46977. * Attach the input controls to a specific dom element to get the input from.
  46978. * @param element Defines the element the controls should be listened from
  46979. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46980. */
  46981. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46982. /**
  46983. * Detach the current controls from the specified dom element.
  46984. * @param element Defines the element to stop listening the inputs from
  46985. */
  46986. detachControl(element: Nullable<HTMLElement>): void;
  46987. /**
  46988. * Gets the class name of the current intput.
  46989. * @returns the class name
  46990. */
  46991. getClassName(): string;
  46992. /**
  46993. * Get the friendly name associated with the input class.
  46994. * @returns the input friendly name
  46995. */
  46996. getSimpleName(): string;
  46997. }
  46998. }
  46999. declare module "babylonjs/Cameras/Inputs/index" {
  47000. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  47001. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  47002. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  47003. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  47004. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  47005. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  47006. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  47007. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  47008. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  47009. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  47010. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  47011. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  47012. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  47013. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  47014. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  47015. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47016. }
  47017. declare module "babylonjs/Cameras/touchCamera" {
  47018. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47019. import { Scene } from "babylonjs/scene";
  47020. import { Vector3 } from "babylonjs/Maths/math.vector";
  47021. /**
  47022. * This represents a FPS type of camera controlled by touch.
  47023. * This is like a universal camera minus the Gamepad controls.
  47024. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47025. */
  47026. export class TouchCamera extends FreeCamera {
  47027. /**
  47028. * Defines the touch sensibility for rotation.
  47029. * The higher the faster.
  47030. */
  47031. get touchAngularSensibility(): number;
  47032. set touchAngularSensibility(value: number);
  47033. /**
  47034. * Defines the touch sensibility for move.
  47035. * The higher the faster.
  47036. */
  47037. get touchMoveSensibility(): number;
  47038. set touchMoveSensibility(value: number);
  47039. /**
  47040. * Instantiates a new touch camera.
  47041. * This represents a FPS type of camera controlled by touch.
  47042. * This is like a universal camera minus the Gamepad controls.
  47043. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47044. * @param name Define the name of the camera in the scene
  47045. * @param position Define the start position of the camera in the scene
  47046. * @param scene Define the scene the camera belongs to
  47047. */
  47048. constructor(name: string, position: Vector3, scene: Scene);
  47049. /**
  47050. * Gets the current object class name.
  47051. * @return the class name
  47052. */
  47053. getClassName(): string;
  47054. /** @hidden */
  47055. _setupInputs(): void;
  47056. }
  47057. }
  47058. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  47059. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47060. import { Scene } from "babylonjs/scene";
  47061. import { Vector3 } from "babylonjs/Maths/math.vector";
  47062. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  47063. import { Axis } from "babylonjs/Maths/math.axis";
  47064. /**
  47065. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  47066. * being tilted forward or back and left or right.
  47067. */
  47068. export class DeviceOrientationCamera extends FreeCamera {
  47069. private _initialQuaternion;
  47070. private _quaternionCache;
  47071. private _tmpDragQuaternion;
  47072. private _disablePointerInputWhenUsingDeviceOrientation;
  47073. /**
  47074. * Creates a new device orientation camera
  47075. * @param name The name of the camera
  47076. * @param position The start position camera
  47077. * @param scene The scene the camera belongs to
  47078. */
  47079. constructor(name: string, position: Vector3, scene: Scene);
  47080. /**
  47081. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  47082. */
  47083. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  47084. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  47085. private _dragFactor;
  47086. /**
  47087. * Enabled turning on the y axis when the orientation sensor is active
  47088. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  47089. */
  47090. enableHorizontalDragging(dragFactor?: number): void;
  47091. /**
  47092. * Gets the current instance class name ("DeviceOrientationCamera").
  47093. * This helps avoiding instanceof at run time.
  47094. * @returns the class name
  47095. */
  47096. getClassName(): string;
  47097. /**
  47098. * @hidden
  47099. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  47100. */
  47101. _checkInputs(): void;
  47102. /**
  47103. * Reset the camera to its default orientation on the specified axis only.
  47104. * @param axis The axis to reset
  47105. */
  47106. resetToCurrentRotation(axis?: Axis): void;
  47107. }
  47108. }
  47109. declare module "babylonjs/Gamepads/xboxGamepad" {
  47110. import { Observable } from "babylonjs/Misc/observable";
  47111. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47112. /**
  47113. * Defines supported buttons for XBox360 compatible gamepads
  47114. */
  47115. export enum Xbox360Button {
  47116. /** A */
  47117. A = 0,
  47118. /** B */
  47119. B = 1,
  47120. /** X */
  47121. X = 2,
  47122. /** Y */
  47123. Y = 3,
  47124. /** Left button */
  47125. LB = 4,
  47126. /** Right button */
  47127. RB = 5,
  47128. /** Back */
  47129. Back = 8,
  47130. /** Start */
  47131. Start = 9,
  47132. /** Left stick */
  47133. LeftStick = 10,
  47134. /** Right stick */
  47135. RightStick = 11
  47136. }
  47137. /** Defines values for XBox360 DPad */
  47138. export enum Xbox360Dpad {
  47139. /** Up */
  47140. Up = 12,
  47141. /** Down */
  47142. Down = 13,
  47143. /** Left */
  47144. Left = 14,
  47145. /** Right */
  47146. Right = 15
  47147. }
  47148. /**
  47149. * Defines a XBox360 gamepad
  47150. */
  47151. export class Xbox360Pad extends Gamepad {
  47152. private _leftTrigger;
  47153. private _rightTrigger;
  47154. private _onlefttriggerchanged;
  47155. private _onrighttriggerchanged;
  47156. private _onbuttondown;
  47157. private _onbuttonup;
  47158. private _ondpaddown;
  47159. private _ondpadup;
  47160. /** Observable raised when a button is pressed */
  47161. onButtonDownObservable: Observable<Xbox360Button>;
  47162. /** Observable raised when a button is released */
  47163. onButtonUpObservable: Observable<Xbox360Button>;
  47164. /** Observable raised when a pad is pressed */
  47165. onPadDownObservable: Observable<Xbox360Dpad>;
  47166. /** Observable raised when a pad is released */
  47167. onPadUpObservable: Observable<Xbox360Dpad>;
  47168. private _buttonA;
  47169. private _buttonB;
  47170. private _buttonX;
  47171. private _buttonY;
  47172. private _buttonBack;
  47173. private _buttonStart;
  47174. private _buttonLB;
  47175. private _buttonRB;
  47176. private _buttonLeftStick;
  47177. private _buttonRightStick;
  47178. private _dPadUp;
  47179. private _dPadDown;
  47180. private _dPadLeft;
  47181. private _dPadRight;
  47182. private _isXboxOnePad;
  47183. /**
  47184. * Creates a new XBox360 gamepad object
  47185. * @param id defines the id of this gamepad
  47186. * @param index defines its index
  47187. * @param gamepad defines the internal HTML gamepad object
  47188. * @param xboxOne defines if it is a XBox One gamepad
  47189. */
  47190. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47191. /**
  47192. * Defines the callback to call when left trigger is pressed
  47193. * @param callback defines the callback to use
  47194. */
  47195. onlefttriggerchanged(callback: (value: number) => void): void;
  47196. /**
  47197. * Defines the callback to call when right trigger is pressed
  47198. * @param callback defines the callback to use
  47199. */
  47200. onrighttriggerchanged(callback: (value: number) => void): void;
  47201. /**
  47202. * Gets the left trigger value
  47203. */
  47204. get leftTrigger(): number;
  47205. /**
  47206. * Sets the left trigger value
  47207. */
  47208. set leftTrigger(newValue: number);
  47209. /**
  47210. * Gets the right trigger value
  47211. */
  47212. get rightTrigger(): number;
  47213. /**
  47214. * Sets the right trigger value
  47215. */
  47216. set rightTrigger(newValue: number);
  47217. /**
  47218. * Defines the callback to call when a button is pressed
  47219. * @param callback defines the callback to use
  47220. */
  47221. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47222. /**
  47223. * Defines the callback to call when a button is released
  47224. * @param callback defines the callback to use
  47225. */
  47226. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47227. /**
  47228. * Defines the callback to call when a pad is pressed
  47229. * @param callback defines the callback to use
  47230. */
  47231. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47232. /**
  47233. * Defines the callback to call when a pad is released
  47234. * @param callback defines the callback to use
  47235. */
  47236. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47237. private _setButtonValue;
  47238. private _setDPadValue;
  47239. /**
  47240. * Gets the value of the `A` button
  47241. */
  47242. get buttonA(): number;
  47243. /**
  47244. * Sets the value of the `A` button
  47245. */
  47246. set buttonA(value: number);
  47247. /**
  47248. * Gets the value of the `B` button
  47249. */
  47250. get buttonB(): number;
  47251. /**
  47252. * Sets the value of the `B` button
  47253. */
  47254. set buttonB(value: number);
  47255. /**
  47256. * Gets the value of the `X` button
  47257. */
  47258. get buttonX(): number;
  47259. /**
  47260. * Sets the value of the `X` button
  47261. */
  47262. set buttonX(value: number);
  47263. /**
  47264. * Gets the value of the `Y` button
  47265. */
  47266. get buttonY(): number;
  47267. /**
  47268. * Sets the value of the `Y` button
  47269. */
  47270. set buttonY(value: number);
  47271. /**
  47272. * Gets the value of the `Start` button
  47273. */
  47274. get buttonStart(): number;
  47275. /**
  47276. * Sets the value of the `Start` button
  47277. */
  47278. set buttonStart(value: number);
  47279. /**
  47280. * Gets the value of the `Back` button
  47281. */
  47282. get buttonBack(): number;
  47283. /**
  47284. * Sets the value of the `Back` button
  47285. */
  47286. set buttonBack(value: number);
  47287. /**
  47288. * Gets the value of the `Left` button
  47289. */
  47290. get buttonLB(): number;
  47291. /**
  47292. * Sets the value of the `Left` button
  47293. */
  47294. set buttonLB(value: number);
  47295. /**
  47296. * Gets the value of the `Right` button
  47297. */
  47298. get buttonRB(): number;
  47299. /**
  47300. * Sets the value of the `Right` button
  47301. */
  47302. set buttonRB(value: number);
  47303. /**
  47304. * Gets the value of the Left joystick
  47305. */
  47306. get buttonLeftStick(): number;
  47307. /**
  47308. * Sets the value of the Left joystick
  47309. */
  47310. set buttonLeftStick(value: number);
  47311. /**
  47312. * Gets the value of the Right joystick
  47313. */
  47314. get buttonRightStick(): number;
  47315. /**
  47316. * Sets the value of the Right joystick
  47317. */
  47318. set buttonRightStick(value: number);
  47319. /**
  47320. * Gets the value of D-pad up
  47321. */
  47322. get dPadUp(): number;
  47323. /**
  47324. * Sets the value of D-pad up
  47325. */
  47326. set dPadUp(value: number);
  47327. /**
  47328. * Gets the value of D-pad down
  47329. */
  47330. get dPadDown(): number;
  47331. /**
  47332. * Sets the value of D-pad down
  47333. */
  47334. set dPadDown(value: number);
  47335. /**
  47336. * Gets the value of D-pad left
  47337. */
  47338. get dPadLeft(): number;
  47339. /**
  47340. * Sets the value of D-pad left
  47341. */
  47342. set dPadLeft(value: number);
  47343. /**
  47344. * Gets the value of D-pad right
  47345. */
  47346. get dPadRight(): number;
  47347. /**
  47348. * Sets the value of D-pad right
  47349. */
  47350. set dPadRight(value: number);
  47351. /**
  47352. * Force the gamepad to synchronize with device values
  47353. */
  47354. update(): void;
  47355. /**
  47356. * Disposes the gamepad
  47357. */
  47358. dispose(): void;
  47359. }
  47360. }
  47361. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47362. import { Observable } from "babylonjs/Misc/observable";
  47363. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47364. /**
  47365. * Defines supported buttons for DualShock compatible gamepads
  47366. */
  47367. export enum DualShockButton {
  47368. /** Cross */
  47369. Cross = 0,
  47370. /** Circle */
  47371. Circle = 1,
  47372. /** Square */
  47373. Square = 2,
  47374. /** Triangle */
  47375. Triangle = 3,
  47376. /** L1 */
  47377. L1 = 4,
  47378. /** R1 */
  47379. R1 = 5,
  47380. /** Share */
  47381. Share = 8,
  47382. /** Options */
  47383. Options = 9,
  47384. /** Left stick */
  47385. LeftStick = 10,
  47386. /** Right stick */
  47387. RightStick = 11
  47388. }
  47389. /** Defines values for DualShock DPad */
  47390. export enum DualShockDpad {
  47391. /** Up */
  47392. Up = 12,
  47393. /** Down */
  47394. Down = 13,
  47395. /** Left */
  47396. Left = 14,
  47397. /** Right */
  47398. Right = 15
  47399. }
  47400. /**
  47401. * Defines a DualShock gamepad
  47402. */
  47403. export class DualShockPad extends Gamepad {
  47404. private _leftTrigger;
  47405. private _rightTrigger;
  47406. private _onlefttriggerchanged;
  47407. private _onrighttriggerchanged;
  47408. private _onbuttondown;
  47409. private _onbuttonup;
  47410. private _ondpaddown;
  47411. private _ondpadup;
  47412. /** Observable raised when a button is pressed */
  47413. onButtonDownObservable: Observable<DualShockButton>;
  47414. /** Observable raised when a button is released */
  47415. onButtonUpObservable: Observable<DualShockButton>;
  47416. /** Observable raised when a pad is pressed */
  47417. onPadDownObservable: Observable<DualShockDpad>;
  47418. /** Observable raised when a pad is released */
  47419. onPadUpObservable: Observable<DualShockDpad>;
  47420. private _buttonCross;
  47421. private _buttonCircle;
  47422. private _buttonSquare;
  47423. private _buttonTriangle;
  47424. private _buttonShare;
  47425. private _buttonOptions;
  47426. private _buttonL1;
  47427. private _buttonR1;
  47428. private _buttonLeftStick;
  47429. private _buttonRightStick;
  47430. private _dPadUp;
  47431. private _dPadDown;
  47432. private _dPadLeft;
  47433. private _dPadRight;
  47434. /**
  47435. * Creates a new DualShock gamepad object
  47436. * @param id defines the id of this gamepad
  47437. * @param index defines its index
  47438. * @param gamepad defines the internal HTML gamepad object
  47439. */
  47440. constructor(id: string, index: number, gamepad: any);
  47441. /**
  47442. * Defines the callback to call when left trigger is pressed
  47443. * @param callback defines the callback to use
  47444. */
  47445. onlefttriggerchanged(callback: (value: number) => void): void;
  47446. /**
  47447. * Defines the callback to call when right trigger is pressed
  47448. * @param callback defines the callback to use
  47449. */
  47450. onrighttriggerchanged(callback: (value: number) => void): void;
  47451. /**
  47452. * Gets the left trigger value
  47453. */
  47454. get leftTrigger(): number;
  47455. /**
  47456. * Sets the left trigger value
  47457. */
  47458. set leftTrigger(newValue: number);
  47459. /**
  47460. * Gets the right trigger value
  47461. */
  47462. get rightTrigger(): number;
  47463. /**
  47464. * Sets the right trigger value
  47465. */
  47466. set rightTrigger(newValue: number);
  47467. /**
  47468. * Defines the callback to call when a button is pressed
  47469. * @param callback defines the callback to use
  47470. */
  47471. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47472. /**
  47473. * Defines the callback to call when a button is released
  47474. * @param callback defines the callback to use
  47475. */
  47476. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47477. /**
  47478. * Defines the callback to call when a pad is pressed
  47479. * @param callback defines the callback to use
  47480. */
  47481. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47482. /**
  47483. * Defines the callback to call when a pad is released
  47484. * @param callback defines the callback to use
  47485. */
  47486. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47487. private _setButtonValue;
  47488. private _setDPadValue;
  47489. /**
  47490. * Gets the value of the `Cross` button
  47491. */
  47492. get buttonCross(): number;
  47493. /**
  47494. * Sets the value of the `Cross` button
  47495. */
  47496. set buttonCross(value: number);
  47497. /**
  47498. * Gets the value of the `Circle` button
  47499. */
  47500. get buttonCircle(): number;
  47501. /**
  47502. * Sets the value of the `Circle` button
  47503. */
  47504. set buttonCircle(value: number);
  47505. /**
  47506. * Gets the value of the `Square` button
  47507. */
  47508. get buttonSquare(): number;
  47509. /**
  47510. * Sets the value of the `Square` button
  47511. */
  47512. set buttonSquare(value: number);
  47513. /**
  47514. * Gets the value of the `Triangle` button
  47515. */
  47516. get buttonTriangle(): number;
  47517. /**
  47518. * Sets the value of the `Triangle` button
  47519. */
  47520. set buttonTriangle(value: number);
  47521. /**
  47522. * Gets the value of the `Options` button
  47523. */
  47524. get buttonOptions(): number;
  47525. /**
  47526. * Sets the value of the `Options` button
  47527. */
  47528. set buttonOptions(value: number);
  47529. /**
  47530. * Gets the value of the `Share` button
  47531. */
  47532. get buttonShare(): number;
  47533. /**
  47534. * Sets the value of the `Share` button
  47535. */
  47536. set buttonShare(value: number);
  47537. /**
  47538. * Gets the value of the `L1` button
  47539. */
  47540. get buttonL1(): number;
  47541. /**
  47542. * Sets the value of the `L1` button
  47543. */
  47544. set buttonL1(value: number);
  47545. /**
  47546. * Gets the value of the `R1` button
  47547. */
  47548. get buttonR1(): number;
  47549. /**
  47550. * Sets the value of the `R1` button
  47551. */
  47552. set buttonR1(value: number);
  47553. /**
  47554. * Gets the value of the Left joystick
  47555. */
  47556. get buttonLeftStick(): number;
  47557. /**
  47558. * Sets the value of the Left joystick
  47559. */
  47560. set buttonLeftStick(value: number);
  47561. /**
  47562. * Gets the value of the Right joystick
  47563. */
  47564. get buttonRightStick(): number;
  47565. /**
  47566. * Sets the value of the Right joystick
  47567. */
  47568. set buttonRightStick(value: number);
  47569. /**
  47570. * Gets the value of D-pad up
  47571. */
  47572. get dPadUp(): number;
  47573. /**
  47574. * Sets the value of D-pad up
  47575. */
  47576. set dPadUp(value: number);
  47577. /**
  47578. * Gets the value of D-pad down
  47579. */
  47580. get dPadDown(): number;
  47581. /**
  47582. * Sets the value of D-pad down
  47583. */
  47584. set dPadDown(value: number);
  47585. /**
  47586. * Gets the value of D-pad left
  47587. */
  47588. get dPadLeft(): number;
  47589. /**
  47590. * Sets the value of D-pad left
  47591. */
  47592. set dPadLeft(value: number);
  47593. /**
  47594. * Gets the value of D-pad right
  47595. */
  47596. get dPadRight(): number;
  47597. /**
  47598. * Sets the value of D-pad right
  47599. */
  47600. set dPadRight(value: number);
  47601. /**
  47602. * Force the gamepad to synchronize with device values
  47603. */
  47604. update(): void;
  47605. /**
  47606. * Disposes the gamepad
  47607. */
  47608. dispose(): void;
  47609. }
  47610. }
  47611. declare module "babylonjs/Gamepads/gamepadManager" {
  47612. import { Observable } from "babylonjs/Misc/observable";
  47613. import { Nullable } from "babylonjs/types";
  47614. import { Scene } from "babylonjs/scene";
  47615. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47616. /**
  47617. * Manager for handling gamepads
  47618. */
  47619. export class GamepadManager {
  47620. private _scene?;
  47621. private _babylonGamepads;
  47622. private _oneGamepadConnected;
  47623. /** @hidden */
  47624. _isMonitoring: boolean;
  47625. private _gamepadEventSupported;
  47626. private _gamepadSupport?;
  47627. /**
  47628. * observable to be triggered when the gamepad controller has been connected
  47629. */
  47630. onGamepadConnectedObservable: Observable<Gamepad>;
  47631. /**
  47632. * observable to be triggered when the gamepad controller has been disconnected
  47633. */
  47634. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47635. private _onGamepadConnectedEvent;
  47636. private _onGamepadDisconnectedEvent;
  47637. /**
  47638. * Initializes the gamepad manager
  47639. * @param _scene BabylonJS scene
  47640. */
  47641. constructor(_scene?: Scene | undefined);
  47642. /**
  47643. * The gamepads in the game pad manager
  47644. */
  47645. get gamepads(): Gamepad[];
  47646. /**
  47647. * Get the gamepad controllers based on type
  47648. * @param type The type of gamepad controller
  47649. * @returns Nullable gamepad
  47650. */
  47651. getGamepadByType(type?: number): Nullable<Gamepad>;
  47652. /**
  47653. * Disposes the gamepad manager
  47654. */
  47655. dispose(): void;
  47656. private _addNewGamepad;
  47657. private _startMonitoringGamepads;
  47658. private _stopMonitoringGamepads;
  47659. /** @hidden */
  47660. _checkGamepadsStatus(): void;
  47661. private _updateGamepadObjects;
  47662. }
  47663. }
  47664. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47665. import { Nullable } from "babylonjs/types";
  47666. import { Scene } from "babylonjs/scene";
  47667. import { ISceneComponent } from "babylonjs/sceneComponent";
  47668. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47669. module "babylonjs/scene" {
  47670. interface Scene {
  47671. /** @hidden */
  47672. _gamepadManager: Nullable<GamepadManager>;
  47673. /**
  47674. * Gets the gamepad manager associated with the scene
  47675. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47676. */
  47677. gamepadManager: GamepadManager;
  47678. }
  47679. }
  47680. module "babylonjs/Cameras/freeCameraInputsManager" {
  47681. /**
  47682. * Interface representing a free camera inputs manager
  47683. */
  47684. interface FreeCameraInputsManager {
  47685. /**
  47686. * Adds gamepad input support to the FreeCameraInputsManager.
  47687. * @returns the FreeCameraInputsManager
  47688. */
  47689. addGamepad(): FreeCameraInputsManager;
  47690. }
  47691. }
  47692. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47693. /**
  47694. * Interface representing an arc rotate camera inputs manager
  47695. */
  47696. interface ArcRotateCameraInputsManager {
  47697. /**
  47698. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47699. * @returns the camera inputs manager
  47700. */
  47701. addGamepad(): ArcRotateCameraInputsManager;
  47702. }
  47703. }
  47704. /**
  47705. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47706. */
  47707. export class GamepadSystemSceneComponent implements ISceneComponent {
  47708. /**
  47709. * The component name helpfull to identify the component in the list of scene components.
  47710. */
  47711. readonly name: string;
  47712. /**
  47713. * The scene the component belongs to.
  47714. */
  47715. scene: Scene;
  47716. /**
  47717. * Creates a new instance of the component for the given scene
  47718. * @param scene Defines the scene to register the component in
  47719. */
  47720. constructor(scene: Scene);
  47721. /**
  47722. * Registers the component in a given scene
  47723. */
  47724. register(): void;
  47725. /**
  47726. * Rebuilds the elements related to this component in case of
  47727. * context lost for instance.
  47728. */
  47729. rebuild(): void;
  47730. /**
  47731. * Disposes the component and the associated ressources
  47732. */
  47733. dispose(): void;
  47734. private _beforeCameraUpdate;
  47735. }
  47736. }
  47737. declare module "babylonjs/Cameras/universalCamera" {
  47738. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47739. import { Scene } from "babylonjs/scene";
  47740. import { Vector3 } from "babylonjs/Maths/math.vector";
  47741. import "babylonjs/Gamepads/gamepadSceneComponent";
  47742. /**
  47743. * 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,
  47744. * which still works and will still be found in many Playgrounds.
  47745. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47746. */
  47747. export class UniversalCamera extends TouchCamera {
  47748. /**
  47749. * Defines the gamepad rotation sensiblity.
  47750. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47751. */
  47752. get gamepadAngularSensibility(): number;
  47753. set gamepadAngularSensibility(value: number);
  47754. /**
  47755. * Defines the gamepad move sensiblity.
  47756. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47757. */
  47758. get gamepadMoveSensibility(): number;
  47759. set gamepadMoveSensibility(value: number);
  47760. /**
  47761. * 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,
  47762. * which still works and will still be found in many Playgrounds.
  47763. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47764. * @param name Define the name of the camera in the scene
  47765. * @param position Define the start position of the camera in the scene
  47766. * @param scene Define the scene the camera belongs to
  47767. */
  47768. constructor(name: string, position: Vector3, scene: Scene);
  47769. /**
  47770. * Gets the current object class name.
  47771. * @return the class name
  47772. */
  47773. getClassName(): string;
  47774. }
  47775. }
  47776. declare module "babylonjs/Cameras/gamepadCamera" {
  47777. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47778. import { Scene } from "babylonjs/scene";
  47779. import { Vector3 } from "babylonjs/Maths/math.vector";
  47780. /**
  47781. * This represents a FPS type of camera. This is only here for back compat purpose.
  47782. * Please use the UniversalCamera instead as both are identical.
  47783. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47784. */
  47785. export class GamepadCamera extends UniversalCamera {
  47786. /**
  47787. * Instantiates a new Gamepad Camera
  47788. * This represents a FPS type of camera. This is only here for back compat purpose.
  47789. * Please use the UniversalCamera instead as both are identical.
  47790. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47791. * @param name Define the name of the camera in the scene
  47792. * @param position Define the start position of the camera in the scene
  47793. * @param scene Define the scene the camera belongs to
  47794. */
  47795. constructor(name: string, position: Vector3, scene: Scene);
  47796. /**
  47797. * Gets the current object class name.
  47798. * @return the class name
  47799. */
  47800. getClassName(): string;
  47801. }
  47802. }
  47803. declare module "babylonjs/Shaders/pass.fragment" {
  47804. /** @hidden */
  47805. export var passPixelShader: {
  47806. name: string;
  47807. shader: string;
  47808. };
  47809. }
  47810. declare module "babylonjs/Shaders/passCube.fragment" {
  47811. /** @hidden */
  47812. export var passCubePixelShader: {
  47813. name: string;
  47814. shader: string;
  47815. };
  47816. }
  47817. declare module "babylonjs/PostProcesses/passPostProcess" {
  47818. import { Nullable } from "babylonjs/types";
  47819. import { Camera } from "babylonjs/Cameras/camera";
  47820. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47821. import { Engine } from "babylonjs/Engines/engine";
  47822. import "babylonjs/Shaders/pass.fragment";
  47823. import "babylonjs/Shaders/passCube.fragment";
  47824. import { Scene } from "babylonjs/scene";
  47825. /**
  47826. * PassPostProcess which produces an output the same as it's input
  47827. */
  47828. export class PassPostProcess extends PostProcess {
  47829. /**
  47830. * Gets a string identifying the name of the class
  47831. * @returns "PassPostProcess" string
  47832. */
  47833. getClassName(): string;
  47834. /**
  47835. * Creates the PassPostProcess
  47836. * @param name The name of the effect.
  47837. * @param options The required width/height ratio to downsize to before computing the render pass.
  47838. * @param camera The camera to apply the render pass to.
  47839. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47840. * @param engine The engine which the post process will be applied. (default: current engine)
  47841. * @param reusable If the post process can be reused on the same frame. (default: false)
  47842. * @param textureType The type of texture to be used when performing the post processing.
  47843. * @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)
  47844. */
  47845. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47846. /** @hidden */
  47847. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47848. }
  47849. /**
  47850. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47851. */
  47852. export class PassCubePostProcess extends PostProcess {
  47853. private _face;
  47854. /**
  47855. * Gets or sets the cube face to display.
  47856. * * 0 is +X
  47857. * * 1 is -X
  47858. * * 2 is +Y
  47859. * * 3 is -Y
  47860. * * 4 is +Z
  47861. * * 5 is -Z
  47862. */
  47863. get face(): number;
  47864. set face(value: number);
  47865. /**
  47866. * Gets a string identifying the name of the class
  47867. * @returns "PassCubePostProcess" string
  47868. */
  47869. getClassName(): string;
  47870. /**
  47871. * Creates the PassCubePostProcess
  47872. * @param name The name of the effect.
  47873. * @param options The required width/height ratio to downsize to before computing the render pass.
  47874. * @param camera The camera to apply the render pass to.
  47875. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47876. * @param engine The engine which the post process will be applied. (default: current engine)
  47877. * @param reusable If the post process can be reused on the same frame. (default: false)
  47878. * @param textureType The type of texture to be used when performing the post processing.
  47879. * @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)
  47880. */
  47881. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47882. /** @hidden */
  47883. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47884. }
  47885. }
  47886. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47887. /** @hidden */
  47888. export var anaglyphPixelShader: {
  47889. name: string;
  47890. shader: string;
  47891. };
  47892. }
  47893. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47894. import { Engine } from "babylonjs/Engines/engine";
  47895. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47896. import { Camera } from "babylonjs/Cameras/camera";
  47897. import "babylonjs/Shaders/anaglyph.fragment";
  47898. /**
  47899. * Postprocess used to generate anaglyphic rendering
  47900. */
  47901. export class AnaglyphPostProcess extends PostProcess {
  47902. private _passedProcess;
  47903. /**
  47904. * Gets a string identifying the name of the class
  47905. * @returns "AnaglyphPostProcess" string
  47906. */
  47907. getClassName(): string;
  47908. /**
  47909. * Creates a new AnaglyphPostProcess
  47910. * @param name defines postprocess name
  47911. * @param options defines creation options or target ratio scale
  47912. * @param rigCameras defines cameras using this postprocess
  47913. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47914. * @param engine defines hosting engine
  47915. * @param reusable defines if the postprocess will be reused multiple times per frame
  47916. */
  47917. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47918. }
  47919. }
  47920. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47921. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47922. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47923. import { Scene } from "babylonjs/scene";
  47924. import { Vector3 } from "babylonjs/Maths/math.vector";
  47925. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47926. /**
  47927. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47928. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47929. */
  47930. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47931. /**
  47932. * Creates a new AnaglyphArcRotateCamera
  47933. * @param name defines camera name
  47934. * @param alpha defines alpha angle (in radians)
  47935. * @param beta defines beta angle (in radians)
  47936. * @param radius defines radius
  47937. * @param target defines camera target
  47938. * @param interaxialDistance defines distance between each color axis
  47939. * @param scene defines the hosting scene
  47940. */
  47941. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47942. /**
  47943. * Gets camera class name
  47944. * @returns AnaglyphArcRotateCamera
  47945. */
  47946. getClassName(): string;
  47947. }
  47948. }
  47949. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47950. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47951. import { Scene } from "babylonjs/scene";
  47952. import { Vector3 } from "babylonjs/Maths/math.vector";
  47953. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47954. /**
  47955. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47956. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47957. */
  47958. export class AnaglyphFreeCamera extends FreeCamera {
  47959. /**
  47960. * Creates a new AnaglyphFreeCamera
  47961. * @param name defines camera name
  47962. * @param position defines initial position
  47963. * @param interaxialDistance defines distance between each color axis
  47964. * @param scene defines the hosting scene
  47965. */
  47966. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47967. /**
  47968. * Gets camera class name
  47969. * @returns AnaglyphFreeCamera
  47970. */
  47971. getClassName(): string;
  47972. }
  47973. }
  47974. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47975. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47976. import { Scene } from "babylonjs/scene";
  47977. import { Vector3 } from "babylonjs/Maths/math.vector";
  47978. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47979. /**
  47980. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47981. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47982. */
  47983. export class AnaglyphGamepadCamera extends GamepadCamera {
  47984. /**
  47985. * Creates a new AnaglyphGamepadCamera
  47986. * @param name defines camera name
  47987. * @param position defines initial position
  47988. * @param interaxialDistance defines distance between each color axis
  47989. * @param scene defines the hosting scene
  47990. */
  47991. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47992. /**
  47993. * Gets camera class name
  47994. * @returns AnaglyphGamepadCamera
  47995. */
  47996. getClassName(): string;
  47997. }
  47998. }
  47999. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  48000. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  48001. import { Scene } from "babylonjs/scene";
  48002. import { Vector3 } from "babylonjs/Maths/math.vector";
  48003. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  48004. /**
  48005. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  48006. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  48007. */
  48008. export class AnaglyphUniversalCamera extends UniversalCamera {
  48009. /**
  48010. * Creates a new AnaglyphUniversalCamera
  48011. * @param name defines camera name
  48012. * @param position defines initial position
  48013. * @param interaxialDistance defines distance between each color axis
  48014. * @param scene defines the hosting scene
  48015. */
  48016. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  48017. /**
  48018. * Gets camera class name
  48019. * @returns AnaglyphUniversalCamera
  48020. */
  48021. getClassName(): string;
  48022. }
  48023. }
  48024. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  48025. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  48026. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48027. import { Scene } from "babylonjs/scene";
  48028. import { Vector3 } from "babylonjs/Maths/math.vector";
  48029. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48030. /**
  48031. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  48032. * @see https://doc.babylonjs.com/features/cameras
  48033. */
  48034. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  48035. /**
  48036. * Creates a new StereoscopicArcRotateCamera
  48037. * @param name defines camera name
  48038. * @param alpha defines alpha angle (in radians)
  48039. * @param beta defines beta angle (in radians)
  48040. * @param radius defines radius
  48041. * @param target defines camera target
  48042. * @param interaxialDistance defines distance between each color axis
  48043. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48044. * @param scene defines the hosting scene
  48045. */
  48046. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48047. /**
  48048. * Gets camera class name
  48049. * @returns StereoscopicArcRotateCamera
  48050. */
  48051. getClassName(): string;
  48052. }
  48053. }
  48054. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  48055. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48056. import { Scene } from "babylonjs/scene";
  48057. import { Vector3 } from "babylonjs/Maths/math.vector";
  48058. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48059. /**
  48060. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  48061. * @see https://doc.babylonjs.com/features/cameras
  48062. */
  48063. export class StereoscopicFreeCamera extends FreeCamera {
  48064. /**
  48065. * Creates a new StereoscopicFreeCamera
  48066. * @param name defines camera name
  48067. * @param position defines initial position
  48068. * @param interaxialDistance defines distance between each color axis
  48069. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48070. * @param scene defines the hosting scene
  48071. */
  48072. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48073. /**
  48074. * Gets camera class name
  48075. * @returns StereoscopicFreeCamera
  48076. */
  48077. getClassName(): string;
  48078. }
  48079. }
  48080. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  48081. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  48082. import { Scene } from "babylonjs/scene";
  48083. import { Vector3 } from "babylonjs/Maths/math.vector";
  48084. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48085. /**
  48086. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  48087. * @see https://doc.babylonjs.com/features/cameras
  48088. */
  48089. export class StereoscopicGamepadCamera extends GamepadCamera {
  48090. /**
  48091. * Creates a new StereoscopicGamepadCamera
  48092. * @param name defines camera name
  48093. * @param position defines initial position
  48094. * @param interaxialDistance defines distance between each color axis
  48095. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48096. * @param scene defines the hosting scene
  48097. */
  48098. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48099. /**
  48100. * Gets camera class name
  48101. * @returns StereoscopicGamepadCamera
  48102. */
  48103. getClassName(): string;
  48104. }
  48105. }
  48106. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  48107. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  48108. import { Scene } from "babylonjs/scene";
  48109. import { Vector3 } from "babylonjs/Maths/math.vector";
  48110. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48111. /**
  48112. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  48113. * @see https://doc.babylonjs.com/features/cameras
  48114. */
  48115. export class StereoscopicUniversalCamera extends UniversalCamera {
  48116. /**
  48117. * Creates a new StereoscopicUniversalCamera
  48118. * @param name defines camera name
  48119. * @param position defines initial position
  48120. * @param interaxialDistance defines distance between each color axis
  48121. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48122. * @param scene defines the hosting scene
  48123. */
  48124. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48125. /**
  48126. * Gets camera class name
  48127. * @returns StereoscopicUniversalCamera
  48128. */
  48129. getClassName(): string;
  48130. }
  48131. }
  48132. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48133. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48134. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48135. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48136. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48137. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48138. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48139. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48140. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48141. }
  48142. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48143. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48144. import { Scene } from "babylonjs/scene";
  48145. import { Vector3 } from "babylonjs/Maths/math.vector";
  48146. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48147. /**
  48148. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48149. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48150. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48151. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48152. */
  48153. export class VirtualJoysticksCamera extends FreeCamera {
  48154. /**
  48155. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48156. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48157. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48158. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48159. * @param name Define the name of the camera in the scene
  48160. * @param position Define the start position of the camera in the scene
  48161. * @param scene Define the scene the camera belongs to
  48162. */
  48163. constructor(name: string, position: Vector3, scene: Scene);
  48164. /**
  48165. * Gets the current object class name.
  48166. * @return the class name
  48167. */
  48168. getClassName(): string;
  48169. }
  48170. }
  48171. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48172. import { Matrix } from "babylonjs/Maths/math.vector";
  48173. /**
  48174. * This represents all the required metrics to create a VR camera.
  48175. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48176. */
  48177. export class VRCameraMetrics {
  48178. /**
  48179. * Define the horizontal resolution off the screen.
  48180. */
  48181. hResolution: number;
  48182. /**
  48183. * Define the vertical resolution off the screen.
  48184. */
  48185. vResolution: number;
  48186. /**
  48187. * Define the horizontal screen size.
  48188. */
  48189. hScreenSize: number;
  48190. /**
  48191. * Define the vertical screen size.
  48192. */
  48193. vScreenSize: number;
  48194. /**
  48195. * Define the vertical screen center position.
  48196. */
  48197. vScreenCenter: number;
  48198. /**
  48199. * Define the distance of the eyes to the screen.
  48200. */
  48201. eyeToScreenDistance: number;
  48202. /**
  48203. * Define the distance between both lenses
  48204. */
  48205. lensSeparationDistance: number;
  48206. /**
  48207. * Define the distance between both viewer's eyes.
  48208. */
  48209. interpupillaryDistance: number;
  48210. /**
  48211. * Define the distortion factor of the VR postprocess.
  48212. * Please, touch with care.
  48213. */
  48214. distortionK: number[];
  48215. /**
  48216. * Define the chromatic aberration correction factors for the VR post process.
  48217. */
  48218. chromaAbCorrection: number[];
  48219. /**
  48220. * Define the scale factor of the post process.
  48221. * The smaller the better but the slower.
  48222. */
  48223. postProcessScaleFactor: number;
  48224. /**
  48225. * Define an offset for the lens center.
  48226. */
  48227. lensCenterOffset: number;
  48228. /**
  48229. * Define if the current vr camera should compensate the distortion of the lense or not.
  48230. */
  48231. compensateDistortion: boolean;
  48232. /**
  48233. * Defines if multiview should be enabled when rendering (Default: false)
  48234. */
  48235. multiviewEnabled: boolean;
  48236. /**
  48237. * Gets the rendering aspect ratio based on the provided resolutions.
  48238. */
  48239. get aspectRatio(): number;
  48240. /**
  48241. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48242. */
  48243. get aspectRatioFov(): number;
  48244. /**
  48245. * @hidden
  48246. */
  48247. get leftHMatrix(): Matrix;
  48248. /**
  48249. * @hidden
  48250. */
  48251. get rightHMatrix(): Matrix;
  48252. /**
  48253. * @hidden
  48254. */
  48255. get leftPreViewMatrix(): Matrix;
  48256. /**
  48257. * @hidden
  48258. */
  48259. get rightPreViewMatrix(): Matrix;
  48260. /**
  48261. * Get the default VRMetrics based on the most generic setup.
  48262. * @returns the default vr metrics
  48263. */
  48264. static GetDefault(): VRCameraMetrics;
  48265. }
  48266. }
  48267. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48268. /** @hidden */
  48269. export var vrDistortionCorrectionPixelShader: {
  48270. name: string;
  48271. shader: string;
  48272. };
  48273. }
  48274. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48275. import { Camera } from "babylonjs/Cameras/camera";
  48276. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48277. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48278. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48279. /**
  48280. * VRDistortionCorrectionPostProcess used for mobile VR
  48281. */
  48282. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48283. private _isRightEye;
  48284. private _distortionFactors;
  48285. private _postProcessScaleFactor;
  48286. private _lensCenterOffset;
  48287. private _scaleIn;
  48288. private _scaleFactor;
  48289. private _lensCenter;
  48290. /**
  48291. * Gets a string identifying the name of the class
  48292. * @returns "VRDistortionCorrectionPostProcess" string
  48293. */
  48294. getClassName(): string;
  48295. /**
  48296. * Initializes the VRDistortionCorrectionPostProcess
  48297. * @param name The name of the effect.
  48298. * @param camera The camera to apply the render pass to.
  48299. * @param isRightEye If this is for the right eye distortion
  48300. * @param vrMetrics All the required metrics for the VR camera
  48301. */
  48302. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48303. }
  48304. }
  48305. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48306. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48307. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48308. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48309. import { Scene } from "babylonjs/scene";
  48310. import { Vector3 } from "babylonjs/Maths/math.vector";
  48311. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48312. import "babylonjs/Cameras/RigModes/vrRigMode";
  48313. /**
  48314. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48315. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48316. */
  48317. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48318. /**
  48319. * Creates a new VRDeviceOrientationArcRotateCamera
  48320. * @param name defines camera name
  48321. * @param alpha defines the camera rotation along the logitudinal axis
  48322. * @param beta defines the camera rotation along the latitudinal axis
  48323. * @param radius defines the camera distance from its target
  48324. * @param target defines the camera target
  48325. * @param scene defines the scene the camera belongs to
  48326. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48327. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48328. */
  48329. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48330. /**
  48331. * Gets camera class name
  48332. * @returns VRDeviceOrientationArcRotateCamera
  48333. */
  48334. getClassName(): string;
  48335. }
  48336. }
  48337. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48338. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48339. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48340. import { Scene } from "babylonjs/scene";
  48341. import { Vector3 } from "babylonjs/Maths/math.vector";
  48342. import "babylonjs/Cameras/RigModes/vrRigMode";
  48343. /**
  48344. * Camera used to simulate VR rendering (based on FreeCamera)
  48345. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48346. */
  48347. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48348. /**
  48349. * Creates a new VRDeviceOrientationFreeCamera
  48350. * @param name defines camera name
  48351. * @param position defines the start position of the camera
  48352. * @param scene defines the scene the camera belongs to
  48353. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48354. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48355. */
  48356. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48357. /**
  48358. * Gets camera class name
  48359. * @returns VRDeviceOrientationFreeCamera
  48360. */
  48361. getClassName(): string;
  48362. }
  48363. }
  48364. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48365. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48366. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48367. import { Scene } from "babylonjs/scene";
  48368. import { Vector3 } from "babylonjs/Maths/math.vector";
  48369. import "babylonjs/Gamepads/gamepadSceneComponent";
  48370. /**
  48371. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48372. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48373. */
  48374. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48375. /**
  48376. * Creates a new VRDeviceOrientationGamepadCamera
  48377. * @param name defines camera name
  48378. * @param position defines the start position of the camera
  48379. * @param scene defines the scene the camera belongs to
  48380. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48381. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48382. */
  48383. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48384. /**
  48385. * Gets camera class name
  48386. * @returns VRDeviceOrientationGamepadCamera
  48387. */
  48388. getClassName(): string;
  48389. }
  48390. }
  48391. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48392. import { Scene } from "babylonjs/scene";
  48393. import { Texture } from "babylonjs/Materials/Textures/texture";
  48394. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48395. /**
  48396. * A class extending Texture allowing drawing on a texture
  48397. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48398. */
  48399. export class DynamicTexture extends Texture {
  48400. private _generateMipMaps;
  48401. private _canvas;
  48402. private _context;
  48403. /**
  48404. * Creates a DynamicTexture
  48405. * @param name defines the name of the texture
  48406. * @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
  48407. * @param scene defines the scene where you want the texture
  48408. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48409. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48410. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48411. */
  48412. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48413. /**
  48414. * Get the current class name of the texture useful for serialization or dynamic coding.
  48415. * @returns "DynamicTexture"
  48416. */
  48417. getClassName(): string;
  48418. /**
  48419. * Gets the current state of canRescale
  48420. */
  48421. get canRescale(): boolean;
  48422. private _recreate;
  48423. /**
  48424. * Scales the texture
  48425. * @param ratio the scale factor to apply to both width and height
  48426. */
  48427. scale(ratio: number): void;
  48428. /**
  48429. * Resizes the texture
  48430. * @param width the new width
  48431. * @param height the new height
  48432. */
  48433. scaleTo(width: number, height: number): void;
  48434. /**
  48435. * Gets the context of the canvas used by the texture
  48436. * @returns the canvas context of the dynamic texture
  48437. */
  48438. getContext(): CanvasRenderingContext2D;
  48439. /**
  48440. * Clears the texture
  48441. */
  48442. clear(): void;
  48443. /**
  48444. * Updates the texture
  48445. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48446. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48447. */
  48448. update(invertY?: boolean, premulAlpha?: boolean): void;
  48449. /**
  48450. * Draws text onto the texture
  48451. * @param text defines the text to be drawn
  48452. * @param x defines the placement of the text from the left
  48453. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48454. * @param font defines the font to be used with font-style, font-size, font-name
  48455. * @param color defines the color used for the text
  48456. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48457. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48458. * @param update defines whether texture is immediately update (default is true)
  48459. */
  48460. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48461. /**
  48462. * Clones the texture
  48463. * @returns the clone of the texture.
  48464. */
  48465. clone(): DynamicTexture;
  48466. /**
  48467. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48468. * @returns a serialized dynamic texture object
  48469. */
  48470. serialize(): any;
  48471. private _IsCanvasElement;
  48472. /** @hidden */
  48473. _rebuild(): void;
  48474. }
  48475. }
  48476. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48477. import { Scene } from "babylonjs/scene";
  48478. import { Color3 } from "babylonjs/Maths/math.color";
  48479. import { Mesh } from "babylonjs/Meshes/mesh";
  48480. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48481. import { Nullable } from "babylonjs/types";
  48482. /**
  48483. * Class containing static functions to help procedurally build meshes
  48484. */
  48485. export class GroundBuilder {
  48486. /**
  48487. * Creates a ground mesh
  48488. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48489. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48490. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48491. * @param name defines the name of the mesh
  48492. * @param options defines the options used to create the mesh
  48493. * @param scene defines the hosting scene
  48494. * @returns the ground mesh
  48495. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48496. */
  48497. static CreateGround(name: string, options: {
  48498. width?: number;
  48499. height?: number;
  48500. subdivisions?: number;
  48501. subdivisionsX?: number;
  48502. subdivisionsY?: number;
  48503. updatable?: boolean;
  48504. }, scene: any): Mesh;
  48505. /**
  48506. * Creates a tiled ground mesh
  48507. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48508. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48509. * * 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
  48510. * * 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
  48511. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48512. * @param name defines the name of the mesh
  48513. * @param options defines the options used to create the mesh
  48514. * @param scene defines the hosting scene
  48515. * @returns the tiled ground mesh
  48516. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48517. */
  48518. static CreateTiledGround(name: string, options: {
  48519. xmin: number;
  48520. zmin: number;
  48521. xmax: number;
  48522. zmax: number;
  48523. subdivisions?: {
  48524. w: number;
  48525. h: number;
  48526. };
  48527. precision?: {
  48528. w: number;
  48529. h: number;
  48530. };
  48531. updatable?: boolean;
  48532. }, scene?: Nullable<Scene>): Mesh;
  48533. /**
  48534. * Creates a ground mesh from a height map
  48535. * * The parameter `url` sets the URL of the height map image resource.
  48536. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48537. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48538. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48539. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48540. * * 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.
  48541. * * 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).
  48542. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48543. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48544. * @param name defines the name of the mesh
  48545. * @param url defines the url to the height map
  48546. * @param options defines the options used to create the mesh
  48547. * @param scene defines the hosting scene
  48548. * @returns the ground mesh
  48549. * @see https://doc.babylonjs.com/babylon101/height_map
  48550. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48551. */
  48552. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48553. width?: number;
  48554. height?: number;
  48555. subdivisions?: number;
  48556. minHeight?: number;
  48557. maxHeight?: number;
  48558. colorFilter?: Color3;
  48559. alphaFilter?: number;
  48560. updatable?: boolean;
  48561. onReady?: (mesh: GroundMesh) => void;
  48562. }, scene?: Nullable<Scene>): GroundMesh;
  48563. }
  48564. }
  48565. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48566. import { Vector4 } from "babylonjs/Maths/math.vector";
  48567. import { Mesh } from "babylonjs/Meshes/mesh";
  48568. /**
  48569. * Class containing static functions to help procedurally build meshes
  48570. */
  48571. export class TorusBuilder {
  48572. /**
  48573. * Creates a torus mesh
  48574. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48575. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48576. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48577. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48578. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48579. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48580. * @param name defines the name of the mesh
  48581. * @param options defines the options used to create the mesh
  48582. * @param scene defines the hosting scene
  48583. * @returns the torus mesh
  48584. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48585. */
  48586. static CreateTorus(name: string, options: {
  48587. diameter?: number;
  48588. thickness?: number;
  48589. tessellation?: number;
  48590. updatable?: boolean;
  48591. sideOrientation?: number;
  48592. frontUVs?: Vector4;
  48593. backUVs?: Vector4;
  48594. }, scene: any): Mesh;
  48595. }
  48596. }
  48597. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48598. import { Vector4 } from "babylonjs/Maths/math.vector";
  48599. import { Color4 } from "babylonjs/Maths/math.color";
  48600. import { Mesh } from "babylonjs/Meshes/mesh";
  48601. /**
  48602. * Class containing static functions to help procedurally build meshes
  48603. */
  48604. export class CylinderBuilder {
  48605. /**
  48606. * Creates a cylinder or a cone mesh
  48607. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48608. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48609. * * 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.
  48610. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48611. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48612. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48613. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48614. * * 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).
  48615. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48616. * * 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).
  48617. * * 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
  48618. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48619. * * 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
  48620. * * 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.
  48621. * * If `enclose` is false, a ring surface is one element.
  48622. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48623. * * 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
  48624. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48625. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48626. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48627. * @param name defines the name of the mesh
  48628. * @param options defines the options used to create the mesh
  48629. * @param scene defines the hosting scene
  48630. * @returns the cylinder mesh
  48631. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48632. */
  48633. static CreateCylinder(name: string, options: {
  48634. height?: number;
  48635. diameterTop?: number;
  48636. diameterBottom?: number;
  48637. diameter?: number;
  48638. tessellation?: number;
  48639. subdivisions?: number;
  48640. arc?: number;
  48641. faceColors?: Color4[];
  48642. faceUV?: Vector4[];
  48643. updatable?: boolean;
  48644. hasRings?: boolean;
  48645. enclose?: boolean;
  48646. cap?: number;
  48647. sideOrientation?: number;
  48648. frontUVs?: Vector4;
  48649. backUVs?: Vector4;
  48650. }, scene: any): Mesh;
  48651. }
  48652. }
  48653. declare module "babylonjs/XR/webXRTypes" {
  48654. import { Nullable } from "babylonjs/types";
  48655. import { IDisposable } from "babylonjs/scene";
  48656. /**
  48657. * States of the webXR experience
  48658. */
  48659. export enum WebXRState {
  48660. /**
  48661. * Transitioning to being in XR mode
  48662. */
  48663. ENTERING_XR = 0,
  48664. /**
  48665. * Transitioning to non XR mode
  48666. */
  48667. EXITING_XR = 1,
  48668. /**
  48669. * In XR mode and presenting
  48670. */
  48671. IN_XR = 2,
  48672. /**
  48673. * Not entered XR mode
  48674. */
  48675. NOT_IN_XR = 3
  48676. }
  48677. /**
  48678. * Abstraction of the XR render target
  48679. */
  48680. export interface WebXRRenderTarget extends IDisposable {
  48681. /**
  48682. * xrpresent context of the canvas which can be used to display/mirror xr content
  48683. */
  48684. canvasContext: WebGLRenderingContext;
  48685. /**
  48686. * xr layer for the canvas
  48687. */
  48688. xrLayer: Nullable<XRWebGLLayer>;
  48689. /**
  48690. * Initializes the xr layer for the session
  48691. * @param xrSession xr session
  48692. * @returns a promise that will resolve once the XR Layer has been created
  48693. */
  48694. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48695. }
  48696. }
  48697. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48698. import { Nullable } from "babylonjs/types";
  48699. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48700. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48701. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48702. import { Observable } from "babylonjs/Misc/observable";
  48703. /**
  48704. * COnfiguration object for WebXR output canvas
  48705. */
  48706. export class WebXRManagedOutputCanvasOptions {
  48707. /**
  48708. * An optional canvas in case you wish to create it yourself and provide it here.
  48709. * If not provided, a new canvas will be created
  48710. */
  48711. canvasElement?: HTMLCanvasElement;
  48712. /**
  48713. * Options for this XR Layer output
  48714. */
  48715. canvasOptions?: XRWebGLLayerOptions;
  48716. /**
  48717. * CSS styling for a newly created canvas (if not provided)
  48718. */
  48719. newCanvasCssStyle?: string;
  48720. /**
  48721. * Get the default values of the configuration object
  48722. * @param engine defines the engine to use (can be null)
  48723. * @returns default values of this configuration object
  48724. */
  48725. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48726. }
  48727. /**
  48728. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48729. */
  48730. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48731. private _options;
  48732. private _canvas;
  48733. private _engine;
  48734. private _originalCanvasSize;
  48735. /**
  48736. * Rendering context of the canvas which can be used to display/mirror xr content
  48737. */
  48738. canvasContext: WebGLRenderingContext;
  48739. /**
  48740. * xr layer for the canvas
  48741. */
  48742. xrLayer: Nullable<XRWebGLLayer>;
  48743. /**
  48744. * Obseervers registered here will be triggered when the xr layer was initialized
  48745. */
  48746. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48747. /**
  48748. * Initializes the canvas to be added/removed upon entering/exiting xr
  48749. * @param _xrSessionManager The XR Session manager
  48750. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48751. */
  48752. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48753. /**
  48754. * Disposes of the object
  48755. */
  48756. dispose(): void;
  48757. /**
  48758. * Initializes the xr layer for the session
  48759. * @param xrSession xr session
  48760. * @returns a promise that will resolve once the XR Layer has been created
  48761. */
  48762. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48763. private _addCanvas;
  48764. private _removeCanvas;
  48765. private _setCanvasSize;
  48766. private _setManagedOutputCanvas;
  48767. }
  48768. }
  48769. declare module "babylonjs/XR/webXRSessionManager" {
  48770. import { Observable } from "babylonjs/Misc/observable";
  48771. import { Nullable } from "babylonjs/types";
  48772. import { IDisposable, Scene } from "babylonjs/scene";
  48773. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48774. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48775. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48776. /**
  48777. * Manages an XRSession to work with Babylon's engine
  48778. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48779. */
  48780. export class WebXRSessionManager implements IDisposable {
  48781. /** The scene which the session should be created for */
  48782. scene: Scene;
  48783. private _referenceSpace;
  48784. private _rttProvider;
  48785. private _sessionEnded;
  48786. private _xrNavigator;
  48787. private baseLayer;
  48788. /**
  48789. * The base reference space from which the session started. good if you want to reset your
  48790. * reference space
  48791. */
  48792. baseReferenceSpace: XRReferenceSpace;
  48793. /**
  48794. * Current XR frame
  48795. */
  48796. currentFrame: Nullable<XRFrame>;
  48797. /** WebXR timestamp updated every frame */
  48798. currentTimestamp: number;
  48799. /**
  48800. * Used just in case of a failure to initialize an immersive session.
  48801. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48802. */
  48803. defaultHeightCompensation: number;
  48804. /**
  48805. * Fires every time a new xrFrame arrives which can be used to update the camera
  48806. */
  48807. onXRFrameObservable: Observable<XRFrame>;
  48808. /**
  48809. * Fires when the reference space changed
  48810. */
  48811. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48812. /**
  48813. * Fires when the xr session is ended either by the device or manually done
  48814. */
  48815. onXRSessionEnded: Observable<any>;
  48816. /**
  48817. * Fires when the xr session is ended either by the device or manually done
  48818. */
  48819. onXRSessionInit: Observable<XRSession>;
  48820. /**
  48821. * Underlying xr session
  48822. */
  48823. session: XRSession;
  48824. /**
  48825. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48826. * or get the offset the player is currently at.
  48827. */
  48828. viewerReferenceSpace: XRReferenceSpace;
  48829. /**
  48830. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48831. * @param scene The scene which the session should be created for
  48832. */
  48833. constructor(
  48834. /** The scene which the session should be created for */
  48835. scene: Scene);
  48836. /**
  48837. * The current reference space used in this session. This reference space can constantly change!
  48838. * It is mainly used to offset the camera's position.
  48839. */
  48840. get referenceSpace(): XRReferenceSpace;
  48841. /**
  48842. * Set a new reference space and triggers the observable
  48843. */
  48844. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48845. /**
  48846. * Disposes of the session manager
  48847. */
  48848. dispose(): void;
  48849. /**
  48850. * Stops the xrSession and restores the render loop
  48851. * @returns Promise which resolves after it exits XR
  48852. */
  48853. exitXRAsync(): Promise<void>;
  48854. /**
  48855. * Gets the correct render target texture to be rendered this frame for this eye
  48856. * @param eye the eye for which to get the render target
  48857. * @returns the render target for the specified eye
  48858. */
  48859. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48860. /**
  48861. * Creates a WebXRRenderTarget object for the XR session
  48862. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48863. * @param options optional options to provide when creating a new render target
  48864. * @returns a WebXR render target to which the session can render
  48865. */
  48866. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48867. /**
  48868. * Initializes the manager
  48869. * After initialization enterXR can be called to start an XR session
  48870. * @returns Promise which resolves after it is initialized
  48871. */
  48872. initializeAsync(): Promise<void>;
  48873. /**
  48874. * Initializes an xr session
  48875. * @param xrSessionMode mode to initialize
  48876. * @param xrSessionInit defines optional and required values to pass to the session builder
  48877. * @returns a promise which will resolve once the session has been initialized
  48878. */
  48879. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48880. /**
  48881. * Checks if a session would be supported for the creation options specified
  48882. * @param sessionMode session mode to check if supported eg. immersive-vr
  48883. * @returns A Promise that resolves to true if supported and false if not
  48884. */
  48885. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48886. /**
  48887. * Resets the reference space to the one started the session
  48888. */
  48889. resetReferenceSpace(): void;
  48890. /**
  48891. * Starts rendering to the xr layer
  48892. */
  48893. runXRRenderLoop(): void;
  48894. /**
  48895. * Sets the reference space on the xr session
  48896. * @param referenceSpaceType space to set
  48897. * @returns a promise that will resolve once the reference space has been set
  48898. */
  48899. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48900. /**
  48901. * Updates the render state of the session
  48902. * @param state state to set
  48903. * @returns a promise that resolves once the render state has been updated
  48904. */
  48905. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48906. /**
  48907. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48908. * @param sessionMode defines the session to test
  48909. * @returns a promise with boolean as final value
  48910. */
  48911. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48912. private _createRenderTargetTexture;
  48913. }
  48914. }
  48915. declare module "babylonjs/XR/webXRCamera" {
  48916. import { Vector3 } from "babylonjs/Maths/math.vector";
  48917. import { Scene } from "babylonjs/scene";
  48918. import { Camera } from "babylonjs/Cameras/camera";
  48919. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48920. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48921. import { Observable } from "babylonjs/Misc/observable";
  48922. /**
  48923. * WebXR Camera which holds the views for the xrSession
  48924. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48925. */
  48926. export class WebXRCamera extends FreeCamera {
  48927. private _xrSessionManager;
  48928. private _firstFrame;
  48929. private _referenceQuaternion;
  48930. private _referencedPosition;
  48931. private _xrInvPositionCache;
  48932. private _xrInvQuaternionCache;
  48933. /**
  48934. * Observable raised before camera teleportation
  48935. */
  48936. onBeforeCameraTeleport: Observable<Vector3>;
  48937. /**
  48938. * Observable raised after camera teleportation
  48939. */
  48940. onAfterCameraTeleport: Observable<Vector3>;
  48941. /**
  48942. * Should position compensation execute on first frame.
  48943. * This is used when copying the position from a native (non XR) camera
  48944. */
  48945. compensateOnFirstFrame: boolean;
  48946. /**
  48947. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48948. * @param name the name of the camera
  48949. * @param scene the scene to add the camera to
  48950. * @param _xrSessionManager a constructed xr session manager
  48951. */
  48952. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48953. /**
  48954. * Return the user's height, unrelated to the current ground.
  48955. * This will be the y position of this camera, when ground level is 0.
  48956. */
  48957. get realWorldHeight(): number;
  48958. /** @hidden */
  48959. _updateForDualEyeDebugging(): void;
  48960. /**
  48961. * Sets this camera's transformation based on a non-vr camera
  48962. * @param otherCamera the non-vr camera to copy the transformation from
  48963. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48964. */
  48965. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48966. /**
  48967. * Gets the current instance class name ("WebXRCamera").
  48968. * @returns the class name
  48969. */
  48970. getClassName(): string;
  48971. private _rotate180;
  48972. private _updateFromXRSession;
  48973. private _updateNumberOfRigCameras;
  48974. private _updateReferenceSpace;
  48975. private _updateReferenceSpaceOffset;
  48976. }
  48977. }
  48978. declare module "babylonjs/XR/webXRFeaturesManager" {
  48979. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48980. import { IDisposable } from "babylonjs/scene";
  48981. /**
  48982. * Defining the interface required for a (webxr) feature
  48983. */
  48984. export interface IWebXRFeature extends IDisposable {
  48985. /**
  48986. * Is this feature attached
  48987. */
  48988. attached: boolean;
  48989. /**
  48990. * Should auto-attach be disabled?
  48991. */
  48992. disableAutoAttach: boolean;
  48993. /**
  48994. * Attach the feature to the session
  48995. * Will usually be called by the features manager
  48996. *
  48997. * @param force should attachment be forced (even when already attached)
  48998. * @returns true if successful.
  48999. */
  49000. attach(force?: boolean): boolean;
  49001. /**
  49002. * Detach the feature from the session
  49003. * Will usually be called by the features manager
  49004. *
  49005. * @returns true if successful.
  49006. */
  49007. detach(): boolean;
  49008. /**
  49009. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  49010. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  49011. *
  49012. * @returns whether or not the feature is compatible in this environment
  49013. */
  49014. isCompatible(): boolean;
  49015. /**
  49016. * Was this feature disposed;
  49017. */
  49018. isDisposed: boolean;
  49019. /**
  49020. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  49021. */
  49022. xrNativeFeatureName?: string;
  49023. /**
  49024. * A list of (Babylon WebXR) features this feature depends on
  49025. */
  49026. dependsOn?: string[];
  49027. }
  49028. /**
  49029. * A list of the currently available features without referencing them
  49030. */
  49031. export class WebXRFeatureName {
  49032. /**
  49033. * The name of the anchor system feature
  49034. */
  49035. static readonly ANCHOR_SYSTEM: string;
  49036. /**
  49037. * The name of the background remover feature
  49038. */
  49039. static readonly BACKGROUND_REMOVER: string;
  49040. /**
  49041. * The name of the hit test feature
  49042. */
  49043. static readonly HIT_TEST: string;
  49044. /**
  49045. * physics impostors for xr controllers feature
  49046. */
  49047. static readonly PHYSICS_CONTROLLERS: string;
  49048. /**
  49049. * The name of the plane detection feature
  49050. */
  49051. static readonly PLANE_DETECTION: string;
  49052. /**
  49053. * The name of the pointer selection feature
  49054. */
  49055. static readonly POINTER_SELECTION: string;
  49056. /**
  49057. * The name of the teleportation feature
  49058. */
  49059. static readonly TELEPORTATION: string;
  49060. /**
  49061. * The name of the feature points feature.
  49062. */
  49063. static readonly FEATURE_POINTS: string;
  49064. /**
  49065. * The name of the hand tracking feature.
  49066. */
  49067. static readonly HAND_TRACKING: string;
  49068. }
  49069. /**
  49070. * Defining the constructor of a feature. Used to register the modules.
  49071. */
  49072. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  49073. /**
  49074. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  49075. * It is mainly used in AR sessions.
  49076. *
  49077. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  49078. */
  49079. export class WebXRFeaturesManager implements IDisposable {
  49080. private _xrSessionManager;
  49081. private static readonly _AvailableFeatures;
  49082. private _features;
  49083. /**
  49084. * constructs a new features manages.
  49085. *
  49086. * @param _xrSessionManager an instance of WebXRSessionManager
  49087. */
  49088. constructor(_xrSessionManager: WebXRSessionManager);
  49089. /**
  49090. * Used to register a module. After calling this function a developer can use this feature in the scene.
  49091. * Mainly used internally.
  49092. *
  49093. * @param featureName the name of the feature to register
  49094. * @param constructorFunction the function used to construct the module
  49095. * @param version the (babylon) version of the module
  49096. * @param stable is that a stable version of this module
  49097. */
  49098. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  49099. /**
  49100. * Returns a constructor of a specific feature.
  49101. *
  49102. * @param featureName the name of the feature to construct
  49103. * @param version the version of the feature to load
  49104. * @param xrSessionManager the xrSessionManager. Used to construct the module
  49105. * @param options optional options provided to the module.
  49106. * @returns a function that, when called, will return a new instance of this feature
  49107. */
  49108. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  49109. /**
  49110. * Can be used to return the list of features currently registered
  49111. *
  49112. * @returns an Array of available features
  49113. */
  49114. static GetAvailableFeatures(): string[];
  49115. /**
  49116. * Gets the versions available for a specific feature
  49117. * @param featureName the name of the feature
  49118. * @returns an array with the available versions
  49119. */
  49120. static GetAvailableVersions(featureName: string): string[];
  49121. /**
  49122. * Return the latest unstable version of this feature
  49123. * @param featureName the name of the feature to search
  49124. * @returns the version number. if not found will return -1
  49125. */
  49126. static GetLatestVersionOfFeature(featureName: string): number;
  49127. /**
  49128. * Return the latest stable version of this feature
  49129. * @param featureName the name of the feature to search
  49130. * @returns the version number. if not found will return -1
  49131. */
  49132. static GetStableVersionOfFeature(featureName: string): number;
  49133. /**
  49134. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49135. * Can be used during a session to start a feature
  49136. * @param featureName the name of feature to attach
  49137. */
  49138. attachFeature(featureName: string): void;
  49139. /**
  49140. * Can be used inside a session or when the session ends to detach a specific feature
  49141. * @param featureName the name of the feature to detach
  49142. */
  49143. detachFeature(featureName: string): void;
  49144. /**
  49145. * Used to disable an already-enabled feature
  49146. * The feature will be disposed and will be recreated once enabled.
  49147. * @param featureName the feature to disable
  49148. * @returns true if disable was successful
  49149. */
  49150. disableFeature(featureName: string | {
  49151. Name: string;
  49152. }): boolean;
  49153. /**
  49154. * dispose this features manager
  49155. */
  49156. dispose(): void;
  49157. /**
  49158. * 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.
  49159. * 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.
  49160. *
  49161. * @param featureName the name of the feature to load or the class of the feature
  49162. * @param version optional version to load. if not provided the latest version will be enabled
  49163. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49164. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49165. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49166. * @returns a new constructed feature or throws an error if feature not found.
  49167. */
  49168. enableFeature(featureName: string | {
  49169. Name: string;
  49170. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49171. /**
  49172. * get the implementation of an enabled feature.
  49173. * @param featureName the name of the feature to load
  49174. * @returns the feature class, if found
  49175. */
  49176. getEnabledFeature(featureName: string): IWebXRFeature;
  49177. /**
  49178. * Get the list of enabled features
  49179. * @returns an array of enabled features
  49180. */
  49181. getEnabledFeatures(): string[];
  49182. /**
  49183. * This function will exten the session creation configuration object with enabled features.
  49184. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49185. * according to the defined "required" variable, provided during enableFeature call
  49186. * @param xrSessionInit the xr Session init object to extend
  49187. *
  49188. * @returns an extended XRSessionInit object
  49189. */
  49190. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49191. }
  49192. }
  49193. declare module "babylonjs/XR/webXRExperienceHelper" {
  49194. import { Observable } from "babylonjs/Misc/observable";
  49195. import { IDisposable, Scene } from "babylonjs/scene";
  49196. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49197. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49198. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49199. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49200. /**
  49201. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49202. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49203. */
  49204. export class WebXRExperienceHelper implements IDisposable {
  49205. private scene;
  49206. private _nonVRCamera;
  49207. private _originalSceneAutoClear;
  49208. private _supported;
  49209. /**
  49210. * Camera used to render xr content
  49211. */
  49212. camera: WebXRCamera;
  49213. /** A features manager for this xr session */
  49214. featuresManager: WebXRFeaturesManager;
  49215. /**
  49216. * Observers registered here will be triggered after the camera's initial transformation is set
  49217. * This can be used to set a different ground level or an extra rotation.
  49218. *
  49219. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49220. * to the position set after this observable is done executing.
  49221. */
  49222. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49223. /**
  49224. * Fires when the state of the experience helper has changed
  49225. */
  49226. onStateChangedObservable: Observable<WebXRState>;
  49227. /** Session manager used to keep track of xr session */
  49228. sessionManager: WebXRSessionManager;
  49229. /**
  49230. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49231. */
  49232. state: WebXRState;
  49233. /**
  49234. * Creates a WebXRExperienceHelper
  49235. * @param scene The scene the helper should be created in
  49236. */
  49237. private constructor();
  49238. /**
  49239. * Creates the experience helper
  49240. * @param scene the scene to attach the experience helper to
  49241. * @returns a promise for the experience helper
  49242. */
  49243. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49244. /**
  49245. * Disposes of the experience helper
  49246. */
  49247. dispose(): void;
  49248. /**
  49249. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49250. * @param sessionMode options for the XR session
  49251. * @param referenceSpaceType frame of reference of the XR session
  49252. * @param renderTarget the output canvas that will be used to enter XR mode
  49253. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49254. * @returns promise that resolves after xr mode has entered
  49255. */
  49256. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49257. /**
  49258. * Exits XR mode and returns the scene to its original state
  49259. * @returns promise that resolves after xr mode has exited
  49260. */
  49261. exitXRAsync(): Promise<void>;
  49262. private _nonXRToXRCamera;
  49263. private _setState;
  49264. }
  49265. }
  49266. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49267. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49268. import { Observable } from "babylonjs/Misc/observable";
  49269. import { IDisposable } from "babylonjs/scene";
  49270. /**
  49271. * X-Y values for axes in WebXR
  49272. */
  49273. export interface IWebXRMotionControllerAxesValue {
  49274. /**
  49275. * The value of the x axis
  49276. */
  49277. x: number;
  49278. /**
  49279. * The value of the y-axis
  49280. */
  49281. y: number;
  49282. }
  49283. /**
  49284. * changed / previous values for the values of this component
  49285. */
  49286. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49287. /**
  49288. * current (this frame) value
  49289. */
  49290. current: T;
  49291. /**
  49292. * previous (last change) value
  49293. */
  49294. previous: T;
  49295. }
  49296. /**
  49297. * Represents changes in the component between current frame and last values recorded
  49298. */
  49299. export interface IWebXRMotionControllerComponentChanges {
  49300. /**
  49301. * will be populated with previous and current values if axes changed
  49302. */
  49303. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49304. /**
  49305. * will be populated with previous and current values if pressed changed
  49306. */
  49307. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49308. /**
  49309. * will be populated with previous and current values if touched changed
  49310. */
  49311. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49312. /**
  49313. * will be populated with previous and current values if value changed
  49314. */
  49315. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49316. }
  49317. /**
  49318. * This class represents a single component (for example button or thumbstick) of a motion controller
  49319. */
  49320. export class WebXRControllerComponent implements IDisposable {
  49321. /**
  49322. * the id of this component
  49323. */
  49324. id: string;
  49325. /**
  49326. * the type of the component
  49327. */
  49328. type: MotionControllerComponentType;
  49329. private _buttonIndex;
  49330. private _axesIndices;
  49331. private _axes;
  49332. private _changes;
  49333. private _currentValue;
  49334. private _hasChanges;
  49335. private _pressed;
  49336. private _touched;
  49337. /**
  49338. * button component type
  49339. */
  49340. static BUTTON_TYPE: MotionControllerComponentType;
  49341. /**
  49342. * squeeze component type
  49343. */
  49344. static SQUEEZE_TYPE: MotionControllerComponentType;
  49345. /**
  49346. * Thumbstick component type
  49347. */
  49348. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49349. /**
  49350. * Touchpad component type
  49351. */
  49352. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49353. /**
  49354. * trigger component type
  49355. */
  49356. static TRIGGER_TYPE: MotionControllerComponentType;
  49357. /**
  49358. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49359. * the axes data changes
  49360. */
  49361. onAxisValueChangedObservable: Observable<{
  49362. x: number;
  49363. y: number;
  49364. }>;
  49365. /**
  49366. * Observers registered here will be triggered when the state of a button changes
  49367. * State change is either pressed / touched / value
  49368. */
  49369. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49370. /**
  49371. * Creates a new component for a motion controller.
  49372. * It is created by the motion controller itself
  49373. *
  49374. * @param id the id of this component
  49375. * @param type the type of the component
  49376. * @param _buttonIndex index in the buttons array of the gamepad
  49377. * @param _axesIndices indices of the values in the axes array of the gamepad
  49378. */
  49379. constructor(
  49380. /**
  49381. * the id of this component
  49382. */
  49383. id: string,
  49384. /**
  49385. * the type of the component
  49386. */
  49387. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49388. /**
  49389. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49390. */
  49391. get axes(): IWebXRMotionControllerAxesValue;
  49392. /**
  49393. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49394. */
  49395. get changes(): IWebXRMotionControllerComponentChanges;
  49396. /**
  49397. * Return whether or not the component changed the last frame
  49398. */
  49399. get hasChanges(): boolean;
  49400. /**
  49401. * is the button currently pressed
  49402. */
  49403. get pressed(): boolean;
  49404. /**
  49405. * is the button currently touched
  49406. */
  49407. get touched(): boolean;
  49408. /**
  49409. * Get the current value of this component
  49410. */
  49411. get value(): number;
  49412. /**
  49413. * Dispose this component
  49414. */
  49415. dispose(): void;
  49416. /**
  49417. * Are there axes correlating to this component
  49418. * @return true is axes data is available
  49419. */
  49420. isAxes(): boolean;
  49421. /**
  49422. * Is this component a button (hence - pressable)
  49423. * @returns true if can be pressed
  49424. */
  49425. isButton(): boolean;
  49426. /**
  49427. * update this component using the gamepad object it is in. Called on every frame
  49428. * @param nativeController the native gamepad controller object
  49429. */
  49430. update(nativeController: IMinimalMotionControllerObject): void;
  49431. }
  49432. }
  49433. declare module "babylonjs/Loading/sceneLoader" {
  49434. import { Observable } from "babylonjs/Misc/observable";
  49435. import { Nullable } from "babylonjs/types";
  49436. import { Scene } from "babylonjs/scene";
  49437. import { Engine } from "babylonjs/Engines/engine";
  49438. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49439. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49440. import { AssetContainer } from "babylonjs/assetContainer";
  49441. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49442. import { Skeleton } from "babylonjs/Bones/skeleton";
  49443. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49444. import { WebRequest } from "babylonjs/Misc/webRequest";
  49445. /**
  49446. * Interface used to represent data loading progression
  49447. */
  49448. export interface ISceneLoaderProgressEvent {
  49449. /**
  49450. * Defines if data length to load can be evaluated
  49451. */
  49452. readonly lengthComputable: boolean;
  49453. /**
  49454. * Defines the loaded data length
  49455. */
  49456. readonly loaded: number;
  49457. /**
  49458. * Defines the data length to load
  49459. */
  49460. readonly total: number;
  49461. }
  49462. /**
  49463. * Interface used by SceneLoader plugins to define supported file extensions
  49464. */
  49465. export interface ISceneLoaderPluginExtensions {
  49466. /**
  49467. * Defines the list of supported extensions
  49468. */
  49469. [extension: string]: {
  49470. isBinary: boolean;
  49471. };
  49472. }
  49473. /**
  49474. * Interface used by SceneLoader plugin factory
  49475. */
  49476. export interface ISceneLoaderPluginFactory {
  49477. /**
  49478. * Defines the name of the factory
  49479. */
  49480. name: string;
  49481. /**
  49482. * Function called to create a new plugin
  49483. * @return the new plugin
  49484. */
  49485. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49486. /**
  49487. * The callback that returns true if the data can be directly loaded.
  49488. * @param data string containing the file data
  49489. * @returns if the data can be loaded directly
  49490. */
  49491. canDirectLoad?(data: string): boolean;
  49492. }
  49493. /**
  49494. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49495. */
  49496. export interface ISceneLoaderPluginBase {
  49497. /**
  49498. * The friendly name of this plugin.
  49499. */
  49500. name: string;
  49501. /**
  49502. * The file extensions supported by this plugin.
  49503. */
  49504. extensions: string | ISceneLoaderPluginExtensions;
  49505. /**
  49506. * The callback called when loading from a url.
  49507. * @param scene scene loading this url
  49508. * @param url url to load
  49509. * @param onSuccess callback called when the file successfully loads
  49510. * @param onProgress callback called while file is loading (if the server supports this mode)
  49511. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49512. * @param onError callback called when the file fails to load
  49513. * @returns a file request object
  49514. */
  49515. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49516. /**
  49517. * The callback called when loading from a file object.
  49518. * @param scene scene loading this file
  49519. * @param file defines the file to load
  49520. * @param onSuccess defines the callback to call when data is loaded
  49521. * @param onProgress defines the callback to call during loading process
  49522. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49523. * @param onError defines the callback to call when an error occurs
  49524. * @returns a file request object
  49525. */
  49526. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49527. /**
  49528. * The callback that returns true if the data can be directly loaded.
  49529. * @param data string containing the file data
  49530. * @returns if the data can be loaded directly
  49531. */
  49532. canDirectLoad?(data: string): boolean;
  49533. /**
  49534. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49535. * @param scene scene loading this data
  49536. * @param data string containing the data
  49537. * @returns data to pass to the plugin
  49538. */
  49539. directLoad?(scene: Scene, data: string): any;
  49540. /**
  49541. * The callback that allows custom handling of the root url based on the response url.
  49542. * @param rootUrl the original root url
  49543. * @param responseURL the response url if available
  49544. * @returns the new root url
  49545. */
  49546. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49547. }
  49548. /**
  49549. * Interface used to define a SceneLoader plugin
  49550. */
  49551. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49552. /**
  49553. * Import meshes into a scene.
  49554. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49555. * @param scene The scene to import into
  49556. * @param data The data to import
  49557. * @param rootUrl The root url for scene and resources
  49558. * @param meshes The meshes array to import into
  49559. * @param particleSystems The particle systems array to import into
  49560. * @param skeletons The skeletons array to import into
  49561. * @param onError The callback when import fails
  49562. * @returns True if successful or false otherwise
  49563. */
  49564. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49565. /**
  49566. * Load into a scene.
  49567. * @param scene The scene to load into
  49568. * @param data The data to import
  49569. * @param rootUrl The root url for scene and resources
  49570. * @param onError The callback when import fails
  49571. * @returns True if successful or false otherwise
  49572. */
  49573. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49574. /**
  49575. * Load into an asset container.
  49576. * @param scene The scene to load into
  49577. * @param data The data to import
  49578. * @param rootUrl The root url for scene and resources
  49579. * @param onError The callback when import fails
  49580. * @returns The loaded asset container
  49581. */
  49582. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49583. }
  49584. /**
  49585. * Interface used to define an async SceneLoader plugin
  49586. */
  49587. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49588. /**
  49589. * Import meshes into a scene.
  49590. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49591. * @param scene The scene to import into
  49592. * @param data The data to import
  49593. * @param rootUrl The root url for scene and resources
  49594. * @param onProgress The callback when the load progresses
  49595. * @param fileName Defines the name of the file to load
  49596. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49597. */
  49598. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49599. meshes: AbstractMesh[];
  49600. particleSystems: IParticleSystem[];
  49601. skeletons: Skeleton[];
  49602. animationGroups: AnimationGroup[];
  49603. }>;
  49604. /**
  49605. * Load into a scene.
  49606. * @param scene The scene to load into
  49607. * @param data The data to import
  49608. * @param rootUrl The root url for scene and resources
  49609. * @param onProgress The callback when the load progresses
  49610. * @param fileName Defines the name of the file to load
  49611. * @returns Nothing
  49612. */
  49613. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49614. /**
  49615. * Load into an asset container.
  49616. * @param scene The scene to load into
  49617. * @param data The data to import
  49618. * @param rootUrl The root url for scene and resources
  49619. * @param onProgress The callback when the load progresses
  49620. * @param fileName Defines the name of the file to load
  49621. * @returns The loaded asset container
  49622. */
  49623. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49624. }
  49625. /**
  49626. * Mode that determines how to handle old animation groups before loading new ones.
  49627. */
  49628. export enum SceneLoaderAnimationGroupLoadingMode {
  49629. /**
  49630. * Reset all old animations to initial state then dispose them.
  49631. */
  49632. Clean = 0,
  49633. /**
  49634. * Stop all old animations.
  49635. */
  49636. Stop = 1,
  49637. /**
  49638. * Restart old animations from first frame.
  49639. */
  49640. Sync = 2,
  49641. /**
  49642. * Old animations remains untouched.
  49643. */
  49644. NoSync = 3
  49645. }
  49646. /**
  49647. * Defines a plugin registered by the SceneLoader
  49648. */
  49649. interface IRegisteredPlugin {
  49650. /**
  49651. * Defines the plugin to use
  49652. */
  49653. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49654. /**
  49655. * Defines if the plugin supports binary data
  49656. */
  49657. isBinary: boolean;
  49658. }
  49659. /**
  49660. * Class used to load scene from various file formats using registered plugins
  49661. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49662. */
  49663. export class SceneLoader {
  49664. /**
  49665. * No logging while loading
  49666. */
  49667. static readonly NO_LOGGING: number;
  49668. /**
  49669. * Minimal logging while loading
  49670. */
  49671. static readonly MINIMAL_LOGGING: number;
  49672. /**
  49673. * Summary logging while loading
  49674. */
  49675. static readonly SUMMARY_LOGGING: number;
  49676. /**
  49677. * Detailled logging while loading
  49678. */
  49679. static readonly DETAILED_LOGGING: number;
  49680. /**
  49681. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49682. */
  49683. static get ForceFullSceneLoadingForIncremental(): boolean;
  49684. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49685. /**
  49686. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49687. */
  49688. static get ShowLoadingScreen(): boolean;
  49689. static set ShowLoadingScreen(value: boolean);
  49690. /**
  49691. * Defines the current logging level (while loading the scene)
  49692. * @ignorenaming
  49693. */
  49694. static get loggingLevel(): number;
  49695. static set loggingLevel(value: number);
  49696. /**
  49697. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49698. */
  49699. static get CleanBoneMatrixWeights(): boolean;
  49700. static set CleanBoneMatrixWeights(value: boolean);
  49701. /**
  49702. * Event raised when a plugin is used to load a scene
  49703. */
  49704. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49705. private static _registeredPlugins;
  49706. private static _showingLoadingScreen;
  49707. /**
  49708. * Gets the default plugin (used to load Babylon files)
  49709. * @returns the .babylon plugin
  49710. */
  49711. static GetDefaultPlugin(): IRegisteredPlugin;
  49712. private static _GetPluginForExtension;
  49713. private static _GetPluginForDirectLoad;
  49714. private static _GetPluginForFilename;
  49715. private static _GetDirectLoad;
  49716. private static _LoadData;
  49717. private static _GetFileInfo;
  49718. /**
  49719. * Gets a plugin that can load the given extension
  49720. * @param extension defines the extension to load
  49721. * @returns a plugin or null if none works
  49722. */
  49723. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49724. /**
  49725. * Gets a boolean indicating that the given extension can be loaded
  49726. * @param extension defines the extension to load
  49727. * @returns true if the extension is supported
  49728. */
  49729. static IsPluginForExtensionAvailable(extension: string): boolean;
  49730. /**
  49731. * Adds a new plugin to the list of registered plugins
  49732. * @param plugin defines the plugin to add
  49733. */
  49734. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49735. /**
  49736. * Import meshes into a scene
  49737. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49738. * @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)
  49739. * @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)
  49740. * @param scene the instance of BABYLON.Scene to append to
  49741. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  49742. * @param onProgress a callback with a progress event for each file being loaded
  49743. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49744. * @param pluginExtension the extension used to determine the plugin
  49745. * @returns The loaded plugin
  49746. */
  49747. 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>;
  49748. /**
  49749. * Import meshes into a scene
  49750. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49751. * @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)
  49752. * @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)
  49753. * @param scene the instance of BABYLON.Scene to append to
  49754. * @param onProgress a callback with a progress event for each file being loaded
  49755. * @param pluginExtension the extension used to determine the plugin
  49756. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49757. */
  49758. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49759. meshes: AbstractMesh[];
  49760. particleSystems: IParticleSystem[];
  49761. skeletons: Skeleton[];
  49762. animationGroups: AnimationGroup[];
  49763. }>;
  49764. /**
  49765. * Load a scene
  49766. * @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)
  49767. * @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)
  49768. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49769. * @param onSuccess a callback with the scene when import succeeds
  49770. * @param onProgress a callback with a progress event for each file being loaded
  49771. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49772. * @param pluginExtension the extension used to determine the plugin
  49773. * @returns The loaded plugin
  49774. */
  49775. 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>;
  49776. /**
  49777. * Load a scene
  49778. * @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)
  49779. * @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)
  49780. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49781. * @param onProgress a callback with a progress event for each file being loaded
  49782. * @param pluginExtension the extension used to determine the plugin
  49783. * @returns The loaded scene
  49784. */
  49785. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49786. /**
  49787. * Append a scene
  49788. * @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)
  49789. * @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)
  49790. * @param scene is the instance of BABYLON.Scene to append to
  49791. * @param onSuccess a callback with the scene when import succeeds
  49792. * @param onProgress a callback with a progress event for each file being loaded
  49793. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49794. * @param pluginExtension the extension used to determine the plugin
  49795. * @returns The loaded plugin
  49796. */
  49797. 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>;
  49798. /**
  49799. * Append a scene
  49800. * @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)
  49801. * @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)
  49802. * @param scene is the instance of BABYLON.Scene to append to
  49803. * @param onProgress a callback with a progress event for each file being loaded
  49804. * @param pluginExtension the extension used to determine the plugin
  49805. * @returns The given scene
  49806. */
  49807. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49808. /**
  49809. * Load a scene into an asset container
  49810. * @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)
  49811. * @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)
  49812. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49813. * @param onSuccess a callback with the scene when import succeeds
  49814. * @param onProgress a callback with a progress event for each file being loaded
  49815. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49816. * @param pluginExtension the extension used to determine the plugin
  49817. * @returns The loaded plugin
  49818. */
  49819. 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>;
  49820. /**
  49821. * Load a scene into an asset container
  49822. * @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)
  49823. * @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)
  49824. * @param scene is the instance of Scene to append to
  49825. * @param onProgress a callback with a progress event for each file being loaded
  49826. * @param pluginExtension the extension used to determine the plugin
  49827. * @returns The loaded asset container
  49828. */
  49829. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49830. /**
  49831. * Import animations from a file into a scene
  49832. * @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)
  49833. * @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)
  49834. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49835. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49836. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49837. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49838. * @param onSuccess a callback with the scene when import succeeds
  49839. * @param onProgress a callback with a progress event for each file being loaded
  49840. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49841. * @param pluginExtension the extension used to determine the plugin
  49842. */
  49843. 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;
  49844. /**
  49845. * Import animations from a file into a scene
  49846. * @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)
  49847. * @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)
  49848. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49849. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49850. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49851. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49852. * @param onSuccess a callback with the scene when import succeeds
  49853. * @param onProgress a callback with a progress event for each file being loaded
  49854. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49855. * @param pluginExtension the extension used to determine the plugin
  49856. * @returns the updated scene with imported animations
  49857. */
  49858. 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>;
  49859. }
  49860. }
  49861. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49862. import { IDisposable, Scene } from "babylonjs/scene";
  49863. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49864. import { Observable } from "babylonjs/Misc/observable";
  49865. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49866. import { Nullable } from "babylonjs/types";
  49867. /**
  49868. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49869. */
  49870. export type MotionControllerHandedness = "none" | "left" | "right";
  49871. /**
  49872. * The type of components available in motion controllers.
  49873. * This is not the name of the component.
  49874. */
  49875. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49876. /**
  49877. * The state of a controller component
  49878. */
  49879. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49880. /**
  49881. * The schema of motion controller layout.
  49882. * No object will be initialized using this interface
  49883. * This is used just to define the profile.
  49884. */
  49885. export interface IMotionControllerLayout {
  49886. /**
  49887. * Path to load the assets. Usually relative to the base path
  49888. */
  49889. assetPath: string;
  49890. /**
  49891. * Available components (unsorted)
  49892. */
  49893. components: {
  49894. /**
  49895. * A map of component Ids
  49896. */
  49897. [componentId: string]: {
  49898. /**
  49899. * The type of input the component outputs
  49900. */
  49901. type: MotionControllerComponentType;
  49902. /**
  49903. * The indices of this component in the gamepad object
  49904. */
  49905. gamepadIndices: {
  49906. /**
  49907. * Index of button
  49908. */
  49909. button?: number;
  49910. /**
  49911. * If available, index of x-axis
  49912. */
  49913. xAxis?: number;
  49914. /**
  49915. * If available, index of y-axis
  49916. */
  49917. yAxis?: number;
  49918. };
  49919. /**
  49920. * The mesh's root node name
  49921. */
  49922. rootNodeName: string;
  49923. /**
  49924. * Animation definitions for this model
  49925. */
  49926. visualResponses: {
  49927. [stateKey: string]: {
  49928. /**
  49929. * What property will be animated
  49930. */
  49931. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49932. /**
  49933. * What states influence this visual response
  49934. */
  49935. states: MotionControllerComponentStateType[];
  49936. /**
  49937. * Type of animation - movement or visibility
  49938. */
  49939. valueNodeProperty: "transform" | "visibility";
  49940. /**
  49941. * Base node name to move. Its position will be calculated according to the min and max nodes
  49942. */
  49943. valueNodeName?: string;
  49944. /**
  49945. * Minimum movement node
  49946. */
  49947. minNodeName?: string;
  49948. /**
  49949. * Max movement node
  49950. */
  49951. maxNodeName?: string;
  49952. };
  49953. };
  49954. /**
  49955. * If touch enabled, what is the name of node to display user feedback
  49956. */
  49957. touchPointNodeName?: string;
  49958. };
  49959. };
  49960. /**
  49961. * Is it xr standard mapping or not
  49962. */
  49963. gamepadMapping: "" | "xr-standard";
  49964. /**
  49965. * Base root node of this entire model
  49966. */
  49967. rootNodeName: string;
  49968. /**
  49969. * Defines the main button component id
  49970. */
  49971. selectComponentId: string;
  49972. }
  49973. /**
  49974. * A definition for the layout map in the input profile
  49975. */
  49976. export interface IMotionControllerLayoutMap {
  49977. /**
  49978. * Layouts with handedness type as a key
  49979. */
  49980. [handedness: string]: IMotionControllerLayout;
  49981. }
  49982. /**
  49983. * The XR Input profile schema
  49984. * Profiles can be found here:
  49985. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49986. */
  49987. export interface IMotionControllerProfile {
  49988. /**
  49989. * fallback profiles for this profileId
  49990. */
  49991. fallbackProfileIds: string[];
  49992. /**
  49993. * The layout map, with handedness as key
  49994. */
  49995. layouts: IMotionControllerLayoutMap;
  49996. /**
  49997. * The id of this profile
  49998. * correlates to the profile(s) in the xrInput.profiles array
  49999. */
  50000. profileId: string;
  50001. }
  50002. /**
  50003. * A helper-interface for the 3 meshes needed for controller button animation
  50004. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  50005. */
  50006. export interface IMotionControllerButtonMeshMap {
  50007. /**
  50008. * the mesh that defines the pressed value mesh position.
  50009. * This is used to find the max-position of this button
  50010. */
  50011. pressedMesh: AbstractMesh;
  50012. /**
  50013. * the mesh that defines the unpressed value mesh position.
  50014. * This is used to find the min (or initial) position of this button
  50015. */
  50016. unpressedMesh: AbstractMesh;
  50017. /**
  50018. * The mesh that will be changed when value changes
  50019. */
  50020. valueMesh: AbstractMesh;
  50021. }
  50022. /**
  50023. * A helper-interface for the 3 meshes needed for controller axis animation.
  50024. * This will be expanded when touchpad animations are fully supported
  50025. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  50026. */
  50027. export interface IMotionControllerMeshMap {
  50028. /**
  50029. * the mesh that defines the maximum value mesh position.
  50030. */
  50031. maxMesh?: AbstractMesh;
  50032. /**
  50033. * the mesh that defines the minimum value mesh position.
  50034. */
  50035. minMesh?: AbstractMesh;
  50036. /**
  50037. * The mesh that will be changed when axis value changes
  50038. */
  50039. valueMesh?: AbstractMesh;
  50040. }
  50041. /**
  50042. * The elements needed for change-detection of the gamepad objects in motion controllers
  50043. */
  50044. export interface IMinimalMotionControllerObject {
  50045. /**
  50046. * Available axes of this controller
  50047. */
  50048. axes: number[];
  50049. /**
  50050. * An array of available buttons
  50051. */
  50052. buttons: Array<{
  50053. /**
  50054. * Value of the button/trigger
  50055. */
  50056. value: number;
  50057. /**
  50058. * If the button/trigger is currently touched
  50059. */
  50060. touched: boolean;
  50061. /**
  50062. * If the button/trigger is currently pressed
  50063. */
  50064. pressed: boolean;
  50065. }>;
  50066. /**
  50067. * EXPERIMENTAL haptic support.
  50068. */
  50069. hapticActuators?: Array<{
  50070. pulse: (value: number, duration: number) => Promise<boolean>;
  50071. }>;
  50072. }
  50073. /**
  50074. * An Abstract Motion controller
  50075. * This class receives an xrInput and a profile layout and uses those to initialize the components
  50076. * Each component has an observable to check for changes in value and state
  50077. */
  50078. export abstract class WebXRAbstractMotionController implements IDisposable {
  50079. protected scene: Scene;
  50080. protected layout: IMotionControllerLayout;
  50081. /**
  50082. * The gamepad object correlating to this controller
  50083. */
  50084. gamepadObject: IMinimalMotionControllerObject;
  50085. /**
  50086. * handedness (left/right/none) of this controller
  50087. */
  50088. handedness: MotionControllerHandedness;
  50089. private _initComponent;
  50090. private _modelReady;
  50091. /**
  50092. * A map of components (WebXRControllerComponent) in this motion controller
  50093. * Components have a ComponentType and can also have both button and axis definitions
  50094. */
  50095. readonly components: {
  50096. [id: string]: WebXRControllerComponent;
  50097. };
  50098. /**
  50099. * Disable the model's animation. Can be set at any time.
  50100. */
  50101. disableAnimation: boolean;
  50102. /**
  50103. * Observers registered here will be triggered when the model of this controller is done loading
  50104. */
  50105. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  50106. /**
  50107. * The profile id of this motion controller
  50108. */
  50109. abstract profileId: string;
  50110. /**
  50111. * The root mesh of the model. It is null if the model was not yet initialized
  50112. */
  50113. rootMesh: Nullable<AbstractMesh>;
  50114. /**
  50115. * constructs a new abstract motion controller
  50116. * @param scene the scene to which the model of the controller will be added
  50117. * @param layout The profile layout to load
  50118. * @param gamepadObject The gamepad object correlating to this controller
  50119. * @param handedness handedness (left/right/none) of this controller
  50120. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  50121. */
  50122. constructor(scene: Scene, layout: IMotionControllerLayout,
  50123. /**
  50124. * The gamepad object correlating to this controller
  50125. */
  50126. gamepadObject: IMinimalMotionControllerObject,
  50127. /**
  50128. * handedness (left/right/none) of this controller
  50129. */
  50130. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  50131. /**
  50132. * Dispose this controller, the model mesh and all its components
  50133. */
  50134. dispose(): void;
  50135. /**
  50136. * Returns all components of specific type
  50137. * @param type the type to search for
  50138. * @return an array of components with this type
  50139. */
  50140. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50141. /**
  50142. * get a component based an its component id as defined in layout.components
  50143. * @param id the id of the component
  50144. * @returns the component correlates to the id or undefined if not found
  50145. */
  50146. getComponent(id: string): WebXRControllerComponent;
  50147. /**
  50148. * Get the list of components available in this motion controller
  50149. * @returns an array of strings correlating to available components
  50150. */
  50151. getComponentIds(): string[];
  50152. /**
  50153. * Get the first component of specific type
  50154. * @param type type of component to find
  50155. * @return a controller component or null if not found
  50156. */
  50157. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50158. /**
  50159. * Get the main (Select) component of this controller as defined in the layout
  50160. * @returns the main component of this controller
  50161. */
  50162. getMainComponent(): WebXRControllerComponent;
  50163. /**
  50164. * Loads the model correlating to this controller
  50165. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50166. * @returns A promise fulfilled with the result of the model loading
  50167. */
  50168. loadModel(): Promise<boolean>;
  50169. /**
  50170. * Update this model using the current XRFrame
  50171. * @param xrFrame the current xr frame to use and update the model
  50172. */
  50173. updateFromXRFrame(xrFrame: XRFrame): void;
  50174. /**
  50175. * Backwards compatibility due to a deeply-integrated typo
  50176. */
  50177. get handness(): XREye;
  50178. /**
  50179. * Pulse (vibrate) this controller
  50180. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50181. * Consecutive calls to this function will cancel the last pulse call
  50182. *
  50183. * @param value the strength of the pulse in 0.0...1.0 range
  50184. * @param duration Duration of the pulse in milliseconds
  50185. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50186. * @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
  50187. */
  50188. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50189. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50190. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50191. /**
  50192. * Moves the axis on the controller mesh based on its current state
  50193. * @param axis the index of the axis
  50194. * @param axisValue the value of the axis which determines the meshes new position
  50195. * @hidden
  50196. */
  50197. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50198. /**
  50199. * Update the model itself with the current frame data
  50200. * @param xrFrame the frame to use for updating the model mesh
  50201. */
  50202. protected updateModel(xrFrame: XRFrame): void;
  50203. /**
  50204. * Get the filename and path for this controller's model
  50205. * @returns a map of filename and path
  50206. */
  50207. protected abstract _getFilenameAndPath(): {
  50208. filename: string;
  50209. path: string;
  50210. };
  50211. /**
  50212. * This function is called before the mesh is loaded. It checks for loading constraints.
  50213. * For example, this function can check if the GLB loader is available
  50214. * If this function returns false, the generic controller will be loaded instead
  50215. * @returns Is the client ready to load the mesh
  50216. */
  50217. protected abstract _getModelLoadingConstraints(): boolean;
  50218. /**
  50219. * This function will be called after the model was successfully loaded and can be used
  50220. * for mesh transformations before it is available for the user
  50221. * @param meshes the loaded meshes
  50222. */
  50223. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50224. /**
  50225. * Set the root mesh for this controller. Important for the WebXR controller class
  50226. * @param meshes the loaded meshes
  50227. */
  50228. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50229. /**
  50230. * A function executed each frame that updates the mesh (if needed)
  50231. * @param xrFrame the current xrFrame
  50232. */
  50233. protected abstract _updateModel(xrFrame: XRFrame): void;
  50234. private _getGenericFilenameAndPath;
  50235. private _getGenericParentMesh;
  50236. }
  50237. }
  50238. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50239. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50241. import { Scene } from "babylonjs/scene";
  50242. /**
  50243. * A generic trigger-only motion controller for WebXR
  50244. */
  50245. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50246. /**
  50247. * Static version of the profile id of this controller
  50248. */
  50249. static ProfileId: string;
  50250. profileId: string;
  50251. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50252. protected _getFilenameAndPath(): {
  50253. filename: string;
  50254. path: string;
  50255. };
  50256. protected _getModelLoadingConstraints(): boolean;
  50257. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50258. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50259. protected _updateModel(): void;
  50260. }
  50261. }
  50262. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50263. import { Vector4 } from "babylonjs/Maths/math.vector";
  50264. import { Mesh } from "babylonjs/Meshes/mesh";
  50265. import { Scene } from "babylonjs/scene";
  50266. import { Nullable } from "babylonjs/types";
  50267. /**
  50268. * Class containing static functions to help procedurally build meshes
  50269. */
  50270. export class SphereBuilder {
  50271. /**
  50272. * Creates a sphere mesh
  50273. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50274. * * 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`)
  50275. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50276. * * 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
  50277. * * 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)
  50278. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50279. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50280. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50281. * @param name defines the name of the mesh
  50282. * @param options defines the options used to create the mesh
  50283. * @param scene defines the hosting scene
  50284. * @returns the sphere mesh
  50285. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50286. */
  50287. static CreateSphere(name: string, options: {
  50288. segments?: number;
  50289. diameter?: number;
  50290. diameterX?: number;
  50291. diameterY?: number;
  50292. diameterZ?: number;
  50293. arc?: number;
  50294. slice?: number;
  50295. sideOrientation?: number;
  50296. frontUVs?: Vector4;
  50297. backUVs?: Vector4;
  50298. updatable?: boolean;
  50299. }, scene?: Nullable<Scene>): Mesh;
  50300. }
  50301. }
  50302. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50303. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50304. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50305. import { Scene } from "babylonjs/scene";
  50306. /**
  50307. * A profiled motion controller has its profile loaded from an online repository.
  50308. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50309. */
  50310. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50311. private _repositoryUrl;
  50312. private _buttonMeshMapping;
  50313. private _touchDots;
  50314. /**
  50315. * The profile ID of this controller. Will be populated when the controller initializes.
  50316. */
  50317. profileId: string;
  50318. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50319. dispose(): void;
  50320. protected _getFilenameAndPath(): {
  50321. filename: string;
  50322. path: string;
  50323. };
  50324. protected _getModelLoadingConstraints(): boolean;
  50325. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50326. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50327. protected _updateModel(_xrFrame: XRFrame): void;
  50328. }
  50329. }
  50330. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50331. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50332. import { Scene } from "babylonjs/scene";
  50333. /**
  50334. * A construction function type to create a new controller based on an xrInput object
  50335. */
  50336. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50337. /**
  50338. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50339. *
  50340. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50341. * it should be replaced with auto-loaded controllers.
  50342. *
  50343. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50344. */
  50345. export class WebXRMotionControllerManager {
  50346. private static _AvailableControllers;
  50347. private static _Fallbacks;
  50348. private static _ProfileLoadingPromises;
  50349. private static _ProfilesList;
  50350. /**
  50351. * The base URL of the online controller repository. Can be changed at any time.
  50352. */
  50353. static BaseRepositoryUrl: string;
  50354. /**
  50355. * Which repository gets priority - local or online
  50356. */
  50357. static PrioritizeOnlineRepository: boolean;
  50358. /**
  50359. * Use the online repository, or use only locally-defined controllers
  50360. */
  50361. static UseOnlineRepository: boolean;
  50362. /**
  50363. * Clear the cache used for profile loading and reload when requested again
  50364. */
  50365. static ClearProfilesCache(): void;
  50366. /**
  50367. * Register the default fallbacks.
  50368. * This function is called automatically when this file is imported.
  50369. */
  50370. static DefaultFallbacks(): void;
  50371. /**
  50372. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50373. * @param profileId the profile to which a fallback needs to be found
  50374. * @return an array with corresponding fallback profiles
  50375. */
  50376. static FindFallbackWithProfileId(profileId: string): string[];
  50377. /**
  50378. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50379. * The order of search:
  50380. *
  50381. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50382. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50383. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50384. * 4) return the generic trigger controller if none were found
  50385. *
  50386. * @param xrInput the xrInput to which a new controller is initialized
  50387. * @param scene the scene to which the model will be added
  50388. * @param forceProfile force a certain profile for this controller
  50389. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50390. */
  50391. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50392. /**
  50393. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50394. *
  50395. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50396. *
  50397. * @param type the profile type to register
  50398. * @param constructFunction the function to be called when loading this profile
  50399. */
  50400. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50401. /**
  50402. * Register a fallback to a specific profile.
  50403. * @param profileId the profileId that will receive the fallbacks
  50404. * @param fallbacks A list of fallback profiles
  50405. */
  50406. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50407. /**
  50408. * Will update the list of profiles available in the repository
  50409. * @return a promise that resolves to a map of profiles available online
  50410. */
  50411. static UpdateProfilesList(): Promise<{
  50412. [profile: string]: string;
  50413. }>;
  50414. private static _LoadProfileFromRepository;
  50415. private static _LoadProfilesFromAvailableControllers;
  50416. }
  50417. }
  50418. declare module "babylonjs/XR/webXRInputSource" {
  50419. import { Observable } from "babylonjs/Misc/observable";
  50420. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50421. import { Ray } from "babylonjs/Culling/ray";
  50422. import { Scene } from "babylonjs/scene";
  50423. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50424. /**
  50425. * Configuration options for the WebXR controller creation
  50426. */
  50427. export interface IWebXRControllerOptions {
  50428. /**
  50429. * Should the controller mesh be animated when a user interacts with it
  50430. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50431. */
  50432. disableMotionControllerAnimation?: boolean;
  50433. /**
  50434. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50435. */
  50436. doNotLoadControllerMesh?: boolean;
  50437. /**
  50438. * Force a specific controller type for this controller.
  50439. * This can be used when creating your own profile or when testing different controllers
  50440. */
  50441. forceControllerProfile?: string;
  50442. /**
  50443. * Defines a rendering group ID for meshes that will be loaded.
  50444. * This is for the default controllers only.
  50445. */
  50446. renderingGroupId?: number;
  50447. }
  50448. /**
  50449. * Represents an XR controller
  50450. */
  50451. export class WebXRInputSource {
  50452. private _scene;
  50453. /** The underlying input source for the controller */
  50454. inputSource: XRInputSource;
  50455. private _options;
  50456. private _tmpVector;
  50457. private _uniqueId;
  50458. private _disposed;
  50459. /**
  50460. * 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
  50461. */
  50462. grip?: AbstractMesh;
  50463. /**
  50464. * If available, this is the gamepad object related to this controller.
  50465. * Using this object it is possible to get click events and trackpad changes of the
  50466. * webxr controller that is currently being used.
  50467. */
  50468. motionController?: WebXRAbstractMotionController;
  50469. /**
  50470. * Event that fires when the controller is removed/disposed.
  50471. * The object provided as event data is this controller, after associated assets were disposed.
  50472. * uniqueId is still available.
  50473. */
  50474. onDisposeObservable: Observable<WebXRInputSource>;
  50475. /**
  50476. * Will be triggered when the mesh associated with the motion controller is done loading.
  50477. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50478. * A shortened version of controller -> motion controller -> on mesh loaded.
  50479. */
  50480. onMeshLoadedObservable: Observable<AbstractMesh>;
  50481. /**
  50482. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50483. */
  50484. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50485. /**
  50486. * Pointer which can be used to select objects or attach a visible laser to
  50487. */
  50488. pointer: AbstractMesh;
  50489. /**
  50490. * Creates the input source object
  50491. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50492. * @param _scene the scene which the controller should be associated to
  50493. * @param inputSource the underlying input source for the controller
  50494. * @param _options options for this controller creation
  50495. */
  50496. constructor(_scene: Scene,
  50497. /** The underlying input source for the controller */
  50498. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50499. /**
  50500. * Get this controllers unique id
  50501. */
  50502. get uniqueId(): string;
  50503. /**
  50504. * Disposes of the object
  50505. */
  50506. dispose(): void;
  50507. /**
  50508. * Gets a world space ray coming from the pointer or grip
  50509. * @param result the resulting ray
  50510. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50511. */
  50512. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50513. /**
  50514. * Updates the controller pose based on the given XRFrame
  50515. * @param xrFrame xr frame to update the pose with
  50516. * @param referenceSpace reference space to use
  50517. */
  50518. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50519. }
  50520. }
  50521. declare module "babylonjs/XR/webXRInput" {
  50522. import { Observable } from "babylonjs/Misc/observable";
  50523. import { IDisposable } from "babylonjs/scene";
  50524. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50525. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50526. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50527. /**
  50528. * The schema for initialization options of the XR Input class
  50529. */
  50530. export interface IWebXRInputOptions {
  50531. /**
  50532. * If set to true no model will be automatically loaded
  50533. */
  50534. doNotLoadControllerMeshes?: boolean;
  50535. /**
  50536. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50537. * If not found, the xr input profile data will be used.
  50538. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50539. */
  50540. forceInputProfile?: string;
  50541. /**
  50542. * Do not send a request to the controller repository to load the profile.
  50543. *
  50544. * Instead, use the controllers available in babylon itself.
  50545. */
  50546. disableOnlineControllerRepository?: boolean;
  50547. /**
  50548. * A custom URL for the controllers repository
  50549. */
  50550. customControllersRepositoryURL?: string;
  50551. /**
  50552. * Should the controller model's components not move according to the user input
  50553. */
  50554. disableControllerAnimation?: boolean;
  50555. /**
  50556. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50557. */
  50558. controllerOptions?: IWebXRControllerOptions;
  50559. }
  50560. /**
  50561. * XR input used to track XR inputs such as controllers/rays
  50562. */
  50563. export class WebXRInput implements IDisposable {
  50564. /**
  50565. * the xr session manager for this session
  50566. */
  50567. xrSessionManager: WebXRSessionManager;
  50568. /**
  50569. * the WebXR camera for this session. Mainly used for teleportation
  50570. */
  50571. xrCamera: WebXRCamera;
  50572. private readonly options;
  50573. /**
  50574. * XR controllers being tracked
  50575. */
  50576. controllers: Array<WebXRInputSource>;
  50577. private _frameObserver;
  50578. private _sessionEndedObserver;
  50579. private _sessionInitObserver;
  50580. /**
  50581. * Event when a controller has been connected/added
  50582. */
  50583. onControllerAddedObservable: Observable<WebXRInputSource>;
  50584. /**
  50585. * Event when a controller has been removed/disconnected
  50586. */
  50587. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50588. /**
  50589. * Initializes the WebXRInput
  50590. * @param xrSessionManager the xr session manager for this session
  50591. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50592. * @param options = initialization options for this xr input
  50593. */
  50594. constructor(
  50595. /**
  50596. * the xr session manager for this session
  50597. */
  50598. xrSessionManager: WebXRSessionManager,
  50599. /**
  50600. * the WebXR camera for this session. Mainly used for teleportation
  50601. */
  50602. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50603. private _onInputSourcesChange;
  50604. private _addAndRemoveControllers;
  50605. /**
  50606. * Disposes of the object
  50607. */
  50608. dispose(): void;
  50609. }
  50610. }
  50611. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50612. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50613. import { Observable, EventState } from "babylonjs/Misc/observable";
  50614. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50615. /**
  50616. * This is the base class for all WebXR features.
  50617. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50618. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50619. */
  50620. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50621. protected _xrSessionManager: WebXRSessionManager;
  50622. private _attached;
  50623. private _removeOnDetach;
  50624. /**
  50625. * Is this feature disposed?
  50626. */
  50627. isDisposed: boolean;
  50628. /**
  50629. * Should auto-attach be disabled?
  50630. */
  50631. disableAutoAttach: boolean;
  50632. /**
  50633. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50634. */
  50635. xrNativeFeatureName: string;
  50636. /**
  50637. * Construct a new (abstract) WebXR feature
  50638. * @param _xrSessionManager the xr session manager for this feature
  50639. */
  50640. constructor(_xrSessionManager: WebXRSessionManager);
  50641. /**
  50642. * Is this feature attached
  50643. */
  50644. get attached(): boolean;
  50645. /**
  50646. * attach this feature
  50647. *
  50648. * @param force should attachment be forced (even when already attached)
  50649. * @returns true if successful, false is failed or already attached
  50650. */
  50651. attach(force?: boolean): boolean;
  50652. /**
  50653. * detach this feature.
  50654. *
  50655. * @returns true if successful, false if failed or already detached
  50656. */
  50657. detach(): boolean;
  50658. /**
  50659. * Dispose this feature and all of the resources attached
  50660. */
  50661. dispose(): void;
  50662. /**
  50663. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50664. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50665. *
  50666. * @returns whether or not the feature is compatible in this environment
  50667. */
  50668. isCompatible(): boolean;
  50669. /**
  50670. * This is used to register callbacks that will automatically be removed when detach is called.
  50671. * @param observable the observable to which the observer will be attached
  50672. * @param callback the callback to register
  50673. */
  50674. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50675. /**
  50676. * Code in this function will be executed on each xrFrame received from the browser.
  50677. * This function will not execute after the feature is detached.
  50678. * @param _xrFrame the current frame
  50679. */
  50680. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50681. }
  50682. }
  50683. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50684. import { IDisposable, Scene } from "babylonjs/scene";
  50685. import { Nullable } from "babylonjs/types";
  50686. import { Observable } from "babylonjs/Misc/observable";
  50687. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50688. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50689. import { Camera } from "babylonjs/Cameras/camera";
  50690. /**
  50691. * Renders a layer on top of an existing scene
  50692. */
  50693. export class UtilityLayerRenderer implements IDisposable {
  50694. /** the original scene that will be rendered on top of */
  50695. originalScene: Scene;
  50696. private _pointerCaptures;
  50697. private _lastPointerEvents;
  50698. private static _DefaultUtilityLayer;
  50699. private static _DefaultKeepDepthUtilityLayer;
  50700. private _sharedGizmoLight;
  50701. private _renderCamera;
  50702. /**
  50703. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50704. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50705. * @returns the camera that is used when rendering the utility layer
  50706. */
  50707. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50708. /**
  50709. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50710. * @param cam the camera that should be used when rendering the utility layer
  50711. */
  50712. setRenderCamera(cam: Nullable<Camera>): void;
  50713. /**
  50714. * @hidden
  50715. * Light which used by gizmos to get light shading
  50716. */
  50717. _getSharedGizmoLight(): HemisphericLight;
  50718. /**
  50719. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50720. */
  50721. pickUtilitySceneFirst: boolean;
  50722. /**
  50723. * 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)
  50724. */
  50725. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50726. /**
  50727. * 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)
  50728. */
  50729. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50730. /**
  50731. * The scene that is rendered on top of the original scene
  50732. */
  50733. utilityLayerScene: Scene;
  50734. /**
  50735. * If the utility layer should automatically be rendered on top of existing scene
  50736. */
  50737. shouldRender: boolean;
  50738. /**
  50739. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50740. */
  50741. onlyCheckPointerDownEvents: boolean;
  50742. /**
  50743. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50744. */
  50745. processAllEvents: boolean;
  50746. /**
  50747. * Observable raised when the pointer move from the utility layer scene to the main scene
  50748. */
  50749. onPointerOutObservable: Observable<number>;
  50750. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50751. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50752. private _afterRenderObserver;
  50753. private _sceneDisposeObserver;
  50754. private _originalPointerObserver;
  50755. /**
  50756. * Instantiates a UtilityLayerRenderer
  50757. * @param originalScene the original scene that will be rendered on top of
  50758. * @param handleEvents boolean indicating if the utility layer should handle events
  50759. */
  50760. constructor(
  50761. /** the original scene that will be rendered on top of */
  50762. originalScene: Scene, handleEvents?: boolean);
  50763. private _notifyObservers;
  50764. /**
  50765. * Renders the utility layers scene on top of the original scene
  50766. */
  50767. render(): void;
  50768. /**
  50769. * Disposes of the renderer
  50770. */
  50771. dispose(): void;
  50772. private _updateCamera;
  50773. }
  50774. }
  50775. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50776. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50777. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50778. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50779. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50780. import { Scene } from "babylonjs/scene";
  50781. import { Nullable } from "babylonjs/types";
  50782. import { Color3 } from "babylonjs/Maths/math.color";
  50783. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50784. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50785. /**
  50786. * Options interface for the pointer selection module
  50787. */
  50788. export interface IWebXRControllerPointerSelectionOptions {
  50789. /**
  50790. * if provided, this scene will be used to render meshes.
  50791. */
  50792. customUtilityLayerScene?: Scene;
  50793. /**
  50794. * 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)
  50795. * If not disabled, the last picked point will be used to execute a pointer up event
  50796. * If disabled, pointer up event will be triggered right after the pointer down event.
  50797. * Used in screen and gaze target ray mode only
  50798. */
  50799. disablePointerUpOnTouchOut: boolean;
  50800. /**
  50801. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50802. */
  50803. forceGazeMode: boolean;
  50804. /**
  50805. * 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
  50806. * to start a new countdown to the pointer down event.
  50807. * Defaults to 1.
  50808. */
  50809. gazeModePointerMovedFactor?: number;
  50810. /**
  50811. * Different button type to use instead of the main component
  50812. */
  50813. overrideButtonId?: string;
  50814. /**
  50815. * use this rendering group id for the meshes (optional)
  50816. */
  50817. renderingGroupId?: number;
  50818. /**
  50819. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50820. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50821. * 3000 means 3 seconds between pointing at something and selecting it
  50822. */
  50823. timeToSelect?: number;
  50824. /**
  50825. * Should meshes created here be added to a utility layer or the main scene
  50826. */
  50827. useUtilityLayer?: boolean;
  50828. /**
  50829. * Optional WebXR camera to be used for gaze selection
  50830. */
  50831. gazeCamera?: WebXRCamera;
  50832. /**
  50833. * the xr input to use with this pointer selection
  50834. */
  50835. xrInput: WebXRInput;
  50836. }
  50837. /**
  50838. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50839. */
  50840. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50841. private readonly _options;
  50842. private static _idCounter;
  50843. private _attachController;
  50844. private _controllers;
  50845. private _scene;
  50846. private _tmpVectorForPickCompare;
  50847. /**
  50848. * The module's name
  50849. */
  50850. static readonly Name: string;
  50851. /**
  50852. * The (Babylon) version of this module.
  50853. * This is an integer representing the implementation version.
  50854. * This number does not correspond to the WebXR specs version
  50855. */
  50856. static readonly Version: number;
  50857. /**
  50858. * Disable lighting on the laser pointer (so it will always be visible)
  50859. */
  50860. disablePointerLighting: boolean;
  50861. /**
  50862. * Disable lighting on the selection mesh (so it will always be visible)
  50863. */
  50864. disableSelectionMeshLighting: boolean;
  50865. /**
  50866. * Should the laser pointer be displayed
  50867. */
  50868. displayLaserPointer: boolean;
  50869. /**
  50870. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50871. */
  50872. displaySelectionMesh: boolean;
  50873. /**
  50874. * This color will be set to the laser pointer when selection is triggered
  50875. */
  50876. laserPointerPickedColor: Color3;
  50877. /**
  50878. * Default color of the laser pointer
  50879. */
  50880. laserPointerDefaultColor: Color3;
  50881. /**
  50882. * default color of the selection ring
  50883. */
  50884. selectionMeshDefaultColor: Color3;
  50885. /**
  50886. * This color will be applied to the selection ring when selection is triggered
  50887. */
  50888. selectionMeshPickedColor: Color3;
  50889. /**
  50890. * Optional filter to be used for ray selection. This predicate shares behavior with
  50891. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50892. */
  50893. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50894. /**
  50895. * constructs a new background remover module
  50896. * @param _xrSessionManager the session manager for this module
  50897. * @param _options read-only options to be used in this module
  50898. */
  50899. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50900. /**
  50901. * attach this feature
  50902. * Will usually be called by the features manager
  50903. *
  50904. * @returns true if successful.
  50905. */
  50906. attach(): boolean;
  50907. /**
  50908. * detach this feature.
  50909. * Will usually be called by the features manager
  50910. *
  50911. * @returns true if successful.
  50912. */
  50913. detach(): boolean;
  50914. /**
  50915. * Will get the mesh under a specific pointer.
  50916. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50917. * @param controllerId the controllerId to check
  50918. * @returns The mesh under pointer or null if no mesh is under the pointer
  50919. */
  50920. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50921. /**
  50922. * Get the xr controller that correlates to the pointer id in the pointer event
  50923. *
  50924. * @param id the pointer id to search for
  50925. * @returns the controller that correlates to this id or null if not found
  50926. */
  50927. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50928. protected _onXRFrame(_xrFrame: XRFrame): void;
  50929. private _attachGazeMode;
  50930. private _attachScreenRayMode;
  50931. private _attachTrackedPointerRayMode;
  50932. private _convertNormalToDirectionOfRay;
  50933. private _detachController;
  50934. private _generateNewMeshPair;
  50935. private _pickingMoved;
  50936. private _updatePointerDistance;
  50937. /** @hidden */
  50938. get lasterPointerDefaultColor(): Color3;
  50939. }
  50940. }
  50941. declare module "babylonjs/XR/webXREnterExitUI" {
  50942. import { Nullable } from "babylonjs/types";
  50943. import { Observable } from "babylonjs/Misc/observable";
  50944. import { IDisposable, Scene } from "babylonjs/scene";
  50945. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50946. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50947. /**
  50948. * Button which can be used to enter a different mode of XR
  50949. */
  50950. export class WebXREnterExitUIButton {
  50951. /** button element */
  50952. element: HTMLElement;
  50953. /** XR initialization options for the button */
  50954. sessionMode: XRSessionMode;
  50955. /** Reference space type */
  50956. referenceSpaceType: XRReferenceSpaceType;
  50957. /**
  50958. * Creates a WebXREnterExitUIButton
  50959. * @param element button element
  50960. * @param sessionMode XR initialization session mode
  50961. * @param referenceSpaceType the type of reference space to be used
  50962. */
  50963. constructor(
  50964. /** button element */
  50965. element: HTMLElement,
  50966. /** XR initialization options for the button */
  50967. sessionMode: XRSessionMode,
  50968. /** Reference space type */
  50969. referenceSpaceType: XRReferenceSpaceType);
  50970. /**
  50971. * Extendable function which can be used to update the button's visuals when the state changes
  50972. * @param activeButton the current active button in the UI
  50973. */
  50974. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50975. }
  50976. /**
  50977. * Options to create the webXR UI
  50978. */
  50979. export class WebXREnterExitUIOptions {
  50980. /**
  50981. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50982. */
  50983. customButtons?: Array<WebXREnterExitUIButton>;
  50984. /**
  50985. * A reference space type to use when creating the default button.
  50986. * Default is local-floor
  50987. */
  50988. referenceSpaceType?: XRReferenceSpaceType;
  50989. /**
  50990. * Context to enter xr with
  50991. */
  50992. renderTarget?: Nullable<WebXRRenderTarget>;
  50993. /**
  50994. * A session mode to use when creating the default button.
  50995. * Default is immersive-vr
  50996. */
  50997. sessionMode?: XRSessionMode;
  50998. /**
  50999. * A list of optional features to init the session with
  51000. */
  51001. optionalFeatures?: string[];
  51002. /**
  51003. * A list of optional features to init the session with
  51004. */
  51005. requiredFeatures?: string[];
  51006. }
  51007. /**
  51008. * UI to allow the user to enter/exit XR mode
  51009. */
  51010. export class WebXREnterExitUI implements IDisposable {
  51011. private scene;
  51012. /** version of the options passed to this UI */
  51013. options: WebXREnterExitUIOptions;
  51014. private _activeButton;
  51015. private _buttons;
  51016. /**
  51017. * The HTML Div Element to which buttons are added.
  51018. */
  51019. readonly overlay: HTMLDivElement;
  51020. /**
  51021. * Fired every time the active button is changed.
  51022. *
  51023. * When xr is entered via a button that launches xr that button will be the callback parameter
  51024. *
  51025. * When exiting xr the callback parameter will be null)
  51026. */
  51027. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  51028. /**
  51029. *
  51030. * @param scene babylon scene object to use
  51031. * @param options (read-only) version of the options passed to this UI
  51032. */
  51033. private constructor();
  51034. /**
  51035. * Creates UI to allow the user to enter/exit XR mode
  51036. * @param scene the scene to add the ui to
  51037. * @param helper the xr experience helper to enter/exit xr with
  51038. * @param options options to configure the UI
  51039. * @returns the created ui
  51040. */
  51041. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  51042. /**
  51043. * Disposes of the XR UI component
  51044. */
  51045. dispose(): void;
  51046. private _updateButtons;
  51047. }
  51048. }
  51049. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  51050. import { Vector3 } from "babylonjs/Maths/math.vector";
  51051. import { Color4 } from "babylonjs/Maths/math.color";
  51052. import { Nullable } from "babylonjs/types";
  51053. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  51054. import { Scene } from "babylonjs/scene";
  51055. /**
  51056. * Class containing static functions to help procedurally build meshes
  51057. */
  51058. export class LinesBuilder {
  51059. /**
  51060. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  51061. * * 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
  51062. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  51063. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  51064. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  51065. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  51066. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  51067. * * 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
  51068. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  51069. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51070. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  51071. * @param name defines the name of the new line system
  51072. * @param options defines the options used to create the line system
  51073. * @param scene defines the hosting scene
  51074. * @returns a new line system mesh
  51075. */
  51076. static CreateLineSystem(name: string, options: {
  51077. lines: Vector3[][];
  51078. updatable?: boolean;
  51079. instance?: Nullable<LinesMesh>;
  51080. colors?: Nullable<Color4[][]>;
  51081. useVertexAlpha?: boolean;
  51082. }, scene: Nullable<Scene>): LinesMesh;
  51083. /**
  51084. * Creates a line mesh
  51085. * 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
  51086. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  51087. * * The parameter `points` is an array successive Vector3
  51088. * * 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
  51089. * * The optional parameter `colors` is an array of successive Color4, one per line point
  51090. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  51091. * * When updating an instance, remember that only point positions can change, not the number of points
  51092. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51093. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  51094. * @param name defines the name of the new line system
  51095. * @param options defines the options used to create the line system
  51096. * @param scene defines the hosting scene
  51097. * @returns a new line mesh
  51098. */
  51099. static CreateLines(name: string, options: {
  51100. points: Vector3[];
  51101. updatable?: boolean;
  51102. instance?: Nullable<LinesMesh>;
  51103. colors?: Color4[];
  51104. useVertexAlpha?: boolean;
  51105. }, scene?: Nullable<Scene>): LinesMesh;
  51106. /**
  51107. * Creates a dashed line mesh
  51108. * * 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
  51109. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  51110. * * The parameter `points` is an array successive Vector3
  51111. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  51112. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  51113. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  51114. * * 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
  51115. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  51116. * * When updating an instance, remember that only point positions can change, not the number of points
  51117. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51118. * @param name defines the name of the mesh
  51119. * @param options defines the options used to create the mesh
  51120. * @param scene defines the hosting scene
  51121. * @returns the dashed line mesh
  51122. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  51123. */
  51124. static CreateDashedLines(name: string, options: {
  51125. points: Vector3[];
  51126. dashSize?: number;
  51127. gapSize?: number;
  51128. dashNb?: number;
  51129. updatable?: boolean;
  51130. instance?: LinesMesh;
  51131. useVertexAlpha?: boolean;
  51132. }, scene?: Nullable<Scene>): LinesMesh;
  51133. }
  51134. }
  51135. declare module "babylonjs/Misc/timer" {
  51136. import { Observable, Observer } from "babylonjs/Misc/observable";
  51137. import { Nullable } from "babylonjs/types";
  51138. import { IDisposable } from "babylonjs/scene";
  51139. /**
  51140. * Construction options for a timer
  51141. */
  51142. export interface ITimerOptions<T> {
  51143. /**
  51144. * Time-to-end
  51145. */
  51146. timeout: number;
  51147. /**
  51148. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51149. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51150. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51151. */
  51152. contextObservable: Observable<T>;
  51153. /**
  51154. * Optional parameters when adding an observer to the observable
  51155. */
  51156. observableParameters?: {
  51157. mask?: number;
  51158. insertFirst?: boolean;
  51159. scope?: any;
  51160. };
  51161. /**
  51162. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51163. */
  51164. breakCondition?: (data?: ITimerData<T>) => boolean;
  51165. /**
  51166. * Will be triggered when the time condition has met
  51167. */
  51168. onEnded?: (data: ITimerData<any>) => void;
  51169. /**
  51170. * Will be triggered when the break condition has met (prematurely ended)
  51171. */
  51172. onAborted?: (data: ITimerData<any>) => void;
  51173. /**
  51174. * Optional function to execute on each tick (or count)
  51175. */
  51176. onTick?: (data: ITimerData<any>) => void;
  51177. }
  51178. /**
  51179. * An interface defining the data sent by the timer
  51180. */
  51181. export interface ITimerData<T> {
  51182. /**
  51183. * When did it start
  51184. */
  51185. startTime: number;
  51186. /**
  51187. * Time now
  51188. */
  51189. currentTime: number;
  51190. /**
  51191. * Time passed since started
  51192. */
  51193. deltaTime: number;
  51194. /**
  51195. * How much is completed, in [0.0...1.0].
  51196. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51197. */
  51198. completeRate: number;
  51199. /**
  51200. * What the registered observable sent in the last count
  51201. */
  51202. payload: T;
  51203. }
  51204. /**
  51205. * The current state of the timer
  51206. */
  51207. export enum TimerState {
  51208. /**
  51209. * Timer initialized, not yet started
  51210. */
  51211. INIT = 0,
  51212. /**
  51213. * Timer started and counting
  51214. */
  51215. STARTED = 1,
  51216. /**
  51217. * Timer ended (whether aborted or time reached)
  51218. */
  51219. ENDED = 2
  51220. }
  51221. /**
  51222. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51223. *
  51224. * @param options options with which to initialize this timer
  51225. */
  51226. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51227. /**
  51228. * An advanced implementation of a timer class
  51229. */
  51230. export class AdvancedTimer<T = any> implements IDisposable {
  51231. /**
  51232. * Will notify each time the timer calculates the remaining time
  51233. */
  51234. onEachCountObservable: Observable<ITimerData<T>>;
  51235. /**
  51236. * Will trigger when the timer was aborted due to the break condition
  51237. */
  51238. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51239. /**
  51240. * Will trigger when the timer ended successfully
  51241. */
  51242. onTimerEndedObservable: Observable<ITimerData<T>>;
  51243. /**
  51244. * Will trigger when the timer state has changed
  51245. */
  51246. onStateChangedObservable: Observable<TimerState>;
  51247. private _observer;
  51248. private _contextObservable;
  51249. private _observableParameters;
  51250. private _startTime;
  51251. private _timer;
  51252. private _state;
  51253. private _breakCondition;
  51254. private _timeToEnd;
  51255. private _breakOnNextTick;
  51256. /**
  51257. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51258. * @param options construction options for this advanced timer
  51259. */
  51260. constructor(options: ITimerOptions<T>);
  51261. /**
  51262. * set a breaking condition for this timer. Default is to never break during count
  51263. * @param predicate the new break condition. Returns true to break, false otherwise
  51264. */
  51265. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51266. /**
  51267. * Reset ALL associated observables in this advanced timer
  51268. */
  51269. clearObservables(): void;
  51270. /**
  51271. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51272. *
  51273. * @param timeToEnd how much time to measure until timer ended
  51274. */
  51275. start(timeToEnd?: number): void;
  51276. /**
  51277. * Will force a stop on the next tick.
  51278. */
  51279. stop(): void;
  51280. /**
  51281. * Dispose this timer, clearing all resources
  51282. */
  51283. dispose(): void;
  51284. private _setState;
  51285. private _tick;
  51286. private _stop;
  51287. }
  51288. }
  51289. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51290. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51291. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51292. import { Nullable } from "babylonjs/types";
  51293. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51294. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51295. import { Vector3 } from "babylonjs/Maths/math.vector";
  51296. import { Material } from "babylonjs/Materials/material";
  51297. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51298. import { Scene } from "babylonjs/scene";
  51299. /**
  51300. * The options container for the teleportation module
  51301. */
  51302. export interface IWebXRTeleportationOptions {
  51303. /**
  51304. * if provided, this scene will be used to render meshes.
  51305. */
  51306. customUtilityLayerScene?: Scene;
  51307. /**
  51308. * Values to configure the default target mesh
  51309. */
  51310. defaultTargetMeshOptions?: {
  51311. /**
  51312. * Fill color of the teleportation area
  51313. */
  51314. teleportationFillColor?: string;
  51315. /**
  51316. * Border color for the teleportation area
  51317. */
  51318. teleportationBorderColor?: string;
  51319. /**
  51320. * Disable the mesh's animation sequence
  51321. */
  51322. disableAnimation?: boolean;
  51323. /**
  51324. * Disable lighting on the material or the ring and arrow
  51325. */
  51326. disableLighting?: boolean;
  51327. /**
  51328. * Override the default material of the torus and arrow
  51329. */
  51330. torusArrowMaterial?: Material;
  51331. };
  51332. /**
  51333. * A list of meshes to use as floor meshes.
  51334. * Meshes can be added and removed after initializing the feature using the
  51335. * addFloorMesh and removeFloorMesh functions
  51336. * If empty, rotation will still work
  51337. */
  51338. floorMeshes?: AbstractMesh[];
  51339. /**
  51340. * use this rendering group id for the meshes (optional)
  51341. */
  51342. renderingGroupId?: number;
  51343. /**
  51344. * Should teleportation move only to snap points
  51345. */
  51346. snapPointsOnly?: boolean;
  51347. /**
  51348. * An array of points to which the teleportation will snap to.
  51349. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51350. */
  51351. snapPositions?: Vector3[];
  51352. /**
  51353. * How close should the teleportation ray be in order to snap to position.
  51354. * Default to 0.8 units (meters)
  51355. */
  51356. snapToPositionRadius?: number;
  51357. /**
  51358. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51359. * If you want to support rotation, make sure your mesh has a direction indicator.
  51360. *
  51361. * When left untouched, the default mesh will be initialized.
  51362. */
  51363. teleportationTargetMesh?: AbstractMesh;
  51364. /**
  51365. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51366. */
  51367. timeToTeleport?: number;
  51368. /**
  51369. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51370. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51371. */
  51372. useMainComponentOnly?: boolean;
  51373. /**
  51374. * Should meshes created here be added to a utility layer or the main scene
  51375. */
  51376. useUtilityLayer?: boolean;
  51377. /**
  51378. * Babylon XR Input class for controller
  51379. */
  51380. xrInput: WebXRInput;
  51381. /**
  51382. * Meshes that the teleportation ray cannot go through
  51383. */
  51384. pickBlockerMeshes?: AbstractMesh[];
  51385. }
  51386. /**
  51387. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51388. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51389. * the input of the attached controllers.
  51390. */
  51391. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51392. private _options;
  51393. private _controllers;
  51394. private _currentTeleportationControllerId;
  51395. private _floorMeshes;
  51396. private _quadraticBezierCurve;
  51397. private _selectionFeature;
  51398. private _snapToPositions;
  51399. private _snappedToPoint;
  51400. private _teleportationRingMaterial?;
  51401. private _tmpRay;
  51402. private _tmpVector;
  51403. private _tmpQuaternion;
  51404. /**
  51405. * The module's name
  51406. */
  51407. static readonly Name: string;
  51408. /**
  51409. * The (Babylon) version of this module.
  51410. * This is an integer representing the implementation version.
  51411. * This number does not correspond to the webxr specs version
  51412. */
  51413. static readonly Version: number;
  51414. /**
  51415. * Is movement backwards enabled
  51416. */
  51417. backwardsMovementEnabled: boolean;
  51418. /**
  51419. * Distance to travel when moving backwards
  51420. */
  51421. backwardsTeleportationDistance: number;
  51422. /**
  51423. * The distance from the user to the inspection point in the direction of the controller
  51424. * A higher number will allow the user to move further
  51425. * defaults to 5 (meters, in xr units)
  51426. */
  51427. parabolicCheckRadius: number;
  51428. /**
  51429. * Should the module support parabolic ray on top of direct ray
  51430. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51431. * Very helpful when moving between floors / different heights
  51432. */
  51433. parabolicRayEnabled: boolean;
  51434. /**
  51435. * How much rotation should be applied when rotating right and left
  51436. */
  51437. rotationAngle: number;
  51438. /**
  51439. * Is rotation enabled when moving forward?
  51440. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51441. */
  51442. rotationEnabled: boolean;
  51443. /**
  51444. * constructs a new anchor system
  51445. * @param _xrSessionManager an instance of WebXRSessionManager
  51446. * @param _options configuration object for this feature
  51447. */
  51448. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51449. /**
  51450. * Get the snapPointsOnly flag
  51451. */
  51452. get snapPointsOnly(): boolean;
  51453. /**
  51454. * Sets the snapPointsOnly flag
  51455. * @param snapToPoints should teleportation be exclusively to snap points
  51456. */
  51457. set snapPointsOnly(snapToPoints: boolean);
  51458. /**
  51459. * Add a new mesh to the floor meshes array
  51460. * @param mesh the mesh to use as floor mesh
  51461. */
  51462. addFloorMesh(mesh: AbstractMesh): void;
  51463. /**
  51464. * Add a new snap-to point to fix teleportation to this position
  51465. * @param newSnapPoint The new Snap-To point
  51466. */
  51467. addSnapPoint(newSnapPoint: Vector3): void;
  51468. attach(): boolean;
  51469. detach(): boolean;
  51470. dispose(): void;
  51471. /**
  51472. * Remove a mesh from the floor meshes array
  51473. * @param mesh the mesh to remove
  51474. */
  51475. removeFloorMesh(mesh: AbstractMesh): void;
  51476. /**
  51477. * Remove a mesh from the floor meshes array using its name
  51478. * @param name the mesh name to remove
  51479. */
  51480. removeFloorMeshByName(name: string): void;
  51481. /**
  51482. * 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
  51483. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51484. * @returns was the point found and removed or not
  51485. */
  51486. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51487. /**
  51488. * This function sets a selection feature that will be disabled when
  51489. * the forward ray is shown and will be reattached when hidden.
  51490. * This is used to remove the selection rays when moving.
  51491. * @param selectionFeature the feature to disable when forward movement is enabled
  51492. */
  51493. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  51494. protected _onXRFrame(_xrFrame: XRFrame): void;
  51495. private _attachController;
  51496. private _createDefaultTargetMesh;
  51497. private _detachController;
  51498. private _findClosestSnapPointWithRadius;
  51499. private _setTargetMeshPosition;
  51500. private _setTargetMeshVisibility;
  51501. private _showParabolicPath;
  51502. private _teleportForward;
  51503. }
  51504. }
  51505. declare module "babylonjs/XR/webXRDefaultExperience" {
  51506. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51507. import { Scene } from "babylonjs/scene";
  51508. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51509. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51510. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51511. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51512. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51513. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51514. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51515. /**
  51516. * Options for the default xr helper
  51517. */
  51518. export class WebXRDefaultExperienceOptions {
  51519. /**
  51520. * Enable or disable default UI to enter XR
  51521. */
  51522. disableDefaultUI?: boolean;
  51523. /**
  51524. * Should teleportation not initialize. defaults to false.
  51525. */
  51526. disableTeleportation?: boolean;
  51527. /**
  51528. * Floor meshes that will be used for teleport
  51529. */
  51530. floorMeshes?: Array<AbstractMesh>;
  51531. /**
  51532. * If set to true, the first frame will not be used to reset position
  51533. * The first frame is mainly used when copying transformation from the old camera
  51534. * Mainly used in AR
  51535. */
  51536. ignoreNativeCameraTransformation?: boolean;
  51537. /**
  51538. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51539. */
  51540. inputOptions?: IWebXRInputOptions;
  51541. /**
  51542. * optional configuration for the output canvas
  51543. */
  51544. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51545. /**
  51546. * optional UI options. This can be used among other to change session mode and reference space type
  51547. */
  51548. uiOptions?: WebXREnterExitUIOptions;
  51549. /**
  51550. * When loading teleportation and pointer select, use stable versions instead of latest.
  51551. */
  51552. useStablePlugins?: boolean;
  51553. /**
  51554. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51555. */
  51556. renderingGroupId?: number;
  51557. /**
  51558. * A list of optional features to init the session with
  51559. * If set to true, all features we support will be added
  51560. */
  51561. optionalFeatures?: boolean | string[];
  51562. }
  51563. /**
  51564. * Default experience which provides a similar setup to the previous webVRExperience
  51565. */
  51566. export class WebXRDefaultExperience {
  51567. /**
  51568. * Base experience
  51569. */
  51570. baseExperience: WebXRExperienceHelper;
  51571. /**
  51572. * Enables ui for entering/exiting xr
  51573. */
  51574. enterExitUI: WebXREnterExitUI;
  51575. /**
  51576. * Input experience extension
  51577. */
  51578. input: WebXRInput;
  51579. /**
  51580. * Enables laser pointer and selection
  51581. */
  51582. pointerSelection: WebXRControllerPointerSelection;
  51583. /**
  51584. * Default target xr should render to
  51585. */
  51586. renderTarget: WebXRRenderTarget;
  51587. /**
  51588. * Enables teleportation
  51589. */
  51590. teleportation: WebXRMotionControllerTeleportation;
  51591. private constructor();
  51592. /**
  51593. * Creates the default xr experience
  51594. * @param scene scene
  51595. * @param options options for basic configuration
  51596. * @returns resulting WebXRDefaultExperience
  51597. */
  51598. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51599. /**
  51600. * DIsposes of the experience helper
  51601. */
  51602. dispose(): void;
  51603. }
  51604. }
  51605. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51606. import { Observable } from "babylonjs/Misc/observable";
  51607. import { Nullable } from "babylonjs/types";
  51608. import { Camera } from "babylonjs/Cameras/camera";
  51609. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51610. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51611. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51612. import { Scene } from "babylonjs/scene";
  51613. import { Vector3 } from "babylonjs/Maths/math.vector";
  51614. import { Color3 } from "babylonjs/Maths/math.color";
  51615. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51616. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51617. import { Mesh } from "babylonjs/Meshes/mesh";
  51618. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51619. import { EasingFunction } from "babylonjs/Animations/easing";
  51620. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51621. import "babylonjs/Meshes/Builders/groundBuilder";
  51622. import "babylonjs/Meshes/Builders/torusBuilder";
  51623. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51624. import "babylonjs/Gamepads/gamepadSceneComponent";
  51625. import "babylonjs/Animations/animatable";
  51626. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51627. /**
  51628. * Options to modify the vr teleportation behavior.
  51629. */
  51630. export interface VRTeleportationOptions {
  51631. /**
  51632. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51633. */
  51634. floorMeshName?: string;
  51635. /**
  51636. * A list of meshes to be used as the teleportation floor. (default: empty)
  51637. */
  51638. floorMeshes?: Mesh[];
  51639. /**
  51640. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51641. */
  51642. teleportationMode?: number;
  51643. /**
  51644. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51645. */
  51646. teleportationTime?: number;
  51647. /**
  51648. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51649. */
  51650. teleportationSpeed?: number;
  51651. /**
  51652. * The easing function used in the animation or null for Linear. (default CircleEase)
  51653. */
  51654. easingFunction?: EasingFunction;
  51655. }
  51656. /**
  51657. * Options to modify the vr experience helper's behavior.
  51658. */
  51659. export interface VRExperienceHelperOptions extends WebVROptions {
  51660. /**
  51661. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51662. */
  51663. createDeviceOrientationCamera?: boolean;
  51664. /**
  51665. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51666. */
  51667. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51668. /**
  51669. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51670. */
  51671. laserToggle?: boolean;
  51672. /**
  51673. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51674. */
  51675. floorMeshes?: Mesh[];
  51676. /**
  51677. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51678. */
  51679. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51680. /**
  51681. * Defines if WebXR should be used instead of WebVR (if available)
  51682. */
  51683. useXR?: boolean;
  51684. }
  51685. /**
  51686. * Event containing information after VR has been entered
  51687. */
  51688. export class OnAfterEnteringVRObservableEvent {
  51689. /**
  51690. * If entering vr was successful
  51691. */
  51692. success: boolean;
  51693. }
  51694. /**
  51695. * Helps to quickly add VR support to an existing scene.
  51696. * See https://doc.babylonjs.com/how_to/webvr_helper
  51697. */
  51698. export class VRExperienceHelper {
  51699. /** Options to modify the vr experience helper's behavior. */
  51700. webVROptions: VRExperienceHelperOptions;
  51701. private _scene;
  51702. private _position;
  51703. private _btnVR;
  51704. private _btnVRDisplayed;
  51705. private _webVRsupported;
  51706. private _webVRready;
  51707. private _webVRrequesting;
  51708. private _webVRpresenting;
  51709. private _hasEnteredVR;
  51710. private _fullscreenVRpresenting;
  51711. private _inputElement;
  51712. private _webVRCamera;
  51713. private _vrDeviceOrientationCamera;
  51714. private _deviceOrientationCamera;
  51715. private _existingCamera;
  51716. private _onKeyDown;
  51717. private _onVrDisplayPresentChange;
  51718. private _onVRDisplayChanged;
  51719. private _onVRRequestPresentStart;
  51720. private _onVRRequestPresentComplete;
  51721. /**
  51722. * 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)
  51723. */
  51724. enableGazeEvenWhenNoPointerLock: boolean;
  51725. /**
  51726. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51727. */
  51728. exitVROnDoubleTap: boolean;
  51729. /**
  51730. * Observable raised right before entering VR.
  51731. */
  51732. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51733. /**
  51734. * Observable raised when entering VR has completed.
  51735. */
  51736. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51737. /**
  51738. * Observable raised when exiting VR.
  51739. */
  51740. onExitingVRObservable: Observable<VRExperienceHelper>;
  51741. /**
  51742. * Observable raised when controller mesh is loaded.
  51743. */
  51744. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51745. /** Return this.onEnteringVRObservable
  51746. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51747. */
  51748. get onEnteringVR(): Observable<VRExperienceHelper>;
  51749. /** Return this.onExitingVRObservable
  51750. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51751. */
  51752. get onExitingVR(): Observable<VRExperienceHelper>;
  51753. /** Return this.onControllerMeshLoadedObservable
  51754. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51755. */
  51756. get onControllerMeshLoaded(): Observable<WebVRController>;
  51757. private _rayLength;
  51758. private _useCustomVRButton;
  51759. private _teleportationRequested;
  51760. private _teleportActive;
  51761. private _floorMeshName;
  51762. private _floorMeshesCollection;
  51763. private _teleportationMode;
  51764. private _teleportationTime;
  51765. private _teleportationSpeed;
  51766. private _teleportationEasing;
  51767. private _rotationAllowed;
  51768. private _teleportBackwardsVector;
  51769. private _teleportationTarget;
  51770. private _isDefaultTeleportationTarget;
  51771. private _postProcessMove;
  51772. private _teleportationFillColor;
  51773. private _teleportationBorderColor;
  51774. private _rotationAngle;
  51775. private _haloCenter;
  51776. private _cameraGazer;
  51777. private _padSensibilityUp;
  51778. private _padSensibilityDown;
  51779. private _leftController;
  51780. private _rightController;
  51781. private _gazeColor;
  51782. private _laserColor;
  51783. private _pickedLaserColor;
  51784. private _pickedGazeColor;
  51785. /**
  51786. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51787. */
  51788. onNewMeshSelected: Observable<AbstractMesh>;
  51789. /**
  51790. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51791. * This observable will provide the mesh and the controller used to select the mesh
  51792. */
  51793. onMeshSelectedWithController: Observable<{
  51794. mesh: AbstractMesh;
  51795. controller: WebVRController;
  51796. }>;
  51797. /**
  51798. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51799. */
  51800. onNewMeshPicked: Observable<PickingInfo>;
  51801. private _circleEase;
  51802. /**
  51803. * Observable raised before camera teleportation
  51804. */
  51805. onBeforeCameraTeleport: Observable<Vector3>;
  51806. /**
  51807. * Observable raised after camera teleportation
  51808. */
  51809. onAfterCameraTeleport: Observable<Vector3>;
  51810. /**
  51811. * Observable raised when current selected mesh gets unselected
  51812. */
  51813. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51814. private _raySelectionPredicate;
  51815. /**
  51816. * To be optionaly changed by user to define custom ray selection
  51817. */
  51818. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51819. /**
  51820. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51821. */
  51822. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51823. /**
  51824. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51825. */
  51826. teleportationEnabled: boolean;
  51827. private _defaultHeight;
  51828. private _teleportationInitialized;
  51829. private _interactionsEnabled;
  51830. private _interactionsRequested;
  51831. private _displayGaze;
  51832. private _displayLaserPointer;
  51833. /**
  51834. * The mesh used to display where the user is going to teleport.
  51835. */
  51836. get teleportationTarget(): Mesh;
  51837. /**
  51838. * Sets the mesh to be used to display where the user is going to teleport.
  51839. */
  51840. set teleportationTarget(value: Mesh);
  51841. /**
  51842. * 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
  51843. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51844. * See https://doc.babylonjs.com/resources/baking_transformations
  51845. */
  51846. get gazeTrackerMesh(): Mesh;
  51847. set gazeTrackerMesh(value: Mesh);
  51848. /**
  51849. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51850. */
  51851. updateGazeTrackerScale: boolean;
  51852. /**
  51853. * If the gaze trackers color should be updated when selecting meshes
  51854. */
  51855. updateGazeTrackerColor: boolean;
  51856. /**
  51857. * If the controller laser color should be updated when selecting meshes
  51858. */
  51859. updateControllerLaserColor: boolean;
  51860. /**
  51861. * The gaze tracking mesh corresponding to the left controller
  51862. */
  51863. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51864. /**
  51865. * The gaze tracking mesh corresponding to the right controller
  51866. */
  51867. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51868. /**
  51869. * If the ray of the gaze should be displayed.
  51870. */
  51871. get displayGaze(): boolean;
  51872. /**
  51873. * Sets if the ray of the gaze should be displayed.
  51874. */
  51875. set displayGaze(value: boolean);
  51876. /**
  51877. * If the ray of the LaserPointer should be displayed.
  51878. */
  51879. get displayLaserPointer(): boolean;
  51880. /**
  51881. * Sets if the ray of the LaserPointer should be displayed.
  51882. */
  51883. set displayLaserPointer(value: boolean);
  51884. /**
  51885. * The deviceOrientationCamera used as the camera when not in VR.
  51886. */
  51887. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51888. /**
  51889. * Based on the current WebVR support, returns the current VR camera used.
  51890. */
  51891. get currentVRCamera(): Nullable<Camera>;
  51892. /**
  51893. * The webVRCamera which is used when in VR.
  51894. */
  51895. get webVRCamera(): WebVRFreeCamera;
  51896. /**
  51897. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51898. */
  51899. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51900. /**
  51901. * The html button that is used to trigger entering into VR.
  51902. */
  51903. get vrButton(): Nullable<HTMLButtonElement>;
  51904. private get _teleportationRequestInitiated();
  51905. /**
  51906. * Defines whether or not Pointer lock should be requested when switching to
  51907. * full screen.
  51908. */
  51909. requestPointerLockOnFullScreen: boolean;
  51910. /**
  51911. * If asking to force XR, this will be populated with the default xr experience
  51912. */
  51913. xr: WebXRDefaultExperience;
  51914. /**
  51915. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51916. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51917. */
  51918. xrTestDone: boolean;
  51919. /**
  51920. * Instantiates a VRExperienceHelper.
  51921. * Helps to quickly add VR support to an existing scene.
  51922. * @param scene The scene the VRExperienceHelper belongs to.
  51923. * @param webVROptions Options to modify the vr experience helper's behavior.
  51924. */
  51925. constructor(scene: Scene,
  51926. /** Options to modify the vr experience helper's behavior. */
  51927. webVROptions?: VRExperienceHelperOptions);
  51928. private completeVRInit;
  51929. private _onDefaultMeshLoaded;
  51930. private _onResize;
  51931. private _onFullscreenChange;
  51932. /**
  51933. * Gets a value indicating if we are currently in VR mode.
  51934. */
  51935. get isInVRMode(): boolean;
  51936. private onVrDisplayPresentChange;
  51937. private onVRDisplayChanged;
  51938. private moveButtonToBottomRight;
  51939. private displayVRButton;
  51940. private updateButtonVisibility;
  51941. private _cachedAngularSensibility;
  51942. /**
  51943. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51944. * Otherwise, will use the fullscreen API.
  51945. */
  51946. enterVR(): void;
  51947. /**
  51948. * Attempt to exit VR, or fullscreen.
  51949. */
  51950. exitVR(): void;
  51951. /**
  51952. * The position of the vr experience helper.
  51953. */
  51954. get position(): Vector3;
  51955. /**
  51956. * Sets the position of the vr experience helper.
  51957. */
  51958. set position(value: Vector3);
  51959. /**
  51960. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51961. */
  51962. enableInteractions(): void;
  51963. private get _noControllerIsActive();
  51964. private beforeRender;
  51965. private _isTeleportationFloor;
  51966. /**
  51967. * Adds a floor mesh to be used for teleportation.
  51968. * @param floorMesh the mesh to be used for teleportation.
  51969. */
  51970. addFloorMesh(floorMesh: Mesh): void;
  51971. /**
  51972. * Removes a floor mesh from being used for teleportation.
  51973. * @param floorMesh the mesh to be removed.
  51974. */
  51975. removeFloorMesh(floorMesh: Mesh): void;
  51976. /**
  51977. * Enables interactions and teleportation using the VR controllers and gaze.
  51978. * @param vrTeleportationOptions options to modify teleportation behavior.
  51979. */
  51980. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51981. private _onNewGamepadConnected;
  51982. private _tryEnableInteractionOnController;
  51983. private _onNewGamepadDisconnected;
  51984. private _enableInteractionOnController;
  51985. private _checkTeleportWithRay;
  51986. private _checkRotate;
  51987. private _checkTeleportBackwards;
  51988. private _enableTeleportationOnController;
  51989. private _createTeleportationCircles;
  51990. private _displayTeleportationTarget;
  51991. private _hideTeleportationTarget;
  51992. private _rotateCamera;
  51993. private _moveTeleportationSelectorTo;
  51994. private _workingVector;
  51995. private _workingQuaternion;
  51996. private _workingMatrix;
  51997. /**
  51998. * Time Constant Teleportation Mode
  51999. */
  52000. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  52001. /**
  52002. * Speed Constant Teleportation Mode
  52003. */
  52004. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  52005. /**
  52006. * Teleports the users feet to the desired location
  52007. * @param location The location where the user's feet should be placed
  52008. */
  52009. teleportCamera(location: Vector3): void;
  52010. private _convertNormalToDirectionOfRay;
  52011. private _castRayAndSelectObject;
  52012. private _notifySelectedMeshUnselected;
  52013. /**
  52014. * Permanently set new colors for the laser pointer
  52015. * @param color the new laser color
  52016. * @param pickedColor the new laser color when picked mesh detected
  52017. */
  52018. setLaserColor(color: Color3, pickedColor?: Color3): void;
  52019. /**
  52020. * Set lighting enabled / disabled on the laser pointer of both controllers
  52021. * @param enabled should the lighting be enabled on the laser pointer
  52022. */
  52023. setLaserLightingState(enabled?: boolean): void;
  52024. /**
  52025. * Permanently set new colors for the gaze pointer
  52026. * @param color the new gaze color
  52027. * @param pickedColor the new gaze color when picked mesh detected
  52028. */
  52029. setGazeColor(color: Color3, pickedColor?: Color3): void;
  52030. /**
  52031. * Sets the color of the laser ray from the vr controllers.
  52032. * @param color new color for the ray.
  52033. */
  52034. changeLaserColor(color: Color3): void;
  52035. /**
  52036. * Sets the color of the ray from the vr headsets gaze.
  52037. * @param color new color for the ray.
  52038. */
  52039. changeGazeColor(color: Color3): void;
  52040. /**
  52041. * Exits VR and disposes of the vr experience helper
  52042. */
  52043. dispose(): void;
  52044. /**
  52045. * Gets the name of the VRExperienceHelper class
  52046. * @returns "VRExperienceHelper"
  52047. */
  52048. getClassName(): string;
  52049. }
  52050. }
  52051. declare module "babylonjs/Cameras/VR/index" {
  52052. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  52053. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  52054. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  52055. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  52056. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  52057. export * from "babylonjs/Cameras/VR/webVRCamera";
  52058. }
  52059. declare module "babylonjs/Cameras/RigModes/index" {
  52060. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  52061. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  52062. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  52063. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  52064. }
  52065. declare module "babylonjs/Cameras/index" {
  52066. export * from "babylonjs/Cameras/Inputs/index";
  52067. export * from "babylonjs/Cameras/cameraInputsManager";
  52068. export * from "babylonjs/Cameras/camera";
  52069. export * from "babylonjs/Cameras/targetCamera";
  52070. export * from "babylonjs/Cameras/freeCamera";
  52071. export * from "babylonjs/Cameras/freeCameraInputsManager";
  52072. export * from "babylonjs/Cameras/touchCamera";
  52073. export * from "babylonjs/Cameras/arcRotateCamera";
  52074. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  52075. export * from "babylonjs/Cameras/deviceOrientationCamera";
  52076. export * from "babylonjs/Cameras/flyCamera";
  52077. export * from "babylonjs/Cameras/flyCameraInputsManager";
  52078. export * from "babylonjs/Cameras/followCamera";
  52079. export * from "babylonjs/Cameras/followCameraInputsManager";
  52080. export * from "babylonjs/Cameras/gamepadCamera";
  52081. export * from "babylonjs/Cameras/Stereoscopic/index";
  52082. export * from "babylonjs/Cameras/universalCamera";
  52083. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  52084. export * from "babylonjs/Cameras/VR/index";
  52085. export * from "babylonjs/Cameras/RigModes/index";
  52086. }
  52087. declare module "babylonjs/Collisions/index" {
  52088. export * from "babylonjs/Collisions/collider";
  52089. export * from "babylonjs/Collisions/collisionCoordinator";
  52090. export * from "babylonjs/Collisions/pickingInfo";
  52091. export * from "babylonjs/Collisions/intersectionInfo";
  52092. export * from "babylonjs/Collisions/meshCollisionData";
  52093. }
  52094. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  52095. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  52096. import { Vector3 } from "babylonjs/Maths/math.vector";
  52097. import { Ray } from "babylonjs/Culling/ray";
  52098. import { Plane } from "babylonjs/Maths/math.plane";
  52099. /**
  52100. * Contains an array of blocks representing the octree
  52101. */
  52102. export interface IOctreeContainer<T> {
  52103. /**
  52104. * Blocks within the octree
  52105. */
  52106. blocks: Array<OctreeBlock<T>>;
  52107. }
  52108. /**
  52109. * Class used to store a cell in an octree
  52110. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52111. */
  52112. export class OctreeBlock<T> {
  52113. /**
  52114. * Gets the content of the current block
  52115. */
  52116. entries: T[];
  52117. /**
  52118. * Gets the list of block children
  52119. */
  52120. blocks: Array<OctreeBlock<T>>;
  52121. private _depth;
  52122. private _maxDepth;
  52123. private _capacity;
  52124. private _minPoint;
  52125. private _maxPoint;
  52126. private _boundingVectors;
  52127. private _creationFunc;
  52128. /**
  52129. * Creates a new block
  52130. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  52131. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  52132. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52133. * @param depth defines the current depth of this block in the octree
  52134. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  52135. * @param creationFunc defines a callback to call when an element is added to the block
  52136. */
  52137. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  52138. /**
  52139. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52140. */
  52141. get capacity(): number;
  52142. /**
  52143. * Gets the minimum vector (in world space) of the block's bounding box
  52144. */
  52145. get minPoint(): Vector3;
  52146. /**
  52147. * Gets the maximum vector (in world space) of the block's bounding box
  52148. */
  52149. get maxPoint(): Vector3;
  52150. /**
  52151. * Add a new element to this block
  52152. * @param entry defines the element to add
  52153. */
  52154. addEntry(entry: T): void;
  52155. /**
  52156. * Remove an element from this block
  52157. * @param entry defines the element to remove
  52158. */
  52159. removeEntry(entry: T): void;
  52160. /**
  52161. * Add an array of elements to this block
  52162. * @param entries defines the array of elements to add
  52163. */
  52164. addEntries(entries: T[]): void;
  52165. /**
  52166. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52167. * @param frustumPlanes defines the frustum planes to test
  52168. * @param selection defines the array to store current content if selection is positive
  52169. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52170. */
  52171. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52172. /**
  52173. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52174. * @param sphereCenter defines the bounding sphere center
  52175. * @param sphereRadius defines the bounding sphere radius
  52176. * @param selection defines the array to store current content if selection is positive
  52177. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52178. */
  52179. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52180. /**
  52181. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52182. * @param ray defines the ray to test with
  52183. * @param selection defines the array to store current content if selection is positive
  52184. */
  52185. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52186. /**
  52187. * Subdivide the content into child blocks (this block will then be empty)
  52188. */
  52189. createInnerBlocks(): void;
  52190. /**
  52191. * @hidden
  52192. */
  52193. 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;
  52194. }
  52195. }
  52196. declare module "babylonjs/Culling/Octrees/octree" {
  52197. import { SmartArray } from "babylonjs/Misc/smartArray";
  52198. import { Vector3 } from "babylonjs/Maths/math.vector";
  52199. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52200. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52201. import { Ray } from "babylonjs/Culling/ray";
  52202. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52203. import { Plane } from "babylonjs/Maths/math.plane";
  52204. /**
  52205. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52206. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52207. */
  52208. export class Octree<T> {
  52209. /** 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.) */
  52210. maxDepth: number;
  52211. /**
  52212. * Blocks within the octree containing objects
  52213. */
  52214. blocks: Array<OctreeBlock<T>>;
  52215. /**
  52216. * Content stored in the octree
  52217. */
  52218. dynamicContent: T[];
  52219. private _maxBlockCapacity;
  52220. private _selectionContent;
  52221. private _creationFunc;
  52222. /**
  52223. * Creates a octree
  52224. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52225. * @param creationFunc function to be used to instatiate the octree
  52226. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52227. * @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.)
  52228. */
  52229. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52230. /** 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.) */
  52231. maxDepth?: number);
  52232. /**
  52233. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52234. * @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);
  52235. * @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);
  52236. * @param entries meshes to be added to the octree blocks
  52237. */
  52238. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52239. /**
  52240. * Adds a mesh to the octree
  52241. * @param entry Mesh to add to the octree
  52242. */
  52243. addMesh(entry: T): void;
  52244. /**
  52245. * Remove an element from the octree
  52246. * @param entry defines the element to remove
  52247. */
  52248. removeMesh(entry: T): void;
  52249. /**
  52250. * Selects an array of meshes within the frustum
  52251. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52252. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52253. * @returns array of meshes within the frustum
  52254. */
  52255. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52256. /**
  52257. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52258. * @param sphereCenter defines the bounding sphere center
  52259. * @param sphereRadius defines the bounding sphere radius
  52260. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52261. * @returns an array of objects that intersect the sphere
  52262. */
  52263. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52264. /**
  52265. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52266. * @param ray defines the ray to test with
  52267. * @returns array of intersected objects
  52268. */
  52269. intersectsRay(ray: Ray): SmartArray<T>;
  52270. /**
  52271. * Adds a mesh into the octree block if it intersects the block
  52272. */
  52273. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52274. /**
  52275. * Adds a submesh into the octree block if it intersects the block
  52276. */
  52277. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52278. }
  52279. }
  52280. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52281. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52282. import { Scene } from "babylonjs/scene";
  52283. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52284. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52285. import { Ray } from "babylonjs/Culling/ray";
  52286. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52287. import { Collider } from "babylonjs/Collisions/collider";
  52288. module "babylonjs/scene" {
  52289. interface Scene {
  52290. /**
  52291. * @hidden
  52292. * Backing Filed
  52293. */
  52294. _selectionOctree: Octree<AbstractMesh>;
  52295. /**
  52296. * Gets the octree used to boost mesh selection (picking)
  52297. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52298. */
  52299. selectionOctree: Octree<AbstractMesh>;
  52300. /**
  52301. * Creates or updates the octree used to boost selection (picking)
  52302. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52303. * @param maxCapacity defines the maximum capacity per leaf
  52304. * @param maxDepth defines the maximum depth of the octree
  52305. * @returns an octree of AbstractMesh
  52306. */
  52307. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52308. }
  52309. }
  52310. module "babylonjs/Meshes/abstractMesh" {
  52311. interface AbstractMesh {
  52312. /**
  52313. * @hidden
  52314. * Backing Field
  52315. */
  52316. _submeshesOctree: Octree<SubMesh>;
  52317. /**
  52318. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52319. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52320. * @param maxCapacity defines the maximum size of each block (64 by default)
  52321. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52322. * @returns the new octree
  52323. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52324. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52325. */
  52326. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52327. }
  52328. }
  52329. /**
  52330. * Defines the octree scene component responsible to manage any octrees
  52331. * in a given scene.
  52332. */
  52333. export class OctreeSceneComponent {
  52334. /**
  52335. * The component name help to identify the component in the list of scene components.
  52336. */
  52337. readonly name: string;
  52338. /**
  52339. * The scene the component belongs to.
  52340. */
  52341. scene: Scene;
  52342. /**
  52343. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52344. */
  52345. readonly checksIsEnabled: boolean;
  52346. /**
  52347. * Creates a new instance of the component for the given scene
  52348. * @param scene Defines the scene to register the component in
  52349. */
  52350. constructor(scene: Scene);
  52351. /**
  52352. * Registers the component in a given scene
  52353. */
  52354. register(): void;
  52355. /**
  52356. * Return the list of active meshes
  52357. * @returns the list of active meshes
  52358. */
  52359. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52360. /**
  52361. * Return the list of active sub meshes
  52362. * @param mesh The mesh to get the candidates sub meshes from
  52363. * @returns the list of active sub meshes
  52364. */
  52365. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52366. private _tempRay;
  52367. /**
  52368. * Return the list of sub meshes intersecting with a given local ray
  52369. * @param mesh defines the mesh to find the submesh for
  52370. * @param localRay defines the ray in local space
  52371. * @returns the list of intersecting sub meshes
  52372. */
  52373. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52374. /**
  52375. * Return the list of sub meshes colliding with a collider
  52376. * @param mesh defines the mesh to find the submesh for
  52377. * @param collider defines the collider to evaluate the collision against
  52378. * @returns the list of colliding sub meshes
  52379. */
  52380. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52381. /**
  52382. * Rebuilds the elements related to this component in case of
  52383. * context lost for instance.
  52384. */
  52385. rebuild(): void;
  52386. /**
  52387. * Disposes the component and the associated ressources.
  52388. */
  52389. dispose(): void;
  52390. }
  52391. }
  52392. declare module "babylonjs/Culling/Octrees/index" {
  52393. export * from "babylonjs/Culling/Octrees/octree";
  52394. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52395. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52396. }
  52397. declare module "babylonjs/Culling/index" {
  52398. export * from "babylonjs/Culling/boundingBox";
  52399. export * from "babylonjs/Culling/boundingInfo";
  52400. export * from "babylonjs/Culling/boundingSphere";
  52401. export * from "babylonjs/Culling/Octrees/index";
  52402. export * from "babylonjs/Culling/ray";
  52403. }
  52404. declare module "babylonjs/Gizmos/gizmo" {
  52405. import { Nullable } from "babylonjs/types";
  52406. import { IDisposable } from "babylonjs/scene";
  52407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52408. import { Mesh } from "babylonjs/Meshes/mesh";
  52409. import { Node } from "babylonjs/node";
  52410. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52411. /**
  52412. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52413. */
  52414. export class Gizmo implements IDisposable {
  52415. /** The utility layer the gizmo will be added to */
  52416. gizmoLayer: UtilityLayerRenderer;
  52417. /**
  52418. * The root mesh of the gizmo
  52419. */
  52420. _rootMesh: Mesh;
  52421. private _attachedMesh;
  52422. private _attachedNode;
  52423. /**
  52424. * Ratio for the scale of the gizmo (Default: 1)
  52425. */
  52426. protected _scaleRatio: number;
  52427. /**
  52428. * boolean updated by pointermove when a gizmo mesh is hovered
  52429. */
  52430. protected _isHovered: boolean;
  52431. /**
  52432. * Ratio for the scale of the gizmo (Default: 1)
  52433. */
  52434. set scaleRatio(value: number);
  52435. get scaleRatio(): number;
  52436. /**
  52437. * True when the mouse pointer is hovered a gizmo mesh
  52438. */
  52439. get isHovered(): boolean;
  52440. /**
  52441. * If a custom mesh has been set (Default: false)
  52442. */
  52443. protected _customMeshSet: boolean;
  52444. /**
  52445. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52446. * * When set, interactions will be enabled
  52447. */
  52448. get attachedMesh(): Nullable<AbstractMesh>;
  52449. set attachedMesh(value: Nullable<AbstractMesh>);
  52450. /**
  52451. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52452. * * When set, interactions will be enabled
  52453. */
  52454. get attachedNode(): Nullable<Node>;
  52455. set attachedNode(value: Nullable<Node>);
  52456. /**
  52457. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52458. * @param mesh The mesh to replace the default mesh of the gizmo
  52459. */
  52460. setCustomMesh(mesh: Mesh): void;
  52461. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52462. /**
  52463. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52464. */
  52465. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52466. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52467. /**
  52468. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52469. */
  52470. updateGizmoPositionToMatchAttachedMesh: boolean;
  52471. /**
  52472. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52473. */
  52474. updateScale: boolean;
  52475. protected _interactionsEnabled: boolean;
  52476. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52477. private _beforeRenderObserver;
  52478. private _tempQuaternion;
  52479. private _tempVector;
  52480. private _tempVector2;
  52481. private _tempMatrix1;
  52482. private _tempMatrix2;
  52483. private _rightHandtoLeftHandMatrix;
  52484. /**
  52485. * Creates a gizmo
  52486. * @param gizmoLayer The utility layer the gizmo will be added to
  52487. */
  52488. constructor(
  52489. /** The utility layer the gizmo will be added to */
  52490. gizmoLayer?: UtilityLayerRenderer);
  52491. /**
  52492. * Updates the gizmo to match the attached mesh's position/rotation
  52493. */
  52494. protected _update(): void;
  52495. /**
  52496. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52497. * @param value Node, TransformNode or mesh
  52498. */
  52499. protected _matrixChanged(): void;
  52500. /**
  52501. * Disposes of the gizmo
  52502. */
  52503. dispose(): void;
  52504. }
  52505. }
  52506. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52507. import { Observable } from "babylonjs/Misc/observable";
  52508. import { Nullable } from "babylonjs/types";
  52509. import { Vector3 } from "babylonjs/Maths/math.vector";
  52510. import { Color3 } from "babylonjs/Maths/math.color";
  52511. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52512. import { Node } from "babylonjs/node";
  52513. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52514. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52515. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52516. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52517. import { Scene } from "babylonjs/scene";
  52518. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52519. /**
  52520. * Single plane drag gizmo
  52521. */
  52522. export class PlaneDragGizmo extends Gizmo {
  52523. /**
  52524. * Drag behavior responsible for the gizmos dragging interactions
  52525. */
  52526. dragBehavior: PointerDragBehavior;
  52527. private _pointerObserver;
  52528. /**
  52529. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52530. */
  52531. snapDistance: number;
  52532. /**
  52533. * Event that fires each time the gizmo snaps to a new location.
  52534. * * snapDistance is the the change in distance
  52535. */
  52536. onSnapObservable: Observable<{
  52537. snapDistance: number;
  52538. }>;
  52539. private _plane;
  52540. private _coloredMaterial;
  52541. private _hoverMaterial;
  52542. private _isEnabled;
  52543. private _parent;
  52544. /** @hidden */
  52545. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52546. /** @hidden */
  52547. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52548. /**
  52549. * Creates a PlaneDragGizmo
  52550. * @param gizmoLayer The utility layer the gizmo will be added to
  52551. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52552. * @param color The color of the gizmo
  52553. */
  52554. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52555. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52556. /**
  52557. * If the gizmo is enabled
  52558. */
  52559. set isEnabled(value: boolean);
  52560. get isEnabled(): boolean;
  52561. /**
  52562. * Disposes of the gizmo
  52563. */
  52564. dispose(): void;
  52565. }
  52566. }
  52567. declare module "babylonjs/Gizmos/positionGizmo" {
  52568. import { Observable } from "babylonjs/Misc/observable";
  52569. import { Nullable } from "babylonjs/types";
  52570. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52571. import { Node } from "babylonjs/node";
  52572. import { Mesh } from "babylonjs/Meshes/mesh";
  52573. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52574. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52575. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52576. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52577. /**
  52578. * Gizmo that enables dragging a mesh along 3 axis
  52579. */
  52580. export class PositionGizmo extends Gizmo {
  52581. /**
  52582. * Internal gizmo used for interactions on the x axis
  52583. */
  52584. xGizmo: AxisDragGizmo;
  52585. /**
  52586. * Internal gizmo used for interactions on the y axis
  52587. */
  52588. yGizmo: AxisDragGizmo;
  52589. /**
  52590. * Internal gizmo used for interactions on the z axis
  52591. */
  52592. zGizmo: AxisDragGizmo;
  52593. /**
  52594. * Internal gizmo used for interactions on the yz plane
  52595. */
  52596. xPlaneGizmo: PlaneDragGizmo;
  52597. /**
  52598. * Internal gizmo used for interactions on the xz plane
  52599. */
  52600. yPlaneGizmo: PlaneDragGizmo;
  52601. /**
  52602. * Internal gizmo used for interactions on the xy plane
  52603. */
  52604. zPlaneGizmo: PlaneDragGizmo;
  52605. /**
  52606. * private variables
  52607. */
  52608. private _meshAttached;
  52609. private _nodeAttached;
  52610. private _snapDistance;
  52611. /** Fires an event when any of it's sub gizmos are dragged */
  52612. onDragStartObservable: Observable<unknown>;
  52613. /** Fires an event when any of it's sub gizmos are released from dragging */
  52614. onDragEndObservable: Observable<unknown>;
  52615. /**
  52616. * If set to true, planar drag is enabled
  52617. */
  52618. private _planarGizmoEnabled;
  52619. get attachedMesh(): Nullable<AbstractMesh>;
  52620. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52621. get attachedNode(): Nullable<Node>;
  52622. set attachedNode(node: Nullable<Node>);
  52623. /**
  52624. * True when the mouse pointer is hovering a gizmo mesh
  52625. */
  52626. get isHovered(): boolean;
  52627. /**
  52628. * Creates a PositionGizmo
  52629. * @param gizmoLayer The utility layer the gizmo will be added to
  52630. @param thickness display gizmo axis thickness
  52631. */
  52632. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52633. /**
  52634. * If the planar drag gizmo is enabled
  52635. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52636. */
  52637. set planarGizmoEnabled(value: boolean);
  52638. get planarGizmoEnabled(): boolean;
  52639. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52640. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52641. /**
  52642. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52643. */
  52644. set snapDistance(value: number);
  52645. get snapDistance(): number;
  52646. /**
  52647. * Ratio for the scale of the gizmo (Default: 1)
  52648. */
  52649. set scaleRatio(value: number);
  52650. get scaleRatio(): number;
  52651. /**
  52652. * Disposes of the gizmo
  52653. */
  52654. dispose(): void;
  52655. /**
  52656. * CustomMeshes are not supported by this gizmo
  52657. * @param mesh The mesh to replace the default mesh of the gizmo
  52658. */
  52659. setCustomMesh(mesh: Mesh): void;
  52660. }
  52661. }
  52662. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52663. import { Observable } from "babylonjs/Misc/observable";
  52664. import { Nullable } from "babylonjs/types";
  52665. import { Vector3 } from "babylonjs/Maths/math.vector";
  52666. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52667. import { Node } from "babylonjs/node";
  52668. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52669. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52670. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52671. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52672. import { Scene } from "babylonjs/scene";
  52673. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52674. import { Color3 } from "babylonjs/Maths/math.color";
  52675. /**
  52676. * Single axis drag gizmo
  52677. */
  52678. export class AxisDragGizmo extends Gizmo {
  52679. /**
  52680. * Drag behavior responsible for the gizmos dragging interactions
  52681. */
  52682. dragBehavior: PointerDragBehavior;
  52683. private _pointerObserver;
  52684. /**
  52685. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52686. */
  52687. snapDistance: number;
  52688. /**
  52689. * Event that fires each time the gizmo snaps to a new location.
  52690. * * snapDistance is the the change in distance
  52691. */
  52692. onSnapObservable: Observable<{
  52693. snapDistance: number;
  52694. }>;
  52695. private _isEnabled;
  52696. private _parent;
  52697. private _arrow;
  52698. private _coloredMaterial;
  52699. private _hoverMaterial;
  52700. /** @hidden */
  52701. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52702. /** @hidden */
  52703. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52704. /**
  52705. * Creates an AxisDragGizmo
  52706. * @param gizmoLayer The utility layer the gizmo will be added to
  52707. * @param dragAxis The axis which the gizmo will be able to drag on
  52708. * @param color The color of the gizmo
  52709. * @param thickness display gizmo axis thickness
  52710. */
  52711. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52712. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52713. /**
  52714. * If the gizmo is enabled
  52715. */
  52716. set isEnabled(value: boolean);
  52717. get isEnabled(): boolean;
  52718. /**
  52719. * Disposes of the gizmo
  52720. */
  52721. dispose(): void;
  52722. }
  52723. }
  52724. declare module "babylonjs/Debug/axesViewer" {
  52725. import { Vector3 } from "babylonjs/Maths/math.vector";
  52726. import { Nullable } from "babylonjs/types";
  52727. import { Scene } from "babylonjs/scene";
  52728. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52729. /**
  52730. * The Axes viewer will show 3 axes in a specific point in space
  52731. */
  52732. export class AxesViewer {
  52733. private _xAxis;
  52734. private _yAxis;
  52735. private _zAxis;
  52736. private _scaleLinesFactor;
  52737. private _instanced;
  52738. /**
  52739. * Gets the hosting scene
  52740. */
  52741. scene: Nullable<Scene>;
  52742. /**
  52743. * Gets or sets a number used to scale line length
  52744. */
  52745. scaleLines: number;
  52746. /** Gets the node hierarchy used to render x-axis */
  52747. get xAxis(): TransformNode;
  52748. /** Gets the node hierarchy used to render y-axis */
  52749. get yAxis(): TransformNode;
  52750. /** Gets the node hierarchy used to render z-axis */
  52751. get zAxis(): TransformNode;
  52752. /**
  52753. * Creates a new AxesViewer
  52754. * @param scene defines the hosting scene
  52755. * @param scaleLines defines a number used to scale line length (1 by default)
  52756. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52757. * @param xAxis defines the node hierarchy used to render the x-axis
  52758. * @param yAxis defines the node hierarchy used to render the y-axis
  52759. * @param zAxis defines the node hierarchy used to render the z-axis
  52760. */
  52761. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52762. /**
  52763. * Force the viewer to update
  52764. * @param position defines the position of the viewer
  52765. * @param xaxis defines the x axis of the viewer
  52766. * @param yaxis defines the y axis of the viewer
  52767. * @param zaxis defines the z axis of the viewer
  52768. */
  52769. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52770. /**
  52771. * Creates an instance of this axes viewer.
  52772. * @returns a new axes viewer with instanced meshes
  52773. */
  52774. createInstance(): AxesViewer;
  52775. /** Releases resources */
  52776. dispose(): void;
  52777. private static _SetRenderingGroupId;
  52778. }
  52779. }
  52780. declare module "babylonjs/Debug/boneAxesViewer" {
  52781. import { Nullable } from "babylonjs/types";
  52782. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52783. import { Vector3 } from "babylonjs/Maths/math.vector";
  52784. import { Mesh } from "babylonjs/Meshes/mesh";
  52785. import { Bone } from "babylonjs/Bones/bone";
  52786. import { Scene } from "babylonjs/scene";
  52787. /**
  52788. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52789. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52790. */
  52791. export class BoneAxesViewer extends AxesViewer {
  52792. /**
  52793. * Gets or sets the target mesh where to display the axes viewer
  52794. */
  52795. mesh: Nullable<Mesh>;
  52796. /**
  52797. * Gets or sets the target bone where to display the axes viewer
  52798. */
  52799. bone: Nullable<Bone>;
  52800. /** Gets current position */
  52801. pos: Vector3;
  52802. /** Gets direction of X axis */
  52803. xaxis: Vector3;
  52804. /** Gets direction of Y axis */
  52805. yaxis: Vector3;
  52806. /** Gets direction of Z axis */
  52807. zaxis: Vector3;
  52808. /**
  52809. * Creates a new BoneAxesViewer
  52810. * @param scene defines the hosting scene
  52811. * @param bone defines the target bone
  52812. * @param mesh defines the target mesh
  52813. * @param scaleLines defines a scaling factor for line length (1 by default)
  52814. */
  52815. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52816. /**
  52817. * Force the viewer to update
  52818. */
  52819. update(): void;
  52820. /** Releases resources */
  52821. dispose(): void;
  52822. }
  52823. }
  52824. declare module "babylonjs/Debug/debugLayer" {
  52825. import { Scene } from "babylonjs/scene";
  52826. /**
  52827. * Interface used to define scene explorer extensibility option
  52828. */
  52829. export interface IExplorerExtensibilityOption {
  52830. /**
  52831. * Define the option label
  52832. */
  52833. label: string;
  52834. /**
  52835. * Defines the action to execute on click
  52836. */
  52837. action: (entity: any) => void;
  52838. }
  52839. /**
  52840. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52841. */
  52842. export interface IExplorerExtensibilityGroup {
  52843. /**
  52844. * Defines a predicate to test if a given type mut be extended
  52845. */
  52846. predicate: (entity: any) => boolean;
  52847. /**
  52848. * Gets the list of options added to a type
  52849. */
  52850. entries: IExplorerExtensibilityOption[];
  52851. }
  52852. /**
  52853. * Interface used to define the options to use to create the Inspector
  52854. */
  52855. export interface IInspectorOptions {
  52856. /**
  52857. * Display in overlay mode (default: false)
  52858. */
  52859. overlay?: boolean;
  52860. /**
  52861. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52862. */
  52863. globalRoot?: HTMLElement;
  52864. /**
  52865. * Display the Scene explorer
  52866. */
  52867. showExplorer?: boolean;
  52868. /**
  52869. * Display the property inspector
  52870. */
  52871. showInspector?: boolean;
  52872. /**
  52873. * Display in embed mode (both panes on the right)
  52874. */
  52875. embedMode?: boolean;
  52876. /**
  52877. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52878. */
  52879. handleResize?: boolean;
  52880. /**
  52881. * Allow the panes to popup (default: true)
  52882. */
  52883. enablePopup?: boolean;
  52884. /**
  52885. * Allow the panes to be closed by users (default: true)
  52886. */
  52887. enableClose?: boolean;
  52888. /**
  52889. * Optional list of extensibility entries
  52890. */
  52891. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52892. /**
  52893. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52894. */
  52895. inspectorURL?: string;
  52896. /**
  52897. * Optional initial tab (default to DebugLayerTab.Properties)
  52898. */
  52899. initialTab?: DebugLayerTab;
  52900. }
  52901. module "babylonjs/scene" {
  52902. interface Scene {
  52903. /**
  52904. * @hidden
  52905. * Backing field
  52906. */
  52907. _debugLayer: DebugLayer;
  52908. /**
  52909. * Gets the debug layer (aka Inspector) associated with the scene
  52910. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52911. */
  52912. debugLayer: DebugLayer;
  52913. }
  52914. }
  52915. /**
  52916. * Enum of inspector action tab
  52917. */
  52918. export enum DebugLayerTab {
  52919. /**
  52920. * Properties tag (default)
  52921. */
  52922. Properties = 0,
  52923. /**
  52924. * Debug tab
  52925. */
  52926. Debug = 1,
  52927. /**
  52928. * Statistics tab
  52929. */
  52930. Statistics = 2,
  52931. /**
  52932. * Tools tab
  52933. */
  52934. Tools = 3,
  52935. /**
  52936. * Settings tab
  52937. */
  52938. Settings = 4
  52939. }
  52940. /**
  52941. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52942. * what is happening in your scene
  52943. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52944. */
  52945. export class DebugLayer {
  52946. /**
  52947. * Define the url to get the inspector script from.
  52948. * By default it uses the babylonjs CDN.
  52949. * @ignoreNaming
  52950. */
  52951. static InspectorURL: string;
  52952. private _scene;
  52953. private BJSINSPECTOR;
  52954. private _onPropertyChangedObservable?;
  52955. /**
  52956. * Observable triggered when a property is changed through the inspector.
  52957. */
  52958. get onPropertyChangedObservable(): any;
  52959. /**
  52960. * Instantiates a new debug layer.
  52961. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52962. * what is happening in your scene
  52963. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52964. * @param scene Defines the scene to inspect
  52965. */
  52966. constructor(scene: Scene);
  52967. /** Creates the inspector window. */
  52968. private _createInspector;
  52969. /**
  52970. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52971. * @param entity defines the entity to select
  52972. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52973. */
  52974. select(entity: any, lineContainerTitles?: string | string[]): void;
  52975. /** Get the inspector from bundle or global */
  52976. private _getGlobalInspector;
  52977. /**
  52978. * Get if the inspector is visible or not.
  52979. * @returns true if visible otherwise, false
  52980. */
  52981. isVisible(): boolean;
  52982. /**
  52983. * Hide the inspector and close its window.
  52984. */
  52985. hide(): void;
  52986. /**
  52987. * Update the scene in the inspector
  52988. */
  52989. setAsActiveScene(): void;
  52990. /**
  52991. * Launch the debugLayer.
  52992. * @param config Define the configuration of the inspector
  52993. * @return a promise fulfilled when the debug layer is visible
  52994. */
  52995. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52996. }
  52997. }
  52998. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52999. import { Nullable } from "babylonjs/types";
  53000. import { Scene } from "babylonjs/scene";
  53001. import { Vector4 } from "babylonjs/Maths/math.vector";
  53002. import { Color4 } from "babylonjs/Maths/math.color";
  53003. import { Mesh } from "babylonjs/Meshes/mesh";
  53004. /**
  53005. * Class containing static functions to help procedurally build meshes
  53006. */
  53007. export class BoxBuilder {
  53008. /**
  53009. * Creates a box mesh
  53010. * * The parameter `size` sets the size (float) of each box side (default 1)
  53011. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  53012. * * 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)
  53013. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  53014. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53015. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53016. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53017. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  53018. * @param name defines the name of the mesh
  53019. * @param options defines the options used to create the mesh
  53020. * @param scene defines the hosting scene
  53021. * @returns the box mesh
  53022. */
  53023. static CreateBox(name: string, options: {
  53024. size?: number;
  53025. width?: number;
  53026. height?: number;
  53027. depth?: number;
  53028. faceUV?: Vector4[];
  53029. faceColors?: Color4[];
  53030. sideOrientation?: number;
  53031. frontUVs?: Vector4;
  53032. backUVs?: Vector4;
  53033. wrap?: boolean;
  53034. topBaseAt?: number;
  53035. bottomBaseAt?: number;
  53036. updatable?: boolean;
  53037. }, scene?: Nullable<Scene>): Mesh;
  53038. }
  53039. }
  53040. declare module "babylonjs/Debug/physicsViewer" {
  53041. import { Nullable } from "babylonjs/types";
  53042. import { Scene } from "babylonjs/scene";
  53043. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53044. import { Mesh } from "babylonjs/Meshes/mesh";
  53045. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53046. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53047. /**
  53048. * Used to show the physics impostor around the specific mesh
  53049. */
  53050. export class PhysicsViewer {
  53051. /** @hidden */
  53052. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  53053. /** @hidden */
  53054. protected _meshes: Array<Nullable<AbstractMesh>>;
  53055. /** @hidden */
  53056. protected _scene: Nullable<Scene>;
  53057. /** @hidden */
  53058. protected _numMeshes: number;
  53059. /** @hidden */
  53060. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  53061. private _renderFunction;
  53062. private _utilityLayer;
  53063. private _debugBoxMesh;
  53064. private _debugSphereMesh;
  53065. private _debugCylinderMesh;
  53066. private _debugMaterial;
  53067. private _debugMeshMeshes;
  53068. /**
  53069. * Creates a new PhysicsViewer
  53070. * @param scene defines the hosting scene
  53071. */
  53072. constructor(scene: Scene);
  53073. /** @hidden */
  53074. protected _updateDebugMeshes(): void;
  53075. /**
  53076. * Renders a specified physic impostor
  53077. * @param impostor defines the impostor to render
  53078. * @param targetMesh defines the mesh represented by the impostor
  53079. * @returns the new debug mesh used to render the impostor
  53080. */
  53081. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  53082. /**
  53083. * Hides a specified physic impostor
  53084. * @param impostor defines the impostor to hide
  53085. */
  53086. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  53087. private _getDebugMaterial;
  53088. private _getDebugBoxMesh;
  53089. private _getDebugSphereMesh;
  53090. private _getDebugCylinderMesh;
  53091. private _getDebugMeshMesh;
  53092. private _getDebugMesh;
  53093. /** Releases all resources */
  53094. dispose(): void;
  53095. }
  53096. }
  53097. declare module "babylonjs/Debug/rayHelper" {
  53098. import { Nullable } from "babylonjs/types";
  53099. import { Ray } from "babylonjs/Culling/ray";
  53100. import { Vector3 } from "babylonjs/Maths/math.vector";
  53101. import { Color3 } from "babylonjs/Maths/math.color";
  53102. import { Scene } from "babylonjs/scene";
  53103. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53104. import "babylonjs/Meshes/Builders/linesBuilder";
  53105. /**
  53106. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  53107. * in order to better appreciate the issue one might have.
  53108. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  53109. */
  53110. export class RayHelper {
  53111. /**
  53112. * Defines the ray we are currently tryin to visualize.
  53113. */
  53114. ray: Nullable<Ray>;
  53115. private _renderPoints;
  53116. private _renderLine;
  53117. private _renderFunction;
  53118. private _scene;
  53119. private _onAfterRenderObserver;
  53120. private _onAfterStepObserver;
  53121. private _attachedToMesh;
  53122. private _meshSpaceDirection;
  53123. private _meshSpaceOrigin;
  53124. /**
  53125. * Helper function to create a colored helper in a scene in one line.
  53126. * @param ray Defines the ray we are currently tryin to visualize
  53127. * @param scene Defines the scene the ray is used in
  53128. * @param color Defines the color we want to see the ray in
  53129. * @returns The newly created ray helper.
  53130. */
  53131. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  53132. /**
  53133. * Instantiate a new ray helper.
  53134. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  53135. * in order to better appreciate the issue one might have.
  53136. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  53137. * @param ray Defines the ray we are currently tryin to visualize
  53138. */
  53139. constructor(ray: Ray);
  53140. /**
  53141. * Shows the ray we are willing to debug.
  53142. * @param scene Defines the scene the ray needs to be rendered in
  53143. * @param color Defines the color the ray needs to be rendered in
  53144. */
  53145. show(scene: Scene, color?: Color3): void;
  53146. /**
  53147. * Hides the ray we are debugging.
  53148. */
  53149. hide(): void;
  53150. private _render;
  53151. /**
  53152. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  53153. * @param mesh Defines the mesh we want the helper attached to
  53154. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  53155. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  53156. * @param length Defines the length of the ray
  53157. */
  53158. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  53159. /**
  53160. * Detach the ray helper from the mesh it has previously been attached to.
  53161. */
  53162. detachFromMesh(): void;
  53163. private _updateToMesh;
  53164. /**
  53165. * Dispose the helper and release its associated resources.
  53166. */
  53167. dispose(): void;
  53168. }
  53169. }
  53170. declare module "babylonjs/Debug/ISkeletonViewer" {
  53171. import { Skeleton } from "babylonjs/Bones/skeleton";
  53172. import { Color3 } from "babylonjs/Maths/math.color";
  53173. /**
  53174. * Defines the options associated with the creation of a SkeletonViewer.
  53175. */
  53176. export interface ISkeletonViewerOptions {
  53177. /** Should the system pause animations before building the Viewer? */
  53178. pauseAnimations: boolean;
  53179. /** Should the system return the skeleton to rest before building? */
  53180. returnToRest: boolean;
  53181. /** public Display Mode of the Viewer */
  53182. displayMode: number;
  53183. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53184. displayOptions: ISkeletonViewerDisplayOptions;
  53185. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53186. computeBonesUsingShaders: boolean;
  53187. /** Flag ignore non weighted bones */
  53188. useAllBones: boolean;
  53189. }
  53190. /**
  53191. * Defines how to display the various bone meshes for the viewer.
  53192. */
  53193. export interface ISkeletonViewerDisplayOptions {
  53194. /** How far down to start tapering the bone spurs */
  53195. midStep?: number;
  53196. /** How big is the midStep? */
  53197. midStepFactor?: number;
  53198. /** Base for the Sphere Size */
  53199. sphereBaseSize?: number;
  53200. /** The ratio of the sphere to the longest bone in units */
  53201. sphereScaleUnit?: number;
  53202. /** Ratio for the Sphere Size */
  53203. sphereFactor?: number;
  53204. /** Whether to show local axes or not */
  53205. showLocalAxes?: boolean;
  53206. /** Length of each local axis */
  53207. localAxesSize?: number;
  53208. }
  53209. /**
  53210. * Defines the constructor options for the BoneWeight Shader.
  53211. */
  53212. export interface IBoneWeightShaderOptions {
  53213. /** Skeleton to Map */
  53214. skeleton: Skeleton;
  53215. /** Colors for Uninfluenced bones */
  53216. colorBase?: Color3;
  53217. /** Colors for 0.0-0.25 Weight bones */
  53218. colorZero?: Color3;
  53219. /** Color for 0.25-0.5 Weight Influence */
  53220. colorQuarter?: Color3;
  53221. /** Color for 0.5-0.75 Weight Influence */
  53222. colorHalf?: Color3;
  53223. /** Color for 0.75-1 Weight Influence */
  53224. colorFull?: Color3;
  53225. /** Color for Zero Weight Influence */
  53226. targetBoneIndex?: number;
  53227. }
  53228. /**
  53229. * Simple structure of the gradient steps for the Color Map.
  53230. */
  53231. export interface ISkeletonMapShaderColorMapKnot {
  53232. /** Color of the Knot */
  53233. color: Color3;
  53234. /** Location of the Knot */
  53235. location: number;
  53236. }
  53237. /**
  53238. * Defines the constructor options for the SkeletonMap Shader.
  53239. */
  53240. export interface ISkeletonMapShaderOptions {
  53241. /** Skeleton to Map */
  53242. skeleton: Skeleton;
  53243. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  53244. colorMap?: ISkeletonMapShaderColorMapKnot[];
  53245. }
  53246. }
  53247. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53248. import { Nullable } from "babylonjs/types";
  53249. import { Scene } from "babylonjs/scene";
  53250. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53251. import { Color4 } from "babylonjs/Maths/math.color";
  53252. import { Mesh } from "babylonjs/Meshes/mesh";
  53253. /**
  53254. * Class containing static functions to help procedurally build meshes
  53255. */
  53256. export class RibbonBuilder {
  53257. /**
  53258. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53259. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53260. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53261. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53262. * * 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
  53263. * * 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
  53264. * * 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
  53265. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53266. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53267. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53268. * * 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
  53269. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53270. * * 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
  53271. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53272. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53273. * @param name defines the name of the mesh
  53274. * @param options defines the options used to create the mesh
  53275. * @param scene defines the hosting scene
  53276. * @returns the ribbon mesh
  53277. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53278. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53279. */
  53280. static CreateRibbon(name: string, options: {
  53281. pathArray: Vector3[][];
  53282. closeArray?: boolean;
  53283. closePath?: boolean;
  53284. offset?: number;
  53285. updatable?: boolean;
  53286. sideOrientation?: number;
  53287. frontUVs?: Vector4;
  53288. backUVs?: Vector4;
  53289. instance?: Mesh;
  53290. invertUV?: boolean;
  53291. uvs?: Vector2[];
  53292. colors?: Color4[];
  53293. }, scene?: Nullable<Scene>): Mesh;
  53294. }
  53295. }
  53296. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53297. import { Nullable } from "babylonjs/types";
  53298. import { Scene } from "babylonjs/scene";
  53299. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53300. import { Mesh } from "babylonjs/Meshes/mesh";
  53301. /**
  53302. * Class containing static functions to help procedurally build meshes
  53303. */
  53304. export class ShapeBuilder {
  53305. /**
  53306. * 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.
  53307. * * 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.
  53308. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53309. * * 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.
  53310. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53311. * * 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
  53312. * * 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
  53313. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53314. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53315. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53316. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53317. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53318. * @param name defines the name of the mesh
  53319. * @param options defines the options used to create the mesh
  53320. * @param scene defines the hosting scene
  53321. * @returns the extruded shape mesh
  53322. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53323. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53324. */
  53325. static ExtrudeShape(name: string, options: {
  53326. shape: Vector3[];
  53327. path: Vector3[];
  53328. scale?: number;
  53329. rotation?: number;
  53330. cap?: number;
  53331. updatable?: boolean;
  53332. sideOrientation?: number;
  53333. frontUVs?: Vector4;
  53334. backUVs?: Vector4;
  53335. instance?: Mesh;
  53336. invertUV?: boolean;
  53337. }, scene?: Nullable<Scene>): Mesh;
  53338. /**
  53339. * Creates an custom extruded shape mesh.
  53340. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53341. * * 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.
  53342. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53343. * * 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
  53344. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53345. * * 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
  53346. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53347. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53348. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53349. * * 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
  53350. * * 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
  53351. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53352. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53353. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53354. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53356. * @param name defines the name of the mesh
  53357. * @param options defines the options used to create the mesh
  53358. * @param scene defines the hosting scene
  53359. * @returns the custom extruded shape mesh
  53360. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53361. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53362. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53363. */
  53364. static ExtrudeShapeCustom(name: string, options: {
  53365. shape: Vector3[];
  53366. path: Vector3[];
  53367. scaleFunction?: any;
  53368. rotationFunction?: any;
  53369. ribbonCloseArray?: boolean;
  53370. ribbonClosePath?: boolean;
  53371. cap?: number;
  53372. updatable?: boolean;
  53373. sideOrientation?: number;
  53374. frontUVs?: Vector4;
  53375. backUVs?: Vector4;
  53376. instance?: Mesh;
  53377. invertUV?: boolean;
  53378. }, scene?: Nullable<Scene>): Mesh;
  53379. private static _ExtrudeShapeGeneric;
  53380. }
  53381. }
  53382. declare module "babylonjs/Debug/skeletonViewer" {
  53383. import { Color3 } from "babylonjs/Maths/math.color";
  53384. import { Scene } from "babylonjs/scene";
  53385. import { Nullable } from "babylonjs/types";
  53386. import { Skeleton } from "babylonjs/Bones/skeleton";
  53387. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53388. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53389. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53390. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  53391. import { ISkeletonViewerOptions, IBoneWeightShaderOptions, ISkeletonMapShaderOptions } from "babylonjs/Debug/ISkeletonViewer";
  53392. /**
  53393. * Class used to render a debug view of a given skeleton
  53394. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53395. */
  53396. export class SkeletonViewer {
  53397. /** defines the skeleton to render */
  53398. skeleton: Skeleton;
  53399. /** defines the mesh attached to the skeleton */
  53400. mesh: AbstractMesh;
  53401. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53402. autoUpdateBonesMatrices: boolean;
  53403. /** defines the rendering group id to use with the viewer */
  53404. renderingGroupId: number;
  53405. /** is the options for the viewer */
  53406. options: Partial<ISkeletonViewerOptions>;
  53407. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53408. static readonly DISPLAY_LINES: number;
  53409. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53410. static readonly DISPLAY_SPHERES: number;
  53411. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53412. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53413. /** public static method to create a BoneWeight Shader
  53414. * @param options The constructor options
  53415. * @param scene The scene that the shader is scoped to
  53416. * @returns The created ShaderMaterial
  53417. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  53418. */
  53419. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  53420. /** public static method to create a BoneWeight Shader
  53421. * @param options The constructor options
  53422. * @param scene The scene that the shader is scoped to
  53423. * @returns The created ShaderMaterial
  53424. */
  53425. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  53426. /** private static method to create a BoneWeight Shader
  53427. * @param size The size of the buffer to create (usually the bone count)
  53428. * @param colorMap The gradient data to generate
  53429. * @param scene The scene that the shader is scoped to
  53430. * @returns an Array of floats from the color gradient values
  53431. */
  53432. private static _CreateBoneMapColorBuffer;
  53433. /** If SkeletonViewer scene scope. */
  53434. private _scene;
  53435. /** Gets or sets the color used to render the skeleton */
  53436. color: Color3;
  53437. /** Array of the points of the skeleton fo the line view. */
  53438. private _debugLines;
  53439. /** The SkeletonViewers Mesh. */
  53440. private _debugMesh;
  53441. /** The local axes Meshes. */
  53442. private _localAxes;
  53443. /** If SkeletonViewer is enabled. */
  53444. private _isEnabled;
  53445. /** If SkeletonViewer is ready. */
  53446. private _ready;
  53447. /** SkeletonViewer render observable. */
  53448. private _obs;
  53449. /** The Utility Layer to render the gizmos in. */
  53450. private _utilityLayer;
  53451. private _boneIndices;
  53452. /** Gets the Scene. */
  53453. get scene(): Scene;
  53454. /** Gets the utilityLayer. */
  53455. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53456. /** Checks Ready Status. */
  53457. get isReady(): Boolean;
  53458. /** Sets Ready Status. */
  53459. set ready(value: boolean);
  53460. /** Gets the debugMesh */
  53461. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53462. /** Sets the debugMesh */
  53463. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53464. /** Gets the displayMode */
  53465. get displayMode(): number;
  53466. /** Sets the displayMode */
  53467. set displayMode(value: number);
  53468. /**
  53469. * Creates a new SkeletonViewer
  53470. * @param skeleton defines the skeleton to render
  53471. * @param mesh defines the mesh attached to the skeleton
  53472. * @param scene defines the hosting scene
  53473. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53474. * @param renderingGroupId defines the rendering group id to use with the viewer
  53475. * @param options All of the extra constructor options for the SkeletonViewer
  53476. */
  53477. constructor(
  53478. /** defines the skeleton to render */
  53479. skeleton: Skeleton,
  53480. /** defines the mesh attached to the skeleton */
  53481. mesh: AbstractMesh,
  53482. /** The Scene scope*/
  53483. scene: Scene,
  53484. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53485. autoUpdateBonesMatrices?: boolean,
  53486. /** defines the rendering group id to use with the viewer */
  53487. renderingGroupId?: number,
  53488. /** is the options for the viewer */
  53489. options?: Partial<ISkeletonViewerOptions>);
  53490. /** The Dynamic bindings for the update functions */
  53491. private _bindObs;
  53492. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53493. update(): void;
  53494. /** Gets or sets a boolean indicating if the viewer is enabled */
  53495. set isEnabled(value: boolean);
  53496. get isEnabled(): boolean;
  53497. private _getBonePosition;
  53498. private _getLinesForBonesWithLength;
  53499. private _getLinesForBonesNoLength;
  53500. /** function to revert the mesh and scene back to the initial state. */
  53501. private _revert;
  53502. private getAbsoluteRestPose;
  53503. /** function to build and bind sphere joint points and spur bone representations. */
  53504. private _buildSpheresAndSpurs;
  53505. private _buildLocalAxes;
  53506. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53507. private _displayLinesUpdate;
  53508. /** Changes the displayMode of the skeleton viewer
  53509. * @param mode The displayMode numerical value
  53510. */
  53511. changeDisplayMode(mode: number): void;
  53512. /** Sets a display option of the skeleton viewer
  53513. *
  53514. * | Option | Type | Default | Description |
  53515. * | --------------- | ------- | ------- | ----------- |
  53516. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  53517. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  53518. *
  53519. * @param option String of the option name
  53520. * @param value The numerical option value
  53521. */
  53522. changeDisplayOptions(option: string, value: number): void;
  53523. /** Release associated resources */
  53524. dispose(): void;
  53525. }
  53526. }
  53527. declare module "babylonjs/Debug/index" {
  53528. export * from "babylonjs/Debug/axesViewer";
  53529. export * from "babylonjs/Debug/boneAxesViewer";
  53530. export * from "babylonjs/Debug/debugLayer";
  53531. export * from "babylonjs/Debug/physicsViewer";
  53532. export * from "babylonjs/Debug/rayHelper";
  53533. export * from "babylonjs/Debug/skeletonViewer";
  53534. export * from "babylonjs/Debug/ISkeletonViewer";
  53535. }
  53536. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53537. /**
  53538. * Enum for Device Types
  53539. */
  53540. export enum DeviceType {
  53541. /** Generic */
  53542. Generic = 0,
  53543. /** Keyboard */
  53544. Keyboard = 1,
  53545. /** Mouse */
  53546. Mouse = 2,
  53547. /** Touch Pointers */
  53548. Touch = 3,
  53549. /** PS4 Dual Shock */
  53550. DualShock = 4,
  53551. /** Xbox */
  53552. Xbox = 5,
  53553. /** Switch Controller */
  53554. Switch = 6
  53555. }
  53556. /**
  53557. * Enum for All Pointers (Touch/Mouse)
  53558. */
  53559. export enum PointerInput {
  53560. /** Horizontal Axis */
  53561. Horizontal = 0,
  53562. /** Vertical Axis */
  53563. Vertical = 1,
  53564. /** Left Click or Touch */
  53565. LeftClick = 2,
  53566. /** Middle Click */
  53567. MiddleClick = 3,
  53568. /** Right Click */
  53569. RightClick = 4,
  53570. /** Browser Back */
  53571. BrowserBack = 5,
  53572. /** Browser Forward */
  53573. BrowserForward = 6
  53574. }
  53575. /**
  53576. * Enum for Dual Shock Gamepad
  53577. */
  53578. export enum DualShockInput {
  53579. /** Cross */
  53580. Cross = 0,
  53581. /** Circle */
  53582. Circle = 1,
  53583. /** Square */
  53584. Square = 2,
  53585. /** Triangle */
  53586. Triangle = 3,
  53587. /** L1 */
  53588. L1 = 4,
  53589. /** R1 */
  53590. R1 = 5,
  53591. /** L2 */
  53592. L2 = 6,
  53593. /** R2 */
  53594. R2 = 7,
  53595. /** Share */
  53596. Share = 8,
  53597. /** Options */
  53598. Options = 9,
  53599. /** L3 */
  53600. L3 = 10,
  53601. /** R3 */
  53602. R3 = 11,
  53603. /** DPadUp */
  53604. DPadUp = 12,
  53605. /** DPadDown */
  53606. DPadDown = 13,
  53607. /** DPadLeft */
  53608. DPadLeft = 14,
  53609. /** DRight */
  53610. DPadRight = 15,
  53611. /** Home */
  53612. Home = 16,
  53613. /** TouchPad */
  53614. TouchPad = 17,
  53615. /** LStickXAxis */
  53616. LStickXAxis = 18,
  53617. /** LStickYAxis */
  53618. LStickYAxis = 19,
  53619. /** RStickXAxis */
  53620. RStickXAxis = 20,
  53621. /** RStickYAxis */
  53622. RStickYAxis = 21
  53623. }
  53624. /**
  53625. * Enum for Xbox Gamepad
  53626. */
  53627. export enum XboxInput {
  53628. /** A */
  53629. A = 0,
  53630. /** B */
  53631. B = 1,
  53632. /** X */
  53633. X = 2,
  53634. /** Y */
  53635. Y = 3,
  53636. /** LB */
  53637. LB = 4,
  53638. /** RB */
  53639. RB = 5,
  53640. /** LT */
  53641. LT = 6,
  53642. /** RT */
  53643. RT = 7,
  53644. /** Back */
  53645. Back = 8,
  53646. /** Start */
  53647. Start = 9,
  53648. /** LS */
  53649. LS = 10,
  53650. /** RS */
  53651. RS = 11,
  53652. /** DPadUp */
  53653. DPadUp = 12,
  53654. /** DPadDown */
  53655. DPadDown = 13,
  53656. /** DPadLeft */
  53657. DPadLeft = 14,
  53658. /** DRight */
  53659. DPadRight = 15,
  53660. /** Home */
  53661. Home = 16,
  53662. /** LStickXAxis */
  53663. LStickXAxis = 17,
  53664. /** LStickYAxis */
  53665. LStickYAxis = 18,
  53666. /** RStickXAxis */
  53667. RStickXAxis = 19,
  53668. /** RStickYAxis */
  53669. RStickYAxis = 20
  53670. }
  53671. /**
  53672. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53673. */
  53674. export enum SwitchInput {
  53675. /** B */
  53676. B = 0,
  53677. /** A */
  53678. A = 1,
  53679. /** Y */
  53680. Y = 2,
  53681. /** X */
  53682. X = 3,
  53683. /** L */
  53684. L = 4,
  53685. /** R */
  53686. R = 5,
  53687. /** ZL */
  53688. ZL = 6,
  53689. /** ZR */
  53690. ZR = 7,
  53691. /** Minus */
  53692. Minus = 8,
  53693. /** Plus */
  53694. Plus = 9,
  53695. /** LS */
  53696. LS = 10,
  53697. /** RS */
  53698. RS = 11,
  53699. /** DPadUp */
  53700. DPadUp = 12,
  53701. /** DPadDown */
  53702. DPadDown = 13,
  53703. /** DPadLeft */
  53704. DPadLeft = 14,
  53705. /** DRight */
  53706. DPadRight = 15,
  53707. /** Home */
  53708. Home = 16,
  53709. /** Capture */
  53710. Capture = 17,
  53711. /** LStickXAxis */
  53712. LStickXAxis = 18,
  53713. /** LStickYAxis */
  53714. LStickYAxis = 19,
  53715. /** RStickXAxis */
  53716. RStickXAxis = 20,
  53717. /** RStickYAxis */
  53718. RStickYAxis = 21
  53719. }
  53720. }
  53721. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53722. import { Engine } from "babylonjs/Engines/engine";
  53723. import { IDisposable } from "babylonjs/scene";
  53724. import { Nullable } from "babylonjs/types";
  53725. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53726. /**
  53727. * This class will take all inputs from Keyboard, Pointer, and
  53728. * any Gamepads and provide a polling system that all devices
  53729. * will use. This class assumes that there will only be one
  53730. * pointer device and one keyboard.
  53731. */
  53732. export class DeviceInputSystem implements IDisposable {
  53733. /**
  53734. * Callback to be triggered when a device is connected
  53735. */
  53736. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53737. /**
  53738. * Callback to be triggered when a device is disconnected
  53739. */
  53740. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53741. /**
  53742. * Callback to be triggered when event driven input is updated
  53743. */
  53744. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53745. private _inputs;
  53746. private _gamepads;
  53747. private _keyboardActive;
  53748. private _pointerActive;
  53749. private _elementToAttachTo;
  53750. private _keyboardDownEvent;
  53751. private _keyboardUpEvent;
  53752. private _pointerMoveEvent;
  53753. private _pointerDownEvent;
  53754. private _pointerUpEvent;
  53755. private _gamepadConnectedEvent;
  53756. private _gamepadDisconnectedEvent;
  53757. private static _MAX_KEYCODES;
  53758. private static _MAX_POINTER_INPUTS;
  53759. private constructor();
  53760. /**
  53761. * Creates a new DeviceInputSystem instance
  53762. * @param engine Engine to pull input element from
  53763. * @returns The new instance
  53764. */
  53765. static Create(engine: Engine): DeviceInputSystem;
  53766. /**
  53767. * Checks for current device input value, given an id and input index
  53768. * @param deviceName Id of connected device
  53769. * @param inputIndex Index of device input
  53770. * @returns Current value of input
  53771. */
  53772. /**
  53773. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53774. * @param deviceType Enum specifiying device type
  53775. * @param deviceSlot "Slot" or index that device is referenced in
  53776. * @param inputIndex Id of input to be checked
  53777. * @returns Current value of input
  53778. */
  53779. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53780. /**
  53781. * Dispose of all the eventlisteners
  53782. */
  53783. dispose(): void;
  53784. /**
  53785. * Add device and inputs to device array
  53786. * @param deviceType Enum specifiying device type
  53787. * @param deviceSlot "Slot" or index that device is referenced in
  53788. * @param numberOfInputs Number of input entries to create for given device
  53789. */
  53790. private _registerDevice;
  53791. /**
  53792. * Given a specific device name, remove that device from the device map
  53793. * @param deviceType Enum specifiying device type
  53794. * @param deviceSlot "Slot" or index that device is referenced in
  53795. */
  53796. private _unregisterDevice;
  53797. /**
  53798. * Handle all actions that come from keyboard interaction
  53799. */
  53800. private _handleKeyActions;
  53801. /**
  53802. * Handle all actions that come from pointer interaction
  53803. */
  53804. private _handlePointerActions;
  53805. /**
  53806. * Handle all actions that come from gamepad interaction
  53807. */
  53808. private _handleGamepadActions;
  53809. /**
  53810. * Update all non-event based devices with each frame
  53811. * @param deviceType Enum specifiying device type
  53812. * @param deviceSlot "Slot" or index that device is referenced in
  53813. * @param inputIndex Id of input to be checked
  53814. */
  53815. private _updateDevice;
  53816. /**
  53817. * Gets DeviceType from the device name
  53818. * @param deviceName Name of Device from DeviceInputSystem
  53819. * @returns DeviceType enum value
  53820. */
  53821. private _getGamepadDeviceType;
  53822. }
  53823. }
  53824. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53825. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53826. /**
  53827. * Type to handle enforcement of inputs
  53828. */
  53829. 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;
  53830. }
  53831. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53832. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53833. import { Engine } from "babylonjs/Engines/engine";
  53834. import { IDisposable } from "babylonjs/scene";
  53835. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53836. import { Nullable } from "babylonjs/types";
  53837. import { Observable } from "babylonjs/Misc/observable";
  53838. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53839. /**
  53840. * Class that handles all input for a specific device
  53841. */
  53842. export class DeviceSource<T extends DeviceType> {
  53843. /** Type of device */
  53844. readonly deviceType: DeviceType;
  53845. /** "Slot" or index that device is referenced in */
  53846. readonly deviceSlot: number;
  53847. /**
  53848. * Observable to handle device input changes per device
  53849. */
  53850. readonly onInputChangedObservable: Observable<{
  53851. inputIndex: DeviceInput<T>;
  53852. previousState: Nullable<number>;
  53853. currentState: Nullable<number>;
  53854. }>;
  53855. private readonly _deviceInputSystem;
  53856. /**
  53857. * Default Constructor
  53858. * @param deviceInputSystem Reference to DeviceInputSystem
  53859. * @param deviceType Type of device
  53860. * @param deviceSlot "Slot" or index that device is referenced in
  53861. */
  53862. constructor(deviceInputSystem: DeviceInputSystem,
  53863. /** Type of device */
  53864. deviceType: DeviceType,
  53865. /** "Slot" or index that device is referenced in */
  53866. deviceSlot?: number);
  53867. /**
  53868. * Get input for specific input
  53869. * @param inputIndex index of specific input on device
  53870. * @returns Input value from DeviceInputSystem
  53871. */
  53872. getInput(inputIndex: DeviceInput<T>): number;
  53873. }
  53874. /**
  53875. * Class to keep track of devices
  53876. */
  53877. export class DeviceSourceManager implements IDisposable {
  53878. /**
  53879. * Observable to be triggered when before a device is connected
  53880. */
  53881. readonly onBeforeDeviceConnectedObservable: Observable<{
  53882. deviceType: DeviceType;
  53883. deviceSlot: number;
  53884. }>;
  53885. /**
  53886. * Observable to be triggered when before a device is disconnected
  53887. */
  53888. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53889. deviceType: DeviceType;
  53890. deviceSlot: number;
  53891. }>;
  53892. /**
  53893. * Observable to be triggered when after a device is connected
  53894. */
  53895. readonly onAfterDeviceConnectedObservable: Observable<{
  53896. deviceType: DeviceType;
  53897. deviceSlot: number;
  53898. }>;
  53899. /**
  53900. * Observable to be triggered when after a device is disconnected
  53901. */
  53902. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53903. deviceType: DeviceType;
  53904. deviceSlot: number;
  53905. }>;
  53906. private readonly _devices;
  53907. private readonly _firstDevice;
  53908. private readonly _deviceInputSystem;
  53909. /**
  53910. * Default Constructor
  53911. * @param engine engine to pull input element from
  53912. */
  53913. constructor(engine: Engine);
  53914. /**
  53915. * Gets a DeviceSource, given a type and slot
  53916. * @param deviceType Enum specifying device type
  53917. * @param deviceSlot "Slot" or index that device is referenced in
  53918. * @returns DeviceSource object
  53919. */
  53920. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53921. /**
  53922. * Gets an array of DeviceSource objects for a given device type
  53923. * @param deviceType Enum specifying device type
  53924. * @returns Array of DeviceSource objects
  53925. */
  53926. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53927. /**
  53928. * Dispose of DeviceInputSystem and other parts
  53929. */
  53930. dispose(): void;
  53931. /**
  53932. * Function to add device name to device list
  53933. * @param deviceType Enum specifying device type
  53934. * @param deviceSlot "Slot" or index that device is referenced in
  53935. */
  53936. private _addDevice;
  53937. /**
  53938. * Function to remove device name to device list
  53939. * @param deviceType Enum specifying device type
  53940. * @param deviceSlot "Slot" or index that device is referenced in
  53941. */
  53942. private _removeDevice;
  53943. /**
  53944. * Updates array storing first connected device of each type
  53945. * @param type Type of Device
  53946. */
  53947. private _updateFirstDevices;
  53948. }
  53949. }
  53950. declare module "babylonjs/DeviceInput/index" {
  53951. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53952. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53953. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53954. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53955. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53956. }
  53957. declare module "babylonjs/Engines/nullEngine" {
  53958. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53959. import { Engine } from "babylonjs/Engines/engine";
  53960. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53961. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53962. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53963. import { Effect } from "babylonjs/Materials/effect";
  53964. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53965. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53966. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53967. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53968. /**
  53969. * Options to create the null engine
  53970. */
  53971. export class NullEngineOptions {
  53972. /**
  53973. * Render width (Default: 512)
  53974. */
  53975. renderWidth: number;
  53976. /**
  53977. * Render height (Default: 256)
  53978. */
  53979. renderHeight: number;
  53980. /**
  53981. * Texture size (Default: 512)
  53982. */
  53983. textureSize: number;
  53984. /**
  53985. * If delta time between frames should be constant
  53986. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53987. */
  53988. deterministicLockstep: boolean;
  53989. /**
  53990. * Maximum about of steps between frames (Default: 4)
  53991. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53992. */
  53993. lockstepMaxSteps: number;
  53994. /**
  53995. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53996. */
  53997. useHighPrecisionMatrix?: boolean;
  53998. }
  53999. /**
  54000. * The null engine class provides support for headless version of babylon.js.
  54001. * This can be used in server side scenario or for testing purposes
  54002. */
  54003. export class NullEngine extends Engine {
  54004. private _options;
  54005. /**
  54006. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  54007. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  54008. * @returns true if engine is in deterministic lock step mode
  54009. */
  54010. isDeterministicLockStep(): boolean;
  54011. /**
  54012. * Gets the max steps when engine is running in deterministic lock step
  54013. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  54014. * @returns the max steps
  54015. */
  54016. getLockstepMaxSteps(): number;
  54017. /**
  54018. * Gets the current hardware scaling level.
  54019. * By default the hardware scaling level is computed from the window device ratio.
  54020. * 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.
  54021. * @returns a number indicating the current hardware scaling level
  54022. */
  54023. getHardwareScalingLevel(): number;
  54024. constructor(options?: NullEngineOptions);
  54025. /**
  54026. * Creates a vertex buffer
  54027. * @param vertices the data for the vertex buffer
  54028. * @returns the new WebGL static buffer
  54029. */
  54030. createVertexBuffer(vertices: FloatArray): DataBuffer;
  54031. /**
  54032. * Creates a new index buffer
  54033. * @param indices defines the content of the index buffer
  54034. * @param updatable defines if the index buffer must be updatable
  54035. * @returns a new webGL buffer
  54036. */
  54037. createIndexBuffer(indices: IndicesArray): DataBuffer;
  54038. /**
  54039. * Clear the current render buffer or the current render target (if any is set up)
  54040. * @param color defines the color to use
  54041. * @param backBuffer defines if the back buffer must be cleared
  54042. * @param depth defines if the depth buffer must be cleared
  54043. * @param stencil defines if the stencil buffer must be cleared
  54044. */
  54045. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54046. /**
  54047. * Gets the current render width
  54048. * @param useScreen defines if screen size must be used (or the current render target if any)
  54049. * @returns a number defining the current render width
  54050. */
  54051. getRenderWidth(useScreen?: boolean): number;
  54052. /**
  54053. * Gets the current render height
  54054. * @param useScreen defines if screen size must be used (or the current render target if any)
  54055. * @returns a number defining the current render height
  54056. */
  54057. getRenderHeight(useScreen?: boolean): number;
  54058. /**
  54059. * Set the WebGL's viewport
  54060. * @param viewport defines the viewport element to be used
  54061. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  54062. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  54063. */
  54064. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  54065. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  54066. /**
  54067. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  54068. * @param pipelineContext defines the pipeline context to use
  54069. * @param uniformsNames defines the list of uniform names
  54070. * @returns an array of webGL uniform locations
  54071. */
  54072. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  54073. /**
  54074. * Gets the lsit of active attributes for a given webGL program
  54075. * @param pipelineContext defines the pipeline context to use
  54076. * @param attributesNames defines the list of attribute names to get
  54077. * @returns an array of indices indicating the offset of each attribute
  54078. */
  54079. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54080. /**
  54081. * Binds an effect to the webGL context
  54082. * @param effect defines the effect to bind
  54083. */
  54084. bindSamplers(effect: Effect): void;
  54085. /**
  54086. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  54087. * @param effect defines the effect to activate
  54088. */
  54089. enableEffect(effect: Effect): void;
  54090. /**
  54091. * Set various states to the webGL context
  54092. * @param culling defines backface culling state
  54093. * @param zOffset defines the value to apply to zOffset (0 by default)
  54094. * @param force defines if states must be applied even if cache is up to date
  54095. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  54096. */
  54097. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54098. /**
  54099. * Set the value of an uniform to an array of int32
  54100. * @param uniform defines the webGL uniform location where to store the value
  54101. * @param array defines the array of int32 to store
  54102. * @returns true if value was set
  54103. */
  54104. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54105. /**
  54106. * Set the value of an uniform to an array of int32 (stored as vec2)
  54107. * @param uniform defines the webGL uniform location where to store the value
  54108. * @param array defines the array of int32 to store
  54109. * @returns true if value was set
  54110. */
  54111. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54112. /**
  54113. * Set the value of an uniform to an array of int32 (stored as vec3)
  54114. * @param uniform defines the webGL uniform location where to store the value
  54115. * @param array defines the array of int32 to store
  54116. * @returns true if value was set
  54117. */
  54118. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54119. /**
  54120. * Set the value of an uniform to an array of int32 (stored as vec4)
  54121. * @param uniform defines the webGL uniform location where to store the value
  54122. * @param array defines the array of int32 to store
  54123. * @returns true if value was set
  54124. */
  54125. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54126. /**
  54127. * Set the value of an uniform to an array of float32
  54128. * @param uniform defines the webGL uniform location where to store the value
  54129. * @param array defines the array of float32 to store
  54130. * @returns true if value was set
  54131. */
  54132. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54133. /**
  54134. * Set the value of an uniform to an array of float32 (stored as vec2)
  54135. * @param uniform defines the webGL uniform location where to store the value
  54136. * @param array defines the array of float32 to store
  54137. * @returns true if value was set
  54138. */
  54139. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54140. /**
  54141. * Set the value of an uniform to an array of float32 (stored as vec3)
  54142. * @param uniform defines the webGL uniform location where to store the value
  54143. * @param array defines the array of float32 to store
  54144. * @returns true if value was set
  54145. */
  54146. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54147. /**
  54148. * Set the value of an uniform to an array of float32 (stored as vec4)
  54149. * @param uniform defines the webGL uniform location where to store the value
  54150. * @param array defines the array of float32 to store
  54151. * @returns true if value was set
  54152. */
  54153. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54154. /**
  54155. * Set the value of an uniform to an array of number
  54156. * @param uniform defines the webGL uniform location where to store the value
  54157. * @param array defines the array of number to store
  54158. * @returns true if value was set
  54159. */
  54160. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  54161. /**
  54162. * Set the value of an uniform to an array of number (stored as vec2)
  54163. * @param uniform defines the webGL uniform location where to store the value
  54164. * @param array defines the array of number to store
  54165. * @returns true if value was set
  54166. */
  54167. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  54168. /**
  54169. * Set the value of an uniform to an array of number (stored as vec3)
  54170. * @param uniform defines the webGL uniform location where to store the value
  54171. * @param array defines the array of number to store
  54172. * @returns true if value was set
  54173. */
  54174. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  54175. /**
  54176. * Set the value of an uniform to an array of number (stored as vec4)
  54177. * @param uniform defines the webGL uniform location where to store the value
  54178. * @param array defines the array of number to store
  54179. * @returns true if value was set
  54180. */
  54181. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  54182. /**
  54183. * Set the value of an uniform to an array of float32 (stored as matrices)
  54184. * @param uniform defines the webGL uniform location where to store the value
  54185. * @param matrices defines the array of float32 to store
  54186. * @returns true if value was set
  54187. */
  54188. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  54189. /**
  54190. * Set the value of an uniform to a matrix (3x3)
  54191. * @param uniform defines the webGL uniform location where to store the value
  54192. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  54193. * @returns true if value was set
  54194. */
  54195. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  54196. /**
  54197. * Set the value of an uniform to a matrix (2x2)
  54198. * @param uniform defines the webGL uniform location where to store the value
  54199. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  54200. * @returns true if value was set
  54201. */
  54202. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  54203. /**
  54204. * Set the value of an uniform to a number (float)
  54205. * @param uniform defines the webGL uniform location where to store the value
  54206. * @param value defines the float number to store
  54207. * @returns true if value was set
  54208. */
  54209. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  54210. /**
  54211. * Set the value of an uniform to a vec2
  54212. * @param uniform defines the webGL uniform location where to store the value
  54213. * @param x defines the 1st component of the value
  54214. * @param y defines the 2nd component of the value
  54215. * @returns true if value was set
  54216. */
  54217. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  54218. /**
  54219. * Set the value of an uniform to a vec3
  54220. * @param uniform defines the webGL uniform location where to store the value
  54221. * @param x defines the 1st component of the value
  54222. * @param y defines the 2nd component of the value
  54223. * @param z defines the 3rd component of the value
  54224. * @returns true if value was set
  54225. */
  54226. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  54227. /**
  54228. * Set the value of an uniform to a boolean
  54229. * @param uniform defines the webGL uniform location where to store the value
  54230. * @param bool defines the boolean to store
  54231. * @returns true if value was set
  54232. */
  54233. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  54234. /**
  54235. * Set the value of an uniform to a vec4
  54236. * @param uniform defines the webGL uniform location where to store the value
  54237. * @param x defines the 1st component of the value
  54238. * @param y defines the 2nd component of the value
  54239. * @param z defines the 3rd component of the value
  54240. * @param w defines the 4th component of the value
  54241. * @returns true if value was set
  54242. */
  54243. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  54244. /**
  54245. * Sets the current alpha mode
  54246. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  54247. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54248. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54249. */
  54250. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54251. /**
  54252. * Bind webGl buffers directly to the webGL context
  54253. * @param vertexBuffers defines the vertex buffer to bind
  54254. * @param indexBuffer defines the index buffer to bind
  54255. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54256. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54257. * @param effect defines the effect associated with the vertex buffer
  54258. */
  54259. bindBuffers(vertexBuffers: {
  54260. [key: string]: VertexBuffer;
  54261. }, indexBuffer: DataBuffer, effect: Effect): void;
  54262. /**
  54263. * Force the entire cache to be cleared
  54264. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54265. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54266. */
  54267. wipeCaches(bruteForce?: boolean): void;
  54268. /**
  54269. * Send a draw order
  54270. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54271. * @param indexStart defines the starting index
  54272. * @param indexCount defines the number of index to draw
  54273. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54274. */
  54275. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54276. /**
  54277. * Draw a list of indexed primitives
  54278. * @param fillMode defines the primitive to use
  54279. * @param indexStart defines the starting index
  54280. * @param indexCount defines the number of index to draw
  54281. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54282. */
  54283. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54284. /**
  54285. * Draw a list of unindexed primitives
  54286. * @param fillMode defines the primitive to use
  54287. * @param verticesStart defines the index of first vertex to draw
  54288. * @param verticesCount defines the count of vertices to draw
  54289. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54290. */
  54291. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54292. /** @hidden */
  54293. _createTexture(): WebGLTexture;
  54294. /** @hidden */
  54295. _releaseTexture(texture: InternalTexture): void;
  54296. /**
  54297. * Usually called from Texture.ts.
  54298. * Passed information to create a WebGLTexture
  54299. * @param urlArg defines a value which contains one of the following:
  54300. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54301. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54302. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54303. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54304. * @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)
  54305. * @param scene needed for loading to the correct scene
  54306. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54307. * @param onLoad optional callback to be called upon successful completion
  54308. * @param onError optional callback to be called upon failure
  54309. * @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
  54310. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54311. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54312. * @param forcedExtension defines the extension to use to pick the right loader
  54313. * @param mimeType defines an optional mime type
  54314. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54315. */
  54316. 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;
  54317. /**
  54318. * Creates a new render target texture
  54319. * @param size defines the size of the texture
  54320. * @param options defines the options used to create the texture
  54321. * @returns a new render target texture stored in an InternalTexture
  54322. */
  54323. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54324. /**
  54325. * Update the sampling mode of a given texture
  54326. * @param samplingMode defines the required sampling mode
  54327. * @param texture defines the texture to update
  54328. */
  54329. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54330. /**
  54331. * Binds the frame buffer to the specified texture.
  54332. * @param texture The texture to render to or null for the default canvas
  54333. * @param faceIndex The face of the texture to render to in case of cube texture
  54334. * @param requiredWidth The width of the target to render to
  54335. * @param requiredHeight The height of the target to render to
  54336. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54337. * @param lodLevel defines le lod level to bind to the frame buffer
  54338. */
  54339. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54340. /**
  54341. * Unbind the current render target texture from the webGL context
  54342. * @param texture defines the render target texture to unbind
  54343. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54344. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54345. */
  54346. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54347. /**
  54348. * Creates a dynamic vertex buffer
  54349. * @param vertices the data for the dynamic vertex buffer
  54350. * @returns the new WebGL dynamic buffer
  54351. */
  54352. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54353. /**
  54354. * Update the content of a dynamic texture
  54355. * @param texture defines the texture to update
  54356. * @param canvas defines the canvas containing the source
  54357. * @param invertY defines if data must be stored with Y axis inverted
  54358. * @param premulAlpha defines if alpha is stored as premultiplied
  54359. * @param format defines the format of the data
  54360. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54361. */
  54362. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54363. /**
  54364. * Gets a boolean indicating if all created effects are ready
  54365. * @returns true if all effects are ready
  54366. */
  54367. areAllEffectsReady(): boolean;
  54368. /**
  54369. * @hidden
  54370. * Get the current error code of the webGL context
  54371. * @returns the error code
  54372. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54373. */
  54374. getError(): number;
  54375. /** @hidden */
  54376. _getUnpackAlignement(): number;
  54377. /** @hidden */
  54378. _unpackFlipY(value: boolean): void;
  54379. /**
  54380. * Update a dynamic index buffer
  54381. * @param indexBuffer defines the target index buffer
  54382. * @param indices defines the data to update
  54383. * @param offset defines the offset in the target index buffer where update should start
  54384. */
  54385. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54386. /**
  54387. * Updates a dynamic vertex buffer.
  54388. * @param vertexBuffer the vertex buffer to update
  54389. * @param vertices the data used to update the vertex buffer
  54390. * @param byteOffset the byte offset of the data (optional)
  54391. * @param byteLength the byte length of the data (optional)
  54392. */
  54393. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54394. /** @hidden */
  54395. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54396. /** @hidden */
  54397. _bindTexture(channel: number, texture: InternalTexture): void;
  54398. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54399. /**
  54400. * 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
  54401. */
  54402. releaseEffects(): void;
  54403. displayLoadingUI(): void;
  54404. hideLoadingUI(): void;
  54405. /** @hidden */
  54406. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54407. /** @hidden */
  54408. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54409. /** @hidden */
  54410. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54411. /** @hidden */
  54412. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54413. }
  54414. }
  54415. declare module "babylonjs/Instrumentation/timeToken" {
  54416. import { Nullable } from "babylonjs/types";
  54417. /**
  54418. * @hidden
  54419. **/
  54420. export class _TimeToken {
  54421. _startTimeQuery: Nullable<WebGLQuery>;
  54422. _endTimeQuery: Nullable<WebGLQuery>;
  54423. _timeElapsedQuery: Nullable<WebGLQuery>;
  54424. _timeElapsedQueryEnded: boolean;
  54425. }
  54426. }
  54427. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54428. import { Nullable, int } from "babylonjs/types";
  54429. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54430. /** @hidden */
  54431. export class _OcclusionDataStorage {
  54432. /** @hidden */
  54433. occlusionInternalRetryCounter: number;
  54434. /** @hidden */
  54435. isOcclusionQueryInProgress: boolean;
  54436. /** @hidden */
  54437. isOccluded: boolean;
  54438. /** @hidden */
  54439. occlusionRetryCount: number;
  54440. /** @hidden */
  54441. occlusionType: number;
  54442. /** @hidden */
  54443. occlusionQueryAlgorithmType: number;
  54444. }
  54445. module "babylonjs/Engines/engine" {
  54446. interface Engine {
  54447. /**
  54448. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54449. * @return the new query
  54450. */
  54451. createQuery(): WebGLQuery;
  54452. /**
  54453. * Delete and release a webGL query
  54454. * @param query defines the query to delete
  54455. * @return the current engine
  54456. */
  54457. deleteQuery(query: WebGLQuery): Engine;
  54458. /**
  54459. * Check if a given query has resolved and got its value
  54460. * @param query defines the query to check
  54461. * @returns true if the query got its value
  54462. */
  54463. isQueryResultAvailable(query: WebGLQuery): boolean;
  54464. /**
  54465. * Gets the value of a given query
  54466. * @param query defines the query to check
  54467. * @returns the value of the query
  54468. */
  54469. getQueryResult(query: WebGLQuery): number;
  54470. /**
  54471. * Initiates an occlusion query
  54472. * @param algorithmType defines the algorithm to use
  54473. * @param query defines the query to use
  54474. * @returns the current engine
  54475. * @see https://doc.babylonjs.com/features/occlusionquery
  54476. */
  54477. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54478. /**
  54479. * Ends an occlusion query
  54480. * @see https://doc.babylonjs.com/features/occlusionquery
  54481. * @param algorithmType defines the algorithm to use
  54482. * @returns the current engine
  54483. */
  54484. endOcclusionQuery(algorithmType: number): Engine;
  54485. /**
  54486. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54487. * Please note that only one query can be issued at a time
  54488. * @returns a time token used to track the time span
  54489. */
  54490. startTimeQuery(): Nullable<_TimeToken>;
  54491. /**
  54492. * Ends a time query
  54493. * @param token defines the token used to measure the time span
  54494. * @returns the time spent (in ns)
  54495. */
  54496. endTimeQuery(token: _TimeToken): int;
  54497. /** @hidden */
  54498. _currentNonTimestampToken: Nullable<_TimeToken>;
  54499. /** @hidden */
  54500. _createTimeQuery(): WebGLQuery;
  54501. /** @hidden */
  54502. _deleteTimeQuery(query: WebGLQuery): void;
  54503. /** @hidden */
  54504. _getGlAlgorithmType(algorithmType: number): number;
  54505. /** @hidden */
  54506. _getTimeQueryResult(query: WebGLQuery): any;
  54507. /** @hidden */
  54508. _getTimeQueryAvailability(query: WebGLQuery): any;
  54509. }
  54510. }
  54511. module "babylonjs/Meshes/abstractMesh" {
  54512. interface AbstractMesh {
  54513. /**
  54514. * Backing filed
  54515. * @hidden
  54516. */
  54517. __occlusionDataStorage: _OcclusionDataStorage;
  54518. /**
  54519. * Access property
  54520. * @hidden
  54521. */
  54522. _occlusionDataStorage: _OcclusionDataStorage;
  54523. /**
  54524. * 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.
  54525. * The default value is -1 which means don't break the query and wait till the result
  54526. * @see https://doc.babylonjs.com/features/occlusionquery
  54527. */
  54528. occlusionRetryCount: number;
  54529. /**
  54530. * 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:
  54531. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54532. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54533. * * 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.
  54534. * @see https://doc.babylonjs.com/features/occlusionquery
  54535. */
  54536. occlusionType: number;
  54537. /**
  54538. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54539. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54540. * * 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.
  54541. * @see https://doc.babylonjs.com/features/occlusionquery
  54542. */
  54543. occlusionQueryAlgorithmType: number;
  54544. /**
  54545. * 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
  54546. * @see https://doc.babylonjs.com/features/occlusionquery
  54547. */
  54548. isOccluded: boolean;
  54549. /**
  54550. * Flag to check the progress status of the query
  54551. * @see https://doc.babylonjs.com/features/occlusionquery
  54552. */
  54553. isOcclusionQueryInProgress: boolean;
  54554. }
  54555. }
  54556. }
  54557. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54558. import { Nullable } from "babylonjs/types";
  54559. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54560. /** @hidden */
  54561. export var _forceTransformFeedbackToBundle: boolean;
  54562. module "babylonjs/Engines/engine" {
  54563. interface Engine {
  54564. /**
  54565. * Creates a webGL transform feedback object
  54566. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54567. * @returns the webGL transform feedback object
  54568. */
  54569. createTransformFeedback(): WebGLTransformFeedback;
  54570. /**
  54571. * Delete a webGL transform feedback object
  54572. * @param value defines the webGL transform feedback object to delete
  54573. */
  54574. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54575. /**
  54576. * Bind a webGL transform feedback object to the webgl context
  54577. * @param value defines the webGL transform feedback object to bind
  54578. */
  54579. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54580. /**
  54581. * Begins a transform feedback operation
  54582. * @param usePoints defines if points or triangles must be used
  54583. */
  54584. beginTransformFeedback(usePoints: boolean): void;
  54585. /**
  54586. * Ends a transform feedback operation
  54587. */
  54588. endTransformFeedback(): void;
  54589. /**
  54590. * Specify the varyings to use with transform feedback
  54591. * @param program defines the associated webGL program
  54592. * @param value defines the list of strings representing the varying names
  54593. */
  54594. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54595. /**
  54596. * Bind a webGL buffer for a transform feedback operation
  54597. * @param value defines the webGL buffer to bind
  54598. */
  54599. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54600. }
  54601. }
  54602. }
  54603. declare module "babylonjs/Engines/Extensions/engine.views" {
  54604. import { Camera } from "babylonjs/Cameras/camera";
  54605. import { Nullable } from "babylonjs/types";
  54606. /**
  54607. * Class used to define an additional view for the engine
  54608. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54609. */
  54610. export class EngineView {
  54611. /** Defines the canvas where to render the view */
  54612. target: HTMLCanvasElement;
  54613. /** Defines an optional camera used to render the view (will use active camera else) */
  54614. camera?: Camera;
  54615. }
  54616. module "babylonjs/Engines/engine" {
  54617. interface Engine {
  54618. /**
  54619. * Gets or sets the HTML element to use for attaching events
  54620. */
  54621. inputElement: Nullable<HTMLElement>;
  54622. /**
  54623. * Gets the current engine view
  54624. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54625. */
  54626. activeView: Nullable<EngineView>;
  54627. /** Gets or sets the list of views */
  54628. views: EngineView[];
  54629. /**
  54630. * Register a new child canvas
  54631. * @param canvas defines the canvas to register
  54632. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54633. * @returns the associated view
  54634. */
  54635. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54636. /**
  54637. * Remove a registered child canvas
  54638. * @param canvas defines the canvas to remove
  54639. * @returns the current engine
  54640. */
  54641. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54642. }
  54643. }
  54644. }
  54645. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54646. import { Nullable } from "babylonjs/types";
  54647. module "babylonjs/Engines/engine" {
  54648. interface Engine {
  54649. /** @hidden */
  54650. _excludedCompressedTextures: string[];
  54651. /** @hidden */
  54652. _textureFormatInUse: string;
  54653. /**
  54654. * Gets the list of texture formats supported
  54655. */
  54656. readonly texturesSupported: Array<string>;
  54657. /**
  54658. * Gets the texture format in use
  54659. */
  54660. readonly textureFormatInUse: Nullable<string>;
  54661. /**
  54662. * Set the compressed texture extensions or file names to skip.
  54663. *
  54664. * @param skippedFiles defines the list of those texture files you want to skip
  54665. * Example: [".dds", ".env", "myfile.png"]
  54666. */
  54667. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54668. /**
  54669. * Set the compressed texture format to use, based on the formats you have, and the formats
  54670. * supported by the hardware / browser.
  54671. *
  54672. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54673. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54674. * to API arguments needed to compressed textures. This puts the burden on the container
  54675. * generator to house the arcane code for determining these for current & future formats.
  54676. *
  54677. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54678. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54679. *
  54680. * Note: The result of this call is not taken into account when a texture is base64.
  54681. *
  54682. * @param formatsAvailable defines the list of those format families you have created
  54683. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54684. *
  54685. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54686. * @returns The extension selected.
  54687. */
  54688. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54689. }
  54690. }
  54691. }
  54692. declare module "babylonjs/Engines/Extensions/index" {
  54693. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54694. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54695. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54696. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54697. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54698. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54699. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54700. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54701. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54702. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54703. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54704. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54705. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54706. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54707. export * from "babylonjs/Engines/Extensions/engine.views";
  54708. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54709. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54710. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54711. }
  54712. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54713. import { Nullable } from "babylonjs/types";
  54714. /**
  54715. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54716. */
  54717. export interface CubeMapInfo {
  54718. /**
  54719. * The pixel array for the front face.
  54720. * This is stored in format, left to right, up to down format.
  54721. */
  54722. front: Nullable<ArrayBufferView>;
  54723. /**
  54724. * The pixel array for the back face.
  54725. * This is stored in format, left to right, up to down format.
  54726. */
  54727. back: Nullable<ArrayBufferView>;
  54728. /**
  54729. * The pixel array for the left face.
  54730. * This is stored in format, left to right, up to down format.
  54731. */
  54732. left: Nullable<ArrayBufferView>;
  54733. /**
  54734. * The pixel array for the right face.
  54735. * This is stored in format, left to right, up to down format.
  54736. */
  54737. right: Nullable<ArrayBufferView>;
  54738. /**
  54739. * The pixel array for the up face.
  54740. * This is stored in format, left to right, up to down format.
  54741. */
  54742. up: Nullable<ArrayBufferView>;
  54743. /**
  54744. * The pixel array for the down face.
  54745. * This is stored in format, left to right, up to down format.
  54746. */
  54747. down: Nullable<ArrayBufferView>;
  54748. /**
  54749. * The size of the cubemap stored.
  54750. *
  54751. * Each faces will be size * size pixels.
  54752. */
  54753. size: number;
  54754. /**
  54755. * The format of the texture.
  54756. *
  54757. * RGBA, RGB.
  54758. */
  54759. format: number;
  54760. /**
  54761. * The type of the texture data.
  54762. *
  54763. * UNSIGNED_INT, FLOAT.
  54764. */
  54765. type: number;
  54766. /**
  54767. * Specifies whether the texture is in gamma space.
  54768. */
  54769. gammaSpace: boolean;
  54770. }
  54771. /**
  54772. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54773. */
  54774. export class PanoramaToCubeMapTools {
  54775. private static FACE_LEFT;
  54776. private static FACE_RIGHT;
  54777. private static FACE_FRONT;
  54778. private static FACE_BACK;
  54779. private static FACE_DOWN;
  54780. private static FACE_UP;
  54781. /**
  54782. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54783. *
  54784. * @param float32Array The source data.
  54785. * @param inputWidth The width of the input panorama.
  54786. * @param inputHeight The height of the input panorama.
  54787. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54788. * @return The cubemap data
  54789. */
  54790. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54791. private static CreateCubemapTexture;
  54792. private static CalcProjectionSpherical;
  54793. }
  54794. }
  54795. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54796. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54797. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54798. import { Nullable } from "babylonjs/types";
  54799. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54800. /**
  54801. * Helper class dealing with the extraction of spherical polynomial dataArray
  54802. * from a cube map.
  54803. */
  54804. export class CubeMapToSphericalPolynomialTools {
  54805. private static FileFaces;
  54806. /**
  54807. * Converts a texture to the according Spherical Polynomial data.
  54808. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54809. *
  54810. * @param texture The texture to extract the information from.
  54811. * @return The Spherical Polynomial data.
  54812. */
  54813. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54814. /**
  54815. * Converts a cubemap to the according Spherical Polynomial data.
  54816. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54817. *
  54818. * @param cubeInfo The Cube map to extract the information from.
  54819. * @return The Spherical Polynomial data.
  54820. */
  54821. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54822. }
  54823. }
  54824. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54825. import { Nullable } from "babylonjs/types";
  54826. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54827. module "babylonjs/Materials/Textures/baseTexture" {
  54828. interface BaseTexture {
  54829. /**
  54830. * Get the polynomial representation of the texture data.
  54831. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54832. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54833. */
  54834. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54835. }
  54836. }
  54837. }
  54838. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54839. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54840. /** @hidden */
  54841. export var rgbdEncodePixelShader: {
  54842. name: string;
  54843. shader: string;
  54844. };
  54845. }
  54846. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54847. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54848. /** @hidden */
  54849. export var rgbdDecodePixelShader: {
  54850. name: string;
  54851. shader: string;
  54852. };
  54853. }
  54854. declare module "babylonjs/Misc/environmentTextureTools" {
  54855. import { Nullable } from "babylonjs/types";
  54856. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54857. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54858. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54859. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54860. import "babylonjs/Engines/Extensions/engine.readTexture";
  54861. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54862. import "babylonjs/Shaders/rgbdEncode.fragment";
  54863. import "babylonjs/Shaders/rgbdDecode.fragment";
  54864. /**
  54865. * Raw texture data and descriptor sufficient for WebGL texture upload
  54866. */
  54867. export interface EnvironmentTextureInfo {
  54868. /**
  54869. * Version of the environment map
  54870. */
  54871. version: number;
  54872. /**
  54873. * Width of image
  54874. */
  54875. width: number;
  54876. /**
  54877. * Irradiance information stored in the file.
  54878. */
  54879. irradiance: any;
  54880. /**
  54881. * Specular information stored in the file.
  54882. */
  54883. specular: any;
  54884. }
  54885. /**
  54886. * Defines One Image in the file. It requires only the position in the file
  54887. * as well as the length.
  54888. */
  54889. interface BufferImageData {
  54890. /**
  54891. * Length of the image data.
  54892. */
  54893. length: number;
  54894. /**
  54895. * Position of the data from the null terminator delimiting the end of the JSON.
  54896. */
  54897. position: number;
  54898. }
  54899. /**
  54900. * Defines the specular data enclosed in the file.
  54901. * This corresponds to the version 1 of the data.
  54902. */
  54903. export interface EnvironmentTextureSpecularInfoV1 {
  54904. /**
  54905. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54906. */
  54907. specularDataPosition?: number;
  54908. /**
  54909. * This contains all the images data needed to reconstruct the cubemap.
  54910. */
  54911. mipmaps: Array<BufferImageData>;
  54912. /**
  54913. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54914. */
  54915. lodGenerationScale: number;
  54916. }
  54917. /**
  54918. * Sets of helpers addressing the serialization and deserialization of environment texture
  54919. * stored in a BabylonJS env file.
  54920. * Those files are usually stored as .env files.
  54921. */
  54922. export class EnvironmentTextureTools {
  54923. /**
  54924. * Magic number identifying the env file.
  54925. */
  54926. private static _MagicBytes;
  54927. /**
  54928. * Gets the environment info from an env file.
  54929. * @param data The array buffer containing the .env bytes.
  54930. * @returns the environment file info (the json header) if successfully parsed.
  54931. */
  54932. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54933. /**
  54934. * Creates an environment texture from a loaded cube texture.
  54935. * @param texture defines the cube texture to convert in env file
  54936. * @return a promise containing the environment data if succesfull.
  54937. */
  54938. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54939. /**
  54940. * Creates a JSON representation of the spherical data.
  54941. * @param texture defines the texture containing the polynomials
  54942. * @return the JSON representation of the spherical info
  54943. */
  54944. private static _CreateEnvTextureIrradiance;
  54945. /**
  54946. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54947. * @param data the image data
  54948. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54949. * @return the views described by info providing access to the underlying buffer
  54950. */
  54951. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54952. /**
  54953. * Uploads the texture info contained in the env file to the GPU.
  54954. * @param texture defines the internal texture to upload to
  54955. * @param data defines the data to load
  54956. * @param info defines the texture info retrieved through the GetEnvInfo method
  54957. * @returns a promise
  54958. */
  54959. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54960. private static _OnImageReadyAsync;
  54961. /**
  54962. * Uploads the levels of image data to the GPU.
  54963. * @param texture defines the internal texture to upload to
  54964. * @param imageData defines the array buffer views of image data [mipmap][face]
  54965. * @returns a promise
  54966. */
  54967. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54968. /**
  54969. * Uploads spherical polynomials information to the texture.
  54970. * @param texture defines the texture we are trying to upload the information to
  54971. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54972. */
  54973. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54974. /** @hidden */
  54975. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54976. }
  54977. }
  54978. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54979. /**
  54980. * Class used to inline functions in shader code
  54981. */
  54982. export class ShaderCodeInliner {
  54983. private static readonly _RegexpFindFunctionNameAndType;
  54984. private _sourceCode;
  54985. private _functionDescr;
  54986. private _numMaxIterations;
  54987. /** Gets or sets the token used to mark the functions to inline */
  54988. inlineToken: string;
  54989. /** Gets or sets the debug mode */
  54990. debug: boolean;
  54991. /** Gets the code after the inlining process */
  54992. get code(): string;
  54993. /**
  54994. * Initializes the inliner
  54995. * @param sourceCode shader code source to inline
  54996. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54997. */
  54998. constructor(sourceCode: string, numMaxIterations?: number);
  54999. /**
  55000. * Start the processing of the shader code
  55001. */
  55002. processCode(): void;
  55003. private _collectFunctions;
  55004. private _processInlining;
  55005. private _extractBetweenMarkers;
  55006. private _skipWhitespaces;
  55007. private _removeComments;
  55008. private _replaceFunctionCallsByCode;
  55009. private _findBackward;
  55010. private _escapeRegExp;
  55011. private _replaceNames;
  55012. }
  55013. }
  55014. declare module "babylonjs/Engines/nativeEngine" {
  55015. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  55016. import { Engine } from "babylonjs/Engines/engine";
  55017. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  55018. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55019. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55020. import { Effect } from "babylonjs/Materials/effect";
  55021. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  55022. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  55023. import { IColor4Like } from "babylonjs/Maths/math.like";
  55024. import { Scene } from "babylonjs/scene";
  55025. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  55026. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  55027. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  55028. /**
  55029. * Container for accessors for natively-stored mesh data buffers.
  55030. */
  55031. class NativeDataBuffer extends DataBuffer {
  55032. /**
  55033. * Accessor value used to identify/retrieve a natively-stored index buffer.
  55034. */
  55035. nativeIndexBuffer?: any;
  55036. /**
  55037. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  55038. */
  55039. nativeVertexBuffer?: any;
  55040. }
  55041. /** @hidden */
  55042. class NativeTexture extends InternalTexture {
  55043. getInternalTexture(): InternalTexture;
  55044. getViewCount(): number;
  55045. }
  55046. /** @hidden */
  55047. export class NativeEngine extends Engine {
  55048. private readonly _native;
  55049. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  55050. private readonly INVALID_HANDLE;
  55051. private _boundBuffersVertexArray;
  55052. getHardwareScalingLevel(): number;
  55053. constructor();
  55054. dispose(): void;
  55055. /**
  55056. * Can be used to override the current requestAnimationFrame requester.
  55057. * @hidden
  55058. */
  55059. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  55060. /**
  55061. * Override default engine behavior.
  55062. * @param color
  55063. * @param backBuffer
  55064. * @param depth
  55065. * @param stencil
  55066. */
  55067. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  55068. /**
  55069. * Gets host document
  55070. * @returns the host document object
  55071. */
  55072. getHostDocument(): Nullable<Document>;
  55073. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  55074. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  55075. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  55076. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  55077. [key: string]: VertexBuffer;
  55078. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  55079. bindBuffers(vertexBuffers: {
  55080. [key: string]: VertexBuffer;
  55081. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  55082. recordVertexArrayObject(vertexBuffers: {
  55083. [key: string]: VertexBuffer;
  55084. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  55085. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  55086. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  55087. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  55088. /**
  55089. * Draw a list of indexed primitives
  55090. * @param fillMode defines the primitive to use
  55091. * @param indexStart defines the starting index
  55092. * @param indexCount defines the number of index to draw
  55093. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  55094. */
  55095. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  55096. /**
  55097. * Draw a list of unindexed primitives
  55098. * @param fillMode defines the primitive to use
  55099. * @param verticesStart defines the index of first vertex to draw
  55100. * @param verticesCount defines the count of vertices to draw
  55101. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  55102. */
  55103. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  55104. createPipelineContext(): IPipelineContext;
  55105. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  55106. /** @hidden */
  55107. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  55108. /** @hidden */
  55109. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  55110. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  55111. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  55112. protected _setProgram(program: WebGLProgram): void;
  55113. _releaseEffect(effect: Effect): void;
  55114. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  55115. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  55116. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  55117. bindSamplers(effect: Effect): void;
  55118. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  55119. getRenderWidth(useScreen?: boolean): number;
  55120. getRenderHeight(useScreen?: boolean): number;
  55121. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  55122. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  55123. /**
  55124. * Set the z offset to apply to current rendering
  55125. * @param value defines the offset to apply
  55126. */
  55127. setZOffset(value: number): void;
  55128. /**
  55129. * Gets the current value of the zOffset
  55130. * @returns the current zOffset state
  55131. */
  55132. getZOffset(): number;
  55133. /**
  55134. * Enable or disable depth buffering
  55135. * @param enable defines the state to set
  55136. */
  55137. setDepthBuffer(enable: boolean): void;
  55138. /**
  55139. * Gets a boolean indicating if depth writing is enabled
  55140. * @returns the current depth writing state
  55141. */
  55142. getDepthWrite(): boolean;
  55143. /**
  55144. * Enable or disable depth writing
  55145. * @param enable defines the state to set
  55146. */
  55147. setDepthWrite(enable: boolean): void;
  55148. /**
  55149. * Enable or disable color writing
  55150. * @param enable defines the state to set
  55151. */
  55152. setColorWrite(enable: boolean): void;
  55153. /**
  55154. * Gets a boolean indicating if color writing is enabled
  55155. * @returns the current color writing state
  55156. */
  55157. getColorWrite(): boolean;
  55158. /**
  55159. * Sets alpha constants used by some alpha blending modes
  55160. * @param r defines the red component
  55161. * @param g defines the green component
  55162. * @param b defines the blue component
  55163. * @param a defines the alpha component
  55164. */
  55165. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  55166. /**
  55167. * Sets the current alpha mode
  55168. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  55169. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  55170. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55171. */
  55172. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  55173. /**
  55174. * Gets the current alpha mode
  55175. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55176. * @returns the current alpha mode
  55177. */
  55178. getAlphaMode(): number;
  55179. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  55180. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55181. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55182. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55183. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55184. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55185. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55186. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55187. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55188. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  55189. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  55190. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  55191. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  55192. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  55193. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  55194. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  55195. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  55196. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  55197. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  55198. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  55199. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  55200. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  55201. wipeCaches(bruteForce?: boolean): void;
  55202. _createTexture(): WebGLTexture;
  55203. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  55204. /**
  55205. * Usually called from Texture.ts.
  55206. * Passed information to create a WebGLTexture
  55207. * @param url defines a value which contains one of the following:
  55208. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  55209. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  55210. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  55211. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  55212. * @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)
  55213. * @param scene needed for loading to the correct scene
  55214. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  55215. * @param onLoad optional callback to be called upon successful completion
  55216. * @param onError optional callback to be called upon failure
  55217. * @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
  55218. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  55219. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  55220. * @param forcedExtension defines the extension to use to pick the right loader
  55221. * @param mimeType defines an optional mime type
  55222. * @returns a InternalTexture for assignment back into BABYLON.Texture
  55223. */
  55224. 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;
  55225. /**
  55226. * Creates a cube texture
  55227. * @param rootUrl defines the url where the files to load is located
  55228. * @param scene defines the current scene
  55229. * @param files defines the list of files to load (1 per face)
  55230. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  55231. * @param onLoad defines an optional callback raised when the texture is loaded
  55232. * @param onError defines an optional callback raised if there is an issue to load the texture
  55233. * @param format defines the format of the data
  55234. * @param forcedExtension defines the extension to use to pick the right loader
  55235. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  55236. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55237. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55238. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  55239. * @returns the cube texture as an InternalTexture
  55240. */
  55241. 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;
  55242. private _getSamplingFilter;
  55243. private static _GetNativeTextureFormat;
  55244. createRenderTargetTexture(size: number | {
  55245. width: number;
  55246. height: number;
  55247. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  55248. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  55249. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  55250. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55251. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55252. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55253. /**
  55254. * Updates a dynamic vertex buffer.
  55255. * @param vertexBuffer the vertex buffer to update
  55256. * @param data the data used to update the vertex buffer
  55257. * @param byteOffset the byte offset of the data (optional)
  55258. * @param byteLength the byte length of the data (optional)
  55259. */
  55260. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55261. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55262. private _updateAnisotropicLevel;
  55263. private _getAddressMode;
  55264. /** @hidden */
  55265. _bindTexture(channel: number, texture: InternalTexture): void;
  55266. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55267. releaseEffects(): void;
  55268. /** @hidden */
  55269. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55270. /** @hidden */
  55271. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55272. /** @hidden */
  55273. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55274. /** @hidden */
  55275. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55276. }
  55277. }
  55278. declare module "babylonjs/Engines/index" {
  55279. export * from "babylonjs/Engines/constants";
  55280. export * from "babylonjs/Engines/engineCapabilities";
  55281. export * from "babylonjs/Engines/instancingAttributeInfo";
  55282. export * from "babylonjs/Engines/thinEngine";
  55283. export * from "babylonjs/Engines/engine";
  55284. export * from "babylonjs/Engines/engineStore";
  55285. export * from "babylonjs/Engines/nullEngine";
  55286. export * from "babylonjs/Engines/Extensions/index";
  55287. export * from "babylonjs/Engines/IPipelineContext";
  55288. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55289. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55290. export * from "babylonjs/Engines/nativeEngine";
  55291. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55292. export * from "babylonjs/Engines/performanceConfigurator";
  55293. }
  55294. declare module "babylonjs/Events/clipboardEvents" {
  55295. /**
  55296. * Gather the list of clipboard event types as constants.
  55297. */
  55298. export class ClipboardEventTypes {
  55299. /**
  55300. * The clipboard event is fired when a copy command is active (pressed).
  55301. */
  55302. static readonly COPY: number;
  55303. /**
  55304. * The clipboard event is fired when a cut command is active (pressed).
  55305. */
  55306. static readonly CUT: number;
  55307. /**
  55308. * The clipboard event is fired when a paste command is active (pressed).
  55309. */
  55310. static readonly PASTE: number;
  55311. }
  55312. /**
  55313. * This class is used to store clipboard related info for the onClipboardObservable event.
  55314. */
  55315. export class ClipboardInfo {
  55316. /**
  55317. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55318. */
  55319. type: number;
  55320. /**
  55321. * Defines the related dom event
  55322. */
  55323. event: ClipboardEvent;
  55324. /**
  55325. *Creates an instance of ClipboardInfo.
  55326. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55327. * @param event Defines the related dom event
  55328. */
  55329. constructor(
  55330. /**
  55331. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55332. */
  55333. type: number,
  55334. /**
  55335. * Defines the related dom event
  55336. */
  55337. event: ClipboardEvent);
  55338. /**
  55339. * Get the clipboard event's type from the keycode.
  55340. * @param keyCode Defines the keyCode for the current keyboard event.
  55341. * @return {number}
  55342. */
  55343. static GetTypeFromCharacter(keyCode: number): number;
  55344. }
  55345. }
  55346. declare module "babylonjs/Events/index" {
  55347. export * from "babylonjs/Events/keyboardEvents";
  55348. export * from "babylonjs/Events/pointerEvents";
  55349. export * from "babylonjs/Events/clipboardEvents";
  55350. }
  55351. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55352. import { Scene } from "babylonjs/scene";
  55353. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55354. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55355. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55356. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55357. /**
  55358. * Google Daydream controller
  55359. */
  55360. export class DaydreamController extends WebVRController {
  55361. /**
  55362. * Base Url for the controller model.
  55363. */
  55364. static MODEL_BASE_URL: string;
  55365. /**
  55366. * File name for the controller model.
  55367. */
  55368. static MODEL_FILENAME: string;
  55369. /**
  55370. * Gamepad Id prefix used to identify Daydream Controller.
  55371. */
  55372. static readonly GAMEPAD_ID_PREFIX: string;
  55373. /**
  55374. * Creates a new DaydreamController from a gamepad
  55375. * @param vrGamepad the gamepad that the controller should be created from
  55376. */
  55377. constructor(vrGamepad: any);
  55378. /**
  55379. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55380. * @param scene scene in which to add meshes
  55381. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55382. */
  55383. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55384. /**
  55385. * Called once for each button that changed state since the last frame
  55386. * @param buttonIdx Which button index changed
  55387. * @param state New state of the button
  55388. * @param changes Which properties on the state changed since last frame
  55389. */
  55390. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55391. }
  55392. }
  55393. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55394. import { Scene } from "babylonjs/scene";
  55395. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55396. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55397. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55398. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55399. /**
  55400. * Gear VR Controller
  55401. */
  55402. export class GearVRController extends WebVRController {
  55403. /**
  55404. * Base Url for the controller model.
  55405. */
  55406. static MODEL_BASE_URL: string;
  55407. /**
  55408. * File name for the controller model.
  55409. */
  55410. static MODEL_FILENAME: string;
  55411. /**
  55412. * Gamepad Id prefix used to identify this controller.
  55413. */
  55414. static readonly GAMEPAD_ID_PREFIX: string;
  55415. private readonly _buttonIndexToObservableNameMap;
  55416. /**
  55417. * Creates a new GearVRController from a gamepad
  55418. * @param vrGamepad the gamepad that the controller should be created from
  55419. */
  55420. constructor(vrGamepad: any);
  55421. /**
  55422. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55423. * @param scene scene in which to add meshes
  55424. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55425. */
  55426. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55427. /**
  55428. * Called once for each button that changed state since the last frame
  55429. * @param buttonIdx Which button index changed
  55430. * @param state New state of the button
  55431. * @param changes Which properties on the state changed since last frame
  55432. */
  55433. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55434. }
  55435. }
  55436. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55437. import { Scene } from "babylonjs/scene";
  55438. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55439. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55440. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55441. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55442. /**
  55443. * Generic Controller
  55444. */
  55445. export class GenericController extends WebVRController {
  55446. /**
  55447. * Base Url for the controller model.
  55448. */
  55449. static readonly MODEL_BASE_URL: string;
  55450. /**
  55451. * File name for the controller model.
  55452. */
  55453. static readonly MODEL_FILENAME: string;
  55454. /**
  55455. * Creates a new GenericController from a gamepad
  55456. * @param vrGamepad the gamepad that the controller should be created from
  55457. */
  55458. constructor(vrGamepad: any);
  55459. /**
  55460. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55461. * @param scene scene in which to add meshes
  55462. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55463. */
  55464. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55465. /**
  55466. * Called once for each button that changed state since the last frame
  55467. * @param buttonIdx Which button index changed
  55468. * @param state New state of the button
  55469. * @param changes Which properties on the state changed since last frame
  55470. */
  55471. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55472. }
  55473. }
  55474. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55475. import { Observable } from "babylonjs/Misc/observable";
  55476. import { Scene } from "babylonjs/scene";
  55477. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55478. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55479. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55480. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55481. /**
  55482. * Oculus Touch Controller
  55483. */
  55484. export class OculusTouchController extends WebVRController {
  55485. /**
  55486. * Base Url for the controller model.
  55487. */
  55488. static MODEL_BASE_URL: string;
  55489. /**
  55490. * File name for the left controller model.
  55491. */
  55492. static MODEL_LEFT_FILENAME: string;
  55493. /**
  55494. * File name for the right controller model.
  55495. */
  55496. static MODEL_RIGHT_FILENAME: string;
  55497. /**
  55498. * Base Url for the Quest controller model.
  55499. */
  55500. static QUEST_MODEL_BASE_URL: string;
  55501. /**
  55502. * @hidden
  55503. * If the controllers are running on a device that needs the updated Quest controller models
  55504. */
  55505. static _IsQuest: boolean;
  55506. /**
  55507. * Fired when the secondary trigger on this controller is modified
  55508. */
  55509. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55510. /**
  55511. * Fired when the thumb rest on this controller is modified
  55512. */
  55513. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55514. /**
  55515. * Creates a new OculusTouchController from a gamepad
  55516. * @param vrGamepad the gamepad that the controller should be created from
  55517. */
  55518. constructor(vrGamepad: any);
  55519. /**
  55520. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55521. * @param scene scene in which to add meshes
  55522. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55523. */
  55524. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55525. /**
  55526. * Fired when the A button on this controller is modified
  55527. */
  55528. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55529. /**
  55530. * Fired when the B button on this controller is modified
  55531. */
  55532. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55533. /**
  55534. * Fired when the X button on this controller is modified
  55535. */
  55536. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55537. /**
  55538. * Fired when the Y button on this controller is modified
  55539. */
  55540. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55541. /**
  55542. * Called once for each button that changed state since the last frame
  55543. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55544. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55545. * 2) secondary trigger (same)
  55546. * 3) A (right) X (left), touch, pressed = value
  55547. * 4) B / Y
  55548. * 5) thumb rest
  55549. * @param buttonIdx Which button index changed
  55550. * @param state New state of the button
  55551. * @param changes Which properties on the state changed since last frame
  55552. */
  55553. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55554. }
  55555. }
  55556. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55557. import { Scene } from "babylonjs/scene";
  55558. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55559. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55560. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55561. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55562. import { Observable } from "babylonjs/Misc/observable";
  55563. /**
  55564. * Vive Controller
  55565. */
  55566. export class ViveController extends WebVRController {
  55567. /**
  55568. * Base Url for the controller model.
  55569. */
  55570. static MODEL_BASE_URL: string;
  55571. /**
  55572. * File name for the controller model.
  55573. */
  55574. static MODEL_FILENAME: string;
  55575. /**
  55576. * Creates a new ViveController from a gamepad
  55577. * @param vrGamepad the gamepad that the controller should be created from
  55578. */
  55579. constructor(vrGamepad: any);
  55580. /**
  55581. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55582. * @param scene scene in which to add meshes
  55583. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55584. */
  55585. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55586. /**
  55587. * Fired when the left button on this controller is modified
  55588. */
  55589. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55590. /**
  55591. * Fired when the right button on this controller is modified
  55592. */
  55593. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55594. /**
  55595. * Fired when the menu button on this controller is modified
  55596. */
  55597. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55598. /**
  55599. * Called once for each button that changed state since the last frame
  55600. * Vive mapping:
  55601. * 0: touchpad
  55602. * 1: trigger
  55603. * 2: left AND right buttons
  55604. * 3: menu button
  55605. * @param buttonIdx Which button index changed
  55606. * @param state New state of the button
  55607. * @param changes Which properties on the state changed since last frame
  55608. */
  55609. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55610. }
  55611. }
  55612. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55613. import { Observable } from "babylonjs/Misc/observable";
  55614. import { Scene } from "babylonjs/scene";
  55615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55616. import { Ray } from "babylonjs/Culling/ray";
  55617. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55618. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55619. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55620. /**
  55621. * Defines the WindowsMotionController object that the state of the windows motion controller
  55622. */
  55623. export class WindowsMotionController extends WebVRController {
  55624. /**
  55625. * The base url used to load the left and right controller models
  55626. */
  55627. static MODEL_BASE_URL: string;
  55628. /**
  55629. * The name of the left controller model file
  55630. */
  55631. static MODEL_LEFT_FILENAME: string;
  55632. /**
  55633. * The name of the right controller model file
  55634. */
  55635. static MODEL_RIGHT_FILENAME: string;
  55636. /**
  55637. * The controller name prefix for this controller type
  55638. */
  55639. static readonly GAMEPAD_ID_PREFIX: string;
  55640. /**
  55641. * The controller id pattern for this controller type
  55642. */
  55643. private static readonly GAMEPAD_ID_PATTERN;
  55644. private _loadedMeshInfo;
  55645. protected readonly _mapping: {
  55646. buttons: string[];
  55647. buttonMeshNames: {
  55648. trigger: string;
  55649. menu: string;
  55650. grip: string;
  55651. thumbstick: string;
  55652. trackpad: string;
  55653. };
  55654. buttonObservableNames: {
  55655. trigger: string;
  55656. menu: string;
  55657. grip: string;
  55658. thumbstick: string;
  55659. trackpad: string;
  55660. };
  55661. axisMeshNames: string[];
  55662. pointingPoseMeshName: string;
  55663. };
  55664. /**
  55665. * Fired when the trackpad on this controller is clicked
  55666. */
  55667. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55668. /**
  55669. * Fired when the trackpad on this controller is modified
  55670. */
  55671. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55672. /**
  55673. * The current x and y values of this controller's trackpad
  55674. */
  55675. trackpad: StickValues;
  55676. /**
  55677. * Creates a new WindowsMotionController from a gamepad
  55678. * @param vrGamepad the gamepad that the controller should be created from
  55679. */
  55680. constructor(vrGamepad: any);
  55681. /**
  55682. * Fired when the trigger on this controller is modified
  55683. */
  55684. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55685. /**
  55686. * Fired when the menu button on this controller is modified
  55687. */
  55688. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55689. /**
  55690. * Fired when the grip button on this controller is modified
  55691. */
  55692. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55693. /**
  55694. * Fired when the thumbstick button on this controller is modified
  55695. */
  55696. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55697. /**
  55698. * Fired when the touchpad button on this controller is modified
  55699. */
  55700. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55701. /**
  55702. * Fired when the touchpad values on this controller are modified
  55703. */
  55704. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55705. protected _updateTrackpad(): void;
  55706. /**
  55707. * Called once per frame by the engine.
  55708. */
  55709. update(): void;
  55710. /**
  55711. * Called once for each button that changed state since the last frame
  55712. * @param buttonIdx Which button index changed
  55713. * @param state New state of the button
  55714. * @param changes Which properties on the state changed since last frame
  55715. */
  55716. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55717. /**
  55718. * Moves the buttons on the controller mesh based on their current state
  55719. * @param buttonName the name of the button to move
  55720. * @param buttonValue the value of the button which determines the buttons new position
  55721. */
  55722. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55723. /**
  55724. * Moves the axis on the controller mesh based on its current state
  55725. * @param axis the index of the axis
  55726. * @param axisValue the value of the axis which determines the meshes new position
  55727. * @hidden
  55728. */
  55729. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55730. /**
  55731. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55732. * @param scene scene in which to add meshes
  55733. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55734. */
  55735. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55736. /**
  55737. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55738. * can be transformed by button presses and axes values, based on this._mapping.
  55739. *
  55740. * @param scene scene in which the meshes exist
  55741. * @param meshes list of meshes that make up the controller model to process
  55742. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55743. */
  55744. private processModel;
  55745. private createMeshInfo;
  55746. /**
  55747. * Gets the ray of the controller in the direction the controller is pointing
  55748. * @param length the length the resulting ray should be
  55749. * @returns a ray in the direction the controller is pointing
  55750. */
  55751. getForwardRay(length?: number): Ray;
  55752. /**
  55753. * Disposes of the controller
  55754. */
  55755. dispose(): void;
  55756. }
  55757. /**
  55758. * This class represents a new windows motion controller in XR.
  55759. */
  55760. export class XRWindowsMotionController extends WindowsMotionController {
  55761. /**
  55762. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55763. */
  55764. protected readonly _mapping: {
  55765. buttons: string[];
  55766. buttonMeshNames: {
  55767. trigger: string;
  55768. menu: string;
  55769. grip: string;
  55770. thumbstick: string;
  55771. trackpad: string;
  55772. };
  55773. buttonObservableNames: {
  55774. trigger: string;
  55775. menu: string;
  55776. grip: string;
  55777. thumbstick: string;
  55778. trackpad: string;
  55779. };
  55780. axisMeshNames: string[];
  55781. pointingPoseMeshName: string;
  55782. };
  55783. /**
  55784. * Construct a new XR-Based windows motion controller
  55785. *
  55786. * @param gamepadInfo the gamepad object from the browser
  55787. */
  55788. constructor(gamepadInfo: any);
  55789. /**
  55790. * holds the thumbstick values (X,Y)
  55791. */
  55792. thumbstickValues: StickValues;
  55793. /**
  55794. * Fired when the thumbstick on this controller is clicked
  55795. */
  55796. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55797. /**
  55798. * Fired when the thumbstick on this controller is modified
  55799. */
  55800. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55801. /**
  55802. * Fired when the touchpad button on this controller is modified
  55803. */
  55804. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55805. /**
  55806. * Fired when the touchpad values on this controller are modified
  55807. */
  55808. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55809. /**
  55810. * Fired when the thumbstick button on this controller is modified
  55811. * here to prevent breaking changes
  55812. */
  55813. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55814. /**
  55815. * updating the thumbstick(!) and not the trackpad.
  55816. * This is named this way due to the difference between WebVR and XR and to avoid
  55817. * changing the parent class.
  55818. */
  55819. protected _updateTrackpad(): void;
  55820. /**
  55821. * Disposes the class with joy
  55822. */
  55823. dispose(): void;
  55824. }
  55825. }
  55826. declare module "babylonjs/Gamepads/Controllers/index" {
  55827. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55828. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55829. export * from "babylonjs/Gamepads/Controllers/genericController";
  55830. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55831. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55832. export * from "babylonjs/Gamepads/Controllers/viveController";
  55833. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55834. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55835. }
  55836. declare module "babylonjs/Gamepads/index" {
  55837. export * from "babylonjs/Gamepads/Controllers/index";
  55838. export * from "babylonjs/Gamepads/gamepad";
  55839. export * from "babylonjs/Gamepads/gamepadManager";
  55840. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55841. export * from "babylonjs/Gamepads/xboxGamepad";
  55842. export * from "babylonjs/Gamepads/dualShockGamepad";
  55843. }
  55844. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55845. import { Scene } from "babylonjs/scene";
  55846. import { Vector4 } from "babylonjs/Maths/math.vector";
  55847. import { Color4 } from "babylonjs/Maths/math.color";
  55848. import { Mesh } from "babylonjs/Meshes/mesh";
  55849. import { Nullable } from "babylonjs/types";
  55850. /**
  55851. * Class containing static functions to help procedurally build meshes
  55852. */
  55853. export class PolyhedronBuilder {
  55854. /**
  55855. * Creates a polyhedron mesh
  55856. * * 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
  55857. * * The parameter `size` (positive float, default 1) sets the polygon size
  55858. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55859. * * 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`
  55860. * * 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
  55861. * * 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)`)
  55862. * * 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
  55863. * * 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
  55864. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55865. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55866. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55867. * @param name defines the name of the mesh
  55868. * @param options defines the options used to create the mesh
  55869. * @param scene defines the hosting scene
  55870. * @returns the polyhedron mesh
  55871. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55872. */
  55873. static CreatePolyhedron(name: string, options: {
  55874. type?: number;
  55875. size?: number;
  55876. sizeX?: number;
  55877. sizeY?: number;
  55878. sizeZ?: number;
  55879. custom?: any;
  55880. faceUV?: Vector4[];
  55881. faceColors?: Color4[];
  55882. flat?: boolean;
  55883. updatable?: boolean;
  55884. sideOrientation?: number;
  55885. frontUVs?: Vector4;
  55886. backUVs?: Vector4;
  55887. }, scene?: Nullable<Scene>): Mesh;
  55888. }
  55889. }
  55890. declare module "babylonjs/Gizmos/scaleGizmo" {
  55891. import { Observable } from "babylonjs/Misc/observable";
  55892. import { Nullable } from "babylonjs/types";
  55893. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55894. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55895. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55896. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55897. import { Node } from "babylonjs/node";
  55898. /**
  55899. * Gizmo that enables scaling a mesh along 3 axis
  55900. */
  55901. export class ScaleGizmo extends Gizmo {
  55902. /**
  55903. * Internal gizmo used for interactions on the x axis
  55904. */
  55905. xGizmo: AxisScaleGizmo;
  55906. /**
  55907. * Internal gizmo used for interactions on the y axis
  55908. */
  55909. yGizmo: AxisScaleGizmo;
  55910. /**
  55911. * Internal gizmo used for interactions on the z axis
  55912. */
  55913. zGizmo: AxisScaleGizmo;
  55914. /**
  55915. * Internal gizmo used to scale all axis equally
  55916. */
  55917. uniformScaleGizmo: AxisScaleGizmo;
  55918. private _meshAttached;
  55919. private _nodeAttached;
  55920. private _snapDistance;
  55921. private _uniformScalingMesh;
  55922. private _octahedron;
  55923. private _sensitivity;
  55924. /** Fires an event when any of it's sub gizmos are dragged */
  55925. onDragStartObservable: Observable<unknown>;
  55926. /** Fires an event when any of it's sub gizmos are released from dragging */
  55927. onDragEndObservable: Observable<unknown>;
  55928. get attachedMesh(): Nullable<AbstractMesh>;
  55929. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55930. get attachedNode(): Nullable<Node>;
  55931. set attachedNode(node: Nullable<Node>);
  55932. /**
  55933. * True when the mouse pointer is hovering a gizmo mesh
  55934. */
  55935. get isHovered(): boolean;
  55936. /**
  55937. * Creates a ScaleGizmo
  55938. * @param gizmoLayer The utility layer the gizmo will be added to
  55939. * @param thickness display gizmo axis thickness
  55940. */
  55941. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55942. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55943. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55944. /**
  55945. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55946. */
  55947. set snapDistance(value: number);
  55948. get snapDistance(): number;
  55949. /**
  55950. * Ratio for the scale of the gizmo (Default: 1)
  55951. */
  55952. set scaleRatio(value: number);
  55953. get scaleRatio(): number;
  55954. /**
  55955. * Sensitivity factor for dragging (Default: 1)
  55956. */
  55957. set sensitivity(value: number);
  55958. get sensitivity(): number;
  55959. /**
  55960. * Disposes of the gizmo
  55961. */
  55962. dispose(): void;
  55963. }
  55964. }
  55965. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55966. import { Observable } from "babylonjs/Misc/observable";
  55967. import { Nullable } from "babylonjs/types";
  55968. import { Vector3 } from "babylonjs/Maths/math.vector";
  55969. import { Node } from "babylonjs/node";
  55970. import { Mesh } from "babylonjs/Meshes/mesh";
  55971. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55972. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55973. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55974. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55975. import { Color3 } from "babylonjs/Maths/math.color";
  55976. /**
  55977. * Single axis scale gizmo
  55978. */
  55979. export class AxisScaleGizmo extends Gizmo {
  55980. /**
  55981. * Drag behavior responsible for the gizmos dragging interactions
  55982. */
  55983. dragBehavior: PointerDragBehavior;
  55984. private _pointerObserver;
  55985. /**
  55986. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55987. */
  55988. snapDistance: number;
  55989. /**
  55990. * Event that fires each time the gizmo snaps to a new location.
  55991. * * snapDistance is the the change in distance
  55992. */
  55993. onSnapObservable: Observable<{
  55994. snapDistance: number;
  55995. }>;
  55996. /**
  55997. * If the scaling operation should be done on all axis (default: false)
  55998. */
  55999. uniformScaling: boolean;
  56000. /**
  56001. * Custom sensitivity value for the drag strength
  56002. */
  56003. sensitivity: number;
  56004. private _isEnabled;
  56005. private _parent;
  56006. private _arrow;
  56007. private _coloredMaterial;
  56008. private _hoverMaterial;
  56009. /**
  56010. * Creates an AxisScaleGizmo
  56011. * @param gizmoLayer The utility layer the gizmo will be added to
  56012. * @param dragAxis The axis which the gizmo will be able to scale on
  56013. * @param color The color of the gizmo
  56014. * @param thickness display gizmo axis thickness
  56015. */
  56016. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  56017. protected _attachedNodeChanged(value: Nullable<Node>): void;
  56018. /**
  56019. * If the gizmo is enabled
  56020. */
  56021. set isEnabled(value: boolean);
  56022. get isEnabled(): boolean;
  56023. /**
  56024. * Disposes of the gizmo
  56025. */
  56026. dispose(): void;
  56027. /**
  56028. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  56029. * @param mesh The mesh to replace the default mesh of the gizmo
  56030. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  56031. */
  56032. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  56033. }
  56034. }
  56035. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  56036. import { Observable } from "babylonjs/Misc/observable";
  56037. import { Nullable } from "babylonjs/types";
  56038. import { Vector3 } from "babylonjs/Maths/math.vector";
  56039. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56040. import { Mesh } from "babylonjs/Meshes/mesh";
  56041. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56042. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56043. import { Color3 } from "babylonjs/Maths/math.color";
  56044. import "babylonjs/Meshes/Builders/boxBuilder";
  56045. /**
  56046. * Bounding box gizmo
  56047. */
  56048. export class BoundingBoxGizmo extends Gizmo {
  56049. private _lineBoundingBox;
  56050. private _rotateSpheresParent;
  56051. private _scaleBoxesParent;
  56052. private _boundingDimensions;
  56053. private _renderObserver;
  56054. private _pointerObserver;
  56055. private _scaleDragSpeed;
  56056. private _tmpQuaternion;
  56057. private _tmpVector;
  56058. private _tmpRotationMatrix;
  56059. /**
  56060. * 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)
  56061. */
  56062. ignoreChildren: boolean;
  56063. /**
  56064. * 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)
  56065. */
  56066. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  56067. /**
  56068. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  56069. */
  56070. rotationSphereSize: number;
  56071. /**
  56072. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  56073. */
  56074. scaleBoxSize: number;
  56075. /**
  56076. * 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)
  56077. */
  56078. fixedDragMeshScreenSize: boolean;
  56079. /**
  56080. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  56081. */
  56082. fixedDragMeshScreenSizeDistanceFactor: number;
  56083. /**
  56084. * Fired when a rotation sphere or scale box is dragged
  56085. */
  56086. onDragStartObservable: Observable<{}>;
  56087. /**
  56088. * Fired when a scale box is dragged
  56089. */
  56090. onScaleBoxDragObservable: Observable<{}>;
  56091. /**
  56092. * Fired when a scale box drag is ended
  56093. */
  56094. onScaleBoxDragEndObservable: Observable<{}>;
  56095. /**
  56096. * Fired when a rotation sphere is dragged
  56097. */
  56098. onRotationSphereDragObservable: Observable<{}>;
  56099. /**
  56100. * Fired when a rotation sphere drag is ended
  56101. */
  56102. onRotationSphereDragEndObservable: Observable<{}>;
  56103. /**
  56104. * 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)
  56105. */
  56106. scalePivot: Nullable<Vector3>;
  56107. /**
  56108. * Mesh used as a pivot to rotate the attached node
  56109. */
  56110. private _anchorMesh;
  56111. private _existingMeshScale;
  56112. private _dragMesh;
  56113. private pointerDragBehavior;
  56114. private coloredMaterial;
  56115. private hoverColoredMaterial;
  56116. /**
  56117. * Sets the color of the bounding box gizmo
  56118. * @param color the color to set
  56119. */
  56120. setColor(color: Color3): void;
  56121. /**
  56122. * Creates an BoundingBoxGizmo
  56123. * @param gizmoLayer The utility layer the gizmo will be added to
  56124. * @param color The color of the gizmo
  56125. */
  56126. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  56127. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  56128. private _selectNode;
  56129. /**
  56130. * Updates the bounding box information for the Gizmo
  56131. */
  56132. updateBoundingBox(): void;
  56133. private _updateRotationSpheres;
  56134. private _updateScaleBoxes;
  56135. /**
  56136. * Enables rotation on the specified axis and disables rotation on the others
  56137. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  56138. */
  56139. setEnabledRotationAxis(axis: string): void;
  56140. /**
  56141. * Enables/disables scaling
  56142. * @param enable if scaling should be enabled
  56143. * @param homogeneousScaling defines if scaling should only be homogeneous
  56144. */
  56145. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  56146. private _updateDummy;
  56147. /**
  56148. * Enables a pointer drag behavior on the bounding box of the gizmo
  56149. */
  56150. enableDragBehavior(): void;
  56151. /**
  56152. * Disposes of the gizmo
  56153. */
  56154. dispose(): void;
  56155. /**
  56156. * 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)
  56157. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  56158. * @returns the bounding box mesh with the passed in mesh as a child
  56159. */
  56160. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  56161. /**
  56162. * CustomMeshes are not supported by this gizmo
  56163. * @param mesh The mesh to replace the default mesh of the gizmo
  56164. */
  56165. setCustomMesh(mesh: Mesh): void;
  56166. }
  56167. }
  56168. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  56169. import { Observable } from "babylonjs/Misc/observable";
  56170. import { Nullable } from "babylonjs/types";
  56171. import { Vector3 } from "babylonjs/Maths/math.vector";
  56172. import { Color3 } from "babylonjs/Maths/math.color";
  56173. import { Node } from "babylonjs/node";
  56174. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  56175. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56176. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56177. import "babylonjs/Meshes/Builders/linesBuilder";
  56178. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56179. /**
  56180. * Single plane rotation gizmo
  56181. */
  56182. export class PlaneRotationGizmo extends Gizmo {
  56183. /**
  56184. * Drag behavior responsible for the gizmos dragging interactions
  56185. */
  56186. dragBehavior: PointerDragBehavior;
  56187. private _pointerObserver;
  56188. /**
  56189. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  56190. */
  56191. snapDistance: number;
  56192. /**
  56193. * Event that fires each time the gizmo snaps to a new location.
  56194. * * snapDistance is the the change in distance
  56195. */
  56196. onSnapObservable: Observable<{
  56197. snapDistance: number;
  56198. }>;
  56199. private _isEnabled;
  56200. private _parent;
  56201. /**
  56202. * Creates a PlaneRotationGizmo
  56203. * @param gizmoLayer The utility layer the gizmo will be added to
  56204. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  56205. * @param color The color of the gizmo
  56206. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56207. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56208. * @param thickness display gizmo axis thickness
  56209. */
  56210. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  56211. protected _attachedNodeChanged(value: Nullable<Node>): void;
  56212. /**
  56213. * If the gizmo is enabled
  56214. */
  56215. set isEnabled(value: boolean);
  56216. get isEnabled(): boolean;
  56217. /**
  56218. * Disposes of the gizmo
  56219. */
  56220. dispose(): void;
  56221. }
  56222. }
  56223. declare module "babylonjs/Gizmos/rotationGizmo" {
  56224. import { Observable } from "babylonjs/Misc/observable";
  56225. import { Nullable } from "babylonjs/types";
  56226. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56227. import { Mesh } from "babylonjs/Meshes/mesh";
  56228. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56229. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  56230. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56231. import { Node } from "babylonjs/node";
  56232. /**
  56233. * Gizmo that enables rotating a mesh along 3 axis
  56234. */
  56235. export class RotationGizmo extends Gizmo {
  56236. /**
  56237. * Internal gizmo used for interactions on the x axis
  56238. */
  56239. xGizmo: PlaneRotationGizmo;
  56240. /**
  56241. * Internal gizmo used for interactions on the y axis
  56242. */
  56243. yGizmo: PlaneRotationGizmo;
  56244. /**
  56245. * Internal gizmo used for interactions on the z axis
  56246. */
  56247. zGizmo: PlaneRotationGizmo;
  56248. /** Fires an event when any of it's sub gizmos are dragged */
  56249. onDragStartObservable: Observable<unknown>;
  56250. /** Fires an event when any of it's sub gizmos are released from dragging */
  56251. onDragEndObservable: Observable<unknown>;
  56252. private _meshAttached;
  56253. private _nodeAttached;
  56254. get attachedMesh(): Nullable<AbstractMesh>;
  56255. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56256. get attachedNode(): Nullable<Node>;
  56257. set attachedNode(node: Nullable<Node>);
  56258. /**
  56259. * True when the mouse pointer is hovering a gizmo mesh
  56260. */
  56261. get isHovered(): boolean;
  56262. /**
  56263. * Creates a RotationGizmo
  56264. * @param gizmoLayer The utility layer the gizmo will be added to
  56265. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56266. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56267. * @param thickness display gizmo axis thickness
  56268. */
  56269. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56270. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56271. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56272. /**
  56273. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56274. */
  56275. set snapDistance(value: number);
  56276. get snapDistance(): number;
  56277. /**
  56278. * Ratio for the scale of the gizmo (Default: 1)
  56279. */
  56280. set scaleRatio(value: number);
  56281. get scaleRatio(): number;
  56282. /**
  56283. * Disposes of the gizmo
  56284. */
  56285. dispose(): void;
  56286. /**
  56287. * CustomMeshes are not supported by this gizmo
  56288. * @param mesh The mesh to replace the default mesh of the gizmo
  56289. */
  56290. setCustomMesh(mesh: Mesh): void;
  56291. }
  56292. }
  56293. declare module "babylonjs/Gizmos/gizmoManager" {
  56294. import { Observable } from "babylonjs/Misc/observable";
  56295. import { Nullable } from "babylonjs/types";
  56296. import { Scene, IDisposable } from "babylonjs/scene";
  56297. import { Node } from "babylonjs/node";
  56298. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56299. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56300. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56301. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56302. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56303. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56304. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56305. /**
  56306. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56307. */
  56308. export class GizmoManager implements IDisposable {
  56309. private scene;
  56310. /**
  56311. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56312. */
  56313. gizmos: {
  56314. positionGizmo: Nullable<PositionGizmo>;
  56315. rotationGizmo: Nullable<RotationGizmo>;
  56316. scaleGizmo: Nullable<ScaleGizmo>;
  56317. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56318. };
  56319. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56320. clearGizmoOnEmptyPointerEvent: boolean;
  56321. /** Fires an event when the manager is attached to a mesh */
  56322. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56323. /** Fires an event when the manager is attached to a node */
  56324. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56325. private _gizmosEnabled;
  56326. private _pointerObserver;
  56327. private _attachedMesh;
  56328. private _attachedNode;
  56329. private _boundingBoxColor;
  56330. private _defaultUtilityLayer;
  56331. private _defaultKeepDepthUtilityLayer;
  56332. private _thickness;
  56333. /**
  56334. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56335. */
  56336. boundingBoxDragBehavior: SixDofDragBehavior;
  56337. /**
  56338. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56339. */
  56340. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56341. /**
  56342. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56343. */
  56344. attachableNodes: Nullable<Array<Node>>;
  56345. /**
  56346. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56347. */
  56348. usePointerToAttachGizmos: boolean;
  56349. /**
  56350. * Utility layer that the bounding box gizmo belongs to
  56351. */
  56352. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56353. /**
  56354. * Utility layer that all gizmos besides bounding box belong to
  56355. */
  56356. get utilityLayer(): UtilityLayerRenderer;
  56357. /**
  56358. * True when the mouse pointer is hovering a gizmo mesh
  56359. */
  56360. get isHovered(): boolean;
  56361. /**
  56362. * Instatiates a gizmo manager
  56363. * @param scene the scene to overlay the gizmos on top of
  56364. * @param thickness display gizmo axis thickness
  56365. */
  56366. constructor(scene: Scene, thickness?: number);
  56367. /**
  56368. * Attaches a set of gizmos to the specified mesh
  56369. * @param mesh The mesh the gizmo's should be attached to
  56370. */
  56371. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56372. /**
  56373. * Attaches a set of gizmos to the specified node
  56374. * @param node The node the gizmo's should be attached to
  56375. */
  56376. attachToNode(node: Nullable<Node>): void;
  56377. /**
  56378. * If the position gizmo is enabled
  56379. */
  56380. set positionGizmoEnabled(value: boolean);
  56381. get positionGizmoEnabled(): boolean;
  56382. /**
  56383. * If the rotation gizmo is enabled
  56384. */
  56385. set rotationGizmoEnabled(value: boolean);
  56386. get rotationGizmoEnabled(): boolean;
  56387. /**
  56388. * If the scale gizmo is enabled
  56389. */
  56390. set scaleGizmoEnabled(value: boolean);
  56391. get scaleGizmoEnabled(): boolean;
  56392. /**
  56393. * If the boundingBox gizmo is enabled
  56394. */
  56395. set boundingBoxGizmoEnabled(value: boolean);
  56396. get boundingBoxGizmoEnabled(): boolean;
  56397. /**
  56398. * Disposes of the gizmo manager
  56399. */
  56400. dispose(): void;
  56401. }
  56402. }
  56403. declare module "babylonjs/Lights/directionalLight" {
  56404. import { Camera } from "babylonjs/Cameras/camera";
  56405. import { Scene } from "babylonjs/scene";
  56406. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56408. import { Light } from "babylonjs/Lights/light";
  56409. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56410. import { Effect } from "babylonjs/Materials/effect";
  56411. /**
  56412. * A directional light is defined by a direction (what a surprise!).
  56413. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56414. * 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.
  56415. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56416. */
  56417. export class DirectionalLight extends ShadowLight {
  56418. private _shadowFrustumSize;
  56419. /**
  56420. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56421. */
  56422. get shadowFrustumSize(): number;
  56423. /**
  56424. * Specifies a fix frustum size for the shadow generation.
  56425. */
  56426. set shadowFrustumSize(value: number);
  56427. private _shadowOrthoScale;
  56428. /**
  56429. * Gets the shadow projection scale against the optimal computed one.
  56430. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56431. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56432. */
  56433. get shadowOrthoScale(): number;
  56434. /**
  56435. * Sets the shadow projection scale against the optimal computed one.
  56436. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56437. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56438. */
  56439. set shadowOrthoScale(value: number);
  56440. /**
  56441. * Automatically compute the projection matrix to best fit (including all the casters)
  56442. * on each frame.
  56443. */
  56444. autoUpdateExtends: boolean;
  56445. /**
  56446. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56447. * on each frame. autoUpdateExtends must be set to true for this to work
  56448. */
  56449. autoCalcShadowZBounds: boolean;
  56450. private _orthoLeft;
  56451. private _orthoRight;
  56452. private _orthoTop;
  56453. private _orthoBottom;
  56454. /**
  56455. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56456. * The directional light is emitted from everywhere in the given direction.
  56457. * It can cast shadows.
  56458. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56459. * @param name The friendly name of the light
  56460. * @param direction The direction of the light
  56461. * @param scene The scene the light belongs to
  56462. */
  56463. constructor(name: string, direction: Vector3, scene: Scene);
  56464. /**
  56465. * Returns the string "DirectionalLight".
  56466. * @return The class name
  56467. */
  56468. getClassName(): string;
  56469. /**
  56470. * Returns the integer 1.
  56471. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56472. */
  56473. getTypeID(): number;
  56474. /**
  56475. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56476. * Returns the DirectionalLight Shadow projection matrix.
  56477. */
  56478. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56479. /**
  56480. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56481. * Returns the DirectionalLight Shadow projection matrix.
  56482. */
  56483. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56484. /**
  56485. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56486. * Returns the DirectionalLight Shadow projection matrix.
  56487. */
  56488. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56489. protected _buildUniformLayout(): void;
  56490. /**
  56491. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56492. * @param effect The effect to update
  56493. * @param lightIndex The index of the light in the effect to update
  56494. * @returns The directional light
  56495. */
  56496. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56497. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56498. /**
  56499. * Gets the minZ used for shadow according to both the scene and the light.
  56500. *
  56501. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56502. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56503. * @param activeCamera The camera we are returning the min for
  56504. * @returns the depth min z
  56505. */
  56506. getDepthMinZ(activeCamera: Camera): number;
  56507. /**
  56508. * Gets the maxZ used for shadow according to both the scene and the light.
  56509. *
  56510. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56511. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56512. * @param activeCamera The camera we are returning the max for
  56513. * @returns the depth max z
  56514. */
  56515. getDepthMaxZ(activeCamera: Camera): number;
  56516. /**
  56517. * Prepares the list of defines specific to the light type.
  56518. * @param defines the list of defines
  56519. * @param lightIndex defines the index of the light for the effect
  56520. */
  56521. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56522. }
  56523. }
  56524. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56525. import { Mesh } from "babylonjs/Meshes/mesh";
  56526. /**
  56527. * Class containing static functions to help procedurally build meshes
  56528. */
  56529. export class HemisphereBuilder {
  56530. /**
  56531. * Creates a hemisphere mesh
  56532. * @param name defines the name of the mesh
  56533. * @param options defines the options used to create the mesh
  56534. * @param scene defines the hosting scene
  56535. * @returns the hemisphere mesh
  56536. */
  56537. static CreateHemisphere(name: string, options: {
  56538. segments?: number;
  56539. diameter?: number;
  56540. sideOrientation?: number;
  56541. }, scene: any): Mesh;
  56542. }
  56543. }
  56544. declare module "babylonjs/Lights/spotLight" {
  56545. import { Nullable } from "babylonjs/types";
  56546. import { Scene } from "babylonjs/scene";
  56547. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56548. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56549. import { Effect } from "babylonjs/Materials/effect";
  56550. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56551. import { Light } from "babylonjs/Lights/light";
  56552. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56553. /**
  56554. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56555. * These values define a cone of light starting from the position, emitting toward the direction.
  56556. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56557. * and the exponent defines the speed of the decay of the light with distance (reach).
  56558. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56559. */
  56560. export class SpotLight extends ShadowLight {
  56561. private _angle;
  56562. private _innerAngle;
  56563. private _cosHalfAngle;
  56564. private _lightAngleScale;
  56565. private _lightAngleOffset;
  56566. /**
  56567. * Gets the cone angle of the spot light in Radians.
  56568. */
  56569. get angle(): number;
  56570. /**
  56571. * Sets the cone angle of the spot light in Radians.
  56572. */
  56573. set angle(value: number);
  56574. /**
  56575. * Only used in gltf falloff mode, this defines the angle where
  56576. * the directional falloff will start before cutting at angle which could be seen
  56577. * as outer angle.
  56578. */
  56579. get innerAngle(): number;
  56580. /**
  56581. * Only used in gltf falloff mode, this defines the angle where
  56582. * the directional falloff will start before cutting at angle which could be seen
  56583. * as outer angle.
  56584. */
  56585. set innerAngle(value: number);
  56586. private _shadowAngleScale;
  56587. /**
  56588. * Allows scaling the angle of the light for shadow generation only.
  56589. */
  56590. get shadowAngleScale(): number;
  56591. /**
  56592. * Allows scaling the angle of the light for shadow generation only.
  56593. */
  56594. set shadowAngleScale(value: number);
  56595. /**
  56596. * The light decay speed with the distance from the emission spot.
  56597. */
  56598. exponent: number;
  56599. private _projectionTextureMatrix;
  56600. /**
  56601. * Allows reading the projecton texture
  56602. */
  56603. get projectionTextureMatrix(): Matrix;
  56604. protected _projectionTextureLightNear: number;
  56605. /**
  56606. * Gets the near clip of the Spotlight for texture projection.
  56607. */
  56608. get projectionTextureLightNear(): number;
  56609. /**
  56610. * Sets the near clip of the Spotlight for texture projection.
  56611. */
  56612. set projectionTextureLightNear(value: number);
  56613. protected _projectionTextureLightFar: number;
  56614. /**
  56615. * Gets the far clip of the Spotlight for texture projection.
  56616. */
  56617. get projectionTextureLightFar(): number;
  56618. /**
  56619. * Sets the far clip of the Spotlight for texture projection.
  56620. */
  56621. set projectionTextureLightFar(value: number);
  56622. protected _projectionTextureUpDirection: Vector3;
  56623. /**
  56624. * Gets the Up vector of the Spotlight for texture projection.
  56625. */
  56626. get projectionTextureUpDirection(): Vector3;
  56627. /**
  56628. * Sets the Up vector of the Spotlight for texture projection.
  56629. */
  56630. set projectionTextureUpDirection(value: Vector3);
  56631. private _projectionTexture;
  56632. /**
  56633. * Gets the projection texture of the light.
  56634. */
  56635. get projectionTexture(): Nullable<BaseTexture>;
  56636. /**
  56637. * Sets the projection texture of the light.
  56638. */
  56639. set projectionTexture(value: Nullable<BaseTexture>);
  56640. private _projectionTextureViewLightDirty;
  56641. private _projectionTextureProjectionLightDirty;
  56642. private _projectionTextureDirty;
  56643. private _projectionTextureViewTargetVector;
  56644. private _projectionTextureViewLightMatrix;
  56645. private _projectionTextureProjectionLightMatrix;
  56646. private _projectionTextureScalingMatrix;
  56647. /**
  56648. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56649. * It can cast shadows.
  56650. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56651. * @param name The light friendly name
  56652. * @param position The position of the spot light in the scene
  56653. * @param direction The direction of the light in the scene
  56654. * @param angle The cone angle of the light in Radians
  56655. * @param exponent The light decay speed with the distance from the emission spot
  56656. * @param scene The scene the lights belongs to
  56657. */
  56658. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56659. /**
  56660. * Returns the string "SpotLight".
  56661. * @returns the class name
  56662. */
  56663. getClassName(): string;
  56664. /**
  56665. * Returns the integer 2.
  56666. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56667. */
  56668. getTypeID(): number;
  56669. /**
  56670. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56671. */
  56672. protected _setDirection(value: Vector3): void;
  56673. /**
  56674. * Overrides the position setter to recompute the projection texture view light Matrix.
  56675. */
  56676. protected _setPosition(value: Vector3): void;
  56677. /**
  56678. * 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.
  56679. * Returns the SpotLight.
  56680. */
  56681. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56682. protected _computeProjectionTextureViewLightMatrix(): void;
  56683. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56684. /**
  56685. * Main function for light texture projection matrix computing.
  56686. */
  56687. protected _computeProjectionTextureMatrix(): void;
  56688. protected _buildUniformLayout(): void;
  56689. private _computeAngleValues;
  56690. /**
  56691. * Sets the passed Effect "effect" with the Light textures.
  56692. * @param effect The effect to update
  56693. * @param lightIndex The index of the light in the effect to update
  56694. * @returns The light
  56695. */
  56696. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56697. /**
  56698. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56699. * @param effect The effect to update
  56700. * @param lightIndex The index of the light in the effect to update
  56701. * @returns The spot light
  56702. */
  56703. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56704. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56705. /**
  56706. * Disposes the light and the associated resources.
  56707. */
  56708. dispose(): void;
  56709. /**
  56710. * Prepares the list of defines specific to the light type.
  56711. * @param defines the list of defines
  56712. * @param lightIndex defines the index of the light for the effect
  56713. */
  56714. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56715. }
  56716. }
  56717. declare module "babylonjs/Gizmos/lightGizmo" {
  56718. import { Nullable } from "babylonjs/types";
  56719. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56720. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56721. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56722. import { Light } from "babylonjs/Lights/light";
  56723. import { Observable } from "babylonjs/Misc/observable";
  56724. /**
  56725. * Gizmo that enables viewing a light
  56726. */
  56727. export class LightGizmo extends Gizmo {
  56728. private _lightMesh;
  56729. private _material;
  56730. private _cachedPosition;
  56731. private _cachedForward;
  56732. private _attachedMeshParent;
  56733. private _pointerObserver;
  56734. /**
  56735. * Event that fires each time the gizmo is clicked
  56736. */
  56737. onClickedObservable: Observable<Light>;
  56738. /**
  56739. * Creates a LightGizmo
  56740. * @param gizmoLayer The utility layer the gizmo will be added to
  56741. */
  56742. constructor(gizmoLayer?: UtilityLayerRenderer);
  56743. private _light;
  56744. /**
  56745. * The light that the gizmo is attached to
  56746. */
  56747. set light(light: Nullable<Light>);
  56748. get light(): Nullable<Light>;
  56749. /**
  56750. * Gets the material used to render the light gizmo
  56751. */
  56752. get material(): StandardMaterial;
  56753. /**
  56754. * @hidden
  56755. * Updates the gizmo to match the attached mesh's position/rotation
  56756. */
  56757. protected _update(): void;
  56758. private static _Scale;
  56759. /**
  56760. * Creates the lines for a light mesh
  56761. */
  56762. private static _CreateLightLines;
  56763. /**
  56764. * Disposes of the light gizmo
  56765. */
  56766. dispose(): void;
  56767. private static _CreateHemisphericLightMesh;
  56768. private static _CreatePointLightMesh;
  56769. private static _CreateSpotLightMesh;
  56770. private static _CreateDirectionalLightMesh;
  56771. }
  56772. }
  56773. declare module "babylonjs/Gizmos/cameraGizmo" {
  56774. import { Nullable } from "babylonjs/types";
  56775. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56776. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56777. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56778. import { Camera } from "babylonjs/Cameras/camera";
  56779. import { Observable } from "babylonjs/Misc/observable";
  56780. /**
  56781. * Gizmo that enables viewing a camera
  56782. */
  56783. export class CameraGizmo extends Gizmo {
  56784. private _cameraMesh;
  56785. private _cameraLinesMesh;
  56786. private _material;
  56787. private _pointerObserver;
  56788. /**
  56789. * Event that fires each time the gizmo is clicked
  56790. */
  56791. onClickedObservable: Observable<Camera>;
  56792. /**
  56793. * Creates a CameraGizmo
  56794. * @param gizmoLayer The utility layer the gizmo will be added to
  56795. */
  56796. constructor(gizmoLayer?: UtilityLayerRenderer);
  56797. private _camera;
  56798. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56799. get displayFrustum(): boolean;
  56800. set displayFrustum(value: boolean);
  56801. /**
  56802. * The camera that the gizmo is attached to
  56803. */
  56804. set camera(camera: Nullable<Camera>);
  56805. get camera(): Nullable<Camera>;
  56806. /**
  56807. * Gets the material used to render the camera gizmo
  56808. */
  56809. get material(): StandardMaterial;
  56810. /**
  56811. * @hidden
  56812. * Updates the gizmo to match the attached mesh's position/rotation
  56813. */
  56814. protected _update(): void;
  56815. private static _Scale;
  56816. private _invProjection;
  56817. /**
  56818. * Disposes of the camera gizmo
  56819. */
  56820. dispose(): void;
  56821. private static _CreateCameraMesh;
  56822. private static _CreateCameraFrustum;
  56823. }
  56824. }
  56825. declare module "babylonjs/Gizmos/index" {
  56826. export * from "babylonjs/Gizmos/axisDragGizmo";
  56827. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56828. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56829. export * from "babylonjs/Gizmos/gizmo";
  56830. export * from "babylonjs/Gizmos/gizmoManager";
  56831. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56832. export * from "babylonjs/Gizmos/positionGizmo";
  56833. export * from "babylonjs/Gizmos/rotationGizmo";
  56834. export * from "babylonjs/Gizmos/scaleGizmo";
  56835. export * from "babylonjs/Gizmos/lightGizmo";
  56836. export * from "babylonjs/Gizmos/cameraGizmo";
  56837. export * from "babylonjs/Gizmos/planeDragGizmo";
  56838. }
  56839. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56840. /** @hidden */
  56841. export var backgroundFragmentDeclaration: {
  56842. name: string;
  56843. shader: string;
  56844. };
  56845. }
  56846. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56847. /** @hidden */
  56848. export var backgroundUboDeclaration: {
  56849. name: string;
  56850. shader: string;
  56851. };
  56852. }
  56853. declare module "babylonjs/Shaders/background.fragment" {
  56854. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56855. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56856. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56857. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56858. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56859. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56860. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56861. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56862. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56863. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56864. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56865. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56866. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56867. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56868. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56869. /** @hidden */
  56870. export var backgroundPixelShader: {
  56871. name: string;
  56872. shader: string;
  56873. };
  56874. }
  56875. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56876. /** @hidden */
  56877. export var backgroundVertexDeclaration: {
  56878. name: string;
  56879. shader: string;
  56880. };
  56881. }
  56882. declare module "babylonjs/Shaders/background.vertex" {
  56883. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56884. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56885. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56886. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56887. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56888. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56889. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56890. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56891. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56892. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56893. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56894. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56895. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56896. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56897. /** @hidden */
  56898. export var backgroundVertexShader: {
  56899. name: string;
  56900. shader: string;
  56901. };
  56902. }
  56903. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56904. import { Nullable, int, float } from "babylonjs/types";
  56905. import { Scene } from "babylonjs/scene";
  56906. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56907. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56908. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56909. import { Mesh } from "babylonjs/Meshes/mesh";
  56910. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56911. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56912. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56913. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56914. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56915. import { Color3 } from "babylonjs/Maths/math.color";
  56916. import "babylonjs/Shaders/background.fragment";
  56917. import "babylonjs/Shaders/background.vertex";
  56918. /**
  56919. * Background material used to create an efficient environement around your scene.
  56920. */
  56921. export class BackgroundMaterial extends PushMaterial {
  56922. /**
  56923. * Standard reflectance value at parallel view angle.
  56924. */
  56925. static StandardReflectance0: number;
  56926. /**
  56927. * Standard reflectance value at grazing angle.
  56928. */
  56929. static StandardReflectance90: number;
  56930. protected _primaryColor: Color3;
  56931. /**
  56932. * Key light Color (multiply against the environement texture)
  56933. */
  56934. primaryColor: Color3;
  56935. protected __perceptualColor: Nullable<Color3>;
  56936. /**
  56937. * Experimental Internal Use Only.
  56938. *
  56939. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56940. * This acts as a helper to set the primary color to a more "human friendly" value.
  56941. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56942. * output color as close as possible from the chosen value.
  56943. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56944. * part of lighting setup.)
  56945. */
  56946. get _perceptualColor(): Nullable<Color3>;
  56947. set _perceptualColor(value: Nullable<Color3>);
  56948. protected _primaryColorShadowLevel: float;
  56949. /**
  56950. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56951. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56952. */
  56953. get primaryColorShadowLevel(): float;
  56954. set primaryColorShadowLevel(value: float);
  56955. protected _primaryColorHighlightLevel: float;
  56956. /**
  56957. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56958. * The primary color is used at the level chosen to define what the white area would look.
  56959. */
  56960. get primaryColorHighlightLevel(): float;
  56961. set primaryColorHighlightLevel(value: float);
  56962. protected _reflectionTexture: Nullable<BaseTexture>;
  56963. /**
  56964. * Reflection Texture used in the material.
  56965. * Should be author in a specific way for the best result (refer to the documentation).
  56966. */
  56967. reflectionTexture: Nullable<BaseTexture>;
  56968. protected _reflectionBlur: float;
  56969. /**
  56970. * Reflection Texture level of blur.
  56971. *
  56972. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56973. * texture twice.
  56974. */
  56975. reflectionBlur: float;
  56976. protected _diffuseTexture: Nullable<BaseTexture>;
  56977. /**
  56978. * Diffuse Texture used in the material.
  56979. * Should be author in a specific way for the best result (refer to the documentation).
  56980. */
  56981. diffuseTexture: Nullable<BaseTexture>;
  56982. protected _shadowLights: Nullable<IShadowLight[]>;
  56983. /**
  56984. * Specify the list of lights casting shadow on the material.
  56985. * All scene shadow lights will be included if null.
  56986. */
  56987. shadowLights: Nullable<IShadowLight[]>;
  56988. protected _shadowLevel: float;
  56989. /**
  56990. * Helps adjusting the shadow to a softer level if required.
  56991. * 0 means black shadows and 1 means no shadows.
  56992. */
  56993. shadowLevel: float;
  56994. protected _sceneCenter: Vector3;
  56995. /**
  56996. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56997. * It is usually zero but might be interesting to modify according to your setup.
  56998. */
  56999. sceneCenter: Vector3;
  57000. protected _opacityFresnel: boolean;
  57001. /**
  57002. * This helps specifying that the material is falling off to the sky box at grazing angle.
  57003. * This helps ensuring a nice transition when the camera goes under the ground.
  57004. */
  57005. opacityFresnel: boolean;
  57006. protected _reflectionFresnel: boolean;
  57007. /**
  57008. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  57009. * This helps adding a mirror texture on the ground.
  57010. */
  57011. reflectionFresnel: boolean;
  57012. protected _reflectionFalloffDistance: number;
  57013. /**
  57014. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  57015. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  57016. */
  57017. reflectionFalloffDistance: number;
  57018. protected _reflectionAmount: number;
  57019. /**
  57020. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  57021. */
  57022. reflectionAmount: number;
  57023. protected _reflectionReflectance0: number;
  57024. /**
  57025. * This specifies the weight of the reflection at grazing angle.
  57026. */
  57027. reflectionReflectance0: number;
  57028. protected _reflectionReflectance90: number;
  57029. /**
  57030. * This specifies the weight of the reflection at a perpendicular point of view.
  57031. */
  57032. reflectionReflectance90: number;
  57033. /**
  57034. * Sets the reflection reflectance fresnel values according to the default standard
  57035. * empirically know to work well :-)
  57036. */
  57037. set reflectionStandardFresnelWeight(value: number);
  57038. protected _useRGBColor: boolean;
  57039. /**
  57040. * Helps to directly use the maps channels instead of their level.
  57041. */
  57042. useRGBColor: boolean;
  57043. protected _enableNoise: boolean;
  57044. /**
  57045. * This helps reducing the banding effect that could occur on the background.
  57046. */
  57047. enableNoise: boolean;
  57048. /**
  57049. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57050. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  57051. * Recommended to be keep at 1.0 except for special cases.
  57052. */
  57053. get fovMultiplier(): number;
  57054. set fovMultiplier(value: number);
  57055. private _fovMultiplier;
  57056. /**
  57057. * Enable the FOV adjustment feature controlled by fovMultiplier.
  57058. */
  57059. useEquirectangularFOV: boolean;
  57060. private _maxSimultaneousLights;
  57061. /**
  57062. * Number of Simultaneous lights allowed on the material.
  57063. */
  57064. maxSimultaneousLights: int;
  57065. private _shadowOnly;
  57066. /**
  57067. * Make the material only render shadows
  57068. */
  57069. shadowOnly: boolean;
  57070. /**
  57071. * Default configuration related to image processing available in the Background Material.
  57072. */
  57073. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  57074. /**
  57075. * Keep track of the image processing observer to allow dispose and replace.
  57076. */
  57077. private _imageProcessingObserver;
  57078. /**
  57079. * Attaches a new image processing configuration to the PBR Material.
  57080. * @param configuration (if null the scene configuration will be use)
  57081. */
  57082. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  57083. /**
  57084. * Gets the image processing configuration used either in this material.
  57085. */
  57086. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  57087. /**
  57088. * Sets the Default image processing configuration used either in the this material.
  57089. *
  57090. * If sets to null, the scene one is in use.
  57091. */
  57092. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  57093. /**
  57094. * Gets wether the color curves effect is enabled.
  57095. */
  57096. get cameraColorCurvesEnabled(): boolean;
  57097. /**
  57098. * Sets wether the color curves effect is enabled.
  57099. */
  57100. set cameraColorCurvesEnabled(value: boolean);
  57101. /**
  57102. * Gets wether the color grading effect is enabled.
  57103. */
  57104. get cameraColorGradingEnabled(): boolean;
  57105. /**
  57106. * Gets wether the color grading effect is enabled.
  57107. */
  57108. set cameraColorGradingEnabled(value: boolean);
  57109. /**
  57110. * Gets wether tonemapping is enabled or not.
  57111. */
  57112. get cameraToneMappingEnabled(): boolean;
  57113. /**
  57114. * Sets wether tonemapping is enabled or not
  57115. */
  57116. set cameraToneMappingEnabled(value: boolean);
  57117. /**
  57118. * The camera exposure used on this material.
  57119. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  57120. * This corresponds to a photographic exposure.
  57121. */
  57122. get cameraExposure(): float;
  57123. /**
  57124. * The camera exposure used on this material.
  57125. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  57126. * This corresponds to a photographic exposure.
  57127. */
  57128. set cameraExposure(value: float);
  57129. /**
  57130. * Gets The camera contrast used on this material.
  57131. */
  57132. get cameraContrast(): float;
  57133. /**
  57134. * Sets The camera contrast used on this material.
  57135. */
  57136. set cameraContrast(value: float);
  57137. /**
  57138. * Gets the Color Grading 2D Lookup Texture.
  57139. */
  57140. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  57141. /**
  57142. * Sets the Color Grading 2D Lookup Texture.
  57143. */
  57144. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  57145. /**
  57146. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  57147. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  57148. * 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;
  57149. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  57150. */
  57151. get cameraColorCurves(): Nullable<ColorCurves>;
  57152. /**
  57153. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  57154. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  57155. * 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;
  57156. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  57157. */
  57158. set cameraColorCurves(value: Nullable<ColorCurves>);
  57159. /**
  57160. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  57161. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  57162. */
  57163. switchToBGR: boolean;
  57164. private _renderTargets;
  57165. private _reflectionControls;
  57166. private _white;
  57167. private _primaryShadowColor;
  57168. private _primaryHighlightColor;
  57169. /**
  57170. * Instantiates a Background Material in the given scene
  57171. * @param name The friendly name of the material
  57172. * @param scene The scene to add the material to
  57173. */
  57174. constructor(name: string, scene: Scene);
  57175. /**
  57176. * Gets a boolean indicating that current material needs to register RTT
  57177. */
  57178. get hasRenderTargetTextures(): boolean;
  57179. /**
  57180. * The entire material has been created in order to prevent overdraw.
  57181. * @returns false
  57182. */
  57183. needAlphaTesting(): boolean;
  57184. /**
  57185. * The entire material has been created in order to prevent overdraw.
  57186. * @returns true if blending is enable
  57187. */
  57188. needAlphaBlending(): boolean;
  57189. /**
  57190. * Checks wether the material is ready to be rendered for a given mesh.
  57191. * @param mesh The mesh to render
  57192. * @param subMesh The submesh to check against
  57193. * @param useInstances Specify wether or not the material is used with instances
  57194. * @returns true if all the dependencies are ready (Textures, Effects...)
  57195. */
  57196. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  57197. /**
  57198. * Compute the primary color according to the chosen perceptual color.
  57199. */
  57200. private _computePrimaryColorFromPerceptualColor;
  57201. /**
  57202. * Compute the highlights and shadow colors according to their chosen levels.
  57203. */
  57204. private _computePrimaryColors;
  57205. /**
  57206. * Build the uniform buffer used in the material.
  57207. */
  57208. buildUniformLayout(): void;
  57209. /**
  57210. * Unbind the material.
  57211. */
  57212. unbind(): void;
  57213. /**
  57214. * Bind only the world matrix to the material.
  57215. * @param world The world matrix to bind.
  57216. */
  57217. bindOnlyWorldMatrix(world: Matrix): void;
  57218. /**
  57219. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  57220. * @param world The world matrix to bind.
  57221. * @param subMesh The submesh to bind for.
  57222. */
  57223. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  57224. /**
  57225. * Checks to see if a texture is used in the material.
  57226. * @param texture - Base texture to use.
  57227. * @returns - Boolean specifying if a texture is used in the material.
  57228. */
  57229. hasTexture(texture: BaseTexture): boolean;
  57230. /**
  57231. * Dispose the material.
  57232. * @param forceDisposeEffect Force disposal of the associated effect.
  57233. * @param forceDisposeTextures Force disposal of the associated textures.
  57234. */
  57235. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  57236. /**
  57237. * Clones the material.
  57238. * @param name The cloned name.
  57239. * @returns The cloned material.
  57240. */
  57241. clone(name: string): BackgroundMaterial;
  57242. /**
  57243. * Serializes the current material to its JSON representation.
  57244. * @returns The JSON representation.
  57245. */
  57246. serialize(): any;
  57247. /**
  57248. * Gets the class name of the material
  57249. * @returns "BackgroundMaterial"
  57250. */
  57251. getClassName(): string;
  57252. /**
  57253. * Parse a JSON input to create back a background material.
  57254. * @param source The JSON data to parse
  57255. * @param scene The scene to create the parsed material in
  57256. * @param rootUrl The root url of the assets the material depends upon
  57257. * @returns the instantiated BackgroundMaterial.
  57258. */
  57259. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  57260. }
  57261. }
  57262. declare module "babylonjs/Helpers/environmentHelper" {
  57263. import { Observable } from "babylonjs/Misc/observable";
  57264. import { Nullable } from "babylonjs/types";
  57265. import { Scene } from "babylonjs/scene";
  57266. import { Vector3 } from "babylonjs/Maths/math.vector";
  57267. import { Color3 } from "babylonjs/Maths/math.color";
  57268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57269. import { Mesh } from "babylonjs/Meshes/mesh";
  57270. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57271. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  57272. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57273. import "babylonjs/Meshes/Builders/planeBuilder";
  57274. import "babylonjs/Meshes/Builders/boxBuilder";
  57275. /**
  57276. * Represents the different options available during the creation of
  57277. * a Environment helper.
  57278. *
  57279. * This can control the default ground, skybox and image processing setup of your scene.
  57280. */
  57281. export interface IEnvironmentHelperOptions {
  57282. /**
  57283. * Specifies whether or not to create a ground.
  57284. * True by default.
  57285. */
  57286. createGround: boolean;
  57287. /**
  57288. * Specifies the ground size.
  57289. * 15 by default.
  57290. */
  57291. groundSize: number;
  57292. /**
  57293. * The texture used on the ground for the main color.
  57294. * Comes from the BabylonJS CDN by default.
  57295. *
  57296. * Remarks: Can be either a texture or a url.
  57297. */
  57298. groundTexture: string | BaseTexture;
  57299. /**
  57300. * The color mixed in the ground texture by default.
  57301. * BabylonJS clearColor by default.
  57302. */
  57303. groundColor: Color3;
  57304. /**
  57305. * Specifies the ground opacity.
  57306. * 1 by default.
  57307. */
  57308. groundOpacity: number;
  57309. /**
  57310. * Enables the ground to receive shadows.
  57311. * True by default.
  57312. */
  57313. enableGroundShadow: boolean;
  57314. /**
  57315. * Helps preventing the shadow to be fully black on the ground.
  57316. * 0.5 by default.
  57317. */
  57318. groundShadowLevel: number;
  57319. /**
  57320. * Creates a mirror texture attach to the ground.
  57321. * false by default.
  57322. */
  57323. enableGroundMirror: boolean;
  57324. /**
  57325. * Specifies the ground mirror size ratio.
  57326. * 0.3 by default as the default kernel is 64.
  57327. */
  57328. groundMirrorSizeRatio: number;
  57329. /**
  57330. * Specifies the ground mirror blur kernel size.
  57331. * 64 by default.
  57332. */
  57333. groundMirrorBlurKernel: number;
  57334. /**
  57335. * Specifies the ground mirror visibility amount.
  57336. * 1 by default
  57337. */
  57338. groundMirrorAmount: number;
  57339. /**
  57340. * Specifies the ground mirror reflectance weight.
  57341. * This uses the standard weight of the background material to setup the fresnel effect
  57342. * of the mirror.
  57343. * 1 by default.
  57344. */
  57345. groundMirrorFresnelWeight: number;
  57346. /**
  57347. * Specifies the ground mirror Falloff distance.
  57348. * This can helps reducing the size of the reflection.
  57349. * 0 by Default.
  57350. */
  57351. groundMirrorFallOffDistance: number;
  57352. /**
  57353. * Specifies the ground mirror texture type.
  57354. * Unsigned Int by Default.
  57355. */
  57356. groundMirrorTextureType: number;
  57357. /**
  57358. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57359. * the shown objects.
  57360. */
  57361. groundYBias: number;
  57362. /**
  57363. * Specifies whether or not to create a skybox.
  57364. * True by default.
  57365. */
  57366. createSkybox: boolean;
  57367. /**
  57368. * Specifies the skybox size.
  57369. * 20 by default.
  57370. */
  57371. skyboxSize: number;
  57372. /**
  57373. * The texture used on the skybox for the main color.
  57374. * Comes from the BabylonJS CDN by default.
  57375. *
  57376. * Remarks: Can be either a texture or a url.
  57377. */
  57378. skyboxTexture: string | BaseTexture;
  57379. /**
  57380. * The color mixed in the skybox texture by default.
  57381. * BabylonJS clearColor by default.
  57382. */
  57383. skyboxColor: Color3;
  57384. /**
  57385. * The background rotation around the Y axis of the scene.
  57386. * This helps aligning the key lights of your scene with the background.
  57387. * 0 by default.
  57388. */
  57389. backgroundYRotation: number;
  57390. /**
  57391. * Compute automatically the size of the elements to best fit with the scene.
  57392. */
  57393. sizeAuto: boolean;
  57394. /**
  57395. * Default position of the rootMesh if autoSize is not true.
  57396. */
  57397. rootPosition: Vector3;
  57398. /**
  57399. * Sets up the image processing in the scene.
  57400. * true by default.
  57401. */
  57402. setupImageProcessing: boolean;
  57403. /**
  57404. * The texture used as your environment texture in the scene.
  57405. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57406. *
  57407. * Remarks: Can be either a texture or a url.
  57408. */
  57409. environmentTexture: string | BaseTexture;
  57410. /**
  57411. * The value of the exposure to apply to the scene.
  57412. * 0.6 by default if setupImageProcessing is true.
  57413. */
  57414. cameraExposure: number;
  57415. /**
  57416. * The value of the contrast to apply to the scene.
  57417. * 1.6 by default if setupImageProcessing is true.
  57418. */
  57419. cameraContrast: number;
  57420. /**
  57421. * Specifies whether or not tonemapping should be enabled in the scene.
  57422. * true by default if setupImageProcessing is true.
  57423. */
  57424. toneMappingEnabled: boolean;
  57425. }
  57426. /**
  57427. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57428. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57429. * It also helps with the default setup of your imageProcessing configuration.
  57430. */
  57431. export class EnvironmentHelper {
  57432. /**
  57433. * Default ground texture URL.
  57434. */
  57435. private static _groundTextureCDNUrl;
  57436. /**
  57437. * Default skybox texture URL.
  57438. */
  57439. private static _skyboxTextureCDNUrl;
  57440. /**
  57441. * Default environment texture URL.
  57442. */
  57443. private static _environmentTextureCDNUrl;
  57444. /**
  57445. * Creates the default options for the helper.
  57446. */
  57447. private static _getDefaultOptions;
  57448. private _rootMesh;
  57449. /**
  57450. * Gets the root mesh created by the helper.
  57451. */
  57452. get rootMesh(): Mesh;
  57453. private _skybox;
  57454. /**
  57455. * Gets the skybox created by the helper.
  57456. */
  57457. get skybox(): Nullable<Mesh>;
  57458. private _skyboxTexture;
  57459. /**
  57460. * Gets the skybox texture created by the helper.
  57461. */
  57462. get skyboxTexture(): Nullable<BaseTexture>;
  57463. private _skyboxMaterial;
  57464. /**
  57465. * Gets the skybox material created by the helper.
  57466. */
  57467. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57468. private _ground;
  57469. /**
  57470. * Gets the ground mesh created by the helper.
  57471. */
  57472. get ground(): Nullable<Mesh>;
  57473. private _groundTexture;
  57474. /**
  57475. * Gets the ground texture created by the helper.
  57476. */
  57477. get groundTexture(): Nullable<BaseTexture>;
  57478. private _groundMirror;
  57479. /**
  57480. * Gets the ground mirror created by the helper.
  57481. */
  57482. get groundMirror(): Nullable<MirrorTexture>;
  57483. /**
  57484. * Gets the ground mirror render list to helps pushing the meshes
  57485. * you wish in the ground reflection.
  57486. */
  57487. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57488. private _groundMaterial;
  57489. /**
  57490. * Gets the ground material created by the helper.
  57491. */
  57492. get groundMaterial(): Nullable<BackgroundMaterial>;
  57493. /**
  57494. * Stores the creation options.
  57495. */
  57496. private readonly _scene;
  57497. private _options;
  57498. /**
  57499. * This observable will be notified with any error during the creation of the environment,
  57500. * mainly texture creation errors.
  57501. */
  57502. onErrorObservable: Observable<{
  57503. message?: string;
  57504. exception?: any;
  57505. }>;
  57506. /**
  57507. * constructor
  57508. * @param options Defines the options we want to customize the helper
  57509. * @param scene The scene to add the material to
  57510. */
  57511. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57512. /**
  57513. * Updates the background according to the new options
  57514. * @param options
  57515. */
  57516. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57517. /**
  57518. * Sets the primary color of all the available elements.
  57519. * @param color the main color to affect to the ground and the background
  57520. */
  57521. setMainColor(color: Color3): void;
  57522. /**
  57523. * Setup the image processing according to the specified options.
  57524. */
  57525. private _setupImageProcessing;
  57526. /**
  57527. * Setup the environment texture according to the specified options.
  57528. */
  57529. private _setupEnvironmentTexture;
  57530. /**
  57531. * Setup the background according to the specified options.
  57532. */
  57533. private _setupBackground;
  57534. /**
  57535. * Get the scene sizes according to the setup.
  57536. */
  57537. private _getSceneSize;
  57538. /**
  57539. * Setup the ground according to the specified options.
  57540. */
  57541. private _setupGround;
  57542. /**
  57543. * Setup the ground material according to the specified options.
  57544. */
  57545. private _setupGroundMaterial;
  57546. /**
  57547. * Setup the ground diffuse texture according to the specified options.
  57548. */
  57549. private _setupGroundDiffuseTexture;
  57550. /**
  57551. * Setup the ground mirror texture according to the specified options.
  57552. */
  57553. private _setupGroundMirrorTexture;
  57554. /**
  57555. * Setup the ground to receive the mirror texture.
  57556. */
  57557. private _setupMirrorInGroundMaterial;
  57558. /**
  57559. * Setup the skybox according to the specified options.
  57560. */
  57561. private _setupSkybox;
  57562. /**
  57563. * Setup the skybox material according to the specified options.
  57564. */
  57565. private _setupSkyboxMaterial;
  57566. /**
  57567. * Setup the skybox reflection texture according to the specified options.
  57568. */
  57569. private _setupSkyboxReflectionTexture;
  57570. private _errorHandler;
  57571. /**
  57572. * Dispose all the elements created by the Helper.
  57573. */
  57574. dispose(): void;
  57575. }
  57576. }
  57577. declare module "babylonjs/Helpers/textureDome" {
  57578. import { Scene } from "babylonjs/scene";
  57579. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57580. import { Mesh } from "babylonjs/Meshes/mesh";
  57581. import { Texture } from "babylonjs/Materials/Textures/texture";
  57582. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57583. import "babylonjs/Meshes/Builders/sphereBuilder";
  57584. import { Nullable } from "babylonjs/types";
  57585. import { Observable } from "babylonjs/Misc/observable";
  57586. /**
  57587. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57588. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57589. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57590. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57591. */
  57592. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57593. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57594. /**
  57595. * Define the source as a Monoscopic panoramic 360/180.
  57596. */
  57597. static readonly MODE_MONOSCOPIC: number;
  57598. /**
  57599. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57600. */
  57601. static readonly MODE_TOPBOTTOM: number;
  57602. /**
  57603. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57604. */
  57605. static readonly MODE_SIDEBYSIDE: number;
  57606. private _halfDome;
  57607. protected _useDirectMapping: boolean;
  57608. /**
  57609. * The texture being displayed on the sphere
  57610. */
  57611. protected _texture: T;
  57612. /**
  57613. * Gets the texture being displayed on the sphere
  57614. */
  57615. get texture(): T;
  57616. /**
  57617. * Sets the texture being displayed on the sphere
  57618. */
  57619. set texture(newTexture: T);
  57620. /**
  57621. * The skybox material
  57622. */
  57623. protected _material: BackgroundMaterial;
  57624. /**
  57625. * The surface used for the dome
  57626. */
  57627. protected _mesh: Mesh;
  57628. /**
  57629. * Gets the mesh used for the dome.
  57630. */
  57631. get mesh(): Mesh;
  57632. /**
  57633. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57634. */
  57635. private _halfDomeMask;
  57636. /**
  57637. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57638. * Also see the options.resolution property.
  57639. */
  57640. get fovMultiplier(): number;
  57641. set fovMultiplier(value: number);
  57642. protected _textureMode: number;
  57643. /**
  57644. * Gets or set the current texture mode for the texture. It can be:
  57645. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57646. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57647. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57648. */
  57649. get textureMode(): number;
  57650. /**
  57651. * Sets the current texture mode for the texture. It can be:
  57652. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57653. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57654. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57655. */
  57656. set textureMode(value: number);
  57657. /**
  57658. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57659. */
  57660. get halfDome(): boolean;
  57661. /**
  57662. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57663. */
  57664. set halfDome(enabled: boolean);
  57665. /**
  57666. * Oberserver used in Stereoscopic VR Mode.
  57667. */
  57668. private _onBeforeCameraRenderObserver;
  57669. /**
  57670. * Observable raised when an error occured while loading the 360 image
  57671. */
  57672. onLoadErrorObservable: Observable<string>;
  57673. /**
  57674. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57675. * @param name Element's name, child elements will append suffixes for their own names.
  57676. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57677. * @param options An object containing optional or exposed sub element properties
  57678. */
  57679. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57680. resolution?: number;
  57681. clickToPlay?: boolean;
  57682. autoPlay?: boolean;
  57683. loop?: boolean;
  57684. size?: number;
  57685. poster?: string;
  57686. faceForward?: boolean;
  57687. useDirectMapping?: boolean;
  57688. halfDomeMode?: boolean;
  57689. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57690. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57691. protected _changeTextureMode(value: number): void;
  57692. /**
  57693. * Releases resources associated with this node.
  57694. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57695. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57696. */
  57697. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57698. }
  57699. }
  57700. declare module "babylonjs/Helpers/photoDome" {
  57701. import { Scene } from "babylonjs/scene";
  57702. import { Texture } from "babylonjs/Materials/Textures/texture";
  57703. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57704. /**
  57705. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57706. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57707. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57708. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57709. */
  57710. export class PhotoDome extends TextureDome<Texture> {
  57711. /**
  57712. * Define the image as a Monoscopic panoramic 360 image.
  57713. */
  57714. static readonly MODE_MONOSCOPIC: number;
  57715. /**
  57716. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57717. */
  57718. static readonly MODE_TOPBOTTOM: number;
  57719. /**
  57720. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57721. */
  57722. static readonly MODE_SIDEBYSIDE: number;
  57723. /**
  57724. * Gets or sets the texture being displayed on the sphere
  57725. */
  57726. get photoTexture(): Texture;
  57727. /**
  57728. * sets the texture being displayed on the sphere
  57729. */
  57730. set photoTexture(value: Texture);
  57731. /**
  57732. * Gets the current video mode for the video. It can be:
  57733. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57734. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57735. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57736. */
  57737. get imageMode(): number;
  57738. /**
  57739. * Sets the current video mode for the video. It can be:
  57740. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57741. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57742. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57743. */
  57744. set imageMode(value: number);
  57745. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57746. }
  57747. }
  57748. declare module "babylonjs/Misc/rgbdTextureTools" {
  57749. import "babylonjs/Shaders/rgbdDecode.fragment";
  57750. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57751. import { Texture } from "babylonjs/Materials/Textures/texture";
  57752. /**
  57753. * Class used to host RGBD texture specific utilities
  57754. */
  57755. export class RGBDTextureTools {
  57756. /**
  57757. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57758. * @param texture the texture to expand.
  57759. */
  57760. static ExpandRGBDTexture(texture: Texture): void;
  57761. }
  57762. }
  57763. declare module "babylonjs/Misc/brdfTextureTools" {
  57764. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57765. import { Scene } from "babylonjs/scene";
  57766. /**
  57767. * Class used to host texture specific utilities
  57768. */
  57769. export class BRDFTextureTools {
  57770. /**
  57771. * Prevents texture cache collision
  57772. */
  57773. private static _instanceNumber;
  57774. /**
  57775. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57776. * @param scene defines the hosting scene
  57777. * @returns the environment BRDF texture
  57778. */
  57779. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57780. private static _environmentBRDFBase64Texture;
  57781. }
  57782. }
  57783. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57784. import { Nullable } from "babylonjs/types";
  57785. import { Color3 } from "babylonjs/Maths/math.color";
  57786. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57787. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57788. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57789. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57790. import { Engine } from "babylonjs/Engines/engine";
  57791. import { Scene } from "babylonjs/scene";
  57792. /**
  57793. * @hidden
  57794. */
  57795. export interface IMaterialClearCoatDefines {
  57796. CLEARCOAT: boolean;
  57797. CLEARCOAT_DEFAULTIOR: boolean;
  57798. CLEARCOAT_TEXTURE: boolean;
  57799. CLEARCOAT_TEXTUREDIRECTUV: number;
  57800. CLEARCOAT_BUMP: boolean;
  57801. CLEARCOAT_BUMPDIRECTUV: number;
  57802. CLEARCOAT_TINT: boolean;
  57803. CLEARCOAT_TINT_TEXTURE: boolean;
  57804. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57805. /** @hidden */
  57806. _areTexturesDirty: boolean;
  57807. }
  57808. /**
  57809. * Define the code related to the clear coat parameters of the pbr material.
  57810. */
  57811. export class PBRClearCoatConfiguration {
  57812. /**
  57813. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57814. * The default fits with a polyurethane material.
  57815. */
  57816. private static readonly _DefaultIndexOfRefraction;
  57817. private _isEnabled;
  57818. /**
  57819. * Defines if the clear coat is enabled in the material.
  57820. */
  57821. isEnabled: boolean;
  57822. /**
  57823. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57824. */
  57825. intensity: number;
  57826. /**
  57827. * Defines the clear coat layer roughness.
  57828. */
  57829. roughness: number;
  57830. private _indexOfRefraction;
  57831. /**
  57832. * Defines the index of refraction of the clear coat.
  57833. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57834. * The default fits with a polyurethane material.
  57835. * Changing the default value is more performance intensive.
  57836. */
  57837. indexOfRefraction: number;
  57838. private _texture;
  57839. /**
  57840. * Stores the clear coat values in a texture.
  57841. */
  57842. texture: Nullable<BaseTexture>;
  57843. private _bumpTexture;
  57844. /**
  57845. * Define the clear coat specific bump texture.
  57846. */
  57847. bumpTexture: Nullable<BaseTexture>;
  57848. private _isTintEnabled;
  57849. /**
  57850. * Defines if the clear coat tint is enabled in the material.
  57851. */
  57852. isTintEnabled: boolean;
  57853. /**
  57854. * Defines the clear coat tint of the material.
  57855. * This is only use if tint is enabled
  57856. */
  57857. tintColor: Color3;
  57858. /**
  57859. * Defines the distance at which the tint color should be found in the
  57860. * clear coat media.
  57861. * This is only use if tint is enabled
  57862. */
  57863. tintColorAtDistance: number;
  57864. /**
  57865. * Defines the clear coat layer thickness.
  57866. * This is only use if tint is enabled
  57867. */
  57868. tintThickness: number;
  57869. private _tintTexture;
  57870. /**
  57871. * Stores the clear tint values in a texture.
  57872. * rgb is tint
  57873. * a is a thickness factor
  57874. */
  57875. tintTexture: Nullable<BaseTexture>;
  57876. /** @hidden */
  57877. private _internalMarkAllSubMeshesAsTexturesDirty;
  57878. /** @hidden */
  57879. _markAllSubMeshesAsTexturesDirty(): void;
  57880. /**
  57881. * Instantiate a new istance of clear coat configuration.
  57882. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57883. */
  57884. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57885. /**
  57886. * Gets wehter the submesh is ready to be used or not.
  57887. * @param defines the list of "defines" to update.
  57888. * @param scene defines the scene the material belongs to.
  57889. * @param engine defines the engine the material belongs to.
  57890. * @param disableBumpMap defines wether the material disables bump or not.
  57891. * @returns - boolean indicating that the submesh is ready or not.
  57892. */
  57893. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57894. /**
  57895. * Checks to see if a texture is used in the material.
  57896. * @param defines the list of "defines" to update.
  57897. * @param scene defines the scene to the material belongs to.
  57898. */
  57899. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57900. /**
  57901. * Binds the material data.
  57902. * @param uniformBuffer defines the Uniform buffer to fill in.
  57903. * @param scene defines the scene the material belongs to.
  57904. * @param engine defines the engine the material belongs to.
  57905. * @param disableBumpMap defines wether the material disables bump or not.
  57906. * @param isFrozen defines wether the material is frozen or not.
  57907. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57908. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57909. */
  57910. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57911. /**
  57912. * Checks to see if a texture is used in the material.
  57913. * @param texture - Base texture to use.
  57914. * @returns - Boolean specifying if a texture is used in the material.
  57915. */
  57916. hasTexture(texture: BaseTexture): boolean;
  57917. /**
  57918. * Returns an array of the actively used textures.
  57919. * @param activeTextures Array of BaseTextures
  57920. */
  57921. getActiveTextures(activeTextures: BaseTexture[]): void;
  57922. /**
  57923. * Returns the animatable textures.
  57924. * @param animatables Array of animatable textures.
  57925. */
  57926. getAnimatables(animatables: IAnimatable[]): void;
  57927. /**
  57928. * Disposes the resources of the material.
  57929. * @param forceDisposeTextures - Forces the disposal of all textures.
  57930. */
  57931. dispose(forceDisposeTextures?: boolean): void;
  57932. /**
  57933. * Get the current class name of the texture useful for serialization or dynamic coding.
  57934. * @returns "PBRClearCoatConfiguration"
  57935. */
  57936. getClassName(): string;
  57937. /**
  57938. * Add fallbacks to the effect fallbacks list.
  57939. * @param defines defines the Base texture to use.
  57940. * @param fallbacks defines the current fallback list.
  57941. * @param currentRank defines the current fallback rank.
  57942. * @returns the new fallback rank.
  57943. */
  57944. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57945. /**
  57946. * Add the required uniforms to the current list.
  57947. * @param uniforms defines the current uniform list.
  57948. */
  57949. static AddUniforms(uniforms: string[]): void;
  57950. /**
  57951. * Add the required samplers to the current list.
  57952. * @param samplers defines the current sampler list.
  57953. */
  57954. static AddSamplers(samplers: string[]): void;
  57955. /**
  57956. * Add the required uniforms to the current buffer.
  57957. * @param uniformBuffer defines the current uniform buffer.
  57958. */
  57959. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57960. /**
  57961. * Makes a duplicate of the current configuration into another one.
  57962. * @param clearCoatConfiguration define the config where to copy the info
  57963. */
  57964. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57965. /**
  57966. * Serializes this clear coat configuration.
  57967. * @returns - An object with the serialized config.
  57968. */
  57969. serialize(): any;
  57970. /**
  57971. * Parses a anisotropy Configuration from a serialized object.
  57972. * @param source - Serialized object.
  57973. * @param scene Defines the scene we are parsing for
  57974. * @param rootUrl Defines the rootUrl to load from
  57975. */
  57976. parse(source: any, scene: Scene, rootUrl: string): void;
  57977. }
  57978. }
  57979. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57980. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57981. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57982. import { Vector2 } from "babylonjs/Maths/math.vector";
  57983. import { Scene } from "babylonjs/scene";
  57984. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57985. import { Nullable } from "babylonjs/types";
  57986. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57987. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57988. /**
  57989. * @hidden
  57990. */
  57991. export interface IMaterialAnisotropicDefines {
  57992. ANISOTROPIC: boolean;
  57993. ANISOTROPIC_TEXTURE: boolean;
  57994. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57995. MAINUV1: boolean;
  57996. _areTexturesDirty: boolean;
  57997. _needUVs: boolean;
  57998. }
  57999. /**
  58000. * Define the code related to the anisotropic parameters of the pbr material.
  58001. */
  58002. export class PBRAnisotropicConfiguration {
  58003. private _isEnabled;
  58004. /**
  58005. * Defines if the anisotropy is enabled in the material.
  58006. */
  58007. isEnabled: boolean;
  58008. /**
  58009. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  58010. */
  58011. intensity: number;
  58012. /**
  58013. * Defines if the effect is along the tangents, bitangents or in between.
  58014. * By default, the effect is "strectching" the highlights along the tangents.
  58015. */
  58016. direction: Vector2;
  58017. private _texture;
  58018. /**
  58019. * Stores the anisotropy values in a texture.
  58020. * rg is direction (like normal from -1 to 1)
  58021. * b is a intensity
  58022. */
  58023. texture: Nullable<BaseTexture>;
  58024. /** @hidden */
  58025. private _internalMarkAllSubMeshesAsTexturesDirty;
  58026. /** @hidden */
  58027. _markAllSubMeshesAsTexturesDirty(): void;
  58028. /**
  58029. * Instantiate a new istance of anisotropy configuration.
  58030. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58031. */
  58032. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58033. /**
  58034. * Specifies that the submesh is ready to be used.
  58035. * @param defines the list of "defines" to update.
  58036. * @param scene defines the scene the material belongs to.
  58037. * @returns - boolean indicating that the submesh is ready or not.
  58038. */
  58039. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  58040. /**
  58041. * Checks to see if a texture is used in the material.
  58042. * @param defines the list of "defines" to update.
  58043. * @param mesh the mesh we are preparing the defines for.
  58044. * @param scene defines the scene the material belongs to.
  58045. */
  58046. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  58047. /**
  58048. * Binds the material data.
  58049. * @param uniformBuffer defines the Uniform buffer to fill in.
  58050. * @param scene defines the scene the material belongs to.
  58051. * @param isFrozen defines wether the material is frozen or not.
  58052. */
  58053. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58054. /**
  58055. * Checks to see if a texture is used in the material.
  58056. * @param texture - Base texture to use.
  58057. * @returns - Boolean specifying if a texture is used in the material.
  58058. */
  58059. hasTexture(texture: BaseTexture): boolean;
  58060. /**
  58061. * Returns an array of the actively used textures.
  58062. * @param activeTextures Array of BaseTextures
  58063. */
  58064. getActiveTextures(activeTextures: BaseTexture[]): void;
  58065. /**
  58066. * Returns the animatable textures.
  58067. * @param animatables Array of animatable textures.
  58068. */
  58069. getAnimatables(animatables: IAnimatable[]): void;
  58070. /**
  58071. * Disposes the resources of the material.
  58072. * @param forceDisposeTextures - Forces the disposal of all textures.
  58073. */
  58074. dispose(forceDisposeTextures?: boolean): void;
  58075. /**
  58076. * Get the current class name of the texture useful for serialization or dynamic coding.
  58077. * @returns "PBRAnisotropicConfiguration"
  58078. */
  58079. getClassName(): string;
  58080. /**
  58081. * Add fallbacks to the effect fallbacks list.
  58082. * @param defines defines the Base texture to use.
  58083. * @param fallbacks defines the current fallback list.
  58084. * @param currentRank defines the current fallback rank.
  58085. * @returns the new fallback rank.
  58086. */
  58087. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58088. /**
  58089. * Add the required uniforms to the current list.
  58090. * @param uniforms defines the current uniform list.
  58091. */
  58092. static AddUniforms(uniforms: string[]): void;
  58093. /**
  58094. * Add the required uniforms to the current buffer.
  58095. * @param uniformBuffer defines the current uniform buffer.
  58096. */
  58097. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58098. /**
  58099. * Add the required samplers to the current list.
  58100. * @param samplers defines the current sampler list.
  58101. */
  58102. static AddSamplers(samplers: string[]): void;
  58103. /**
  58104. * Makes a duplicate of the current configuration into another one.
  58105. * @param anisotropicConfiguration define the config where to copy the info
  58106. */
  58107. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  58108. /**
  58109. * Serializes this anisotropy configuration.
  58110. * @returns - An object with the serialized config.
  58111. */
  58112. serialize(): any;
  58113. /**
  58114. * Parses a anisotropy Configuration from a serialized object.
  58115. * @param source - Serialized object.
  58116. * @param scene Defines the scene we are parsing for
  58117. * @param rootUrl Defines the rootUrl to load from
  58118. */
  58119. parse(source: any, scene: Scene, rootUrl: string): void;
  58120. }
  58121. }
  58122. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  58123. import { Scene } from "babylonjs/scene";
  58124. /**
  58125. * @hidden
  58126. */
  58127. export interface IMaterialBRDFDefines {
  58128. BRDF_V_HEIGHT_CORRELATED: boolean;
  58129. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58130. SPHERICAL_HARMONICS: boolean;
  58131. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58132. /** @hidden */
  58133. _areMiscDirty: boolean;
  58134. }
  58135. /**
  58136. * Define the code related to the BRDF parameters of the pbr material.
  58137. */
  58138. export class PBRBRDFConfiguration {
  58139. /**
  58140. * Default value used for the energy conservation.
  58141. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  58142. */
  58143. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  58144. /**
  58145. * Default value used for the Smith Visibility Height Correlated mode.
  58146. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  58147. */
  58148. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  58149. /**
  58150. * Default value used for the IBL diffuse part.
  58151. * This can help switching back to the polynomials mode globally which is a tiny bit
  58152. * less GPU intensive at the drawback of a lower quality.
  58153. */
  58154. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  58155. /**
  58156. * Default value used for activating energy conservation for the specular workflow.
  58157. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  58158. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  58159. */
  58160. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  58161. private _useEnergyConservation;
  58162. /**
  58163. * Defines if the material uses energy conservation.
  58164. */
  58165. useEnergyConservation: boolean;
  58166. private _useSmithVisibilityHeightCorrelated;
  58167. /**
  58168. * LEGACY Mode set to false
  58169. * Defines if the material uses height smith correlated visibility term.
  58170. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  58171. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  58172. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  58173. * Not relying on height correlated will also disable energy conservation.
  58174. */
  58175. useSmithVisibilityHeightCorrelated: boolean;
  58176. private _useSphericalHarmonics;
  58177. /**
  58178. * LEGACY Mode set to false
  58179. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  58180. * diffuse part of the IBL.
  58181. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  58182. * to the ground truth.
  58183. */
  58184. useSphericalHarmonics: boolean;
  58185. private _useSpecularGlossinessInputEnergyConservation;
  58186. /**
  58187. * Defines if the material uses energy conservation, when the specular workflow is active.
  58188. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  58189. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  58190. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  58191. */
  58192. useSpecularGlossinessInputEnergyConservation: boolean;
  58193. /** @hidden */
  58194. private _internalMarkAllSubMeshesAsMiscDirty;
  58195. /** @hidden */
  58196. _markAllSubMeshesAsMiscDirty(): void;
  58197. /**
  58198. * Instantiate a new istance of clear coat configuration.
  58199. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  58200. */
  58201. constructor(markAllSubMeshesAsMiscDirty: () => void);
  58202. /**
  58203. * Checks to see if a texture is used in the material.
  58204. * @param defines the list of "defines" to update.
  58205. */
  58206. prepareDefines(defines: IMaterialBRDFDefines): void;
  58207. /**
  58208. * Get the current class name of the texture useful for serialization or dynamic coding.
  58209. * @returns "PBRClearCoatConfiguration"
  58210. */
  58211. getClassName(): string;
  58212. /**
  58213. * Makes a duplicate of the current configuration into another one.
  58214. * @param brdfConfiguration define the config where to copy the info
  58215. */
  58216. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  58217. /**
  58218. * Serializes this BRDF configuration.
  58219. * @returns - An object with the serialized config.
  58220. */
  58221. serialize(): any;
  58222. /**
  58223. * Parses a anisotropy Configuration from a serialized object.
  58224. * @param source - Serialized object.
  58225. * @param scene Defines the scene we are parsing for
  58226. * @param rootUrl Defines the rootUrl to load from
  58227. */
  58228. parse(source: any, scene: Scene, rootUrl: string): void;
  58229. }
  58230. }
  58231. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  58232. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58233. import { Color3 } from "babylonjs/Maths/math.color";
  58234. import { Scene } from "babylonjs/scene";
  58235. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58236. import { Nullable } from "babylonjs/types";
  58237. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58238. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58239. /**
  58240. * @hidden
  58241. */
  58242. export interface IMaterialSheenDefines {
  58243. SHEEN: boolean;
  58244. SHEEN_TEXTURE: boolean;
  58245. SHEEN_TEXTUREDIRECTUV: number;
  58246. SHEEN_LINKWITHALBEDO: boolean;
  58247. SHEEN_ROUGHNESS: boolean;
  58248. SHEEN_ALBEDOSCALING: boolean;
  58249. /** @hidden */
  58250. _areTexturesDirty: boolean;
  58251. }
  58252. /**
  58253. * Define the code related to the Sheen parameters of the pbr material.
  58254. */
  58255. export class PBRSheenConfiguration {
  58256. private _isEnabled;
  58257. /**
  58258. * Defines if the material uses sheen.
  58259. */
  58260. isEnabled: boolean;
  58261. private _linkSheenWithAlbedo;
  58262. /**
  58263. * Defines if the sheen is linked to the sheen color.
  58264. */
  58265. linkSheenWithAlbedo: boolean;
  58266. /**
  58267. * Defines the sheen intensity.
  58268. */
  58269. intensity: number;
  58270. /**
  58271. * Defines the sheen color.
  58272. */
  58273. color: Color3;
  58274. private _texture;
  58275. /**
  58276. * Stores the sheen tint values in a texture.
  58277. * rgb is tint
  58278. * a is a intensity or roughness if roughness has been defined
  58279. */
  58280. texture: Nullable<BaseTexture>;
  58281. private _roughness;
  58282. /**
  58283. * Defines the sheen roughness.
  58284. * It is not taken into account if linkSheenWithAlbedo is true.
  58285. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58286. */
  58287. roughness: Nullable<number>;
  58288. private _albedoScaling;
  58289. /**
  58290. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58291. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58292. * making it easier to setup and tweak the effect
  58293. */
  58294. albedoScaling: boolean;
  58295. /** @hidden */
  58296. private _internalMarkAllSubMeshesAsTexturesDirty;
  58297. /** @hidden */
  58298. _markAllSubMeshesAsTexturesDirty(): void;
  58299. /**
  58300. * Instantiate a new istance of clear coat configuration.
  58301. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58302. */
  58303. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58304. /**
  58305. * Specifies that the submesh is ready to be used.
  58306. * @param defines the list of "defines" to update.
  58307. * @param scene defines the scene the material belongs to.
  58308. * @returns - boolean indicating that the submesh is ready or not.
  58309. */
  58310. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58311. /**
  58312. * Checks to see if a texture is used in the material.
  58313. * @param defines the list of "defines" to update.
  58314. * @param scene defines the scene the material belongs to.
  58315. */
  58316. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58317. /**
  58318. * Binds the material data.
  58319. * @param uniformBuffer defines the Uniform buffer to fill in.
  58320. * @param scene defines the scene the material belongs to.
  58321. * @param isFrozen defines wether the material is frozen or not.
  58322. */
  58323. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58324. /**
  58325. * Checks to see if a texture is used in the material.
  58326. * @param texture - Base texture to use.
  58327. * @returns - Boolean specifying if a texture is used in the material.
  58328. */
  58329. hasTexture(texture: BaseTexture): boolean;
  58330. /**
  58331. * Returns an array of the actively used textures.
  58332. * @param activeTextures Array of BaseTextures
  58333. */
  58334. getActiveTextures(activeTextures: BaseTexture[]): void;
  58335. /**
  58336. * Returns the animatable textures.
  58337. * @param animatables Array of animatable textures.
  58338. */
  58339. getAnimatables(animatables: IAnimatable[]): void;
  58340. /**
  58341. * Disposes the resources of the material.
  58342. * @param forceDisposeTextures - Forces the disposal of all textures.
  58343. */
  58344. dispose(forceDisposeTextures?: boolean): void;
  58345. /**
  58346. * Get the current class name of the texture useful for serialization or dynamic coding.
  58347. * @returns "PBRSheenConfiguration"
  58348. */
  58349. getClassName(): string;
  58350. /**
  58351. * Add fallbacks to the effect fallbacks list.
  58352. * @param defines defines the Base texture to use.
  58353. * @param fallbacks defines the current fallback list.
  58354. * @param currentRank defines the current fallback rank.
  58355. * @returns the new fallback rank.
  58356. */
  58357. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58358. /**
  58359. * Add the required uniforms to the current list.
  58360. * @param uniforms defines the current uniform list.
  58361. */
  58362. static AddUniforms(uniforms: string[]): void;
  58363. /**
  58364. * Add the required uniforms to the current buffer.
  58365. * @param uniformBuffer defines the current uniform buffer.
  58366. */
  58367. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58368. /**
  58369. * Add the required samplers to the current list.
  58370. * @param samplers defines the current sampler list.
  58371. */
  58372. static AddSamplers(samplers: string[]): void;
  58373. /**
  58374. * Makes a duplicate of the current configuration into another one.
  58375. * @param sheenConfiguration define the config where to copy the info
  58376. */
  58377. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58378. /**
  58379. * Serializes this BRDF configuration.
  58380. * @returns - An object with the serialized config.
  58381. */
  58382. serialize(): any;
  58383. /**
  58384. * Parses a anisotropy Configuration from a serialized object.
  58385. * @param source - Serialized object.
  58386. * @param scene Defines the scene we are parsing for
  58387. * @param rootUrl Defines the rootUrl to load from
  58388. */
  58389. parse(source: any, scene: Scene, rootUrl: string): void;
  58390. }
  58391. }
  58392. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58393. import { Nullable } from "babylonjs/types";
  58394. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58395. import { Color3 } from "babylonjs/Maths/math.color";
  58396. import { SmartArray } from "babylonjs/Misc/smartArray";
  58397. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58398. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58399. import { Effect } from "babylonjs/Materials/effect";
  58400. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58401. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58402. import { Engine } from "babylonjs/Engines/engine";
  58403. import { Scene } from "babylonjs/scene";
  58404. /**
  58405. * @hidden
  58406. */
  58407. export interface IMaterialSubSurfaceDefines {
  58408. SUBSURFACE: boolean;
  58409. SS_REFRACTION: boolean;
  58410. SS_TRANSLUCENCY: boolean;
  58411. SS_SCATTERING: boolean;
  58412. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58413. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58414. SS_REFRACTIONMAP_3D: boolean;
  58415. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58416. SS_LODINREFRACTIONALPHA: boolean;
  58417. SS_GAMMAREFRACTION: boolean;
  58418. SS_RGBDREFRACTION: boolean;
  58419. SS_LINEARSPECULARREFRACTION: boolean;
  58420. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58421. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58422. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58423. /** @hidden */
  58424. _areTexturesDirty: boolean;
  58425. }
  58426. /**
  58427. * Define the code related to the sub surface parameters of the pbr material.
  58428. */
  58429. export class PBRSubSurfaceConfiguration {
  58430. private _isRefractionEnabled;
  58431. /**
  58432. * Defines if the refraction is enabled in the material.
  58433. */
  58434. isRefractionEnabled: boolean;
  58435. private _isTranslucencyEnabled;
  58436. /**
  58437. * Defines if the translucency is enabled in the material.
  58438. */
  58439. isTranslucencyEnabled: boolean;
  58440. private _isScatteringEnabled;
  58441. /**
  58442. * Defines if the sub surface scattering is enabled in the material.
  58443. */
  58444. isScatteringEnabled: boolean;
  58445. private _scatteringDiffusionProfileIndex;
  58446. /**
  58447. * Diffusion profile for subsurface scattering.
  58448. * Useful for better scattering in the skins or foliages.
  58449. */
  58450. get scatteringDiffusionProfile(): Nullable<Color3>;
  58451. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58452. /**
  58453. * Defines the refraction intensity of the material.
  58454. * The refraction when enabled replaces the Diffuse part of the material.
  58455. * The intensity helps transitionning between diffuse and refraction.
  58456. */
  58457. refractionIntensity: number;
  58458. /**
  58459. * Defines the translucency intensity of the material.
  58460. * When translucency has been enabled, this defines how much of the "translucency"
  58461. * is addded to the diffuse part of the material.
  58462. */
  58463. translucencyIntensity: number;
  58464. /**
  58465. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58466. */
  58467. useAlbedoToTintRefraction: boolean;
  58468. private _thicknessTexture;
  58469. /**
  58470. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58471. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58472. * 0 would mean minimumThickness
  58473. * 1 would mean maximumThickness
  58474. * The other channels might be use as a mask to vary the different effects intensity.
  58475. */
  58476. thicknessTexture: Nullable<BaseTexture>;
  58477. private _refractionTexture;
  58478. /**
  58479. * Defines the texture to use for refraction.
  58480. */
  58481. refractionTexture: Nullable<BaseTexture>;
  58482. private _indexOfRefraction;
  58483. /**
  58484. * Index of refraction of the material base layer.
  58485. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58486. *
  58487. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58488. *
  58489. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58490. */
  58491. indexOfRefraction: number;
  58492. private _volumeIndexOfRefraction;
  58493. /**
  58494. * Index of refraction of the material's volume.
  58495. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58496. *
  58497. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58498. * the volume will use the same IOR as the surface.
  58499. */
  58500. get volumeIndexOfRefraction(): number;
  58501. set volumeIndexOfRefraction(value: number);
  58502. private _invertRefractionY;
  58503. /**
  58504. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58505. */
  58506. invertRefractionY: boolean;
  58507. private _linkRefractionWithTransparency;
  58508. /**
  58509. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58510. * Materials half opaque for instance using refraction could benefit from this control.
  58511. */
  58512. linkRefractionWithTransparency: boolean;
  58513. /**
  58514. * Defines the minimum thickness stored in the thickness map.
  58515. * If no thickness map is defined, this value will be used to simulate thickness.
  58516. */
  58517. minimumThickness: number;
  58518. /**
  58519. * Defines the maximum thickness stored in the thickness map.
  58520. */
  58521. maximumThickness: number;
  58522. /**
  58523. * Defines the volume tint of the material.
  58524. * This is used for both translucency and scattering.
  58525. */
  58526. tintColor: Color3;
  58527. /**
  58528. * Defines the distance at which the tint color should be found in the media.
  58529. * This is used for refraction only.
  58530. */
  58531. tintColorAtDistance: number;
  58532. /**
  58533. * Defines how far each channel transmit through the media.
  58534. * It is defined as a color to simplify it selection.
  58535. */
  58536. diffusionDistance: Color3;
  58537. private _useMaskFromThicknessTexture;
  58538. /**
  58539. * Stores the intensity of the different subsurface effects in the thickness texture.
  58540. * * the green channel is the translucency intensity.
  58541. * * the blue channel is the scattering intensity.
  58542. * * the alpha channel is the refraction intensity.
  58543. */
  58544. useMaskFromThicknessTexture: boolean;
  58545. private _scene;
  58546. /** @hidden */
  58547. private _internalMarkAllSubMeshesAsTexturesDirty;
  58548. private _internalMarkScenePrePassDirty;
  58549. /** @hidden */
  58550. _markAllSubMeshesAsTexturesDirty(): void;
  58551. /** @hidden */
  58552. _markScenePrePassDirty(): void;
  58553. /**
  58554. * Instantiate a new istance of sub surface configuration.
  58555. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58556. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58557. * @param scene The scene
  58558. */
  58559. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58560. /**
  58561. * Gets wehter the submesh is ready to be used or not.
  58562. * @param defines the list of "defines" to update.
  58563. * @param scene defines the scene the material belongs to.
  58564. * @returns - boolean indicating that the submesh is ready or not.
  58565. */
  58566. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58567. /**
  58568. * Checks to see if a texture is used in the material.
  58569. * @param defines the list of "defines" to update.
  58570. * @param scene defines the scene to the material belongs to.
  58571. */
  58572. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58573. /**
  58574. * Binds the material data.
  58575. * @param uniformBuffer defines the Uniform buffer to fill in.
  58576. * @param scene defines the scene the material belongs to.
  58577. * @param engine defines the engine the material belongs to.
  58578. * @param isFrozen defines whether the material is frozen or not.
  58579. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58580. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58581. */
  58582. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58583. /**
  58584. * Unbinds the material from the mesh.
  58585. * @param activeEffect defines the effect that should be unbound from.
  58586. * @returns true if unbound, otherwise false
  58587. */
  58588. unbind(activeEffect: Effect): boolean;
  58589. /**
  58590. * Returns the texture used for refraction or null if none is used.
  58591. * @param scene defines the scene the material belongs to.
  58592. * @returns - Refraction texture if present. If no refraction texture and refraction
  58593. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58594. */
  58595. private _getRefractionTexture;
  58596. /**
  58597. * Returns true if alpha blending should be disabled.
  58598. */
  58599. get disableAlphaBlending(): boolean;
  58600. /**
  58601. * Fills the list of render target textures.
  58602. * @param renderTargets the list of render targets to update
  58603. */
  58604. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58605. /**
  58606. * Checks to see if a texture is used in the material.
  58607. * @param texture - Base texture to use.
  58608. * @returns - Boolean specifying if a texture is used in the material.
  58609. */
  58610. hasTexture(texture: BaseTexture): boolean;
  58611. /**
  58612. * Gets a boolean indicating that current material needs to register RTT
  58613. * @returns true if this uses a render target otherwise false.
  58614. */
  58615. hasRenderTargetTextures(): boolean;
  58616. /**
  58617. * Returns an array of the actively used textures.
  58618. * @param activeTextures Array of BaseTextures
  58619. */
  58620. getActiveTextures(activeTextures: BaseTexture[]): void;
  58621. /**
  58622. * Returns the animatable textures.
  58623. * @param animatables Array of animatable textures.
  58624. */
  58625. getAnimatables(animatables: IAnimatable[]): void;
  58626. /**
  58627. * Disposes the resources of the material.
  58628. * @param forceDisposeTextures - Forces the disposal of all textures.
  58629. */
  58630. dispose(forceDisposeTextures?: boolean): void;
  58631. /**
  58632. * Get the current class name of the texture useful for serialization or dynamic coding.
  58633. * @returns "PBRSubSurfaceConfiguration"
  58634. */
  58635. getClassName(): string;
  58636. /**
  58637. * Add fallbacks to the effect fallbacks list.
  58638. * @param defines defines the Base texture to use.
  58639. * @param fallbacks defines the current fallback list.
  58640. * @param currentRank defines the current fallback rank.
  58641. * @returns the new fallback rank.
  58642. */
  58643. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58644. /**
  58645. * Add the required uniforms to the current list.
  58646. * @param uniforms defines the current uniform list.
  58647. */
  58648. static AddUniforms(uniforms: string[]): void;
  58649. /**
  58650. * Add the required samplers to the current list.
  58651. * @param samplers defines the current sampler list.
  58652. */
  58653. static AddSamplers(samplers: string[]): void;
  58654. /**
  58655. * Add the required uniforms to the current buffer.
  58656. * @param uniformBuffer defines the current uniform buffer.
  58657. */
  58658. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58659. /**
  58660. * Makes a duplicate of the current configuration into another one.
  58661. * @param configuration define the config where to copy the info
  58662. */
  58663. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58664. /**
  58665. * Serializes this Sub Surface configuration.
  58666. * @returns - An object with the serialized config.
  58667. */
  58668. serialize(): any;
  58669. /**
  58670. * Parses a anisotropy Configuration from a serialized object.
  58671. * @param source - Serialized object.
  58672. * @param scene Defines the scene we are parsing for
  58673. * @param rootUrl Defines the rootUrl to load from
  58674. */
  58675. parse(source: any, scene: Scene, rootUrl: string): void;
  58676. }
  58677. }
  58678. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58679. /** @hidden */
  58680. export var pbrFragmentDeclaration: {
  58681. name: string;
  58682. shader: string;
  58683. };
  58684. }
  58685. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58686. /** @hidden */
  58687. export var pbrUboDeclaration: {
  58688. name: string;
  58689. shader: string;
  58690. };
  58691. }
  58692. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58693. /** @hidden */
  58694. export var pbrFragmentExtraDeclaration: {
  58695. name: string;
  58696. shader: string;
  58697. };
  58698. }
  58699. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58700. /** @hidden */
  58701. export var pbrFragmentSamplersDeclaration: {
  58702. name: string;
  58703. shader: string;
  58704. };
  58705. }
  58706. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  58707. /** @hidden */
  58708. export var subSurfaceScatteringFunctions: {
  58709. name: string;
  58710. shader: string;
  58711. };
  58712. }
  58713. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58714. /** @hidden */
  58715. export var importanceSampling: {
  58716. name: string;
  58717. shader: string;
  58718. };
  58719. }
  58720. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58721. /** @hidden */
  58722. export var pbrHelperFunctions: {
  58723. name: string;
  58724. shader: string;
  58725. };
  58726. }
  58727. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58728. /** @hidden */
  58729. export var harmonicsFunctions: {
  58730. name: string;
  58731. shader: string;
  58732. };
  58733. }
  58734. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58735. /** @hidden */
  58736. export var pbrDirectLightingSetupFunctions: {
  58737. name: string;
  58738. shader: string;
  58739. };
  58740. }
  58741. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58742. /** @hidden */
  58743. export var pbrDirectLightingFalloffFunctions: {
  58744. name: string;
  58745. shader: string;
  58746. };
  58747. }
  58748. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58749. /** @hidden */
  58750. export var pbrBRDFFunctions: {
  58751. name: string;
  58752. shader: string;
  58753. };
  58754. }
  58755. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58756. /** @hidden */
  58757. export var hdrFilteringFunctions: {
  58758. name: string;
  58759. shader: string;
  58760. };
  58761. }
  58762. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58763. /** @hidden */
  58764. export var pbrDirectLightingFunctions: {
  58765. name: string;
  58766. shader: string;
  58767. };
  58768. }
  58769. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58770. /** @hidden */
  58771. export var pbrIBLFunctions: {
  58772. name: string;
  58773. shader: string;
  58774. };
  58775. }
  58776. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58777. /** @hidden */
  58778. export var pbrBlockAlbedoOpacity: {
  58779. name: string;
  58780. shader: string;
  58781. };
  58782. }
  58783. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58784. /** @hidden */
  58785. export var pbrBlockReflectivity: {
  58786. name: string;
  58787. shader: string;
  58788. };
  58789. }
  58790. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58791. /** @hidden */
  58792. export var pbrBlockAmbientOcclusion: {
  58793. name: string;
  58794. shader: string;
  58795. };
  58796. }
  58797. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58798. /** @hidden */
  58799. export var pbrBlockAlphaFresnel: {
  58800. name: string;
  58801. shader: string;
  58802. };
  58803. }
  58804. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58805. /** @hidden */
  58806. export var pbrBlockAnisotropic: {
  58807. name: string;
  58808. shader: string;
  58809. };
  58810. }
  58811. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58812. /** @hidden */
  58813. export var pbrBlockReflection: {
  58814. name: string;
  58815. shader: string;
  58816. };
  58817. }
  58818. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58819. /** @hidden */
  58820. export var pbrBlockSheen: {
  58821. name: string;
  58822. shader: string;
  58823. };
  58824. }
  58825. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58826. /** @hidden */
  58827. export var pbrBlockClearcoat: {
  58828. name: string;
  58829. shader: string;
  58830. };
  58831. }
  58832. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58833. /** @hidden */
  58834. export var pbrBlockSubSurface: {
  58835. name: string;
  58836. shader: string;
  58837. };
  58838. }
  58839. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58840. /** @hidden */
  58841. export var pbrBlockNormalGeometric: {
  58842. name: string;
  58843. shader: string;
  58844. };
  58845. }
  58846. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58847. /** @hidden */
  58848. export var pbrBlockNormalFinal: {
  58849. name: string;
  58850. shader: string;
  58851. };
  58852. }
  58853. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58854. /** @hidden */
  58855. export var pbrBlockLightmapInit: {
  58856. name: string;
  58857. shader: string;
  58858. };
  58859. }
  58860. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58861. /** @hidden */
  58862. export var pbrBlockGeometryInfo: {
  58863. name: string;
  58864. shader: string;
  58865. };
  58866. }
  58867. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58868. /** @hidden */
  58869. export var pbrBlockReflectance0: {
  58870. name: string;
  58871. shader: string;
  58872. };
  58873. }
  58874. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58875. /** @hidden */
  58876. export var pbrBlockReflectance: {
  58877. name: string;
  58878. shader: string;
  58879. };
  58880. }
  58881. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58882. /** @hidden */
  58883. export var pbrBlockDirectLighting: {
  58884. name: string;
  58885. shader: string;
  58886. };
  58887. }
  58888. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58889. /** @hidden */
  58890. export var pbrBlockFinalLitComponents: {
  58891. name: string;
  58892. shader: string;
  58893. };
  58894. }
  58895. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58896. /** @hidden */
  58897. export var pbrBlockFinalUnlitComponents: {
  58898. name: string;
  58899. shader: string;
  58900. };
  58901. }
  58902. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58903. /** @hidden */
  58904. export var pbrBlockFinalColorComposition: {
  58905. name: string;
  58906. shader: string;
  58907. };
  58908. }
  58909. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58910. /** @hidden */
  58911. export var pbrBlockImageProcessing: {
  58912. name: string;
  58913. shader: string;
  58914. };
  58915. }
  58916. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58917. /** @hidden */
  58918. export var pbrDebug: {
  58919. name: string;
  58920. shader: string;
  58921. };
  58922. }
  58923. declare module "babylonjs/Shaders/pbr.fragment" {
  58924. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58925. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58926. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58927. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58928. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58929. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58930. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58931. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58932. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58933. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58934. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58935. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58936. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58937. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58938. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58939. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58940. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58941. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58942. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58943. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58944. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58945. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58946. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58947. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58948. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58949. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58950. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58951. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58952. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58953. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58954. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58955. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58956. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58957. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58958. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58959. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58960. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58961. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58962. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58963. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58964. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58965. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58966. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58967. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58968. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58969. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58970. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58971. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58972. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58973. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58974. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58975. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58976. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58977. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58978. /** @hidden */
  58979. export var pbrPixelShader: {
  58980. name: string;
  58981. shader: string;
  58982. };
  58983. }
  58984. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58985. /** @hidden */
  58986. export var pbrVertexDeclaration: {
  58987. name: string;
  58988. shader: string;
  58989. };
  58990. }
  58991. declare module "babylonjs/Shaders/pbr.vertex" {
  58992. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58993. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58994. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58995. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58996. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58997. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58998. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58999. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  59000. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  59001. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  59002. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  59003. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  59004. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  59005. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  59006. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  59007. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  59008. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  59009. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  59010. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  59011. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  59012. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  59013. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  59014. /** @hidden */
  59015. export var pbrVertexShader: {
  59016. name: string;
  59017. shader: string;
  59018. };
  59019. }
  59020. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  59021. import { Nullable } from "babylonjs/types";
  59022. import { Scene } from "babylonjs/scene";
  59023. import { Matrix } from "babylonjs/Maths/math.vector";
  59024. import { SubMesh } from "babylonjs/Meshes/subMesh";
  59025. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59026. import { Mesh } from "babylonjs/Meshes/mesh";
  59027. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  59028. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  59029. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  59030. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  59031. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  59032. import { Color3 } from "babylonjs/Maths/math.color";
  59033. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  59034. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  59035. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  59036. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  59037. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59038. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  59039. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  59040. import "babylonjs/Shaders/pbr.fragment";
  59041. import "babylonjs/Shaders/pbr.vertex";
  59042. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  59043. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  59044. /**
  59045. * Manages the defines for the PBR Material.
  59046. * @hidden
  59047. */
  59048. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  59049. PBR: boolean;
  59050. NUM_SAMPLES: string;
  59051. REALTIME_FILTERING: boolean;
  59052. MAINUV1: boolean;
  59053. MAINUV2: boolean;
  59054. UV1: boolean;
  59055. UV2: boolean;
  59056. ALBEDO: boolean;
  59057. GAMMAALBEDO: boolean;
  59058. ALBEDODIRECTUV: number;
  59059. VERTEXCOLOR: boolean;
  59060. DETAIL: boolean;
  59061. DETAILDIRECTUV: number;
  59062. DETAIL_NORMALBLENDMETHOD: number;
  59063. AMBIENT: boolean;
  59064. AMBIENTDIRECTUV: number;
  59065. AMBIENTINGRAYSCALE: boolean;
  59066. OPACITY: boolean;
  59067. VERTEXALPHA: boolean;
  59068. OPACITYDIRECTUV: number;
  59069. OPACITYRGB: boolean;
  59070. ALPHATEST: boolean;
  59071. DEPTHPREPASS: boolean;
  59072. ALPHABLEND: boolean;
  59073. ALPHAFROMALBEDO: boolean;
  59074. ALPHATESTVALUE: string;
  59075. SPECULAROVERALPHA: boolean;
  59076. RADIANCEOVERALPHA: boolean;
  59077. ALPHAFRESNEL: boolean;
  59078. LINEARALPHAFRESNEL: boolean;
  59079. PREMULTIPLYALPHA: boolean;
  59080. EMISSIVE: boolean;
  59081. EMISSIVEDIRECTUV: number;
  59082. REFLECTIVITY: boolean;
  59083. REFLECTIVITYDIRECTUV: number;
  59084. SPECULARTERM: boolean;
  59085. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  59086. MICROSURFACEAUTOMATIC: boolean;
  59087. LODBASEDMICROSFURACE: boolean;
  59088. MICROSURFACEMAP: boolean;
  59089. MICROSURFACEMAPDIRECTUV: number;
  59090. METALLICWORKFLOW: boolean;
  59091. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  59092. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  59093. METALLNESSSTOREINMETALMAPBLUE: boolean;
  59094. AOSTOREINMETALMAPRED: boolean;
  59095. METALLIC_REFLECTANCE: boolean;
  59096. METALLIC_REFLECTANCEDIRECTUV: number;
  59097. ENVIRONMENTBRDF: boolean;
  59098. ENVIRONMENTBRDF_RGBD: boolean;
  59099. NORMAL: boolean;
  59100. TANGENT: boolean;
  59101. BUMP: boolean;
  59102. BUMPDIRECTUV: number;
  59103. OBJECTSPACE_NORMALMAP: boolean;
  59104. PARALLAX: boolean;
  59105. PARALLAXOCCLUSION: boolean;
  59106. NORMALXYSCALE: boolean;
  59107. LIGHTMAP: boolean;
  59108. LIGHTMAPDIRECTUV: number;
  59109. USELIGHTMAPASSHADOWMAP: boolean;
  59110. GAMMALIGHTMAP: boolean;
  59111. RGBDLIGHTMAP: boolean;
  59112. REFLECTION: boolean;
  59113. REFLECTIONMAP_3D: boolean;
  59114. REFLECTIONMAP_SPHERICAL: boolean;
  59115. REFLECTIONMAP_PLANAR: boolean;
  59116. REFLECTIONMAP_CUBIC: boolean;
  59117. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  59118. REFLECTIONMAP_PROJECTION: boolean;
  59119. REFLECTIONMAP_SKYBOX: boolean;
  59120. REFLECTIONMAP_EXPLICIT: boolean;
  59121. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  59122. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  59123. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  59124. INVERTCUBICMAP: boolean;
  59125. USESPHERICALFROMREFLECTIONMAP: boolean;
  59126. USEIRRADIANCEMAP: boolean;
  59127. SPHERICAL_HARMONICS: boolean;
  59128. USESPHERICALINVERTEX: boolean;
  59129. REFLECTIONMAP_OPPOSITEZ: boolean;
  59130. LODINREFLECTIONALPHA: boolean;
  59131. GAMMAREFLECTION: boolean;
  59132. RGBDREFLECTION: boolean;
  59133. LINEARSPECULARREFLECTION: boolean;
  59134. RADIANCEOCCLUSION: boolean;
  59135. HORIZONOCCLUSION: boolean;
  59136. INSTANCES: boolean;
  59137. THIN_INSTANCES: boolean;
  59138. PREPASS: boolean;
  59139. PREPASS_IRRADIANCE: boolean;
  59140. PREPASS_IRRADIANCE_INDEX: number;
  59141. PREPASS_ALBEDO: boolean;
  59142. PREPASS_ALBEDO_INDEX: number;
  59143. PREPASS_DEPTHNORMAL: boolean;
  59144. PREPASS_DEPTHNORMAL_INDEX: number;
  59145. SCENE_MRT_COUNT: number;
  59146. NUM_BONE_INFLUENCERS: number;
  59147. BonesPerMesh: number;
  59148. BONETEXTURE: boolean;
  59149. NONUNIFORMSCALING: boolean;
  59150. MORPHTARGETS: boolean;
  59151. MORPHTARGETS_NORMAL: boolean;
  59152. MORPHTARGETS_TANGENT: boolean;
  59153. MORPHTARGETS_UV: boolean;
  59154. NUM_MORPH_INFLUENCERS: number;
  59155. IMAGEPROCESSING: boolean;
  59156. VIGNETTE: boolean;
  59157. VIGNETTEBLENDMODEMULTIPLY: boolean;
  59158. VIGNETTEBLENDMODEOPAQUE: boolean;
  59159. TONEMAPPING: boolean;
  59160. TONEMAPPING_ACES: boolean;
  59161. CONTRAST: boolean;
  59162. COLORCURVES: boolean;
  59163. COLORGRADING: boolean;
  59164. COLORGRADING3D: boolean;
  59165. SAMPLER3DGREENDEPTH: boolean;
  59166. SAMPLER3DBGRMAP: boolean;
  59167. IMAGEPROCESSINGPOSTPROCESS: boolean;
  59168. EXPOSURE: boolean;
  59169. MULTIVIEW: boolean;
  59170. USEPHYSICALLIGHTFALLOFF: boolean;
  59171. USEGLTFLIGHTFALLOFF: boolean;
  59172. TWOSIDEDLIGHTING: boolean;
  59173. SHADOWFLOAT: boolean;
  59174. CLIPPLANE: boolean;
  59175. CLIPPLANE2: boolean;
  59176. CLIPPLANE3: boolean;
  59177. CLIPPLANE4: boolean;
  59178. CLIPPLANE5: boolean;
  59179. CLIPPLANE6: boolean;
  59180. POINTSIZE: boolean;
  59181. FOG: boolean;
  59182. LOGARITHMICDEPTH: boolean;
  59183. FORCENORMALFORWARD: boolean;
  59184. SPECULARAA: boolean;
  59185. CLEARCOAT: boolean;
  59186. CLEARCOAT_DEFAULTIOR: boolean;
  59187. CLEARCOAT_TEXTURE: boolean;
  59188. CLEARCOAT_TEXTUREDIRECTUV: number;
  59189. CLEARCOAT_BUMP: boolean;
  59190. CLEARCOAT_BUMPDIRECTUV: number;
  59191. CLEARCOAT_TINT: boolean;
  59192. CLEARCOAT_TINT_TEXTURE: boolean;
  59193. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  59194. ANISOTROPIC: boolean;
  59195. ANISOTROPIC_TEXTURE: boolean;
  59196. ANISOTROPIC_TEXTUREDIRECTUV: number;
  59197. BRDF_V_HEIGHT_CORRELATED: boolean;
  59198. MS_BRDF_ENERGY_CONSERVATION: boolean;
  59199. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  59200. SHEEN: boolean;
  59201. SHEEN_TEXTURE: boolean;
  59202. SHEEN_TEXTUREDIRECTUV: number;
  59203. SHEEN_LINKWITHALBEDO: boolean;
  59204. SHEEN_ROUGHNESS: boolean;
  59205. SHEEN_ALBEDOSCALING: boolean;
  59206. SUBSURFACE: boolean;
  59207. SS_REFRACTION: boolean;
  59208. SS_TRANSLUCENCY: boolean;
  59209. SS_SCATTERING: boolean;
  59210. SS_THICKNESSANDMASK_TEXTURE: boolean;
  59211. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  59212. SS_REFRACTIONMAP_3D: boolean;
  59213. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  59214. SS_LODINREFRACTIONALPHA: boolean;
  59215. SS_GAMMAREFRACTION: boolean;
  59216. SS_RGBDREFRACTION: boolean;
  59217. SS_LINEARSPECULARREFRACTION: boolean;
  59218. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  59219. SS_ALBEDOFORREFRACTIONTINT: boolean;
  59220. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  59221. UNLIT: boolean;
  59222. DEBUGMODE: number;
  59223. /**
  59224. * Initializes the PBR Material defines.
  59225. */
  59226. constructor();
  59227. /**
  59228. * Resets the PBR Material defines.
  59229. */
  59230. reset(): void;
  59231. }
  59232. /**
  59233. * The Physically based material base class of BJS.
  59234. *
  59235. * This offers the main features of a standard PBR material.
  59236. * For more information, please refer to the documentation :
  59237. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59238. */
  59239. export abstract class PBRBaseMaterial extends PushMaterial {
  59240. /**
  59241. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59242. */
  59243. static readonly PBRMATERIAL_OPAQUE: number;
  59244. /**
  59245. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59246. */
  59247. static readonly PBRMATERIAL_ALPHATEST: number;
  59248. /**
  59249. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59250. */
  59251. static readonly PBRMATERIAL_ALPHABLEND: number;
  59252. /**
  59253. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59254. * They are also discarded below the alpha cutoff threshold to improve performances.
  59255. */
  59256. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59257. /**
  59258. * Defines the default value of how much AO map is occluding the analytical lights
  59259. * (point spot...).
  59260. */
  59261. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59262. /**
  59263. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  59264. */
  59265. static readonly LIGHTFALLOFF_PHYSICAL: number;
  59266. /**
  59267. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  59268. * to enhance interoperability with other engines.
  59269. */
  59270. static readonly LIGHTFALLOFF_GLTF: number;
  59271. /**
  59272. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  59273. * to enhance interoperability with other materials.
  59274. */
  59275. static readonly LIGHTFALLOFF_STANDARD: number;
  59276. /**
  59277. * Intensity of the direct lights e.g. the four lights available in your scene.
  59278. * This impacts both the direct diffuse and specular highlights.
  59279. */
  59280. protected _directIntensity: number;
  59281. /**
  59282. * Intensity of the emissive part of the material.
  59283. * This helps controlling the emissive effect without modifying the emissive color.
  59284. */
  59285. protected _emissiveIntensity: number;
  59286. /**
  59287. * Intensity of the environment e.g. how much the environment will light the object
  59288. * either through harmonics for rough material or through the refelction for shiny ones.
  59289. */
  59290. protected _environmentIntensity: number;
  59291. /**
  59292. * This is a special control allowing the reduction of the specular highlights coming from the
  59293. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59294. */
  59295. protected _specularIntensity: number;
  59296. /**
  59297. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59298. */
  59299. private _lightingInfos;
  59300. /**
  59301. * Debug Control allowing disabling the bump map on this material.
  59302. */
  59303. protected _disableBumpMap: boolean;
  59304. /**
  59305. * AKA Diffuse Texture in standard nomenclature.
  59306. */
  59307. protected _albedoTexture: Nullable<BaseTexture>;
  59308. /**
  59309. * AKA Occlusion Texture in other nomenclature.
  59310. */
  59311. protected _ambientTexture: Nullable<BaseTexture>;
  59312. /**
  59313. * AKA Occlusion Texture Intensity in other nomenclature.
  59314. */
  59315. protected _ambientTextureStrength: number;
  59316. /**
  59317. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59318. * 1 means it completely occludes it
  59319. * 0 mean it has no impact
  59320. */
  59321. protected _ambientTextureImpactOnAnalyticalLights: number;
  59322. /**
  59323. * Stores the alpha values in a texture.
  59324. */
  59325. protected _opacityTexture: Nullable<BaseTexture>;
  59326. /**
  59327. * Stores the reflection values in a texture.
  59328. */
  59329. protected _reflectionTexture: Nullable<BaseTexture>;
  59330. /**
  59331. * Stores the emissive values in a texture.
  59332. */
  59333. protected _emissiveTexture: Nullable<BaseTexture>;
  59334. /**
  59335. * AKA Specular texture in other nomenclature.
  59336. */
  59337. protected _reflectivityTexture: Nullable<BaseTexture>;
  59338. /**
  59339. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59340. */
  59341. protected _metallicTexture: Nullable<BaseTexture>;
  59342. /**
  59343. * Specifies the metallic scalar of the metallic/roughness workflow.
  59344. * Can also be used to scale the metalness values of the metallic texture.
  59345. */
  59346. protected _metallic: Nullable<number>;
  59347. /**
  59348. * Specifies the roughness scalar of the metallic/roughness workflow.
  59349. * Can also be used to scale the roughness values of the metallic texture.
  59350. */
  59351. protected _roughness: Nullable<number>;
  59352. /**
  59353. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59354. * By default the indexOfrefraction is used to compute F0;
  59355. *
  59356. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59357. *
  59358. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59359. * F90 = metallicReflectanceColor;
  59360. */
  59361. protected _metallicF0Factor: number;
  59362. /**
  59363. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59364. * By default the F90 is always 1;
  59365. *
  59366. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59367. *
  59368. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59369. * F90 = metallicReflectanceColor;
  59370. */
  59371. protected _metallicReflectanceColor: Color3;
  59372. /**
  59373. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59374. * This is multiply against the scalar values defined in the material.
  59375. */
  59376. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59377. /**
  59378. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59379. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59380. */
  59381. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59382. /**
  59383. * Stores surface normal data used to displace a mesh in a texture.
  59384. */
  59385. protected _bumpTexture: Nullable<BaseTexture>;
  59386. /**
  59387. * Stores the pre-calculated light information of a mesh in a texture.
  59388. */
  59389. protected _lightmapTexture: Nullable<BaseTexture>;
  59390. /**
  59391. * The color of a material in ambient lighting.
  59392. */
  59393. protected _ambientColor: Color3;
  59394. /**
  59395. * AKA Diffuse Color in other nomenclature.
  59396. */
  59397. protected _albedoColor: Color3;
  59398. /**
  59399. * AKA Specular Color in other nomenclature.
  59400. */
  59401. protected _reflectivityColor: Color3;
  59402. /**
  59403. * The color applied when light is reflected from a material.
  59404. */
  59405. protected _reflectionColor: Color3;
  59406. /**
  59407. * The color applied when light is emitted from a material.
  59408. */
  59409. protected _emissiveColor: Color3;
  59410. /**
  59411. * AKA Glossiness in other nomenclature.
  59412. */
  59413. protected _microSurface: number;
  59414. /**
  59415. * Specifies that the material will use the light map as a show map.
  59416. */
  59417. protected _useLightmapAsShadowmap: boolean;
  59418. /**
  59419. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59420. * makes the reflect vector face the model (under horizon).
  59421. */
  59422. protected _useHorizonOcclusion: boolean;
  59423. /**
  59424. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59425. * too much the area relying on ambient texture to define their ambient occlusion.
  59426. */
  59427. protected _useRadianceOcclusion: boolean;
  59428. /**
  59429. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59430. */
  59431. protected _useAlphaFromAlbedoTexture: boolean;
  59432. /**
  59433. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59434. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59435. */
  59436. protected _useSpecularOverAlpha: boolean;
  59437. /**
  59438. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59439. */
  59440. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59441. /**
  59442. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59443. */
  59444. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59445. /**
  59446. * Specifies if the metallic texture contains the roughness information in its green channel.
  59447. */
  59448. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59449. /**
  59450. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59451. */
  59452. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59453. /**
  59454. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59455. */
  59456. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59457. /**
  59458. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59459. */
  59460. protected _useAmbientInGrayScale: boolean;
  59461. /**
  59462. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59463. * The material will try to infer what glossiness each pixel should be.
  59464. */
  59465. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59466. /**
  59467. * Defines the falloff type used in this material.
  59468. * It by default is Physical.
  59469. */
  59470. protected _lightFalloff: number;
  59471. /**
  59472. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59473. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59474. */
  59475. protected _useRadianceOverAlpha: boolean;
  59476. /**
  59477. * Allows using an object space normal map (instead of tangent space).
  59478. */
  59479. protected _useObjectSpaceNormalMap: boolean;
  59480. /**
  59481. * Allows using the bump map in parallax mode.
  59482. */
  59483. protected _useParallax: boolean;
  59484. /**
  59485. * Allows using the bump map in parallax occlusion mode.
  59486. */
  59487. protected _useParallaxOcclusion: boolean;
  59488. /**
  59489. * Controls the scale bias of the parallax mode.
  59490. */
  59491. protected _parallaxScaleBias: number;
  59492. /**
  59493. * If sets to true, disables all the lights affecting the material.
  59494. */
  59495. protected _disableLighting: boolean;
  59496. /**
  59497. * Number of Simultaneous lights allowed on the material.
  59498. */
  59499. protected _maxSimultaneousLights: number;
  59500. /**
  59501. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59502. */
  59503. protected _invertNormalMapX: boolean;
  59504. /**
  59505. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59506. */
  59507. protected _invertNormalMapY: boolean;
  59508. /**
  59509. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59510. */
  59511. protected _twoSidedLighting: boolean;
  59512. /**
  59513. * Defines the alpha limits in alpha test mode.
  59514. */
  59515. protected _alphaCutOff: number;
  59516. /**
  59517. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59518. */
  59519. protected _forceAlphaTest: boolean;
  59520. /**
  59521. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59522. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59523. */
  59524. protected _useAlphaFresnel: boolean;
  59525. /**
  59526. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59527. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59528. */
  59529. protected _useLinearAlphaFresnel: boolean;
  59530. /**
  59531. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59532. * from cos thetav and roughness:
  59533. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59534. */
  59535. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59536. /**
  59537. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59538. */
  59539. protected _forceIrradianceInFragment: boolean;
  59540. private _realTimeFiltering;
  59541. /**
  59542. * Enables realtime filtering on the texture.
  59543. */
  59544. get realTimeFiltering(): boolean;
  59545. set realTimeFiltering(b: boolean);
  59546. private _realTimeFilteringQuality;
  59547. /**
  59548. * Quality switch for realtime filtering
  59549. */
  59550. get realTimeFilteringQuality(): number;
  59551. set realTimeFilteringQuality(n: number);
  59552. /**
  59553. * Can this material render to several textures at once
  59554. */
  59555. get canRenderToMRT(): boolean;
  59556. /**
  59557. * Force normal to face away from face.
  59558. */
  59559. protected _forceNormalForward: boolean;
  59560. /**
  59561. * Enables specular anti aliasing in the PBR shader.
  59562. * It will both interacts on the Geometry for analytical and IBL lighting.
  59563. * It also prefilter the roughness map based on the bump values.
  59564. */
  59565. protected _enableSpecularAntiAliasing: boolean;
  59566. /**
  59567. * Default configuration related to image processing available in the PBR Material.
  59568. */
  59569. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59570. /**
  59571. * Keep track of the image processing observer to allow dispose and replace.
  59572. */
  59573. private _imageProcessingObserver;
  59574. /**
  59575. * Attaches a new image processing configuration to the PBR Material.
  59576. * @param configuration
  59577. */
  59578. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59579. /**
  59580. * Stores the available render targets.
  59581. */
  59582. private _renderTargets;
  59583. /**
  59584. * Sets the global ambient color for the material used in lighting calculations.
  59585. */
  59586. private _globalAmbientColor;
  59587. /**
  59588. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59589. */
  59590. private _useLogarithmicDepth;
  59591. /**
  59592. * If set to true, no lighting calculations will be applied.
  59593. */
  59594. private _unlit;
  59595. private _debugMode;
  59596. /**
  59597. * @hidden
  59598. * This is reserved for the inspector.
  59599. * Defines the material debug mode.
  59600. * It helps seeing only some components of the material while troubleshooting.
  59601. */
  59602. debugMode: number;
  59603. /**
  59604. * @hidden
  59605. * This is reserved for the inspector.
  59606. * Specify from where on screen the debug mode should start.
  59607. * The value goes from -1 (full screen) to 1 (not visible)
  59608. * It helps with side by side comparison against the final render
  59609. * This defaults to -1
  59610. */
  59611. private debugLimit;
  59612. /**
  59613. * @hidden
  59614. * This is reserved for the inspector.
  59615. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59616. * You can use the factor to better multiply the final value.
  59617. */
  59618. private debugFactor;
  59619. /**
  59620. * Defines the clear coat layer parameters for the material.
  59621. */
  59622. readonly clearCoat: PBRClearCoatConfiguration;
  59623. /**
  59624. * Defines the anisotropic parameters for the material.
  59625. */
  59626. readonly anisotropy: PBRAnisotropicConfiguration;
  59627. /**
  59628. * Defines the BRDF parameters for the material.
  59629. */
  59630. readonly brdf: PBRBRDFConfiguration;
  59631. /**
  59632. * Defines the Sheen parameters for the material.
  59633. */
  59634. readonly sheen: PBRSheenConfiguration;
  59635. /**
  59636. * Defines the SubSurface parameters for the material.
  59637. */
  59638. readonly subSurface: PBRSubSurfaceConfiguration;
  59639. /**
  59640. * Defines the detail map parameters for the material.
  59641. */
  59642. readonly detailMap: DetailMapConfiguration;
  59643. protected _rebuildInParallel: boolean;
  59644. /**
  59645. * Instantiates a new PBRMaterial instance.
  59646. *
  59647. * @param name The material name
  59648. * @param scene The scene the material will be use in.
  59649. */
  59650. constructor(name: string, scene: Scene);
  59651. /**
  59652. * Gets a boolean indicating that current material needs to register RTT
  59653. */
  59654. get hasRenderTargetTextures(): boolean;
  59655. /**
  59656. * Gets the name of the material class.
  59657. */
  59658. getClassName(): string;
  59659. /**
  59660. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59661. */
  59662. get useLogarithmicDepth(): boolean;
  59663. /**
  59664. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59665. */
  59666. set useLogarithmicDepth(value: boolean);
  59667. /**
  59668. * Returns true if alpha blending should be disabled.
  59669. */
  59670. protected get _disableAlphaBlending(): boolean;
  59671. /**
  59672. * Specifies whether or not this material should be rendered in alpha blend mode.
  59673. */
  59674. needAlphaBlending(): boolean;
  59675. /**
  59676. * Specifies whether or not this material should be rendered in alpha test mode.
  59677. */
  59678. needAlphaTesting(): boolean;
  59679. /**
  59680. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59681. */
  59682. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59683. /**
  59684. * Gets the texture used for the alpha test.
  59685. */
  59686. getAlphaTestTexture(): Nullable<BaseTexture>;
  59687. /**
  59688. * Specifies that the submesh is ready to be used.
  59689. * @param mesh - BJS mesh.
  59690. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59691. * @param useInstances - Specifies that instances should be used.
  59692. * @returns - boolean indicating that the submesh is ready or not.
  59693. */
  59694. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59695. /**
  59696. * Specifies if the material uses metallic roughness workflow.
  59697. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59698. */
  59699. isMetallicWorkflow(): boolean;
  59700. private _prepareEffect;
  59701. private _prepareDefines;
  59702. /**
  59703. * Force shader compilation
  59704. */
  59705. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59706. /**
  59707. * Initializes the uniform buffer layout for the shader.
  59708. */
  59709. buildUniformLayout(): void;
  59710. /**
  59711. * Unbinds the material from the mesh
  59712. */
  59713. unbind(): void;
  59714. /**
  59715. * Binds the submesh data.
  59716. * @param world - The world matrix.
  59717. * @param mesh - The BJS mesh.
  59718. * @param subMesh - A submesh of the BJS mesh.
  59719. */
  59720. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59721. /**
  59722. * Returns the animatable textures.
  59723. * @returns - Array of animatable textures.
  59724. */
  59725. getAnimatables(): IAnimatable[];
  59726. /**
  59727. * Returns the texture used for reflections.
  59728. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59729. */
  59730. private _getReflectionTexture;
  59731. /**
  59732. * Returns an array of the actively used textures.
  59733. * @returns - Array of BaseTextures
  59734. */
  59735. getActiveTextures(): BaseTexture[];
  59736. /**
  59737. * Checks to see if a texture is used in the material.
  59738. * @param texture - Base texture to use.
  59739. * @returns - Boolean specifying if a texture is used in the material.
  59740. */
  59741. hasTexture(texture: BaseTexture): boolean;
  59742. /**
  59743. * Sets the required values to the prepass renderer.
  59744. * @param prePassRenderer defines the prepass renderer to setup
  59745. */
  59746. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59747. /**
  59748. * Disposes the resources of the material.
  59749. * @param forceDisposeEffect - Forces the disposal of effects.
  59750. * @param forceDisposeTextures - Forces the disposal of all textures.
  59751. */
  59752. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59753. }
  59754. }
  59755. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59756. import { Nullable } from "babylonjs/types";
  59757. import { Scene } from "babylonjs/scene";
  59758. import { Color3 } from "babylonjs/Maths/math.color";
  59759. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59760. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59761. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59762. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59763. /**
  59764. * The Physically based material of BJS.
  59765. *
  59766. * This offers the main features of a standard PBR material.
  59767. * For more information, please refer to the documentation :
  59768. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59769. */
  59770. export class PBRMaterial extends PBRBaseMaterial {
  59771. /**
  59772. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59773. */
  59774. static readonly PBRMATERIAL_OPAQUE: number;
  59775. /**
  59776. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59777. */
  59778. static readonly PBRMATERIAL_ALPHATEST: number;
  59779. /**
  59780. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59781. */
  59782. static readonly PBRMATERIAL_ALPHABLEND: number;
  59783. /**
  59784. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59785. * They are also discarded below the alpha cutoff threshold to improve performances.
  59786. */
  59787. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59788. /**
  59789. * Defines the default value of how much AO map is occluding the analytical lights
  59790. * (point spot...).
  59791. */
  59792. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59793. /**
  59794. * Intensity of the direct lights e.g. the four lights available in your scene.
  59795. * This impacts both the direct diffuse and specular highlights.
  59796. */
  59797. directIntensity: number;
  59798. /**
  59799. * Intensity of the emissive part of the material.
  59800. * This helps controlling the emissive effect without modifying the emissive color.
  59801. */
  59802. emissiveIntensity: number;
  59803. /**
  59804. * Intensity of the environment e.g. how much the environment will light the object
  59805. * either through harmonics for rough material or through the refelction for shiny ones.
  59806. */
  59807. environmentIntensity: number;
  59808. /**
  59809. * This is a special control allowing the reduction of the specular highlights coming from the
  59810. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59811. */
  59812. specularIntensity: number;
  59813. /**
  59814. * Debug Control allowing disabling the bump map on this material.
  59815. */
  59816. disableBumpMap: boolean;
  59817. /**
  59818. * AKA Diffuse Texture in standard nomenclature.
  59819. */
  59820. albedoTexture: BaseTexture;
  59821. /**
  59822. * AKA Occlusion Texture in other nomenclature.
  59823. */
  59824. ambientTexture: BaseTexture;
  59825. /**
  59826. * AKA Occlusion Texture Intensity in other nomenclature.
  59827. */
  59828. ambientTextureStrength: number;
  59829. /**
  59830. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59831. * 1 means it completely occludes it
  59832. * 0 mean it has no impact
  59833. */
  59834. ambientTextureImpactOnAnalyticalLights: number;
  59835. /**
  59836. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59837. */
  59838. opacityTexture: BaseTexture;
  59839. /**
  59840. * Stores the reflection values in a texture.
  59841. */
  59842. reflectionTexture: Nullable<BaseTexture>;
  59843. /**
  59844. * Stores the emissive values in a texture.
  59845. */
  59846. emissiveTexture: BaseTexture;
  59847. /**
  59848. * AKA Specular texture in other nomenclature.
  59849. */
  59850. reflectivityTexture: BaseTexture;
  59851. /**
  59852. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59853. */
  59854. metallicTexture: BaseTexture;
  59855. /**
  59856. * Specifies the metallic scalar of the metallic/roughness workflow.
  59857. * Can also be used to scale the metalness values of the metallic texture.
  59858. */
  59859. metallic: Nullable<number>;
  59860. /**
  59861. * Specifies the roughness scalar of the metallic/roughness workflow.
  59862. * Can also be used to scale the roughness values of the metallic texture.
  59863. */
  59864. roughness: Nullable<number>;
  59865. /**
  59866. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59867. * By default the indexOfrefraction is used to compute F0;
  59868. *
  59869. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59870. *
  59871. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59872. * F90 = metallicReflectanceColor;
  59873. */
  59874. metallicF0Factor: number;
  59875. /**
  59876. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59877. * By default the F90 is always 1;
  59878. *
  59879. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59880. *
  59881. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59882. * F90 = metallicReflectanceColor;
  59883. */
  59884. metallicReflectanceColor: Color3;
  59885. /**
  59886. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59887. * This is multiply against the scalar values defined in the material.
  59888. */
  59889. metallicReflectanceTexture: Nullable<BaseTexture>;
  59890. /**
  59891. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59892. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59893. */
  59894. microSurfaceTexture: BaseTexture;
  59895. /**
  59896. * Stores surface normal data used to displace a mesh in a texture.
  59897. */
  59898. bumpTexture: BaseTexture;
  59899. /**
  59900. * Stores the pre-calculated light information of a mesh in a texture.
  59901. */
  59902. lightmapTexture: BaseTexture;
  59903. /**
  59904. * Stores the refracted light information in a texture.
  59905. */
  59906. get refractionTexture(): Nullable<BaseTexture>;
  59907. set refractionTexture(value: Nullable<BaseTexture>);
  59908. /**
  59909. * The color of a material in ambient lighting.
  59910. */
  59911. ambientColor: Color3;
  59912. /**
  59913. * AKA Diffuse Color in other nomenclature.
  59914. */
  59915. albedoColor: Color3;
  59916. /**
  59917. * AKA Specular Color in other nomenclature.
  59918. */
  59919. reflectivityColor: Color3;
  59920. /**
  59921. * The color reflected from the material.
  59922. */
  59923. reflectionColor: Color3;
  59924. /**
  59925. * The color emitted from the material.
  59926. */
  59927. emissiveColor: Color3;
  59928. /**
  59929. * AKA Glossiness in other nomenclature.
  59930. */
  59931. microSurface: number;
  59932. /**
  59933. * Index of refraction of the material base layer.
  59934. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59935. *
  59936. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59937. *
  59938. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59939. */
  59940. get indexOfRefraction(): number;
  59941. set indexOfRefraction(value: number);
  59942. /**
  59943. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59944. */
  59945. get invertRefractionY(): boolean;
  59946. set invertRefractionY(value: boolean);
  59947. /**
  59948. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59949. * Materials half opaque for instance using refraction could benefit from this control.
  59950. */
  59951. get linkRefractionWithTransparency(): boolean;
  59952. set linkRefractionWithTransparency(value: boolean);
  59953. /**
  59954. * If true, the light map contains occlusion information instead of lighting info.
  59955. */
  59956. useLightmapAsShadowmap: boolean;
  59957. /**
  59958. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59959. */
  59960. useAlphaFromAlbedoTexture: boolean;
  59961. /**
  59962. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59963. */
  59964. forceAlphaTest: boolean;
  59965. /**
  59966. * Defines the alpha limits in alpha test mode.
  59967. */
  59968. alphaCutOff: number;
  59969. /**
  59970. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59971. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59972. */
  59973. useSpecularOverAlpha: boolean;
  59974. /**
  59975. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59976. */
  59977. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59978. /**
  59979. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59980. */
  59981. useRoughnessFromMetallicTextureAlpha: boolean;
  59982. /**
  59983. * Specifies if the metallic texture contains the roughness information in its green channel.
  59984. */
  59985. useRoughnessFromMetallicTextureGreen: boolean;
  59986. /**
  59987. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59988. */
  59989. useMetallnessFromMetallicTextureBlue: boolean;
  59990. /**
  59991. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59992. */
  59993. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59994. /**
  59995. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59996. */
  59997. useAmbientInGrayScale: boolean;
  59998. /**
  59999. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  60000. * The material will try to infer what glossiness each pixel should be.
  60001. */
  60002. useAutoMicroSurfaceFromReflectivityMap: boolean;
  60003. /**
  60004. * BJS is using an harcoded light falloff based on a manually sets up range.
  60005. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  60006. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  60007. */
  60008. get usePhysicalLightFalloff(): boolean;
  60009. /**
  60010. * BJS is using an harcoded light falloff based on a manually sets up range.
  60011. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  60012. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  60013. */
  60014. set usePhysicalLightFalloff(value: boolean);
  60015. /**
  60016. * In order to support the falloff compatibility with gltf, a special mode has been added
  60017. * to reproduce the gltf light falloff.
  60018. */
  60019. get useGLTFLightFalloff(): boolean;
  60020. /**
  60021. * In order to support the falloff compatibility with gltf, a special mode has been added
  60022. * to reproduce the gltf light falloff.
  60023. */
  60024. set useGLTFLightFalloff(value: boolean);
  60025. /**
  60026. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  60027. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  60028. */
  60029. useRadianceOverAlpha: boolean;
  60030. /**
  60031. * Allows using an object space normal map (instead of tangent space).
  60032. */
  60033. useObjectSpaceNormalMap: boolean;
  60034. /**
  60035. * Allows using the bump map in parallax mode.
  60036. */
  60037. useParallax: boolean;
  60038. /**
  60039. * Allows using the bump map in parallax occlusion mode.
  60040. */
  60041. useParallaxOcclusion: boolean;
  60042. /**
  60043. * Controls the scale bias of the parallax mode.
  60044. */
  60045. parallaxScaleBias: number;
  60046. /**
  60047. * If sets to true, disables all the lights affecting the material.
  60048. */
  60049. disableLighting: boolean;
  60050. /**
  60051. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  60052. */
  60053. forceIrradianceInFragment: boolean;
  60054. /**
  60055. * Number of Simultaneous lights allowed on the material.
  60056. */
  60057. maxSimultaneousLights: number;
  60058. /**
  60059. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  60060. */
  60061. invertNormalMapX: boolean;
  60062. /**
  60063. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  60064. */
  60065. invertNormalMapY: boolean;
  60066. /**
  60067. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  60068. */
  60069. twoSidedLighting: boolean;
  60070. /**
  60071. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  60072. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  60073. */
  60074. useAlphaFresnel: boolean;
  60075. /**
  60076. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  60077. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  60078. */
  60079. useLinearAlphaFresnel: boolean;
  60080. /**
  60081. * Let user defines the brdf lookup texture used for IBL.
  60082. * A default 8bit version is embedded but you could point at :
  60083. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  60084. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  60085. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  60086. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  60087. */
  60088. environmentBRDFTexture: Nullable<BaseTexture>;
  60089. /**
  60090. * Force normal to face away from face.
  60091. */
  60092. forceNormalForward: boolean;
  60093. /**
  60094. * Enables specular anti aliasing in the PBR shader.
  60095. * It will both interacts on the Geometry for analytical and IBL lighting.
  60096. * It also prefilter the roughness map based on the bump values.
  60097. */
  60098. enableSpecularAntiAliasing: boolean;
  60099. /**
  60100. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  60101. * makes the reflect vector face the model (under horizon).
  60102. */
  60103. useHorizonOcclusion: boolean;
  60104. /**
  60105. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  60106. * too much the area relying on ambient texture to define their ambient occlusion.
  60107. */
  60108. useRadianceOcclusion: boolean;
  60109. /**
  60110. * If set to true, no lighting calculations will be applied.
  60111. */
  60112. unlit: boolean;
  60113. /**
  60114. * Gets the image processing configuration used either in this material.
  60115. */
  60116. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  60117. /**
  60118. * Sets the Default image processing configuration used either in the this material.
  60119. *
  60120. * If sets to null, the scene one is in use.
  60121. */
  60122. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  60123. /**
  60124. * Gets wether the color curves effect is enabled.
  60125. */
  60126. get cameraColorCurvesEnabled(): boolean;
  60127. /**
  60128. * Sets wether the color curves effect is enabled.
  60129. */
  60130. set cameraColorCurvesEnabled(value: boolean);
  60131. /**
  60132. * Gets wether the color grading effect is enabled.
  60133. */
  60134. get cameraColorGradingEnabled(): boolean;
  60135. /**
  60136. * Gets wether the color grading effect is enabled.
  60137. */
  60138. set cameraColorGradingEnabled(value: boolean);
  60139. /**
  60140. * Gets wether tonemapping is enabled or not.
  60141. */
  60142. get cameraToneMappingEnabled(): boolean;
  60143. /**
  60144. * Sets wether tonemapping is enabled or not
  60145. */
  60146. set cameraToneMappingEnabled(value: boolean);
  60147. /**
  60148. * The camera exposure used on this material.
  60149. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  60150. * This corresponds to a photographic exposure.
  60151. */
  60152. get cameraExposure(): number;
  60153. /**
  60154. * The camera exposure used on this material.
  60155. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  60156. * This corresponds to a photographic exposure.
  60157. */
  60158. set cameraExposure(value: number);
  60159. /**
  60160. * Gets The camera contrast used on this material.
  60161. */
  60162. get cameraContrast(): number;
  60163. /**
  60164. * Sets The camera contrast used on this material.
  60165. */
  60166. set cameraContrast(value: number);
  60167. /**
  60168. * Gets the Color Grading 2D Lookup Texture.
  60169. */
  60170. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  60171. /**
  60172. * Sets the Color Grading 2D Lookup Texture.
  60173. */
  60174. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  60175. /**
  60176. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  60177. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  60178. * 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;
  60179. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60180. */
  60181. get cameraColorCurves(): Nullable<ColorCurves>;
  60182. /**
  60183. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  60184. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  60185. * 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;
  60186. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60187. */
  60188. set cameraColorCurves(value: Nullable<ColorCurves>);
  60189. /**
  60190. * Instantiates a new PBRMaterial instance.
  60191. *
  60192. * @param name The material name
  60193. * @param scene The scene the material will be use in.
  60194. */
  60195. constructor(name: string, scene: Scene);
  60196. /**
  60197. * Returns the name of this material class.
  60198. */
  60199. getClassName(): string;
  60200. /**
  60201. * Makes a duplicate of the current material.
  60202. * @param name - name to use for the new material.
  60203. */
  60204. clone(name: string): PBRMaterial;
  60205. /**
  60206. * Serializes this PBR Material.
  60207. * @returns - An object with the serialized material.
  60208. */
  60209. serialize(): any;
  60210. /**
  60211. * Parses a PBR Material from a serialized object.
  60212. * @param source - Serialized object.
  60213. * @param scene - BJS scene instance.
  60214. * @param rootUrl - url for the scene object
  60215. * @returns - PBRMaterial
  60216. */
  60217. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  60218. }
  60219. }
  60220. declare module "babylonjs/Misc/dds" {
  60221. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  60222. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60223. import { Nullable } from "babylonjs/types";
  60224. import { Scene } from "babylonjs/scene";
  60225. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  60226. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60227. /**
  60228. * Direct draw surface info
  60229. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  60230. */
  60231. export interface DDSInfo {
  60232. /**
  60233. * Width of the texture
  60234. */
  60235. width: number;
  60236. /**
  60237. * Width of the texture
  60238. */
  60239. height: number;
  60240. /**
  60241. * Number of Mipmaps for the texture
  60242. * @see https://en.wikipedia.org/wiki/Mipmap
  60243. */
  60244. mipmapCount: number;
  60245. /**
  60246. * If the textures format is a known fourCC format
  60247. * @see https://www.fourcc.org/
  60248. */
  60249. isFourCC: boolean;
  60250. /**
  60251. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  60252. */
  60253. isRGB: boolean;
  60254. /**
  60255. * If the texture is a lumincance format
  60256. */
  60257. isLuminance: boolean;
  60258. /**
  60259. * If this is a cube texture
  60260. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  60261. */
  60262. isCube: boolean;
  60263. /**
  60264. * If the texture is a compressed format eg. FOURCC_DXT1
  60265. */
  60266. isCompressed: boolean;
  60267. /**
  60268. * The dxgiFormat of the texture
  60269. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  60270. */
  60271. dxgiFormat: number;
  60272. /**
  60273. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  60274. */
  60275. textureType: number;
  60276. /**
  60277. * Sphericle polynomial created for the dds texture
  60278. */
  60279. sphericalPolynomial?: SphericalPolynomial;
  60280. }
  60281. /**
  60282. * Class used to provide DDS decompression tools
  60283. */
  60284. export class DDSTools {
  60285. /**
  60286. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60287. */
  60288. static StoreLODInAlphaChannel: boolean;
  60289. /**
  60290. * Gets DDS information from an array buffer
  60291. * @param data defines the array buffer view to read data from
  60292. * @returns the DDS information
  60293. */
  60294. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60295. private static _FloatView;
  60296. private static _Int32View;
  60297. private static _ToHalfFloat;
  60298. private static _FromHalfFloat;
  60299. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60300. private static _GetHalfFloatRGBAArrayBuffer;
  60301. private static _GetFloatRGBAArrayBuffer;
  60302. private static _GetFloatAsUIntRGBAArrayBuffer;
  60303. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60304. private static _GetRGBAArrayBuffer;
  60305. private static _ExtractLongWordOrder;
  60306. private static _GetRGBArrayBuffer;
  60307. private static _GetLuminanceArrayBuffer;
  60308. /**
  60309. * Uploads DDS Levels to a Babylon Texture
  60310. * @hidden
  60311. */
  60312. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60313. }
  60314. module "babylonjs/Engines/thinEngine" {
  60315. interface ThinEngine {
  60316. /**
  60317. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60318. * @param rootUrl defines the url where the file to load is located
  60319. * @param scene defines the current scene
  60320. * @param lodScale defines scale to apply to the mip map selection
  60321. * @param lodOffset defines offset to apply to the mip map selection
  60322. * @param onLoad defines an optional callback raised when the texture is loaded
  60323. * @param onError defines an optional callback raised if there is an issue to load the texture
  60324. * @param format defines the format of the data
  60325. * @param forcedExtension defines the extension to use to pick the right loader
  60326. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60327. * @returns the cube texture as an InternalTexture
  60328. */
  60329. 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;
  60330. }
  60331. }
  60332. }
  60333. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60334. import { Nullable } from "babylonjs/types";
  60335. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60336. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60337. /**
  60338. * Implementation of the DDS Texture Loader.
  60339. * @hidden
  60340. */
  60341. export class _DDSTextureLoader implements IInternalTextureLoader {
  60342. /**
  60343. * Defines wether the loader supports cascade loading the different faces.
  60344. */
  60345. readonly supportCascades: boolean;
  60346. /**
  60347. * This returns if the loader support the current file information.
  60348. * @param extension defines the file extension of the file being loaded
  60349. * @returns true if the loader can load the specified file
  60350. */
  60351. canLoad(extension: string): boolean;
  60352. /**
  60353. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60354. * @param data contains the texture data
  60355. * @param texture defines the BabylonJS internal texture
  60356. * @param createPolynomials will be true if polynomials have been requested
  60357. * @param onLoad defines the callback to trigger once the texture is ready
  60358. * @param onError defines the callback to trigger in case of error
  60359. */
  60360. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60361. /**
  60362. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60363. * @param data contains the texture data
  60364. * @param texture defines the BabylonJS internal texture
  60365. * @param callback defines the method to call once ready to upload
  60366. */
  60367. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60368. }
  60369. }
  60370. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60371. import { Nullable } from "babylonjs/types";
  60372. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60373. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60374. /**
  60375. * Implementation of the ENV Texture Loader.
  60376. * @hidden
  60377. */
  60378. export class _ENVTextureLoader implements IInternalTextureLoader {
  60379. /**
  60380. * Defines wether the loader supports cascade loading the different faces.
  60381. */
  60382. readonly supportCascades: boolean;
  60383. /**
  60384. * This returns if the loader support the current file information.
  60385. * @param extension defines the file extension of the file being loaded
  60386. * @returns true if the loader can load the specified file
  60387. */
  60388. canLoad(extension: string): boolean;
  60389. /**
  60390. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60391. * @param data contains the texture data
  60392. * @param texture defines the BabylonJS internal texture
  60393. * @param createPolynomials will be true if polynomials have been requested
  60394. * @param onLoad defines the callback to trigger once the texture is ready
  60395. * @param onError defines the callback to trigger in case of error
  60396. */
  60397. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60398. /**
  60399. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60400. * @param data contains the texture data
  60401. * @param texture defines the BabylonJS internal texture
  60402. * @param callback defines the method to call once ready to upload
  60403. */
  60404. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60405. }
  60406. }
  60407. declare module "babylonjs/Misc/khronosTextureContainer" {
  60408. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60409. /**
  60410. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60411. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60412. */
  60413. export class KhronosTextureContainer {
  60414. /** contents of the KTX container file */
  60415. data: ArrayBufferView;
  60416. private static HEADER_LEN;
  60417. private static COMPRESSED_2D;
  60418. private static COMPRESSED_3D;
  60419. private static TEX_2D;
  60420. private static TEX_3D;
  60421. /**
  60422. * Gets the openGL type
  60423. */
  60424. glType: number;
  60425. /**
  60426. * Gets the openGL type size
  60427. */
  60428. glTypeSize: number;
  60429. /**
  60430. * Gets the openGL format
  60431. */
  60432. glFormat: number;
  60433. /**
  60434. * Gets the openGL internal format
  60435. */
  60436. glInternalFormat: number;
  60437. /**
  60438. * Gets the base internal format
  60439. */
  60440. glBaseInternalFormat: number;
  60441. /**
  60442. * Gets image width in pixel
  60443. */
  60444. pixelWidth: number;
  60445. /**
  60446. * Gets image height in pixel
  60447. */
  60448. pixelHeight: number;
  60449. /**
  60450. * Gets image depth in pixels
  60451. */
  60452. pixelDepth: number;
  60453. /**
  60454. * Gets the number of array elements
  60455. */
  60456. numberOfArrayElements: number;
  60457. /**
  60458. * Gets the number of faces
  60459. */
  60460. numberOfFaces: number;
  60461. /**
  60462. * Gets the number of mipmap levels
  60463. */
  60464. numberOfMipmapLevels: number;
  60465. /**
  60466. * Gets the bytes of key value data
  60467. */
  60468. bytesOfKeyValueData: number;
  60469. /**
  60470. * Gets the load type
  60471. */
  60472. loadType: number;
  60473. /**
  60474. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60475. */
  60476. isInvalid: boolean;
  60477. /**
  60478. * Creates a new KhronosTextureContainer
  60479. * @param data contents of the KTX container file
  60480. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60481. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60482. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60483. */
  60484. constructor(
  60485. /** contents of the KTX container file */
  60486. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60487. /**
  60488. * Uploads KTX content to a Babylon Texture.
  60489. * It is assumed that the texture has already been created & is currently bound
  60490. * @hidden
  60491. */
  60492. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60493. private _upload2DCompressedLevels;
  60494. /**
  60495. * Checks if the given data starts with a KTX file identifier.
  60496. * @param data the data to check
  60497. * @returns true if the data is a KTX file or false otherwise
  60498. */
  60499. static IsValid(data: ArrayBufferView): boolean;
  60500. }
  60501. }
  60502. declare module "babylonjs/Misc/workerPool" {
  60503. import { IDisposable } from "babylonjs/scene";
  60504. /**
  60505. * Helper class to push actions to a pool of workers.
  60506. */
  60507. export class WorkerPool implements IDisposable {
  60508. private _workerInfos;
  60509. private _pendingActions;
  60510. /**
  60511. * Constructor
  60512. * @param workers Array of workers to use for actions
  60513. */
  60514. constructor(workers: Array<Worker>);
  60515. /**
  60516. * Terminates all workers and clears any pending actions.
  60517. */
  60518. dispose(): void;
  60519. /**
  60520. * Pushes an action to the worker pool. If all the workers are active, the action will be
  60521. * pended until a worker has completed its action.
  60522. * @param action The action to perform. Call onComplete when the action is complete.
  60523. */
  60524. push(action: (worker: Worker, onComplete: () => void) => void): void;
  60525. private _execute;
  60526. }
  60527. }
  60528. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60529. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60530. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60531. /**
  60532. * Class for loading KTX2 files
  60533. * @hidden
  60534. */
  60535. export class KhronosTextureContainer2 {
  60536. private static _WorkerPoolPromise?;
  60537. private static _Initialized;
  60538. private static _Ktx2Decoder;
  60539. /**
  60540. * URL to use when loading the KTX2 decoder module
  60541. */
  60542. static JSModuleURL: string;
  60543. /**
  60544. * Default number of workers used to handle data decoding
  60545. */
  60546. static DefaultNumWorkers: number;
  60547. private static GetDefaultNumWorkers;
  60548. private _engine;
  60549. private static _CreateWorkerPool;
  60550. /**
  60551. * Constructor
  60552. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  60553. */
  60554. constructor(engine: ThinEngine, numWorkers?: number);
  60555. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60556. /**
  60557. * Stop all async operations and release resources.
  60558. */
  60559. dispose(): void;
  60560. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  60561. /**
  60562. * Checks if the given data starts with a KTX2 file identifier.
  60563. * @param data the data to check
  60564. * @returns true if the data is a KTX2 file or false otherwise
  60565. */
  60566. static IsValid(data: ArrayBufferView): boolean;
  60567. }
  60568. export function workerFunc(): void;
  60569. }
  60570. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60571. import { Nullable } from "babylonjs/types";
  60572. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60573. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60574. /**
  60575. * Implementation of the KTX Texture Loader.
  60576. * @hidden
  60577. */
  60578. export class _KTXTextureLoader implements IInternalTextureLoader {
  60579. /**
  60580. * Defines wether the loader supports cascade loading the different faces.
  60581. */
  60582. readonly supportCascades: boolean;
  60583. /**
  60584. * This returns if the loader support the current file information.
  60585. * @param extension defines the file extension of the file being loaded
  60586. * @param mimeType defines the optional mime type of the file being loaded
  60587. * @returns true if the loader can load the specified file
  60588. */
  60589. canLoad(extension: string, mimeType?: string): boolean;
  60590. /**
  60591. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60592. * @param data contains the texture data
  60593. * @param texture defines the BabylonJS internal texture
  60594. * @param createPolynomials will be true if polynomials have been requested
  60595. * @param onLoad defines the callback to trigger once the texture is ready
  60596. * @param onError defines the callback to trigger in case of error
  60597. */
  60598. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60599. /**
  60600. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60601. * @param data contains the texture data
  60602. * @param texture defines the BabylonJS internal texture
  60603. * @param callback defines the method to call once ready to upload
  60604. */
  60605. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60606. }
  60607. }
  60608. declare module "babylonjs/Helpers/sceneHelpers" {
  60609. import { Nullable } from "babylonjs/types";
  60610. import { Mesh } from "babylonjs/Meshes/mesh";
  60611. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60612. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60613. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60614. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60615. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60616. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60617. import "babylonjs/Meshes/Builders/boxBuilder";
  60618. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60619. /** @hidden */
  60620. export var _forceSceneHelpersToBundle: boolean;
  60621. module "babylonjs/scene" {
  60622. interface Scene {
  60623. /**
  60624. * Creates a default light for the scene.
  60625. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60626. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60627. */
  60628. createDefaultLight(replace?: boolean): void;
  60629. /**
  60630. * Creates a default camera for the scene.
  60631. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60632. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60633. * @param replace has default false, when true replaces the active camera in the scene
  60634. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60635. */
  60636. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60637. /**
  60638. * Creates a default camera and a default light.
  60639. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60640. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60641. * @param replace has the default false, when true replaces the active camera/light in the scene
  60642. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60643. */
  60644. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60645. /**
  60646. * Creates a new sky box
  60647. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60648. * @param environmentTexture defines the texture to use as environment texture
  60649. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60650. * @param scale defines the overall scale of the skybox
  60651. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60652. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60653. * @returns a new mesh holding the sky box
  60654. */
  60655. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60656. /**
  60657. * Creates a new environment
  60658. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60659. * @param options defines the options you can use to configure the environment
  60660. * @returns the new EnvironmentHelper
  60661. */
  60662. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60663. /**
  60664. * Creates a new VREXperienceHelper
  60665. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60666. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60667. * @returns a new VREXperienceHelper
  60668. */
  60669. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60670. /**
  60671. * Creates a new WebXRDefaultExperience
  60672. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60673. * @param options experience options
  60674. * @returns a promise for a new WebXRDefaultExperience
  60675. */
  60676. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60677. }
  60678. }
  60679. }
  60680. declare module "babylonjs/Helpers/videoDome" {
  60681. import { Scene } from "babylonjs/scene";
  60682. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60683. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60684. /**
  60685. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60686. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60687. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60688. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60689. */
  60690. export class VideoDome extends TextureDome<VideoTexture> {
  60691. /**
  60692. * Define the video source as a Monoscopic panoramic 360 video.
  60693. */
  60694. static readonly MODE_MONOSCOPIC: number;
  60695. /**
  60696. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60697. */
  60698. static readonly MODE_TOPBOTTOM: number;
  60699. /**
  60700. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60701. */
  60702. static readonly MODE_SIDEBYSIDE: number;
  60703. /**
  60704. * Get the video texture associated with this video dome
  60705. */
  60706. get videoTexture(): VideoTexture;
  60707. /**
  60708. * Get the video mode of this dome
  60709. */
  60710. get videoMode(): number;
  60711. /**
  60712. * Set the video mode of this dome.
  60713. * @see textureMode
  60714. */
  60715. set videoMode(value: number);
  60716. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60717. }
  60718. }
  60719. declare module "babylonjs/Helpers/index" {
  60720. export * from "babylonjs/Helpers/environmentHelper";
  60721. export * from "babylonjs/Helpers/photoDome";
  60722. export * from "babylonjs/Helpers/sceneHelpers";
  60723. export * from "babylonjs/Helpers/videoDome";
  60724. }
  60725. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60726. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60727. import { IDisposable } from "babylonjs/scene";
  60728. import { Engine } from "babylonjs/Engines/engine";
  60729. /**
  60730. * This class can be used to get instrumentation data from a Babylon engine
  60731. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60732. */
  60733. export class EngineInstrumentation implements IDisposable {
  60734. /**
  60735. * Define the instrumented engine.
  60736. */
  60737. engine: Engine;
  60738. private _captureGPUFrameTime;
  60739. private _gpuFrameTimeToken;
  60740. private _gpuFrameTime;
  60741. private _captureShaderCompilationTime;
  60742. private _shaderCompilationTime;
  60743. private _onBeginFrameObserver;
  60744. private _onEndFrameObserver;
  60745. private _onBeforeShaderCompilationObserver;
  60746. private _onAfterShaderCompilationObserver;
  60747. /**
  60748. * Gets the perf counter used for GPU frame time
  60749. */
  60750. get gpuFrameTimeCounter(): PerfCounter;
  60751. /**
  60752. * Gets the GPU frame time capture status
  60753. */
  60754. get captureGPUFrameTime(): boolean;
  60755. /**
  60756. * Enable or disable the GPU frame time capture
  60757. */
  60758. set captureGPUFrameTime(value: boolean);
  60759. /**
  60760. * Gets the perf counter used for shader compilation time
  60761. */
  60762. get shaderCompilationTimeCounter(): PerfCounter;
  60763. /**
  60764. * Gets the shader compilation time capture status
  60765. */
  60766. get captureShaderCompilationTime(): boolean;
  60767. /**
  60768. * Enable or disable the shader compilation time capture
  60769. */
  60770. set captureShaderCompilationTime(value: boolean);
  60771. /**
  60772. * Instantiates a new engine instrumentation.
  60773. * This class can be used to get instrumentation data from a Babylon engine
  60774. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60775. * @param engine Defines the engine to instrument
  60776. */
  60777. constructor(
  60778. /**
  60779. * Define the instrumented engine.
  60780. */
  60781. engine: Engine);
  60782. /**
  60783. * Dispose and release associated resources.
  60784. */
  60785. dispose(): void;
  60786. }
  60787. }
  60788. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60789. import { Scene, IDisposable } from "babylonjs/scene";
  60790. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60791. /**
  60792. * This class can be used to get instrumentation data from a Babylon engine
  60793. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60794. */
  60795. export class SceneInstrumentation implements IDisposable {
  60796. /**
  60797. * Defines the scene to instrument
  60798. */
  60799. scene: Scene;
  60800. private _captureActiveMeshesEvaluationTime;
  60801. private _activeMeshesEvaluationTime;
  60802. private _captureRenderTargetsRenderTime;
  60803. private _renderTargetsRenderTime;
  60804. private _captureFrameTime;
  60805. private _frameTime;
  60806. private _captureRenderTime;
  60807. private _renderTime;
  60808. private _captureInterFrameTime;
  60809. private _interFrameTime;
  60810. private _captureParticlesRenderTime;
  60811. private _particlesRenderTime;
  60812. private _captureSpritesRenderTime;
  60813. private _spritesRenderTime;
  60814. private _capturePhysicsTime;
  60815. private _physicsTime;
  60816. private _captureAnimationsTime;
  60817. private _animationsTime;
  60818. private _captureCameraRenderTime;
  60819. private _cameraRenderTime;
  60820. private _onBeforeActiveMeshesEvaluationObserver;
  60821. private _onAfterActiveMeshesEvaluationObserver;
  60822. private _onBeforeRenderTargetsRenderObserver;
  60823. private _onAfterRenderTargetsRenderObserver;
  60824. private _onAfterRenderObserver;
  60825. private _onBeforeDrawPhaseObserver;
  60826. private _onAfterDrawPhaseObserver;
  60827. private _onBeforeAnimationsObserver;
  60828. private _onBeforeParticlesRenderingObserver;
  60829. private _onAfterParticlesRenderingObserver;
  60830. private _onBeforeSpritesRenderingObserver;
  60831. private _onAfterSpritesRenderingObserver;
  60832. private _onBeforePhysicsObserver;
  60833. private _onAfterPhysicsObserver;
  60834. private _onAfterAnimationsObserver;
  60835. private _onBeforeCameraRenderObserver;
  60836. private _onAfterCameraRenderObserver;
  60837. /**
  60838. * Gets the perf counter used for active meshes evaluation time
  60839. */
  60840. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60841. /**
  60842. * Gets the active meshes evaluation time capture status
  60843. */
  60844. get captureActiveMeshesEvaluationTime(): boolean;
  60845. /**
  60846. * Enable or disable the active meshes evaluation time capture
  60847. */
  60848. set captureActiveMeshesEvaluationTime(value: boolean);
  60849. /**
  60850. * Gets the perf counter used for render targets render time
  60851. */
  60852. get renderTargetsRenderTimeCounter(): PerfCounter;
  60853. /**
  60854. * Gets the render targets render time capture status
  60855. */
  60856. get captureRenderTargetsRenderTime(): boolean;
  60857. /**
  60858. * Enable or disable the render targets render time capture
  60859. */
  60860. set captureRenderTargetsRenderTime(value: boolean);
  60861. /**
  60862. * Gets the perf counter used for particles render time
  60863. */
  60864. get particlesRenderTimeCounter(): PerfCounter;
  60865. /**
  60866. * Gets the particles render time capture status
  60867. */
  60868. get captureParticlesRenderTime(): boolean;
  60869. /**
  60870. * Enable or disable the particles render time capture
  60871. */
  60872. set captureParticlesRenderTime(value: boolean);
  60873. /**
  60874. * Gets the perf counter used for sprites render time
  60875. */
  60876. get spritesRenderTimeCounter(): PerfCounter;
  60877. /**
  60878. * Gets the sprites render time capture status
  60879. */
  60880. get captureSpritesRenderTime(): boolean;
  60881. /**
  60882. * Enable or disable the sprites render time capture
  60883. */
  60884. set captureSpritesRenderTime(value: boolean);
  60885. /**
  60886. * Gets the perf counter used for physics time
  60887. */
  60888. get physicsTimeCounter(): PerfCounter;
  60889. /**
  60890. * Gets the physics time capture status
  60891. */
  60892. get capturePhysicsTime(): boolean;
  60893. /**
  60894. * Enable or disable the physics time capture
  60895. */
  60896. set capturePhysicsTime(value: boolean);
  60897. /**
  60898. * Gets the perf counter used for animations time
  60899. */
  60900. get animationsTimeCounter(): PerfCounter;
  60901. /**
  60902. * Gets the animations time capture status
  60903. */
  60904. get captureAnimationsTime(): boolean;
  60905. /**
  60906. * Enable or disable the animations time capture
  60907. */
  60908. set captureAnimationsTime(value: boolean);
  60909. /**
  60910. * Gets the perf counter used for frame time capture
  60911. */
  60912. get frameTimeCounter(): PerfCounter;
  60913. /**
  60914. * Gets the frame time capture status
  60915. */
  60916. get captureFrameTime(): boolean;
  60917. /**
  60918. * Enable or disable the frame time capture
  60919. */
  60920. set captureFrameTime(value: boolean);
  60921. /**
  60922. * Gets the perf counter used for inter-frames time capture
  60923. */
  60924. get interFrameTimeCounter(): PerfCounter;
  60925. /**
  60926. * Gets the inter-frames time capture status
  60927. */
  60928. get captureInterFrameTime(): boolean;
  60929. /**
  60930. * Enable or disable the inter-frames time capture
  60931. */
  60932. set captureInterFrameTime(value: boolean);
  60933. /**
  60934. * Gets the perf counter used for render time capture
  60935. */
  60936. get renderTimeCounter(): PerfCounter;
  60937. /**
  60938. * Gets the render time capture status
  60939. */
  60940. get captureRenderTime(): boolean;
  60941. /**
  60942. * Enable or disable the render time capture
  60943. */
  60944. set captureRenderTime(value: boolean);
  60945. /**
  60946. * Gets the perf counter used for camera render time capture
  60947. */
  60948. get cameraRenderTimeCounter(): PerfCounter;
  60949. /**
  60950. * Gets the camera render time capture status
  60951. */
  60952. get captureCameraRenderTime(): boolean;
  60953. /**
  60954. * Enable or disable the camera render time capture
  60955. */
  60956. set captureCameraRenderTime(value: boolean);
  60957. /**
  60958. * Gets the perf counter used for draw calls
  60959. */
  60960. get drawCallsCounter(): PerfCounter;
  60961. /**
  60962. * Instantiates a new scene instrumentation.
  60963. * This class can be used to get instrumentation data from a Babylon engine
  60964. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60965. * @param scene Defines the scene to instrument
  60966. */
  60967. constructor(
  60968. /**
  60969. * Defines the scene to instrument
  60970. */
  60971. scene: Scene);
  60972. /**
  60973. * Dispose and release associated resources.
  60974. */
  60975. dispose(): void;
  60976. }
  60977. }
  60978. declare module "babylonjs/Instrumentation/index" {
  60979. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60980. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60981. export * from "babylonjs/Instrumentation/timeToken";
  60982. }
  60983. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60984. /** @hidden */
  60985. export var glowMapGenerationPixelShader: {
  60986. name: string;
  60987. shader: string;
  60988. };
  60989. }
  60990. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60991. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60992. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60993. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60994. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60995. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60996. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60997. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60998. /** @hidden */
  60999. export var glowMapGenerationVertexShader: {
  61000. name: string;
  61001. shader: string;
  61002. };
  61003. }
  61004. declare module "babylonjs/Layers/effectLayer" {
  61005. import { Observable } from "babylonjs/Misc/observable";
  61006. import { Nullable } from "babylonjs/types";
  61007. import { Camera } from "babylonjs/Cameras/camera";
  61008. import { Scene } from "babylonjs/scene";
  61009. import { ISize } from "babylonjs/Maths/math.size";
  61010. import { Color4 } from "babylonjs/Maths/math.color";
  61011. import { Engine } from "babylonjs/Engines/engine";
  61012. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61013. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61014. import { Mesh } from "babylonjs/Meshes/mesh";
  61015. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61016. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  61017. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61018. import { Effect } from "babylonjs/Materials/effect";
  61019. import { Material } from "babylonjs/Materials/material";
  61020. import "babylonjs/Shaders/glowMapGeneration.fragment";
  61021. import "babylonjs/Shaders/glowMapGeneration.vertex";
  61022. /**
  61023. * Effect layer options. This helps customizing the behaviour
  61024. * of the effect layer.
  61025. */
  61026. export interface IEffectLayerOptions {
  61027. /**
  61028. * Multiplication factor apply to the canvas size to compute the render target size
  61029. * used to generated the objects (the smaller the faster).
  61030. */
  61031. mainTextureRatio: number;
  61032. /**
  61033. * Enforces a fixed size texture to ensure effect stability across devices.
  61034. */
  61035. mainTextureFixedSize?: number;
  61036. /**
  61037. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  61038. */
  61039. alphaBlendingMode: number;
  61040. /**
  61041. * The camera attached to the layer.
  61042. */
  61043. camera: Nullable<Camera>;
  61044. /**
  61045. * The rendering group to draw the layer in.
  61046. */
  61047. renderingGroupId: number;
  61048. }
  61049. /**
  61050. * The effect layer Helps adding post process effect blended with the main pass.
  61051. *
  61052. * This can be for instance use to generate glow or higlight effects on the scene.
  61053. *
  61054. * The effect layer class can not be used directly and is intented to inherited from to be
  61055. * customized per effects.
  61056. */
  61057. export abstract class EffectLayer {
  61058. private _vertexBuffers;
  61059. private _indexBuffer;
  61060. private _cachedDefines;
  61061. private _effectLayerMapGenerationEffect;
  61062. private _effectLayerOptions;
  61063. private _mergeEffect;
  61064. protected _scene: Scene;
  61065. protected _engine: Engine;
  61066. protected _maxSize: number;
  61067. protected _mainTextureDesiredSize: ISize;
  61068. protected _mainTexture: RenderTargetTexture;
  61069. protected _shouldRender: boolean;
  61070. protected _postProcesses: PostProcess[];
  61071. protected _textures: BaseTexture[];
  61072. protected _emissiveTextureAndColor: {
  61073. texture: Nullable<BaseTexture>;
  61074. color: Color4;
  61075. };
  61076. /**
  61077. * The name of the layer
  61078. */
  61079. name: string;
  61080. /**
  61081. * The clear color of the texture used to generate the glow map.
  61082. */
  61083. neutralColor: Color4;
  61084. /**
  61085. * Specifies whether the highlight layer is enabled or not.
  61086. */
  61087. isEnabled: boolean;
  61088. /**
  61089. * Gets the camera attached to the layer.
  61090. */
  61091. get camera(): Nullable<Camera>;
  61092. /**
  61093. * Gets the rendering group id the layer should render in.
  61094. */
  61095. get renderingGroupId(): number;
  61096. set renderingGroupId(renderingGroupId: number);
  61097. /**
  61098. * An event triggered when the effect layer has been disposed.
  61099. */
  61100. onDisposeObservable: Observable<EffectLayer>;
  61101. /**
  61102. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  61103. */
  61104. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  61105. /**
  61106. * An event triggered when the generated texture is being merged in the scene.
  61107. */
  61108. onBeforeComposeObservable: Observable<EffectLayer>;
  61109. /**
  61110. * An event triggered when the mesh is rendered into the effect render target.
  61111. */
  61112. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  61113. /**
  61114. * An event triggered after the mesh has been rendered into the effect render target.
  61115. */
  61116. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  61117. /**
  61118. * An event triggered when the generated texture has been merged in the scene.
  61119. */
  61120. onAfterComposeObservable: Observable<EffectLayer>;
  61121. /**
  61122. * An event triggered when the efffect layer changes its size.
  61123. */
  61124. onSizeChangedObservable: Observable<EffectLayer>;
  61125. /** @hidden */
  61126. static _SceneComponentInitialization: (scene: Scene) => void;
  61127. /**
  61128. * Instantiates a new effect Layer and references it in the scene.
  61129. * @param name The name of the layer
  61130. * @param scene The scene to use the layer in
  61131. */
  61132. constructor(
  61133. /** The Friendly of the effect in the scene */
  61134. name: string, scene: Scene);
  61135. /**
  61136. * Get the effect name of the layer.
  61137. * @return The effect name
  61138. */
  61139. abstract getEffectName(): string;
  61140. /**
  61141. * Checks for the readiness of the element composing the layer.
  61142. * @param subMesh the mesh to check for
  61143. * @param useInstances specify whether or not to use instances to render the mesh
  61144. * @return true if ready otherwise, false
  61145. */
  61146. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61147. /**
  61148. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61149. * @returns true if the effect requires stencil during the main canvas render pass.
  61150. */
  61151. abstract needStencil(): boolean;
  61152. /**
  61153. * Create the merge effect. This is the shader use to blit the information back
  61154. * to the main canvas at the end of the scene rendering.
  61155. * @returns The effect containing the shader used to merge the effect on the main canvas
  61156. */
  61157. protected abstract _createMergeEffect(): Effect;
  61158. /**
  61159. * Creates the render target textures and post processes used in the effect layer.
  61160. */
  61161. protected abstract _createTextureAndPostProcesses(): void;
  61162. /**
  61163. * Implementation specific of rendering the generating effect on the main canvas.
  61164. * @param effect The effect used to render through
  61165. */
  61166. protected abstract _internalRender(effect: Effect): void;
  61167. /**
  61168. * Sets the required values for both the emissive texture and and the main color.
  61169. */
  61170. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61171. /**
  61172. * Free any resources and references associated to a mesh.
  61173. * Internal use
  61174. * @param mesh The mesh to free.
  61175. */
  61176. abstract _disposeMesh(mesh: Mesh): void;
  61177. /**
  61178. * Serializes this layer (Glow or Highlight for example)
  61179. * @returns a serialized layer object
  61180. */
  61181. abstract serialize?(): any;
  61182. /**
  61183. * Initializes the effect layer with the required options.
  61184. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  61185. */
  61186. protected _init(options: Partial<IEffectLayerOptions>): void;
  61187. /**
  61188. * Generates the index buffer of the full screen quad blending to the main canvas.
  61189. */
  61190. private _generateIndexBuffer;
  61191. /**
  61192. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  61193. */
  61194. private _generateVertexBuffer;
  61195. /**
  61196. * Sets the main texture desired size which is the closest power of two
  61197. * of the engine canvas size.
  61198. */
  61199. private _setMainTextureSize;
  61200. /**
  61201. * Creates the main texture for the effect layer.
  61202. */
  61203. protected _createMainTexture(): void;
  61204. /**
  61205. * Adds specific effects defines.
  61206. * @param defines The defines to add specifics to.
  61207. */
  61208. protected _addCustomEffectDefines(defines: string[]): void;
  61209. /**
  61210. * Checks for the readiness of the element composing the layer.
  61211. * @param subMesh the mesh to check for
  61212. * @param useInstances specify whether or not to use instances to render the mesh
  61213. * @param emissiveTexture the associated emissive texture used to generate the glow
  61214. * @return true if ready otherwise, false
  61215. */
  61216. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  61217. /**
  61218. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  61219. */
  61220. render(): void;
  61221. /**
  61222. * Determine if a given mesh will be used in the current effect.
  61223. * @param mesh mesh to test
  61224. * @returns true if the mesh will be used
  61225. */
  61226. hasMesh(mesh: AbstractMesh): boolean;
  61227. /**
  61228. * Returns true if the layer contains information to display, otherwise false.
  61229. * @returns true if the glow layer should be rendered
  61230. */
  61231. shouldRender(): boolean;
  61232. /**
  61233. * Returns true if the mesh should render, otherwise false.
  61234. * @param mesh The mesh to render
  61235. * @returns true if it should render otherwise false
  61236. */
  61237. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  61238. /**
  61239. * Returns true if the mesh can be rendered, otherwise false.
  61240. * @param mesh The mesh to render
  61241. * @param material The material used on the mesh
  61242. * @returns true if it can be rendered otherwise false
  61243. */
  61244. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61245. /**
  61246. * Returns true if the mesh should render, otherwise false.
  61247. * @param mesh The mesh to render
  61248. * @returns true if it should render otherwise false
  61249. */
  61250. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  61251. /**
  61252. * Renders the submesh passed in parameter to the generation map.
  61253. */
  61254. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  61255. /**
  61256. * Defines whether the current material of the mesh should be use to render the effect.
  61257. * @param mesh defines the current mesh to render
  61258. */
  61259. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61260. /**
  61261. * Rebuild the required buffers.
  61262. * @hidden Internal use only.
  61263. */
  61264. _rebuild(): void;
  61265. /**
  61266. * Dispose only the render target textures and post process.
  61267. */
  61268. private _disposeTextureAndPostProcesses;
  61269. /**
  61270. * Dispose the highlight layer and free resources.
  61271. */
  61272. dispose(): void;
  61273. /**
  61274. * Gets the class name of the effect layer
  61275. * @returns the string with the class name of the effect layer
  61276. */
  61277. getClassName(): string;
  61278. /**
  61279. * Creates an effect layer from parsed effect layer data
  61280. * @param parsedEffectLayer defines effect layer data
  61281. * @param scene defines the current scene
  61282. * @param rootUrl defines the root URL containing the effect layer information
  61283. * @returns a parsed effect Layer
  61284. */
  61285. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  61286. }
  61287. }
  61288. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  61289. import { Scene } from "babylonjs/scene";
  61290. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61291. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61292. import { AbstractScene } from "babylonjs/abstractScene";
  61293. module "babylonjs/abstractScene" {
  61294. interface AbstractScene {
  61295. /**
  61296. * The list of effect layers (highlights/glow) added to the scene
  61297. * @see https://doc.babylonjs.com/how_to/highlight_layer
  61298. * @see https://doc.babylonjs.com/how_to/glow_layer
  61299. */
  61300. effectLayers: Array<EffectLayer>;
  61301. /**
  61302. * Removes the given effect layer from this scene.
  61303. * @param toRemove defines the effect layer to remove
  61304. * @returns the index of the removed effect layer
  61305. */
  61306. removeEffectLayer(toRemove: EffectLayer): number;
  61307. /**
  61308. * Adds the given effect layer to this scene
  61309. * @param newEffectLayer defines the effect layer to add
  61310. */
  61311. addEffectLayer(newEffectLayer: EffectLayer): void;
  61312. }
  61313. }
  61314. /**
  61315. * Defines the layer scene component responsible to manage any effect layers
  61316. * in a given scene.
  61317. */
  61318. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  61319. /**
  61320. * The component name helpfull to identify the component in the list of scene components.
  61321. */
  61322. readonly name: string;
  61323. /**
  61324. * The scene the component belongs to.
  61325. */
  61326. scene: Scene;
  61327. private _engine;
  61328. private _renderEffects;
  61329. private _needStencil;
  61330. private _previousStencilState;
  61331. /**
  61332. * Creates a new instance of the component for the given scene
  61333. * @param scene Defines the scene to register the component in
  61334. */
  61335. constructor(scene: Scene);
  61336. /**
  61337. * Registers the component in a given scene
  61338. */
  61339. register(): void;
  61340. /**
  61341. * Rebuilds the elements related to this component in case of
  61342. * context lost for instance.
  61343. */
  61344. rebuild(): void;
  61345. /**
  61346. * Serializes the component data to the specified json object
  61347. * @param serializationObject The object to serialize to
  61348. */
  61349. serialize(serializationObject: any): void;
  61350. /**
  61351. * Adds all the elements from the container to the scene
  61352. * @param container the container holding the elements
  61353. */
  61354. addFromContainer(container: AbstractScene): void;
  61355. /**
  61356. * Removes all the elements in the container from the scene
  61357. * @param container contains the elements to remove
  61358. * @param dispose if the removed element should be disposed (default: false)
  61359. */
  61360. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61361. /**
  61362. * Disposes the component and the associated ressources.
  61363. */
  61364. dispose(): void;
  61365. private _isReadyForMesh;
  61366. private _renderMainTexture;
  61367. private _setStencil;
  61368. private _setStencilBack;
  61369. private _draw;
  61370. private _drawCamera;
  61371. private _drawRenderingGroup;
  61372. }
  61373. }
  61374. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61375. /** @hidden */
  61376. export var glowMapMergePixelShader: {
  61377. name: string;
  61378. shader: string;
  61379. };
  61380. }
  61381. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61382. /** @hidden */
  61383. export var glowMapMergeVertexShader: {
  61384. name: string;
  61385. shader: string;
  61386. };
  61387. }
  61388. declare module "babylonjs/Layers/glowLayer" {
  61389. import { Nullable } from "babylonjs/types";
  61390. import { Camera } from "babylonjs/Cameras/camera";
  61391. import { Scene } from "babylonjs/scene";
  61392. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61394. import { Mesh } from "babylonjs/Meshes/mesh";
  61395. import { Texture } from "babylonjs/Materials/Textures/texture";
  61396. import { Effect } from "babylonjs/Materials/effect";
  61397. import { Material } from "babylonjs/Materials/material";
  61398. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61399. import { Color4 } from "babylonjs/Maths/math.color";
  61400. import "babylonjs/Shaders/glowMapMerge.fragment";
  61401. import "babylonjs/Shaders/glowMapMerge.vertex";
  61402. import "babylonjs/Layers/effectLayerSceneComponent";
  61403. module "babylonjs/abstractScene" {
  61404. interface AbstractScene {
  61405. /**
  61406. * Return a the first highlight layer of the scene with a given name.
  61407. * @param name The name of the highlight layer to look for.
  61408. * @return The highlight layer if found otherwise null.
  61409. */
  61410. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61411. }
  61412. }
  61413. /**
  61414. * Glow layer options. This helps customizing the behaviour
  61415. * of the glow layer.
  61416. */
  61417. export interface IGlowLayerOptions {
  61418. /**
  61419. * Multiplication factor apply to the canvas size to compute the render target size
  61420. * used to generated the glowing objects (the smaller the faster).
  61421. */
  61422. mainTextureRatio: number;
  61423. /**
  61424. * Enforces a fixed size texture to ensure resize independant blur.
  61425. */
  61426. mainTextureFixedSize?: number;
  61427. /**
  61428. * How big is the kernel of the blur texture.
  61429. */
  61430. blurKernelSize: number;
  61431. /**
  61432. * The camera attached to the layer.
  61433. */
  61434. camera: Nullable<Camera>;
  61435. /**
  61436. * Enable MSAA by chosing the number of samples.
  61437. */
  61438. mainTextureSamples?: number;
  61439. /**
  61440. * The rendering group to draw the layer in.
  61441. */
  61442. renderingGroupId: number;
  61443. }
  61444. /**
  61445. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61446. *
  61447. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61448. *
  61449. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61450. */
  61451. export class GlowLayer extends EffectLayer {
  61452. /**
  61453. * Effect Name of the layer.
  61454. */
  61455. static readonly EffectName: string;
  61456. /**
  61457. * The default blur kernel size used for the glow.
  61458. */
  61459. static DefaultBlurKernelSize: number;
  61460. /**
  61461. * The default texture size ratio used for the glow.
  61462. */
  61463. static DefaultTextureRatio: number;
  61464. /**
  61465. * Sets the kernel size of the blur.
  61466. */
  61467. set blurKernelSize(value: number);
  61468. /**
  61469. * Gets the kernel size of the blur.
  61470. */
  61471. get blurKernelSize(): number;
  61472. /**
  61473. * Sets the glow intensity.
  61474. */
  61475. set intensity(value: number);
  61476. /**
  61477. * Gets the glow intensity.
  61478. */
  61479. get intensity(): number;
  61480. private _options;
  61481. private _intensity;
  61482. private _horizontalBlurPostprocess1;
  61483. private _verticalBlurPostprocess1;
  61484. private _horizontalBlurPostprocess2;
  61485. private _verticalBlurPostprocess2;
  61486. private _blurTexture1;
  61487. private _blurTexture2;
  61488. private _postProcesses1;
  61489. private _postProcesses2;
  61490. private _includedOnlyMeshes;
  61491. private _excludedMeshes;
  61492. private _meshesUsingTheirOwnMaterials;
  61493. /**
  61494. * Callback used to let the user override the color selection on a per mesh basis
  61495. */
  61496. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61497. /**
  61498. * Callback used to let the user override the texture selection on a per mesh basis
  61499. */
  61500. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61501. /**
  61502. * Instantiates a new glow Layer and references it to the scene.
  61503. * @param name The name of the layer
  61504. * @param scene The scene to use the layer in
  61505. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61506. */
  61507. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61508. /**
  61509. * Get the effect name of the layer.
  61510. * @return The effect name
  61511. */
  61512. getEffectName(): string;
  61513. /**
  61514. * Create the merge effect. This is the shader use to blit the information back
  61515. * to the main canvas at the end of the scene rendering.
  61516. */
  61517. protected _createMergeEffect(): Effect;
  61518. /**
  61519. * Creates the render target textures and post processes used in the glow layer.
  61520. */
  61521. protected _createTextureAndPostProcesses(): void;
  61522. /**
  61523. * Checks for the readiness of the element composing the layer.
  61524. * @param subMesh the mesh to check for
  61525. * @param useInstances specify wether or not to use instances to render the mesh
  61526. * @param emissiveTexture the associated emissive texture used to generate the glow
  61527. * @return true if ready otherwise, false
  61528. */
  61529. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61530. /**
  61531. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61532. */
  61533. needStencil(): boolean;
  61534. /**
  61535. * Returns true if the mesh can be rendered, otherwise false.
  61536. * @param mesh The mesh to render
  61537. * @param material The material used on the mesh
  61538. * @returns true if it can be rendered otherwise false
  61539. */
  61540. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61541. /**
  61542. * Implementation specific of rendering the generating effect on the main canvas.
  61543. * @param effect The effect used to render through
  61544. */
  61545. protected _internalRender(effect: Effect): void;
  61546. /**
  61547. * Sets the required values for both the emissive texture and and the main color.
  61548. */
  61549. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61550. /**
  61551. * Returns true if the mesh should render, otherwise false.
  61552. * @param mesh The mesh to render
  61553. * @returns true if it should render otherwise false
  61554. */
  61555. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61556. /**
  61557. * Adds specific effects defines.
  61558. * @param defines The defines to add specifics to.
  61559. */
  61560. protected _addCustomEffectDefines(defines: string[]): void;
  61561. /**
  61562. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61563. * @param mesh The mesh to exclude from the glow layer
  61564. */
  61565. addExcludedMesh(mesh: Mesh): void;
  61566. /**
  61567. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61568. * @param mesh The mesh to remove
  61569. */
  61570. removeExcludedMesh(mesh: Mesh): void;
  61571. /**
  61572. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61573. * @param mesh The mesh to include in the glow layer
  61574. */
  61575. addIncludedOnlyMesh(mesh: Mesh): void;
  61576. /**
  61577. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61578. * @param mesh The mesh to remove
  61579. */
  61580. removeIncludedOnlyMesh(mesh: Mesh): void;
  61581. /**
  61582. * Determine if a given mesh will be used in the glow layer
  61583. * @param mesh The mesh to test
  61584. * @returns true if the mesh will be highlighted by the current glow layer
  61585. */
  61586. hasMesh(mesh: AbstractMesh): boolean;
  61587. /**
  61588. * Defines whether the current material of the mesh should be use to render the effect.
  61589. * @param mesh defines the current mesh to render
  61590. */
  61591. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61592. /**
  61593. * Add a mesh to be rendered through its own material and not with emissive only.
  61594. * @param mesh The mesh for which we need to use its material
  61595. */
  61596. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61597. /**
  61598. * Remove a mesh from being rendered through its own material and not with emissive only.
  61599. * @param mesh The mesh for which we need to not use its material
  61600. */
  61601. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61602. /**
  61603. * Free any resources and references associated to a mesh.
  61604. * Internal use
  61605. * @param mesh The mesh to free.
  61606. * @hidden
  61607. */
  61608. _disposeMesh(mesh: Mesh): void;
  61609. /**
  61610. * Gets the class name of the effect layer
  61611. * @returns the string with the class name of the effect layer
  61612. */
  61613. getClassName(): string;
  61614. /**
  61615. * Serializes this glow layer
  61616. * @returns a serialized glow layer object
  61617. */
  61618. serialize(): any;
  61619. /**
  61620. * Creates a Glow Layer from parsed glow layer data
  61621. * @param parsedGlowLayer defines glow layer data
  61622. * @param scene defines the current scene
  61623. * @param rootUrl defines the root URL containing the glow layer information
  61624. * @returns a parsed Glow Layer
  61625. */
  61626. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61627. }
  61628. }
  61629. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61630. /** @hidden */
  61631. export var glowBlurPostProcessPixelShader: {
  61632. name: string;
  61633. shader: string;
  61634. };
  61635. }
  61636. declare module "babylonjs/Layers/highlightLayer" {
  61637. import { Observable } from "babylonjs/Misc/observable";
  61638. import { Nullable } from "babylonjs/types";
  61639. import { Camera } from "babylonjs/Cameras/camera";
  61640. import { Scene } from "babylonjs/scene";
  61641. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61643. import { Mesh } from "babylonjs/Meshes/mesh";
  61644. import { Effect } from "babylonjs/Materials/effect";
  61645. import { Material } from "babylonjs/Materials/material";
  61646. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61647. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61648. import "babylonjs/Shaders/glowMapMerge.fragment";
  61649. import "babylonjs/Shaders/glowMapMerge.vertex";
  61650. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61651. module "babylonjs/abstractScene" {
  61652. interface AbstractScene {
  61653. /**
  61654. * Return a the first highlight layer of the scene with a given name.
  61655. * @param name The name of the highlight layer to look for.
  61656. * @return The highlight layer if found otherwise null.
  61657. */
  61658. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61659. }
  61660. }
  61661. /**
  61662. * Highlight layer options. This helps customizing the behaviour
  61663. * of the highlight layer.
  61664. */
  61665. export interface IHighlightLayerOptions {
  61666. /**
  61667. * Multiplication factor apply to the canvas size to compute the render target size
  61668. * used to generated the glowing objects (the smaller the faster).
  61669. */
  61670. mainTextureRatio: number;
  61671. /**
  61672. * Enforces a fixed size texture to ensure resize independant blur.
  61673. */
  61674. mainTextureFixedSize?: number;
  61675. /**
  61676. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61677. * of the picture to blur (the smaller the faster).
  61678. */
  61679. blurTextureSizeRatio: number;
  61680. /**
  61681. * How big in texel of the blur texture is the vertical blur.
  61682. */
  61683. blurVerticalSize: number;
  61684. /**
  61685. * How big in texel of the blur texture is the horizontal blur.
  61686. */
  61687. blurHorizontalSize: number;
  61688. /**
  61689. * Alpha blending mode used to apply the blur. Default is combine.
  61690. */
  61691. alphaBlendingMode: number;
  61692. /**
  61693. * The camera attached to the layer.
  61694. */
  61695. camera: Nullable<Camera>;
  61696. /**
  61697. * Should we display highlight as a solid stroke?
  61698. */
  61699. isStroke?: boolean;
  61700. /**
  61701. * The rendering group to draw the layer in.
  61702. */
  61703. renderingGroupId: number;
  61704. }
  61705. /**
  61706. * The highlight layer Helps adding a glow effect around a mesh.
  61707. *
  61708. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61709. * glowy meshes to your scene.
  61710. *
  61711. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61712. */
  61713. export class HighlightLayer extends EffectLayer {
  61714. name: string;
  61715. /**
  61716. * Effect Name of the highlight layer.
  61717. */
  61718. static readonly EffectName: string;
  61719. /**
  61720. * The neutral color used during the preparation of the glow effect.
  61721. * This is black by default as the blend operation is a blend operation.
  61722. */
  61723. static NeutralColor: Color4;
  61724. /**
  61725. * Stencil value used for glowing meshes.
  61726. */
  61727. static GlowingMeshStencilReference: number;
  61728. /**
  61729. * Stencil value used for the other meshes in the scene.
  61730. */
  61731. static NormalMeshStencilReference: number;
  61732. /**
  61733. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61734. */
  61735. innerGlow: boolean;
  61736. /**
  61737. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61738. */
  61739. outerGlow: boolean;
  61740. /**
  61741. * Specifies the horizontal size of the blur.
  61742. */
  61743. set blurHorizontalSize(value: number);
  61744. /**
  61745. * Specifies the vertical size of the blur.
  61746. */
  61747. set blurVerticalSize(value: number);
  61748. /**
  61749. * Gets the horizontal size of the blur.
  61750. */
  61751. get blurHorizontalSize(): number;
  61752. /**
  61753. * Gets the vertical size of the blur.
  61754. */
  61755. get blurVerticalSize(): number;
  61756. /**
  61757. * An event triggered when the highlight layer is being blurred.
  61758. */
  61759. onBeforeBlurObservable: Observable<HighlightLayer>;
  61760. /**
  61761. * An event triggered when the highlight layer has been blurred.
  61762. */
  61763. onAfterBlurObservable: Observable<HighlightLayer>;
  61764. private _instanceGlowingMeshStencilReference;
  61765. private _options;
  61766. private _downSamplePostprocess;
  61767. private _horizontalBlurPostprocess;
  61768. private _verticalBlurPostprocess;
  61769. private _blurTexture;
  61770. private _meshes;
  61771. private _excludedMeshes;
  61772. /**
  61773. * Instantiates a new highlight Layer and references it to the scene..
  61774. * @param name The name of the layer
  61775. * @param scene The scene to use the layer in
  61776. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61777. */
  61778. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61779. /**
  61780. * Get the effect name of the layer.
  61781. * @return The effect name
  61782. */
  61783. getEffectName(): string;
  61784. /**
  61785. * Create the merge effect. This is the shader use to blit the information back
  61786. * to the main canvas at the end of the scene rendering.
  61787. */
  61788. protected _createMergeEffect(): Effect;
  61789. /**
  61790. * Creates the render target textures and post processes used in the highlight layer.
  61791. */
  61792. protected _createTextureAndPostProcesses(): void;
  61793. /**
  61794. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61795. */
  61796. needStencil(): boolean;
  61797. /**
  61798. * Checks for the readiness of the element composing the layer.
  61799. * @param subMesh the mesh to check for
  61800. * @param useInstances specify wether or not to use instances to render the mesh
  61801. * @param emissiveTexture the associated emissive texture used to generate the glow
  61802. * @return true if ready otherwise, false
  61803. */
  61804. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61805. /**
  61806. * Implementation specific of rendering the generating effect on the main canvas.
  61807. * @param effect The effect used to render through
  61808. */
  61809. protected _internalRender(effect: Effect): void;
  61810. /**
  61811. * Returns true if the layer contains information to display, otherwise false.
  61812. */
  61813. shouldRender(): boolean;
  61814. /**
  61815. * Returns true if the mesh should render, otherwise false.
  61816. * @param mesh The mesh to render
  61817. * @returns true if it should render otherwise false
  61818. */
  61819. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61820. /**
  61821. * Returns true if the mesh can be rendered, otherwise false.
  61822. * @param mesh The mesh to render
  61823. * @param material The material used on the mesh
  61824. * @returns true if it can be rendered otherwise false
  61825. */
  61826. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61827. /**
  61828. * Adds specific effects defines.
  61829. * @param defines The defines to add specifics to.
  61830. */
  61831. protected _addCustomEffectDefines(defines: string[]): void;
  61832. /**
  61833. * Sets the required values for both the emissive texture and and the main color.
  61834. */
  61835. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61836. /**
  61837. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61838. * @param mesh The mesh to exclude from the highlight layer
  61839. */
  61840. addExcludedMesh(mesh: Mesh): void;
  61841. /**
  61842. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61843. * @param mesh The mesh to highlight
  61844. */
  61845. removeExcludedMesh(mesh: Mesh): void;
  61846. /**
  61847. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61848. * @param mesh mesh to test
  61849. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61850. */
  61851. hasMesh(mesh: AbstractMesh): boolean;
  61852. /**
  61853. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61854. * @param mesh The mesh to highlight
  61855. * @param color The color of the highlight
  61856. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61857. */
  61858. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61859. /**
  61860. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61861. * @param mesh The mesh to highlight
  61862. */
  61863. removeMesh(mesh: Mesh): void;
  61864. /**
  61865. * Remove all the meshes currently referenced in the highlight layer
  61866. */
  61867. removeAllMeshes(): void;
  61868. /**
  61869. * Force the stencil to the normal expected value for none glowing parts
  61870. */
  61871. private _defaultStencilReference;
  61872. /**
  61873. * Free any resources and references associated to a mesh.
  61874. * Internal use
  61875. * @param mesh The mesh to free.
  61876. * @hidden
  61877. */
  61878. _disposeMesh(mesh: Mesh): void;
  61879. /**
  61880. * Dispose the highlight layer and free resources.
  61881. */
  61882. dispose(): void;
  61883. /**
  61884. * Gets the class name of the effect layer
  61885. * @returns the string with the class name of the effect layer
  61886. */
  61887. getClassName(): string;
  61888. /**
  61889. * Serializes this Highlight layer
  61890. * @returns a serialized Highlight layer object
  61891. */
  61892. serialize(): any;
  61893. /**
  61894. * Creates a Highlight layer from parsed Highlight layer data
  61895. * @param parsedHightlightLayer defines the Highlight layer data
  61896. * @param scene defines the current scene
  61897. * @param rootUrl defines the root URL containing the Highlight layer information
  61898. * @returns a parsed Highlight layer
  61899. */
  61900. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61901. }
  61902. }
  61903. declare module "babylonjs/Layers/layerSceneComponent" {
  61904. import { Scene } from "babylonjs/scene";
  61905. import { ISceneComponent } from "babylonjs/sceneComponent";
  61906. import { Layer } from "babylonjs/Layers/layer";
  61907. import { AbstractScene } from "babylonjs/abstractScene";
  61908. module "babylonjs/abstractScene" {
  61909. interface AbstractScene {
  61910. /**
  61911. * The list of layers (background and foreground) of the scene
  61912. */
  61913. layers: Array<Layer>;
  61914. }
  61915. }
  61916. /**
  61917. * Defines the layer scene component responsible to manage any layers
  61918. * in a given scene.
  61919. */
  61920. export class LayerSceneComponent implements ISceneComponent {
  61921. /**
  61922. * The component name helpfull to identify the component in the list of scene components.
  61923. */
  61924. readonly name: string;
  61925. /**
  61926. * The scene the component belongs to.
  61927. */
  61928. scene: Scene;
  61929. private _engine;
  61930. /**
  61931. * Creates a new instance of the component for the given scene
  61932. * @param scene Defines the scene to register the component in
  61933. */
  61934. constructor(scene: Scene);
  61935. /**
  61936. * Registers the component in a given scene
  61937. */
  61938. register(): void;
  61939. /**
  61940. * Rebuilds the elements related to this component in case of
  61941. * context lost for instance.
  61942. */
  61943. rebuild(): void;
  61944. /**
  61945. * Disposes the component and the associated ressources.
  61946. */
  61947. dispose(): void;
  61948. private _draw;
  61949. private _drawCameraPredicate;
  61950. private _drawCameraBackground;
  61951. private _drawCameraForeground;
  61952. private _drawRenderTargetPredicate;
  61953. private _drawRenderTargetBackground;
  61954. private _drawRenderTargetForeground;
  61955. /**
  61956. * Adds all the elements from the container to the scene
  61957. * @param container the container holding the elements
  61958. */
  61959. addFromContainer(container: AbstractScene): void;
  61960. /**
  61961. * Removes all the elements in the container from the scene
  61962. * @param container contains the elements to remove
  61963. * @param dispose if the removed element should be disposed (default: false)
  61964. */
  61965. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61966. }
  61967. }
  61968. declare module "babylonjs/Shaders/layer.fragment" {
  61969. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61970. /** @hidden */
  61971. export var layerPixelShader: {
  61972. name: string;
  61973. shader: string;
  61974. };
  61975. }
  61976. declare module "babylonjs/Shaders/layer.vertex" {
  61977. /** @hidden */
  61978. export var layerVertexShader: {
  61979. name: string;
  61980. shader: string;
  61981. };
  61982. }
  61983. declare module "babylonjs/Layers/layer" {
  61984. import { Observable } from "babylonjs/Misc/observable";
  61985. import { Nullable } from "babylonjs/types";
  61986. import { Scene } from "babylonjs/scene";
  61987. import { Vector2 } from "babylonjs/Maths/math.vector";
  61988. import { Color4 } from "babylonjs/Maths/math.color";
  61989. import { Texture } from "babylonjs/Materials/Textures/texture";
  61990. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61991. import "babylonjs/Shaders/layer.fragment";
  61992. import "babylonjs/Shaders/layer.vertex";
  61993. /**
  61994. * This represents a full screen 2d layer.
  61995. * This can be useful to display a picture in the background of your scene for instance.
  61996. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61997. */
  61998. export class Layer {
  61999. /**
  62000. * Define the name of the layer.
  62001. */
  62002. name: string;
  62003. /**
  62004. * Define the texture the layer should display.
  62005. */
  62006. texture: Nullable<Texture>;
  62007. /**
  62008. * Is the layer in background or foreground.
  62009. */
  62010. isBackground: boolean;
  62011. /**
  62012. * Define the color of the layer (instead of texture).
  62013. */
  62014. color: Color4;
  62015. /**
  62016. * Define the scale of the layer in order to zoom in out of the texture.
  62017. */
  62018. scale: Vector2;
  62019. /**
  62020. * Define an offset for the layer in order to shift the texture.
  62021. */
  62022. offset: Vector2;
  62023. /**
  62024. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  62025. */
  62026. alphaBlendingMode: number;
  62027. /**
  62028. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  62029. * Alpha test will not mix with the background color in case of transparency.
  62030. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  62031. */
  62032. alphaTest: boolean;
  62033. /**
  62034. * Define a mask to restrict the layer to only some of the scene cameras.
  62035. */
  62036. layerMask: number;
  62037. /**
  62038. * Define the list of render target the layer is visible into.
  62039. */
  62040. renderTargetTextures: RenderTargetTexture[];
  62041. /**
  62042. * Define if the layer is only used in renderTarget or if it also
  62043. * renders in the main frame buffer of the canvas.
  62044. */
  62045. renderOnlyInRenderTargetTextures: boolean;
  62046. private _scene;
  62047. private _vertexBuffers;
  62048. private _indexBuffer;
  62049. private _effect;
  62050. private _previousDefines;
  62051. /**
  62052. * An event triggered when the layer is disposed.
  62053. */
  62054. onDisposeObservable: Observable<Layer>;
  62055. private _onDisposeObserver;
  62056. /**
  62057. * Back compatibility with callback before the onDisposeObservable existed.
  62058. * The set callback will be triggered when the layer has been disposed.
  62059. */
  62060. set onDispose(callback: () => void);
  62061. /**
  62062. * An event triggered before rendering the scene
  62063. */
  62064. onBeforeRenderObservable: Observable<Layer>;
  62065. private _onBeforeRenderObserver;
  62066. /**
  62067. * Back compatibility with callback before the onBeforeRenderObservable existed.
  62068. * The set callback will be triggered just before rendering the layer.
  62069. */
  62070. set onBeforeRender(callback: () => void);
  62071. /**
  62072. * An event triggered after rendering the scene
  62073. */
  62074. onAfterRenderObservable: Observable<Layer>;
  62075. private _onAfterRenderObserver;
  62076. /**
  62077. * Back compatibility with callback before the onAfterRenderObservable existed.
  62078. * The set callback will be triggered just after rendering the layer.
  62079. */
  62080. set onAfterRender(callback: () => void);
  62081. /**
  62082. * Instantiates a new layer.
  62083. * This represents a full screen 2d layer.
  62084. * This can be useful to display a picture in the background of your scene for instance.
  62085. * @see https://www.babylonjs-playground.com/#08A2BS#1
  62086. * @param name Define the name of the layer in the scene
  62087. * @param imgUrl Define the url of the texture to display in the layer
  62088. * @param scene Define the scene the layer belongs to
  62089. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  62090. * @param color Defines a color for the layer
  62091. */
  62092. constructor(
  62093. /**
  62094. * Define the name of the layer.
  62095. */
  62096. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  62097. private _createIndexBuffer;
  62098. /** @hidden */
  62099. _rebuild(): void;
  62100. /**
  62101. * Renders the layer in the scene.
  62102. */
  62103. render(): void;
  62104. /**
  62105. * Disposes and releases the associated ressources.
  62106. */
  62107. dispose(): void;
  62108. }
  62109. }
  62110. declare module "babylonjs/Layers/index" {
  62111. export * from "babylonjs/Layers/effectLayer";
  62112. export * from "babylonjs/Layers/effectLayerSceneComponent";
  62113. export * from "babylonjs/Layers/glowLayer";
  62114. export * from "babylonjs/Layers/highlightLayer";
  62115. export * from "babylonjs/Layers/layer";
  62116. export * from "babylonjs/Layers/layerSceneComponent";
  62117. }
  62118. declare module "babylonjs/Shaders/lensFlare.fragment" {
  62119. /** @hidden */
  62120. export var lensFlarePixelShader: {
  62121. name: string;
  62122. shader: string;
  62123. };
  62124. }
  62125. declare module "babylonjs/Shaders/lensFlare.vertex" {
  62126. /** @hidden */
  62127. export var lensFlareVertexShader: {
  62128. name: string;
  62129. shader: string;
  62130. };
  62131. }
  62132. declare module "babylonjs/LensFlares/lensFlareSystem" {
  62133. import { Scene } from "babylonjs/scene";
  62134. import { Vector3 } from "babylonjs/Maths/math.vector";
  62135. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62136. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  62137. import "babylonjs/Shaders/lensFlare.fragment";
  62138. import "babylonjs/Shaders/lensFlare.vertex";
  62139. import { Viewport } from "babylonjs/Maths/math.viewport";
  62140. /**
  62141. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62142. * It is usually composed of several `lensFlare`.
  62143. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62144. */
  62145. export class LensFlareSystem {
  62146. /**
  62147. * Define the name of the lens flare system
  62148. */
  62149. name: string;
  62150. /**
  62151. * List of lens flares used in this system.
  62152. */
  62153. lensFlares: LensFlare[];
  62154. /**
  62155. * Define a limit from the border the lens flare can be visible.
  62156. */
  62157. borderLimit: number;
  62158. /**
  62159. * Define a viewport border we do not want to see the lens flare in.
  62160. */
  62161. viewportBorder: number;
  62162. /**
  62163. * Define a predicate which could limit the list of meshes able to occlude the effect.
  62164. */
  62165. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  62166. /**
  62167. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  62168. */
  62169. layerMask: number;
  62170. /**
  62171. * Define the id of the lens flare system in the scene.
  62172. * (equal to name by default)
  62173. */
  62174. id: string;
  62175. private _scene;
  62176. private _emitter;
  62177. private _vertexBuffers;
  62178. private _indexBuffer;
  62179. private _effect;
  62180. private _positionX;
  62181. private _positionY;
  62182. private _isEnabled;
  62183. /** @hidden */
  62184. static _SceneComponentInitialization: (scene: Scene) => void;
  62185. /**
  62186. * Instantiates a lens flare system.
  62187. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62188. * It is usually composed of several `lensFlare`.
  62189. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62190. * @param name Define the name of the lens flare system in the scene
  62191. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  62192. * @param scene Define the scene the lens flare system belongs to
  62193. */
  62194. constructor(
  62195. /**
  62196. * Define the name of the lens flare system
  62197. */
  62198. name: string, emitter: any, scene: Scene);
  62199. /**
  62200. * Define if the lens flare system is enabled.
  62201. */
  62202. get isEnabled(): boolean;
  62203. set isEnabled(value: boolean);
  62204. /**
  62205. * Get the scene the effects belongs to.
  62206. * @returns the scene holding the lens flare system
  62207. */
  62208. getScene(): Scene;
  62209. /**
  62210. * Get the emitter of the lens flare system.
  62211. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62212. * @returns the emitter of the lens flare system
  62213. */
  62214. getEmitter(): any;
  62215. /**
  62216. * Set the emitter of the lens flare system.
  62217. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62218. * @param newEmitter Define the new emitter of the system
  62219. */
  62220. setEmitter(newEmitter: any): void;
  62221. /**
  62222. * Get the lens flare system emitter position.
  62223. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  62224. * @returns the position
  62225. */
  62226. getEmitterPosition(): Vector3;
  62227. /**
  62228. * @hidden
  62229. */
  62230. computeEffectivePosition(globalViewport: Viewport): boolean;
  62231. /** @hidden */
  62232. _isVisible(): boolean;
  62233. /**
  62234. * @hidden
  62235. */
  62236. render(): boolean;
  62237. /**
  62238. * Dispose and release the lens flare with its associated resources.
  62239. */
  62240. dispose(): void;
  62241. /**
  62242. * Parse a lens flare system from a JSON repressentation
  62243. * @param parsedLensFlareSystem Define the JSON to parse
  62244. * @param scene Define the scene the parsed system should be instantiated in
  62245. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  62246. * @returns the parsed system
  62247. */
  62248. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  62249. /**
  62250. * Serialize the current Lens Flare System into a JSON representation.
  62251. * @returns the serialized JSON
  62252. */
  62253. serialize(): any;
  62254. }
  62255. }
  62256. declare module "babylonjs/LensFlares/lensFlare" {
  62257. import { Nullable } from "babylonjs/types";
  62258. import { Color3 } from "babylonjs/Maths/math.color";
  62259. import { Texture } from "babylonjs/Materials/Textures/texture";
  62260. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62261. /**
  62262. * This represents one of the lens effect in a `lensFlareSystem`.
  62263. * It controls one of the indiviual texture used in the effect.
  62264. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62265. */
  62266. export class LensFlare {
  62267. /**
  62268. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62269. */
  62270. size: number;
  62271. /**
  62272. * 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.
  62273. */
  62274. position: number;
  62275. /**
  62276. * Define the lens color.
  62277. */
  62278. color: Color3;
  62279. /**
  62280. * Define the lens texture.
  62281. */
  62282. texture: Nullable<Texture>;
  62283. /**
  62284. * Define the alpha mode to render this particular lens.
  62285. */
  62286. alphaMode: number;
  62287. private _system;
  62288. /**
  62289. * Creates a new Lens Flare.
  62290. * This represents one of the lens effect in a `lensFlareSystem`.
  62291. * It controls one of the indiviual texture used in the effect.
  62292. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62293. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  62294. * @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.
  62295. * @param color Define the lens color
  62296. * @param imgUrl Define the lens texture url
  62297. * @param system Define the `lensFlareSystem` this flare is part of
  62298. * @returns The newly created Lens Flare
  62299. */
  62300. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  62301. /**
  62302. * Instantiates a new Lens Flare.
  62303. * This represents one of the lens effect in a `lensFlareSystem`.
  62304. * It controls one of the indiviual texture used in the effect.
  62305. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62306. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  62307. * @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.
  62308. * @param color Define the lens color
  62309. * @param imgUrl Define the lens texture url
  62310. * @param system Define the `lensFlareSystem` this flare is part of
  62311. */
  62312. constructor(
  62313. /**
  62314. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62315. */
  62316. size: number,
  62317. /**
  62318. * 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.
  62319. */
  62320. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  62321. /**
  62322. * Dispose and release the lens flare with its associated resources.
  62323. */
  62324. dispose(): void;
  62325. }
  62326. }
  62327. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62328. import { Nullable } from "babylonjs/types";
  62329. import { Scene } from "babylonjs/scene";
  62330. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62331. import { AbstractScene } from "babylonjs/abstractScene";
  62332. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62333. module "babylonjs/abstractScene" {
  62334. interface AbstractScene {
  62335. /**
  62336. * The list of lens flare system added to the scene
  62337. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62338. */
  62339. lensFlareSystems: Array<LensFlareSystem>;
  62340. /**
  62341. * Removes the given lens flare system from this scene.
  62342. * @param toRemove The lens flare system to remove
  62343. * @returns The index of the removed lens flare system
  62344. */
  62345. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62346. /**
  62347. * Adds the given lens flare system to this scene
  62348. * @param newLensFlareSystem The lens flare system to add
  62349. */
  62350. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62351. /**
  62352. * Gets a lens flare system using its name
  62353. * @param name defines the name to look for
  62354. * @returns the lens flare system or null if not found
  62355. */
  62356. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62357. /**
  62358. * Gets a lens flare system using its id
  62359. * @param id defines the id to look for
  62360. * @returns the lens flare system or null if not found
  62361. */
  62362. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62363. }
  62364. }
  62365. /**
  62366. * Defines the lens flare scene component responsible to manage any lens flares
  62367. * in a given scene.
  62368. */
  62369. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62370. /**
  62371. * The component name helpfull to identify the component in the list of scene components.
  62372. */
  62373. readonly name: string;
  62374. /**
  62375. * The scene the component belongs to.
  62376. */
  62377. scene: Scene;
  62378. /**
  62379. * Creates a new instance of the component for the given scene
  62380. * @param scene Defines the scene to register the component in
  62381. */
  62382. constructor(scene: Scene);
  62383. /**
  62384. * Registers the component in a given scene
  62385. */
  62386. register(): void;
  62387. /**
  62388. * Rebuilds the elements related to this component in case of
  62389. * context lost for instance.
  62390. */
  62391. rebuild(): void;
  62392. /**
  62393. * Adds all the elements from the container to the scene
  62394. * @param container the container holding the elements
  62395. */
  62396. addFromContainer(container: AbstractScene): void;
  62397. /**
  62398. * Removes all the elements in the container from the scene
  62399. * @param container contains the elements to remove
  62400. * @param dispose if the removed element should be disposed (default: false)
  62401. */
  62402. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62403. /**
  62404. * Serializes the component data to the specified json object
  62405. * @param serializationObject The object to serialize to
  62406. */
  62407. serialize(serializationObject: any): void;
  62408. /**
  62409. * Disposes the component and the associated ressources.
  62410. */
  62411. dispose(): void;
  62412. private _draw;
  62413. }
  62414. }
  62415. declare module "babylonjs/LensFlares/index" {
  62416. export * from "babylonjs/LensFlares/lensFlare";
  62417. export * from "babylonjs/LensFlares/lensFlareSystem";
  62418. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62419. }
  62420. declare module "babylonjs/Shaders/depth.fragment" {
  62421. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62422. /** @hidden */
  62423. export var depthPixelShader: {
  62424. name: string;
  62425. shader: string;
  62426. };
  62427. }
  62428. declare module "babylonjs/Shaders/depth.vertex" {
  62429. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62430. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62431. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62432. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62433. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62434. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62435. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62436. /** @hidden */
  62437. export var depthVertexShader: {
  62438. name: string;
  62439. shader: string;
  62440. };
  62441. }
  62442. declare module "babylonjs/Rendering/depthRenderer" {
  62443. import { Nullable } from "babylonjs/types";
  62444. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62445. import { Scene } from "babylonjs/scene";
  62446. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62447. import { Camera } from "babylonjs/Cameras/camera";
  62448. import "babylonjs/Shaders/depth.fragment";
  62449. import "babylonjs/Shaders/depth.vertex";
  62450. /**
  62451. * This represents a depth renderer in Babylon.
  62452. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62453. */
  62454. export class DepthRenderer {
  62455. private _scene;
  62456. private _depthMap;
  62457. private _effect;
  62458. private readonly _storeNonLinearDepth;
  62459. private readonly _clearColor;
  62460. /** Get if the depth renderer is using packed depth or not */
  62461. readonly isPacked: boolean;
  62462. private _cachedDefines;
  62463. private _camera;
  62464. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62465. enabled: boolean;
  62466. /**
  62467. * Specifiess that the depth renderer will only be used within
  62468. * the camera it is created for.
  62469. * This can help forcing its rendering during the camera processing.
  62470. */
  62471. useOnlyInActiveCamera: boolean;
  62472. /** @hidden */
  62473. static _SceneComponentInitialization: (scene: Scene) => void;
  62474. /**
  62475. * Instantiates a depth renderer
  62476. * @param scene The scene the renderer belongs to
  62477. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62478. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62479. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62480. */
  62481. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62482. /**
  62483. * Creates the depth rendering effect and checks if the effect is ready.
  62484. * @param subMesh The submesh to be used to render the depth map of
  62485. * @param useInstances If multiple world instances should be used
  62486. * @returns if the depth renderer is ready to render the depth map
  62487. */
  62488. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62489. /**
  62490. * Gets the texture which the depth map will be written to.
  62491. * @returns The depth map texture
  62492. */
  62493. getDepthMap(): RenderTargetTexture;
  62494. /**
  62495. * Disposes of the depth renderer.
  62496. */
  62497. dispose(): void;
  62498. }
  62499. }
  62500. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62501. /** @hidden */
  62502. export var minmaxReduxPixelShader: {
  62503. name: string;
  62504. shader: string;
  62505. };
  62506. }
  62507. declare module "babylonjs/Misc/minMaxReducer" {
  62508. import { Nullable } from "babylonjs/types";
  62509. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62510. import { Camera } from "babylonjs/Cameras/camera";
  62511. import { Observer } from "babylonjs/Misc/observable";
  62512. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62513. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62514. import { Observable } from "babylonjs/Misc/observable";
  62515. import "babylonjs/Shaders/minmaxRedux.fragment";
  62516. /**
  62517. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62518. * and maximum values from all values of the texture.
  62519. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62520. * The source values are read from the red channel of the texture.
  62521. */
  62522. export class MinMaxReducer {
  62523. /**
  62524. * Observable triggered when the computation has been performed
  62525. */
  62526. onAfterReductionPerformed: Observable<{
  62527. min: number;
  62528. max: number;
  62529. }>;
  62530. protected _camera: Camera;
  62531. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62532. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62533. protected _postProcessManager: PostProcessManager;
  62534. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62535. protected _forceFullscreenViewport: boolean;
  62536. /**
  62537. * Creates a min/max reducer
  62538. * @param camera The camera to use for the post processes
  62539. */
  62540. constructor(camera: Camera);
  62541. /**
  62542. * Gets the texture used to read the values from.
  62543. */
  62544. get sourceTexture(): Nullable<RenderTargetTexture>;
  62545. /**
  62546. * Sets the source texture to read the values from.
  62547. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62548. * because in such textures '1' value must not be taken into account to compute the maximum
  62549. * as this value is used to clear the texture.
  62550. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62551. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62552. * @param depthRedux Indicates if the texture is a depth texture or not
  62553. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62554. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62555. */
  62556. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62557. /**
  62558. * Defines the refresh rate of the computation.
  62559. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62560. */
  62561. get refreshRate(): number;
  62562. set refreshRate(value: number);
  62563. protected _activated: boolean;
  62564. /**
  62565. * Gets the activation status of the reducer
  62566. */
  62567. get activated(): boolean;
  62568. /**
  62569. * Activates the reduction computation.
  62570. * When activated, the observers registered in onAfterReductionPerformed are
  62571. * called after the compuation is performed
  62572. */
  62573. activate(): void;
  62574. /**
  62575. * Deactivates the reduction computation.
  62576. */
  62577. deactivate(): void;
  62578. /**
  62579. * Disposes the min/max reducer
  62580. * @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.
  62581. */
  62582. dispose(disposeAll?: boolean): void;
  62583. }
  62584. }
  62585. declare module "babylonjs/Misc/depthReducer" {
  62586. import { Nullable } from "babylonjs/types";
  62587. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62588. import { Camera } from "babylonjs/Cameras/camera";
  62589. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62590. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62591. /**
  62592. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62593. */
  62594. export class DepthReducer extends MinMaxReducer {
  62595. private _depthRenderer;
  62596. private _depthRendererId;
  62597. /**
  62598. * Gets the depth renderer used for the computation.
  62599. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62600. */
  62601. get depthRenderer(): Nullable<DepthRenderer>;
  62602. /**
  62603. * Creates a depth reducer
  62604. * @param camera The camera used to render the depth texture
  62605. */
  62606. constructor(camera: Camera);
  62607. /**
  62608. * Sets the depth renderer to use to generate the depth map
  62609. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62610. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62611. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62612. */
  62613. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62614. /** @hidden */
  62615. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62616. /**
  62617. * Activates the reduction computation.
  62618. * When activated, the observers registered in onAfterReductionPerformed are
  62619. * called after the compuation is performed
  62620. */
  62621. activate(): void;
  62622. /**
  62623. * Deactivates the reduction computation.
  62624. */
  62625. deactivate(): void;
  62626. /**
  62627. * Disposes the depth reducer
  62628. * @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.
  62629. */
  62630. dispose(disposeAll?: boolean): void;
  62631. }
  62632. }
  62633. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62634. import { Nullable } from "babylonjs/types";
  62635. import { Scene } from "babylonjs/scene";
  62636. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62637. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62638. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62639. import { Effect } from "babylonjs/Materials/effect";
  62640. import "babylonjs/Shaders/shadowMap.fragment";
  62641. import "babylonjs/Shaders/shadowMap.vertex";
  62642. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62643. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62644. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62645. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62646. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62647. /**
  62648. * A CSM implementation allowing casting shadows on large scenes.
  62649. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62650. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62651. */
  62652. export class CascadedShadowGenerator extends ShadowGenerator {
  62653. private static readonly frustumCornersNDCSpace;
  62654. /**
  62655. * Name of the CSM class
  62656. */
  62657. static CLASSNAME: string;
  62658. /**
  62659. * Defines the default number of cascades used by the CSM.
  62660. */
  62661. static readonly DEFAULT_CASCADES_COUNT: number;
  62662. /**
  62663. * Defines the minimum number of cascades used by the CSM.
  62664. */
  62665. static readonly MIN_CASCADES_COUNT: number;
  62666. /**
  62667. * Defines the maximum number of cascades used by the CSM.
  62668. */
  62669. static readonly MAX_CASCADES_COUNT: number;
  62670. protected _validateFilter(filter: number): number;
  62671. /**
  62672. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62673. */
  62674. penumbraDarkness: number;
  62675. private _numCascades;
  62676. /**
  62677. * Gets or set the number of cascades used by the CSM.
  62678. */
  62679. get numCascades(): number;
  62680. set numCascades(value: number);
  62681. /**
  62682. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62683. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62684. */
  62685. stabilizeCascades: boolean;
  62686. private _freezeShadowCastersBoundingInfo;
  62687. private _freezeShadowCastersBoundingInfoObservable;
  62688. /**
  62689. * Enables or disables the shadow casters bounding info computation.
  62690. * If your shadow casters don't move, you can disable this feature.
  62691. * If it is enabled, the bounding box computation is done every frame.
  62692. */
  62693. get freezeShadowCastersBoundingInfo(): boolean;
  62694. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62695. private _scbiMin;
  62696. private _scbiMax;
  62697. protected _computeShadowCastersBoundingInfo(): void;
  62698. protected _shadowCastersBoundingInfo: BoundingInfo;
  62699. /**
  62700. * Gets or sets the shadow casters bounding info.
  62701. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62702. * so that the system won't overwrite the bounds you provide
  62703. */
  62704. get shadowCastersBoundingInfo(): BoundingInfo;
  62705. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62706. protected _breaksAreDirty: boolean;
  62707. protected _minDistance: number;
  62708. protected _maxDistance: number;
  62709. /**
  62710. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62711. *
  62712. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62713. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62714. * @param min minimal distance for the breaks (default to 0.)
  62715. * @param max maximal distance for the breaks (default to 1.)
  62716. */
  62717. setMinMaxDistance(min: number, max: number): void;
  62718. /** Gets the minimal distance used in the cascade break computation */
  62719. get minDistance(): number;
  62720. /** Gets the maximal distance used in the cascade break computation */
  62721. get maxDistance(): number;
  62722. /**
  62723. * Gets the class name of that object
  62724. * @returns "CascadedShadowGenerator"
  62725. */
  62726. getClassName(): string;
  62727. private _cascadeMinExtents;
  62728. private _cascadeMaxExtents;
  62729. /**
  62730. * Gets a cascade minimum extents
  62731. * @param cascadeIndex index of the cascade
  62732. * @returns the minimum cascade extents
  62733. */
  62734. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62735. /**
  62736. * Gets a cascade maximum extents
  62737. * @param cascadeIndex index of the cascade
  62738. * @returns the maximum cascade extents
  62739. */
  62740. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62741. private _cascades;
  62742. private _currentLayer;
  62743. private _viewSpaceFrustumsZ;
  62744. private _viewMatrices;
  62745. private _projectionMatrices;
  62746. private _transformMatrices;
  62747. private _transformMatricesAsArray;
  62748. private _frustumLengths;
  62749. private _lightSizeUVCorrection;
  62750. private _depthCorrection;
  62751. private _frustumCornersWorldSpace;
  62752. private _frustumCenter;
  62753. private _shadowCameraPos;
  62754. private _shadowMaxZ;
  62755. /**
  62756. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62757. * It defaults to camera.maxZ
  62758. */
  62759. get shadowMaxZ(): number;
  62760. /**
  62761. * Sets the shadow max z distance.
  62762. */
  62763. set shadowMaxZ(value: number);
  62764. protected _debug: boolean;
  62765. /**
  62766. * Gets or sets the debug flag.
  62767. * When enabled, the cascades are materialized by different colors on the screen.
  62768. */
  62769. get debug(): boolean;
  62770. set debug(dbg: boolean);
  62771. private _depthClamp;
  62772. /**
  62773. * Gets or sets the depth clamping value.
  62774. *
  62775. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62776. * to account for the shadow casters far away.
  62777. *
  62778. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62779. */
  62780. get depthClamp(): boolean;
  62781. set depthClamp(value: boolean);
  62782. private _cascadeBlendPercentage;
  62783. /**
  62784. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62785. * It defaults to 0.1 (10% blending).
  62786. */
  62787. get cascadeBlendPercentage(): number;
  62788. set cascadeBlendPercentage(value: number);
  62789. private _lambda;
  62790. /**
  62791. * Gets or set the lambda parameter.
  62792. * This parameter is used to split the camera frustum and create the cascades.
  62793. * 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.
  62794. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62795. */
  62796. get lambda(): number;
  62797. set lambda(value: number);
  62798. /**
  62799. * Gets the view matrix corresponding to a given cascade
  62800. * @param cascadeNum cascade to retrieve the view matrix from
  62801. * @returns the cascade view matrix
  62802. */
  62803. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62804. /**
  62805. * Gets the projection matrix corresponding to a given cascade
  62806. * @param cascadeNum cascade to retrieve the projection matrix from
  62807. * @returns the cascade projection matrix
  62808. */
  62809. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62810. /**
  62811. * Gets the transformation matrix corresponding to a given cascade
  62812. * @param cascadeNum cascade to retrieve the transformation matrix from
  62813. * @returns the cascade transformation matrix
  62814. */
  62815. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62816. private _depthRenderer;
  62817. /**
  62818. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62819. *
  62820. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62821. *
  62822. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62823. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62824. * @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
  62825. */
  62826. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62827. private _depthReducer;
  62828. private _autoCalcDepthBounds;
  62829. /**
  62830. * Gets or sets the autoCalcDepthBounds property.
  62831. *
  62832. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62833. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62834. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62835. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62836. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62837. */
  62838. get autoCalcDepthBounds(): boolean;
  62839. set autoCalcDepthBounds(value: boolean);
  62840. /**
  62841. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62842. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62843. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62844. * for setting the refresh rate on the renderer yourself!
  62845. */
  62846. get autoCalcDepthBoundsRefreshRate(): number;
  62847. set autoCalcDepthBoundsRefreshRate(value: number);
  62848. /**
  62849. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62850. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62851. * you change the camera near/far planes!
  62852. */
  62853. splitFrustum(): void;
  62854. private _splitFrustum;
  62855. private _computeMatrices;
  62856. private _computeFrustumInWorldSpace;
  62857. private _computeCascadeFrustum;
  62858. /**
  62859. * Support test.
  62860. */
  62861. static get IsSupported(): boolean;
  62862. /** @hidden */
  62863. static _SceneComponentInitialization: (scene: Scene) => void;
  62864. /**
  62865. * Creates a Cascaded Shadow Generator object.
  62866. * A ShadowGenerator is the required tool to use the shadows.
  62867. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62868. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62869. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62870. * @param light The directional light object generating the shadows.
  62871. * @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.
  62872. */
  62873. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62874. protected _initializeGenerator(): void;
  62875. protected _createTargetRenderTexture(): void;
  62876. protected _initializeShadowMap(): void;
  62877. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62878. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62879. /**
  62880. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62881. * @param defines Defines of the material we want to update
  62882. * @param lightIndex Index of the light in the enabled light list of the material
  62883. */
  62884. prepareDefines(defines: any, lightIndex: number): void;
  62885. /**
  62886. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62887. * defined in the generator but impacting the effect).
  62888. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62889. * @param effect The effect we are binfing the information for
  62890. */
  62891. bindShadowLight(lightIndex: string, effect: Effect): void;
  62892. /**
  62893. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62894. * (eq to view projection * shadow projection matrices)
  62895. * @returns The transform matrix used to create the shadow map
  62896. */
  62897. getTransformMatrix(): Matrix;
  62898. /**
  62899. * Disposes the ShadowGenerator.
  62900. * Returns nothing.
  62901. */
  62902. dispose(): void;
  62903. /**
  62904. * Serializes the shadow generator setup to a json object.
  62905. * @returns The serialized JSON object
  62906. */
  62907. serialize(): any;
  62908. /**
  62909. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62910. * @param parsedShadowGenerator The JSON object to parse
  62911. * @param scene The scene to create the shadow map for
  62912. * @returns The parsed shadow generator
  62913. */
  62914. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62915. }
  62916. }
  62917. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62918. import { Scene } from "babylonjs/scene";
  62919. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62920. import { AbstractScene } from "babylonjs/abstractScene";
  62921. /**
  62922. * Defines the shadow generator component responsible to manage any shadow generators
  62923. * in a given scene.
  62924. */
  62925. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62926. /**
  62927. * The component name helpfull to identify the component in the list of scene components.
  62928. */
  62929. readonly name: string;
  62930. /**
  62931. * The scene the component belongs to.
  62932. */
  62933. scene: Scene;
  62934. /**
  62935. * Creates a new instance of the component for the given scene
  62936. * @param scene Defines the scene to register the component in
  62937. */
  62938. constructor(scene: Scene);
  62939. /**
  62940. * Registers the component in a given scene
  62941. */
  62942. register(): void;
  62943. /**
  62944. * Rebuilds the elements related to this component in case of
  62945. * context lost for instance.
  62946. */
  62947. rebuild(): void;
  62948. /**
  62949. * Serializes the component data to the specified json object
  62950. * @param serializationObject The object to serialize to
  62951. */
  62952. serialize(serializationObject: any): void;
  62953. /**
  62954. * Adds all the elements from the container to the scene
  62955. * @param container the container holding the elements
  62956. */
  62957. addFromContainer(container: AbstractScene): void;
  62958. /**
  62959. * Removes all the elements in the container from the scene
  62960. * @param container contains the elements to remove
  62961. * @param dispose if the removed element should be disposed (default: false)
  62962. */
  62963. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62964. /**
  62965. * Rebuilds the elements related to this component in case of
  62966. * context lost for instance.
  62967. */
  62968. dispose(): void;
  62969. private _gatherRenderTargets;
  62970. }
  62971. }
  62972. declare module "babylonjs/Lights/Shadows/index" {
  62973. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62974. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62975. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62976. }
  62977. declare module "babylonjs/Lights/pointLight" {
  62978. import { Scene } from "babylonjs/scene";
  62979. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62980. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62981. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62982. import { Effect } from "babylonjs/Materials/effect";
  62983. /**
  62984. * A point light is a light defined by an unique point in world space.
  62985. * The light is emitted in every direction from this point.
  62986. * A good example of a point light is a standard light bulb.
  62987. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62988. */
  62989. export class PointLight extends ShadowLight {
  62990. private _shadowAngle;
  62991. /**
  62992. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62993. * This specifies what angle the shadow will use to be created.
  62994. *
  62995. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62996. */
  62997. get shadowAngle(): number;
  62998. /**
  62999. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63000. * This specifies what angle the shadow will use to be created.
  63001. *
  63002. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  63003. */
  63004. set shadowAngle(value: number);
  63005. /**
  63006. * Gets the direction if it has been set.
  63007. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63008. */
  63009. get direction(): Vector3;
  63010. /**
  63011. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63012. */
  63013. set direction(value: Vector3);
  63014. /**
  63015. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  63016. * A PointLight emits the light in every direction.
  63017. * It can cast shadows.
  63018. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  63019. * ```javascript
  63020. * var pointLight = new PointLight("pl", camera.position, scene);
  63021. * ```
  63022. * Documentation : https://doc.babylonjs.com/babylon101/lights
  63023. * @param name The light friendly name
  63024. * @param position The position of the point light in the scene
  63025. * @param scene The scene the lights belongs to
  63026. */
  63027. constructor(name: string, position: Vector3, scene: Scene);
  63028. /**
  63029. * Returns the string "PointLight"
  63030. * @returns the class name
  63031. */
  63032. getClassName(): string;
  63033. /**
  63034. * Returns the integer 0.
  63035. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  63036. */
  63037. getTypeID(): number;
  63038. /**
  63039. * Specifies wether or not the shadowmap should be a cube texture.
  63040. * @returns true if the shadowmap needs to be a cube texture.
  63041. */
  63042. needCube(): boolean;
  63043. /**
  63044. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  63045. * @param faceIndex The index of the face we are computed the direction to generate shadow
  63046. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  63047. */
  63048. getShadowDirection(faceIndex?: number): Vector3;
  63049. /**
  63050. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  63051. * - fov = PI / 2
  63052. * - aspect ratio : 1.0
  63053. * - z-near and far equal to the active camera minZ and maxZ.
  63054. * Returns the PointLight.
  63055. */
  63056. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  63057. protected _buildUniformLayout(): void;
  63058. /**
  63059. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  63060. * @param effect The effect to update
  63061. * @param lightIndex The index of the light in the effect to update
  63062. * @returns The point light
  63063. */
  63064. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  63065. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  63066. /**
  63067. * Prepares the list of defines specific to the light type.
  63068. * @param defines the list of defines
  63069. * @param lightIndex defines the index of the light for the effect
  63070. */
  63071. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  63072. }
  63073. }
  63074. declare module "babylonjs/Lights/index" {
  63075. export * from "babylonjs/Lights/light";
  63076. export * from "babylonjs/Lights/shadowLight";
  63077. export * from "babylonjs/Lights/Shadows/index";
  63078. export * from "babylonjs/Lights/directionalLight";
  63079. export * from "babylonjs/Lights/hemisphericLight";
  63080. export * from "babylonjs/Lights/pointLight";
  63081. export * from "babylonjs/Lights/spotLight";
  63082. }
  63083. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  63084. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  63085. /**
  63086. * Header information of HDR texture files.
  63087. */
  63088. export interface HDRInfo {
  63089. /**
  63090. * The height of the texture in pixels.
  63091. */
  63092. height: number;
  63093. /**
  63094. * The width of the texture in pixels.
  63095. */
  63096. width: number;
  63097. /**
  63098. * The index of the beginning of the data in the binary file.
  63099. */
  63100. dataPosition: number;
  63101. }
  63102. /**
  63103. * This groups tools to convert HDR texture to native colors array.
  63104. */
  63105. export class HDRTools {
  63106. private static Ldexp;
  63107. private static Rgbe2float;
  63108. private static readStringLine;
  63109. /**
  63110. * Reads header information from an RGBE texture stored in a native array.
  63111. * More information on this format are available here:
  63112. * https://en.wikipedia.org/wiki/RGBE_image_format
  63113. *
  63114. * @param uint8array The binary file stored in native array.
  63115. * @return The header information.
  63116. */
  63117. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  63118. /**
  63119. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  63120. * This RGBE texture needs to store the information as a panorama.
  63121. *
  63122. * More information on this format are available here:
  63123. * https://en.wikipedia.org/wiki/RGBE_image_format
  63124. *
  63125. * @param buffer The binary file stored in an array buffer.
  63126. * @param size The expected size of the extracted cubemap.
  63127. * @return The Cube Map information.
  63128. */
  63129. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  63130. /**
  63131. * Returns the pixels data extracted from an RGBE texture.
  63132. * This pixels will be stored left to right up to down in the R G B order in one array.
  63133. *
  63134. * More information on this format are available here:
  63135. * https://en.wikipedia.org/wiki/RGBE_image_format
  63136. *
  63137. * @param uint8array The binary file stored in an array buffer.
  63138. * @param hdrInfo The header information of the file.
  63139. * @return The pixels data in RGB right to left up to down order.
  63140. */
  63141. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  63142. private static RGBE_ReadPixels_RLE;
  63143. private static RGBE_ReadPixels_NOT_RLE;
  63144. }
  63145. }
  63146. declare module "babylonjs/Materials/effectRenderer" {
  63147. import { Nullable } from "babylonjs/types";
  63148. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63149. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63150. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63151. import { Viewport } from "babylonjs/Maths/math.viewport";
  63152. import { Observable } from "babylonjs/Misc/observable";
  63153. import { Effect } from "babylonjs/Materials/effect";
  63154. import "babylonjs/Shaders/postprocess.vertex";
  63155. /**
  63156. * Effect Render Options
  63157. */
  63158. export interface IEffectRendererOptions {
  63159. /**
  63160. * Defines the vertices positions.
  63161. */
  63162. positions?: number[];
  63163. /**
  63164. * Defines the indices.
  63165. */
  63166. indices?: number[];
  63167. }
  63168. /**
  63169. * Helper class to render one or more effects.
  63170. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  63171. */
  63172. export class EffectRenderer {
  63173. private engine;
  63174. private static _DefaultOptions;
  63175. private _vertexBuffers;
  63176. private _indexBuffer;
  63177. private _fullscreenViewport;
  63178. /**
  63179. * Creates an effect renderer
  63180. * @param engine the engine to use for rendering
  63181. * @param options defines the options of the effect renderer
  63182. */
  63183. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  63184. /**
  63185. * Sets the current viewport in normalized coordinates 0-1
  63186. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  63187. */
  63188. setViewport(viewport?: Viewport): void;
  63189. /**
  63190. * Binds the embedded attributes buffer to the effect.
  63191. * @param effect Defines the effect to bind the attributes for
  63192. */
  63193. bindBuffers(effect: Effect): void;
  63194. /**
  63195. * Sets the current effect wrapper to use during draw.
  63196. * The effect needs to be ready before calling this api.
  63197. * This also sets the default full screen position attribute.
  63198. * @param effectWrapper Defines the effect to draw with
  63199. */
  63200. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  63201. /**
  63202. * Restores engine states
  63203. */
  63204. restoreStates(): void;
  63205. /**
  63206. * Draws a full screen quad.
  63207. */
  63208. draw(): void;
  63209. private isRenderTargetTexture;
  63210. /**
  63211. * renders one or more effects to a specified texture
  63212. * @param effectWrapper the effect to renderer
  63213. * @param outputTexture texture to draw to, if null it will render to the screen.
  63214. */
  63215. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  63216. /**
  63217. * Disposes of the effect renderer
  63218. */
  63219. dispose(): void;
  63220. }
  63221. /**
  63222. * Options to create an EffectWrapper
  63223. */
  63224. interface EffectWrapperCreationOptions {
  63225. /**
  63226. * Engine to use to create the effect
  63227. */
  63228. engine: ThinEngine;
  63229. /**
  63230. * Fragment shader for the effect
  63231. */
  63232. fragmentShader: string;
  63233. /**
  63234. * Use the shader store instead of direct source code
  63235. */
  63236. useShaderStore?: boolean;
  63237. /**
  63238. * Vertex shader for the effect
  63239. */
  63240. vertexShader?: string;
  63241. /**
  63242. * Attributes to use in the shader
  63243. */
  63244. attributeNames?: Array<string>;
  63245. /**
  63246. * Uniforms to use in the shader
  63247. */
  63248. uniformNames?: Array<string>;
  63249. /**
  63250. * Texture sampler names to use in the shader
  63251. */
  63252. samplerNames?: Array<string>;
  63253. /**
  63254. * Defines to use in the shader
  63255. */
  63256. defines?: Array<string>;
  63257. /**
  63258. * Callback when effect is compiled
  63259. */
  63260. onCompiled?: Nullable<(effect: Effect) => void>;
  63261. /**
  63262. * The friendly name of the effect displayed in Spector.
  63263. */
  63264. name?: string;
  63265. }
  63266. /**
  63267. * Wraps an effect to be used for rendering
  63268. */
  63269. export class EffectWrapper {
  63270. /**
  63271. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  63272. */
  63273. onApplyObservable: Observable<{}>;
  63274. /**
  63275. * The underlying effect
  63276. */
  63277. effect: Effect;
  63278. /**
  63279. * Creates an effect to be renderer
  63280. * @param creationOptions options to create the effect
  63281. */
  63282. constructor(creationOptions: EffectWrapperCreationOptions);
  63283. /**
  63284. * Disposes of the effect wrapper
  63285. */
  63286. dispose(): void;
  63287. }
  63288. }
  63289. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  63290. /** @hidden */
  63291. export var hdrFilteringVertexShader: {
  63292. name: string;
  63293. shader: string;
  63294. };
  63295. }
  63296. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  63297. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63298. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  63299. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  63300. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  63301. /** @hidden */
  63302. export var hdrFilteringPixelShader: {
  63303. name: string;
  63304. shader: string;
  63305. };
  63306. }
  63307. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  63308. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63309. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63310. import { Nullable } from "babylonjs/types";
  63311. import "babylonjs/Shaders/hdrFiltering.vertex";
  63312. import "babylonjs/Shaders/hdrFiltering.fragment";
  63313. /**
  63314. * Options for texture filtering
  63315. */
  63316. interface IHDRFilteringOptions {
  63317. /**
  63318. * Scales pixel intensity for the input HDR map.
  63319. */
  63320. hdrScale?: number;
  63321. /**
  63322. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  63323. */
  63324. quality?: number;
  63325. }
  63326. /**
  63327. * Filters HDR maps to get correct renderings of PBR reflections
  63328. */
  63329. export class HDRFiltering {
  63330. private _engine;
  63331. private _effectRenderer;
  63332. private _effectWrapper;
  63333. private _lodGenerationOffset;
  63334. private _lodGenerationScale;
  63335. /**
  63336. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63337. * you care about baking speed.
  63338. */
  63339. quality: number;
  63340. /**
  63341. * Scales pixel intensity for the input HDR map.
  63342. */
  63343. hdrScale: number;
  63344. /**
  63345. * Instantiates HDR filter for reflection maps
  63346. *
  63347. * @param engine Thin engine
  63348. * @param options Options
  63349. */
  63350. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63351. private _createRenderTarget;
  63352. private _prefilterInternal;
  63353. private _createEffect;
  63354. /**
  63355. * Get a value indicating if the filter is ready to be used
  63356. * @param texture Texture to filter
  63357. * @returns true if the filter is ready
  63358. */
  63359. isReady(texture: BaseTexture): boolean;
  63360. /**
  63361. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63362. * Prefiltering will be invoked at the end of next rendering pass.
  63363. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63364. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63365. * @param texture Texture to filter
  63366. * @param onFinished Callback when filtering is done
  63367. * @return Promise called when prefiltering is done
  63368. */
  63369. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63370. }
  63371. }
  63372. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63373. import { Nullable } from "babylonjs/types";
  63374. import { Scene } from "babylonjs/scene";
  63375. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63376. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63377. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63378. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63379. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63380. /**
  63381. * This represents a texture coming from an HDR input.
  63382. *
  63383. * The only supported format is currently panorama picture stored in RGBE format.
  63384. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63385. */
  63386. export class HDRCubeTexture extends BaseTexture {
  63387. private static _facesMapping;
  63388. private _generateHarmonics;
  63389. private _noMipmap;
  63390. private _prefilterOnLoad;
  63391. private _textureMatrix;
  63392. private _size;
  63393. private _onLoad;
  63394. private _onError;
  63395. /**
  63396. * The texture URL.
  63397. */
  63398. url: string;
  63399. protected _isBlocking: boolean;
  63400. /**
  63401. * Sets wether or not the texture is blocking during loading.
  63402. */
  63403. set isBlocking(value: boolean);
  63404. /**
  63405. * Gets wether or not the texture is blocking during loading.
  63406. */
  63407. get isBlocking(): boolean;
  63408. protected _rotationY: number;
  63409. /**
  63410. * Sets texture matrix rotation angle around Y axis in radians.
  63411. */
  63412. set rotationY(value: number);
  63413. /**
  63414. * Gets texture matrix rotation angle around Y axis radians.
  63415. */
  63416. get rotationY(): number;
  63417. /**
  63418. * Gets or sets the center of the bounding box associated with the cube texture
  63419. * It must define where the camera used to render the texture was set
  63420. */
  63421. boundingBoxPosition: Vector3;
  63422. private _boundingBoxSize;
  63423. /**
  63424. * Gets or sets the size of the bounding box associated with the cube texture
  63425. * When defined, the cubemap will switch to local mode
  63426. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63427. * @example https://www.babylonjs-playground.com/#RNASML
  63428. */
  63429. set boundingBoxSize(value: Vector3);
  63430. get boundingBoxSize(): Vector3;
  63431. /**
  63432. * Instantiates an HDRTexture from the following parameters.
  63433. *
  63434. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63435. * @param sceneOrEngine The scene or engine the texture will be used in
  63436. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63437. * @param noMipmap Forces to not generate the mipmap if true
  63438. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63439. * @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)
  63440. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63441. */
  63442. 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>);
  63443. /**
  63444. * Get the current class name of the texture useful for serialization or dynamic coding.
  63445. * @returns "HDRCubeTexture"
  63446. */
  63447. getClassName(): string;
  63448. /**
  63449. * Occurs when the file is raw .hdr file.
  63450. */
  63451. private loadTexture;
  63452. clone(): HDRCubeTexture;
  63453. delayLoad(): void;
  63454. /**
  63455. * Get the texture reflection matrix used to rotate/transform the reflection.
  63456. * @returns the reflection matrix
  63457. */
  63458. getReflectionTextureMatrix(): Matrix;
  63459. /**
  63460. * Set the texture reflection matrix used to rotate/transform the reflection.
  63461. * @param value Define the reflection matrix to set
  63462. */
  63463. setReflectionTextureMatrix(value: Matrix): void;
  63464. /**
  63465. * Parses a JSON representation of an HDR Texture in order to create the texture
  63466. * @param parsedTexture Define the JSON representation
  63467. * @param scene Define the scene the texture should be created in
  63468. * @param rootUrl Define the root url in case we need to load relative dependencies
  63469. * @returns the newly created texture after parsing
  63470. */
  63471. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63472. serialize(): any;
  63473. }
  63474. }
  63475. declare module "babylonjs/Physics/physicsEngine" {
  63476. import { Nullable } from "babylonjs/types";
  63477. import { Vector3 } from "babylonjs/Maths/math.vector";
  63478. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63479. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63480. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63481. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63482. /**
  63483. * Class used to control physics engine
  63484. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63485. */
  63486. export class PhysicsEngine implements IPhysicsEngine {
  63487. private _physicsPlugin;
  63488. /**
  63489. * Global value used to control the smallest number supported by the simulation
  63490. */
  63491. static Epsilon: number;
  63492. private _impostors;
  63493. private _joints;
  63494. private _subTimeStep;
  63495. /**
  63496. * Gets the gravity vector used by the simulation
  63497. */
  63498. gravity: Vector3;
  63499. /**
  63500. * Factory used to create the default physics plugin.
  63501. * @returns The default physics plugin
  63502. */
  63503. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63504. /**
  63505. * Creates a new Physics Engine
  63506. * @param gravity defines the gravity vector used by the simulation
  63507. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63508. */
  63509. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63510. /**
  63511. * Sets the gravity vector used by the simulation
  63512. * @param gravity defines the gravity vector to use
  63513. */
  63514. setGravity(gravity: Vector3): void;
  63515. /**
  63516. * Set the time step of the physics engine.
  63517. * Default is 1/60.
  63518. * To slow it down, enter 1/600 for example.
  63519. * To speed it up, 1/30
  63520. * @param newTimeStep defines the new timestep to apply to this world.
  63521. */
  63522. setTimeStep(newTimeStep?: number): void;
  63523. /**
  63524. * Get the time step of the physics engine.
  63525. * @returns the current time step
  63526. */
  63527. getTimeStep(): number;
  63528. /**
  63529. * Set the sub time step of the physics engine.
  63530. * Default is 0 meaning there is no sub steps
  63531. * To increase physics resolution precision, set a small value (like 1 ms)
  63532. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63533. */
  63534. setSubTimeStep(subTimeStep?: number): void;
  63535. /**
  63536. * Get the sub time step of the physics engine.
  63537. * @returns the current sub time step
  63538. */
  63539. getSubTimeStep(): number;
  63540. /**
  63541. * Release all resources
  63542. */
  63543. dispose(): void;
  63544. /**
  63545. * Gets the name of the current physics plugin
  63546. * @returns the name of the plugin
  63547. */
  63548. getPhysicsPluginName(): string;
  63549. /**
  63550. * Adding a new impostor for the impostor tracking.
  63551. * This will be done by the impostor itself.
  63552. * @param impostor the impostor to add
  63553. */
  63554. addImpostor(impostor: PhysicsImpostor): void;
  63555. /**
  63556. * Remove an impostor from the engine.
  63557. * This impostor and its mesh will not longer be updated by the physics engine.
  63558. * @param impostor the impostor to remove
  63559. */
  63560. removeImpostor(impostor: PhysicsImpostor): void;
  63561. /**
  63562. * Add a joint to the physics engine
  63563. * @param mainImpostor defines the main impostor to which the joint is added.
  63564. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63565. * @param joint defines the joint that will connect both impostors.
  63566. */
  63567. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63568. /**
  63569. * Removes a joint from the simulation
  63570. * @param mainImpostor defines the impostor used with the joint
  63571. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63572. * @param joint defines the joint to remove
  63573. */
  63574. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63575. /**
  63576. * Called by the scene. No need to call it.
  63577. * @param delta defines the timespam between frames
  63578. */
  63579. _step(delta: number): void;
  63580. /**
  63581. * Gets the current plugin used to run the simulation
  63582. * @returns current plugin
  63583. */
  63584. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63585. /**
  63586. * Gets the list of physic impostors
  63587. * @returns an array of PhysicsImpostor
  63588. */
  63589. getImpostors(): Array<PhysicsImpostor>;
  63590. /**
  63591. * Gets the impostor for a physics enabled object
  63592. * @param object defines the object impersonated by the impostor
  63593. * @returns the PhysicsImpostor or null if not found
  63594. */
  63595. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63596. /**
  63597. * Gets the impostor for a physics body object
  63598. * @param body defines physics body used by the impostor
  63599. * @returns the PhysicsImpostor or null if not found
  63600. */
  63601. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63602. /**
  63603. * Does a raycast in the physics world
  63604. * @param from when should the ray start?
  63605. * @param to when should the ray end?
  63606. * @returns PhysicsRaycastResult
  63607. */
  63608. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63609. }
  63610. }
  63611. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63612. import { Nullable } from "babylonjs/types";
  63613. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63614. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63615. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63616. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63617. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63618. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63619. /** @hidden */
  63620. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63621. private _useDeltaForWorldStep;
  63622. world: any;
  63623. name: string;
  63624. private _physicsMaterials;
  63625. private _fixedTimeStep;
  63626. private _cannonRaycastResult;
  63627. private _raycastResult;
  63628. private _physicsBodysToRemoveAfterStep;
  63629. private _firstFrame;
  63630. BJSCANNON: any;
  63631. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63632. setGravity(gravity: Vector3): void;
  63633. setTimeStep(timeStep: number): void;
  63634. getTimeStep(): number;
  63635. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63636. private _removeMarkedPhysicsBodiesFromWorld;
  63637. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63638. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63639. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63640. private _processChildMeshes;
  63641. removePhysicsBody(impostor: PhysicsImpostor): void;
  63642. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63643. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63644. private _addMaterial;
  63645. private _checkWithEpsilon;
  63646. private _createShape;
  63647. private _createHeightmap;
  63648. private _minus90X;
  63649. private _plus90X;
  63650. private _tmpPosition;
  63651. private _tmpDeltaPosition;
  63652. private _tmpUnityRotation;
  63653. private _updatePhysicsBodyTransformation;
  63654. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63655. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63656. isSupported(): boolean;
  63657. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63658. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63659. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63660. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63661. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63662. getBodyMass(impostor: PhysicsImpostor): number;
  63663. getBodyFriction(impostor: PhysicsImpostor): number;
  63664. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63665. getBodyRestitution(impostor: PhysicsImpostor): number;
  63666. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63667. sleepBody(impostor: PhysicsImpostor): void;
  63668. wakeUpBody(impostor: PhysicsImpostor): void;
  63669. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63670. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63671. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63672. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63673. getRadius(impostor: PhysicsImpostor): number;
  63674. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63675. dispose(): void;
  63676. private _extendNamespace;
  63677. /**
  63678. * Does a raycast in the physics world
  63679. * @param from when should the ray start?
  63680. * @param to when should the ray end?
  63681. * @returns PhysicsRaycastResult
  63682. */
  63683. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63684. }
  63685. }
  63686. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63687. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63688. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63689. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63690. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63691. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63692. import { Nullable } from "babylonjs/types";
  63693. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63694. /** @hidden */
  63695. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63696. private _useDeltaForWorldStep;
  63697. world: any;
  63698. name: string;
  63699. BJSOIMO: any;
  63700. private _raycastResult;
  63701. private _fixedTimeStep;
  63702. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63703. setGravity(gravity: Vector3): void;
  63704. setTimeStep(timeStep: number): void;
  63705. getTimeStep(): number;
  63706. private _tmpImpostorsArray;
  63707. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63708. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63709. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63710. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63711. private _tmpPositionVector;
  63712. removePhysicsBody(impostor: PhysicsImpostor): void;
  63713. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63714. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63715. isSupported(): boolean;
  63716. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63717. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63718. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63719. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63720. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63721. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63722. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63723. getBodyMass(impostor: PhysicsImpostor): number;
  63724. getBodyFriction(impostor: PhysicsImpostor): number;
  63725. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63726. getBodyRestitution(impostor: PhysicsImpostor): number;
  63727. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63728. sleepBody(impostor: PhysicsImpostor): void;
  63729. wakeUpBody(impostor: PhysicsImpostor): void;
  63730. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63731. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63732. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63733. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63734. getRadius(impostor: PhysicsImpostor): number;
  63735. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63736. dispose(): void;
  63737. /**
  63738. * Does a raycast in the physics world
  63739. * @param from when should the ray start?
  63740. * @param to when should the ray end?
  63741. * @returns PhysicsRaycastResult
  63742. */
  63743. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63744. }
  63745. }
  63746. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63747. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63748. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63749. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63750. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63751. import { Nullable } from "babylonjs/types";
  63752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63753. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63754. /**
  63755. * AmmoJS Physics plugin
  63756. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63757. * @see https://github.com/kripken/ammo.js/
  63758. */
  63759. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63760. private _useDeltaForWorldStep;
  63761. /**
  63762. * Reference to the Ammo library
  63763. */
  63764. bjsAMMO: any;
  63765. /**
  63766. * Created ammoJS world which physics bodies are added to
  63767. */
  63768. world: any;
  63769. /**
  63770. * Name of the plugin
  63771. */
  63772. name: string;
  63773. private _timeStep;
  63774. private _fixedTimeStep;
  63775. private _maxSteps;
  63776. private _tmpQuaternion;
  63777. private _tmpAmmoTransform;
  63778. private _tmpAmmoQuaternion;
  63779. private _tmpAmmoConcreteContactResultCallback;
  63780. private _collisionConfiguration;
  63781. private _dispatcher;
  63782. private _overlappingPairCache;
  63783. private _solver;
  63784. private _softBodySolver;
  63785. private _tmpAmmoVectorA;
  63786. private _tmpAmmoVectorB;
  63787. private _tmpAmmoVectorC;
  63788. private _tmpAmmoVectorD;
  63789. private _tmpContactCallbackResult;
  63790. private _tmpAmmoVectorRCA;
  63791. private _tmpAmmoVectorRCB;
  63792. private _raycastResult;
  63793. private static readonly DISABLE_COLLISION_FLAG;
  63794. private static readonly KINEMATIC_FLAG;
  63795. private static readonly DISABLE_DEACTIVATION_FLAG;
  63796. /**
  63797. * Initializes the ammoJS plugin
  63798. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63799. * @param ammoInjection can be used to inject your own ammo reference
  63800. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63801. */
  63802. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63803. /**
  63804. * Sets the gravity of the physics world (m/(s^2))
  63805. * @param gravity Gravity to set
  63806. */
  63807. setGravity(gravity: Vector3): void;
  63808. /**
  63809. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63810. * @param timeStep timestep to use in seconds
  63811. */
  63812. setTimeStep(timeStep: number): void;
  63813. /**
  63814. * 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)
  63815. * @param fixedTimeStep fixedTimeStep to use in seconds
  63816. */
  63817. setFixedTimeStep(fixedTimeStep: number): void;
  63818. /**
  63819. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63820. * @param maxSteps the maximum number of steps by the physics engine per frame
  63821. */
  63822. setMaxSteps(maxSteps: number): void;
  63823. /**
  63824. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63825. * @returns the current timestep in seconds
  63826. */
  63827. getTimeStep(): number;
  63828. /**
  63829. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63830. */
  63831. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63832. private _isImpostorInContact;
  63833. private _isImpostorPairInContact;
  63834. private _stepSimulation;
  63835. /**
  63836. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63837. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63838. * After the step the babylon meshes are set to the position of the physics imposters
  63839. * @param delta amount of time to step forward
  63840. * @param impostors array of imposters to update before/after the step
  63841. */
  63842. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63843. /**
  63844. * Update babylon mesh to match physics world object
  63845. * @param impostor imposter to match
  63846. */
  63847. private _afterSoftStep;
  63848. /**
  63849. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63850. * @param impostor imposter to match
  63851. */
  63852. private _ropeStep;
  63853. /**
  63854. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63855. * @param impostor imposter to match
  63856. */
  63857. private _softbodyOrClothStep;
  63858. private _tmpMatrix;
  63859. /**
  63860. * Applies an impulse on the imposter
  63861. * @param impostor imposter to apply impulse to
  63862. * @param force amount of force to be applied to the imposter
  63863. * @param contactPoint the location to apply the impulse on the imposter
  63864. */
  63865. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63866. /**
  63867. * Applies a force on the imposter
  63868. * @param impostor imposter to apply force
  63869. * @param force amount of force to be applied to the imposter
  63870. * @param contactPoint the location to apply the force on the imposter
  63871. */
  63872. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63873. /**
  63874. * Creates a physics body using the plugin
  63875. * @param impostor the imposter to create the physics body on
  63876. */
  63877. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63878. /**
  63879. * Removes the physics body from the imposter and disposes of the body's memory
  63880. * @param impostor imposter to remove the physics body from
  63881. */
  63882. removePhysicsBody(impostor: PhysicsImpostor): void;
  63883. /**
  63884. * Generates a joint
  63885. * @param impostorJoint the imposter joint to create the joint with
  63886. */
  63887. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63888. /**
  63889. * Removes a joint
  63890. * @param impostorJoint the imposter joint to remove the joint from
  63891. */
  63892. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63893. private _addMeshVerts;
  63894. /**
  63895. * Initialise the soft body vertices to match its object's (mesh) vertices
  63896. * Softbody vertices (nodes) are in world space and to match this
  63897. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63898. * @param impostor to create the softbody for
  63899. */
  63900. private _softVertexData;
  63901. /**
  63902. * Create an impostor's soft body
  63903. * @param impostor to create the softbody for
  63904. */
  63905. private _createSoftbody;
  63906. /**
  63907. * Create cloth for an impostor
  63908. * @param impostor to create the softbody for
  63909. */
  63910. private _createCloth;
  63911. /**
  63912. * Create rope for an impostor
  63913. * @param impostor to create the softbody for
  63914. */
  63915. private _createRope;
  63916. /**
  63917. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63918. * @param impostor to create the custom physics shape for
  63919. */
  63920. private _createCustom;
  63921. private _addHullVerts;
  63922. private _createShape;
  63923. /**
  63924. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63925. * @param impostor imposter containing the physics body and babylon object
  63926. */
  63927. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63928. /**
  63929. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63930. * @param impostor imposter containing the physics body and babylon object
  63931. * @param newPosition new position
  63932. * @param newRotation new rotation
  63933. */
  63934. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63935. /**
  63936. * If this plugin is supported
  63937. * @returns true if its supported
  63938. */
  63939. isSupported(): boolean;
  63940. /**
  63941. * Sets the linear velocity of the physics body
  63942. * @param impostor imposter to set the velocity on
  63943. * @param velocity velocity to set
  63944. */
  63945. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63946. /**
  63947. * Sets the angular velocity of the physics body
  63948. * @param impostor imposter to set the velocity on
  63949. * @param velocity velocity to set
  63950. */
  63951. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63952. /**
  63953. * gets the linear velocity
  63954. * @param impostor imposter to get linear velocity from
  63955. * @returns linear velocity
  63956. */
  63957. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63958. /**
  63959. * gets the angular velocity
  63960. * @param impostor imposter to get angular velocity from
  63961. * @returns angular velocity
  63962. */
  63963. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63964. /**
  63965. * Sets the mass of physics body
  63966. * @param impostor imposter to set the mass on
  63967. * @param mass mass to set
  63968. */
  63969. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63970. /**
  63971. * Gets the mass of the physics body
  63972. * @param impostor imposter to get the mass from
  63973. * @returns mass
  63974. */
  63975. getBodyMass(impostor: PhysicsImpostor): number;
  63976. /**
  63977. * Gets friction of the impostor
  63978. * @param impostor impostor to get friction from
  63979. * @returns friction value
  63980. */
  63981. getBodyFriction(impostor: PhysicsImpostor): number;
  63982. /**
  63983. * Sets friction of the impostor
  63984. * @param impostor impostor to set friction on
  63985. * @param friction friction value
  63986. */
  63987. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63988. /**
  63989. * Gets restitution of the impostor
  63990. * @param impostor impostor to get restitution from
  63991. * @returns restitution value
  63992. */
  63993. getBodyRestitution(impostor: PhysicsImpostor): number;
  63994. /**
  63995. * Sets resitution of the impostor
  63996. * @param impostor impostor to set resitution on
  63997. * @param restitution resitution value
  63998. */
  63999. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  64000. /**
  64001. * Gets pressure inside the impostor
  64002. * @param impostor impostor to get pressure from
  64003. * @returns pressure value
  64004. */
  64005. getBodyPressure(impostor: PhysicsImpostor): number;
  64006. /**
  64007. * Sets pressure inside a soft body impostor
  64008. * Cloth and rope must remain 0 pressure
  64009. * @param impostor impostor to set pressure on
  64010. * @param pressure pressure value
  64011. */
  64012. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  64013. /**
  64014. * Gets stiffness of the impostor
  64015. * @param impostor impostor to get stiffness from
  64016. * @returns pressure value
  64017. */
  64018. getBodyStiffness(impostor: PhysicsImpostor): number;
  64019. /**
  64020. * Sets stiffness of the impostor
  64021. * @param impostor impostor to set stiffness on
  64022. * @param stiffness stiffness value from 0 to 1
  64023. */
  64024. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  64025. /**
  64026. * Gets velocityIterations of the impostor
  64027. * @param impostor impostor to get velocity iterations from
  64028. * @returns velocityIterations value
  64029. */
  64030. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  64031. /**
  64032. * Sets velocityIterations of the impostor
  64033. * @param impostor impostor to set velocity iterations on
  64034. * @param velocityIterations velocityIterations value
  64035. */
  64036. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  64037. /**
  64038. * Gets positionIterations of the impostor
  64039. * @param impostor impostor to get position iterations from
  64040. * @returns positionIterations value
  64041. */
  64042. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  64043. /**
  64044. * Sets positionIterations of the impostor
  64045. * @param impostor impostor to set position on
  64046. * @param positionIterations positionIterations value
  64047. */
  64048. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  64049. /**
  64050. * Append an anchor to a cloth object
  64051. * @param impostor is the cloth impostor to add anchor to
  64052. * @param otherImpostor is the rigid impostor to anchor to
  64053. * @param width ratio across width from 0 to 1
  64054. * @param height ratio up height from 0 to 1
  64055. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  64056. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  64057. */
  64058. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  64059. /**
  64060. * Append an hook to a rope object
  64061. * @param impostor is the rope impostor to add hook to
  64062. * @param otherImpostor is the rigid impostor to hook to
  64063. * @param length ratio along the rope from 0 to 1
  64064. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  64065. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  64066. */
  64067. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  64068. /**
  64069. * Sleeps the physics body and stops it from being active
  64070. * @param impostor impostor to sleep
  64071. */
  64072. sleepBody(impostor: PhysicsImpostor): void;
  64073. /**
  64074. * Activates the physics body
  64075. * @param impostor impostor to activate
  64076. */
  64077. wakeUpBody(impostor: PhysicsImpostor): void;
  64078. /**
  64079. * Updates the distance parameters of the joint
  64080. * @param joint joint to update
  64081. * @param maxDistance maximum distance of the joint
  64082. * @param minDistance minimum distance of the joint
  64083. */
  64084. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  64085. /**
  64086. * Sets a motor on the joint
  64087. * @param joint joint to set motor on
  64088. * @param speed speed of the motor
  64089. * @param maxForce maximum force of the motor
  64090. * @param motorIndex index of the motor
  64091. */
  64092. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  64093. /**
  64094. * Sets the motors limit
  64095. * @param joint joint to set limit on
  64096. * @param upperLimit upper limit
  64097. * @param lowerLimit lower limit
  64098. */
  64099. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  64100. /**
  64101. * Syncs the position and rotation of a mesh with the impostor
  64102. * @param mesh mesh to sync
  64103. * @param impostor impostor to update the mesh with
  64104. */
  64105. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  64106. /**
  64107. * Gets the radius of the impostor
  64108. * @param impostor impostor to get radius from
  64109. * @returns the radius
  64110. */
  64111. getRadius(impostor: PhysicsImpostor): number;
  64112. /**
  64113. * Gets the box size of the impostor
  64114. * @param impostor impostor to get box size from
  64115. * @param result the resulting box size
  64116. */
  64117. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  64118. /**
  64119. * Disposes of the impostor
  64120. */
  64121. dispose(): void;
  64122. /**
  64123. * Does a raycast in the physics world
  64124. * @param from when should the ray start?
  64125. * @param to when should the ray end?
  64126. * @returns PhysicsRaycastResult
  64127. */
  64128. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  64129. }
  64130. }
  64131. declare module "babylonjs/Probes/reflectionProbe" {
  64132. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  64133. import { Vector3 } from "babylonjs/Maths/math.vector";
  64134. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64135. import { Nullable } from "babylonjs/types";
  64136. import { Scene } from "babylonjs/scene";
  64137. module "babylonjs/abstractScene" {
  64138. interface AbstractScene {
  64139. /**
  64140. * The list of reflection probes added to the scene
  64141. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  64142. */
  64143. reflectionProbes: Array<ReflectionProbe>;
  64144. /**
  64145. * Removes the given reflection probe from this scene.
  64146. * @param toRemove The reflection probe to remove
  64147. * @returns The index of the removed reflection probe
  64148. */
  64149. removeReflectionProbe(toRemove: ReflectionProbe): number;
  64150. /**
  64151. * Adds the given reflection probe to this scene.
  64152. * @param newReflectionProbe The reflection probe to add
  64153. */
  64154. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  64155. }
  64156. }
  64157. /**
  64158. * Class used to generate realtime reflection / refraction cube textures
  64159. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  64160. */
  64161. export class ReflectionProbe {
  64162. /** defines the name of the probe */
  64163. name: string;
  64164. private _scene;
  64165. private _renderTargetTexture;
  64166. private _projectionMatrix;
  64167. private _viewMatrix;
  64168. private _target;
  64169. private _add;
  64170. private _attachedMesh;
  64171. private _invertYAxis;
  64172. /** Gets or sets probe position (center of the cube map) */
  64173. position: Vector3;
  64174. /**
  64175. * Creates a new reflection probe
  64176. * @param name defines the name of the probe
  64177. * @param size defines the texture resolution (for each face)
  64178. * @param scene defines the hosting scene
  64179. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  64180. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  64181. */
  64182. constructor(
  64183. /** defines the name of the probe */
  64184. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  64185. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  64186. get samples(): number;
  64187. set samples(value: number);
  64188. /** Gets or sets the refresh rate to use (on every frame by default) */
  64189. get refreshRate(): number;
  64190. set refreshRate(value: number);
  64191. /**
  64192. * Gets the hosting scene
  64193. * @returns a Scene
  64194. */
  64195. getScene(): Scene;
  64196. /** Gets the internal CubeTexture used to render to */
  64197. get cubeTexture(): RenderTargetTexture;
  64198. /** Gets the list of meshes to render */
  64199. get renderList(): Nullable<AbstractMesh[]>;
  64200. /**
  64201. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  64202. * @param mesh defines the mesh to attach to
  64203. */
  64204. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  64205. /**
  64206. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  64207. * @param renderingGroupId The rendering group id corresponding to its index
  64208. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  64209. */
  64210. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  64211. /**
  64212. * Clean all associated resources
  64213. */
  64214. dispose(): void;
  64215. /**
  64216. * Converts the reflection probe information to a readable string for debug purpose.
  64217. * @param fullDetails Supports for multiple levels of logging within scene loading
  64218. * @returns the human readable reflection probe info
  64219. */
  64220. toString(fullDetails?: boolean): string;
  64221. /**
  64222. * Get the class name of the relfection probe.
  64223. * @returns "ReflectionProbe"
  64224. */
  64225. getClassName(): string;
  64226. /**
  64227. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  64228. * @returns The JSON representation of the texture
  64229. */
  64230. serialize(): any;
  64231. /**
  64232. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  64233. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  64234. * @param scene Define the scene the parsed reflection probe should be instantiated in
  64235. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  64236. * @returns The parsed reflection probe if successful
  64237. */
  64238. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  64239. }
  64240. }
  64241. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  64242. /** @hidden */
  64243. export var _BabylonLoaderRegistered: boolean;
  64244. /**
  64245. * Helps setting up some configuration for the babylon file loader.
  64246. */
  64247. export class BabylonFileLoaderConfiguration {
  64248. /**
  64249. * The loader does not allow injecting custom physix engine into the plugins.
  64250. * Unfortunately in ES6, we need to manually inject them into the plugin.
  64251. * So you could set this variable to your engine import to make it work.
  64252. */
  64253. static LoaderInjectedPhysicsEngine: any;
  64254. }
  64255. }
  64256. declare module "babylonjs/Loading/Plugins/index" {
  64257. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  64258. }
  64259. declare module "babylonjs/Loading/index" {
  64260. export * from "babylonjs/Loading/loadingScreen";
  64261. export * from "babylonjs/Loading/Plugins/index";
  64262. export * from "babylonjs/Loading/sceneLoader";
  64263. export * from "babylonjs/Loading/sceneLoaderFlags";
  64264. }
  64265. declare module "babylonjs/Materials/Background/index" {
  64266. export * from "babylonjs/Materials/Background/backgroundMaterial";
  64267. }
  64268. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  64269. import { Scene } from "babylonjs/scene";
  64270. import { Color3 } from "babylonjs/Maths/math.color";
  64271. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64272. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64273. /**
  64274. * The Physically based simple base material of BJS.
  64275. *
  64276. * This enables better naming and convention enforcements on top of the pbrMaterial.
  64277. * It is used as the base class for both the specGloss and metalRough conventions.
  64278. */
  64279. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  64280. /**
  64281. * Number of Simultaneous lights allowed on the material.
  64282. */
  64283. maxSimultaneousLights: number;
  64284. /**
  64285. * If sets to true, disables all the lights affecting the material.
  64286. */
  64287. disableLighting: boolean;
  64288. /**
  64289. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  64290. */
  64291. environmentTexture: BaseTexture;
  64292. /**
  64293. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  64294. */
  64295. invertNormalMapX: boolean;
  64296. /**
  64297. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  64298. */
  64299. invertNormalMapY: boolean;
  64300. /**
  64301. * Normal map used in the model.
  64302. */
  64303. normalTexture: BaseTexture;
  64304. /**
  64305. * Emissivie color used to self-illuminate the model.
  64306. */
  64307. emissiveColor: Color3;
  64308. /**
  64309. * Emissivie texture used to self-illuminate the model.
  64310. */
  64311. emissiveTexture: BaseTexture;
  64312. /**
  64313. * Occlusion Channel Strenght.
  64314. */
  64315. occlusionStrength: number;
  64316. /**
  64317. * Occlusion Texture of the material (adding extra occlusion effects).
  64318. */
  64319. occlusionTexture: BaseTexture;
  64320. /**
  64321. * Defines the alpha limits in alpha test mode.
  64322. */
  64323. alphaCutOff: number;
  64324. /**
  64325. * Gets the current double sided mode.
  64326. */
  64327. get doubleSided(): boolean;
  64328. /**
  64329. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64330. */
  64331. set doubleSided(value: boolean);
  64332. /**
  64333. * Stores the pre-calculated light information of a mesh in a texture.
  64334. */
  64335. lightmapTexture: BaseTexture;
  64336. /**
  64337. * If true, the light map contains occlusion information instead of lighting info.
  64338. */
  64339. useLightmapAsShadowmap: boolean;
  64340. /**
  64341. * Instantiates a new PBRMaterial instance.
  64342. *
  64343. * @param name The material name
  64344. * @param scene The scene the material will be use in.
  64345. */
  64346. constructor(name: string, scene: Scene);
  64347. getClassName(): string;
  64348. }
  64349. }
  64350. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64351. import { Scene } from "babylonjs/scene";
  64352. import { Color3 } from "babylonjs/Maths/math.color";
  64353. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64354. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64355. /**
  64356. * The PBR material of BJS following the metal roughness convention.
  64357. *
  64358. * This fits to the PBR convention in the GLTF definition:
  64359. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64360. */
  64361. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64362. /**
  64363. * The base color has two different interpretations depending on the value of metalness.
  64364. * When the material is a metal, the base color is the specific measured reflectance value
  64365. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64366. * of the material.
  64367. */
  64368. baseColor: Color3;
  64369. /**
  64370. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64371. * well as opacity information in the alpha channel.
  64372. */
  64373. baseTexture: BaseTexture;
  64374. /**
  64375. * Specifies the metallic scalar value of the material.
  64376. * Can also be used to scale the metalness values of the metallic texture.
  64377. */
  64378. metallic: number;
  64379. /**
  64380. * Specifies the roughness scalar value of the material.
  64381. * Can also be used to scale the roughness values of the metallic texture.
  64382. */
  64383. roughness: number;
  64384. /**
  64385. * Texture containing both the metallic value in the B channel and the
  64386. * roughness value in the G channel to keep better precision.
  64387. */
  64388. metallicRoughnessTexture: BaseTexture;
  64389. /**
  64390. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64391. *
  64392. * @param name The material name
  64393. * @param scene The scene the material will be use in.
  64394. */
  64395. constructor(name: string, scene: Scene);
  64396. /**
  64397. * Return the currrent class name of the material.
  64398. */
  64399. getClassName(): string;
  64400. /**
  64401. * Makes a duplicate of the current material.
  64402. * @param name - name to use for the new material.
  64403. */
  64404. clone(name: string): PBRMetallicRoughnessMaterial;
  64405. /**
  64406. * Serialize the material to a parsable JSON object.
  64407. */
  64408. serialize(): any;
  64409. /**
  64410. * Parses a JSON object correponding to the serialize function.
  64411. */
  64412. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64413. }
  64414. }
  64415. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64416. import { Scene } from "babylonjs/scene";
  64417. import { Color3 } from "babylonjs/Maths/math.color";
  64418. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64419. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64420. /**
  64421. * The PBR material of BJS following the specular glossiness convention.
  64422. *
  64423. * This fits to the PBR convention in the GLTF definition:
  64424. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64425. */
  64426. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64427. /**
  64428. * Specifies the diffuse color of the material.
  64429. */
  64430. diffuseColor: Color3;
  64431. /**
  64432. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64433. * channel.
  64434. */
  64435. diffuseTexture: BaseTexture;
  64436. /**
  64437. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64438. */
  64439. specularColor: Color3;
  64440. /**
  64441. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64442. */
  64443. glossiness: number;
  64444. /**
  64445. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64446. */
  64447. specularGlossinessTexture: BaseTexture;
  64448. /**
  64449. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64450. *
  64451. * @param name The material name
  64452. * @param scene The scene the material will be use in.
  64453. */
  64454. constructor(name: string, scene: Scene);
  64455. /**
  64456. * Return the currrent class name of the material.
  64457. */
  64458. getClassName(): string;
  64459. /**
  64460. * Makes a duplicate of the current material.
  64461. * @param name - name to use for the new material.
  64462. */
  64463. clone(name: string): PBRSpecularGlossinessMaterial;
  64464. /**
  64465. * Serialize the material to a parsable JSON object.
  64466. */
  64467. serialize(): any;
  64468. /**
  64469. * Parses a JSON object correponding to the serialize function.
  64470. */
  64471. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64472. }
  64473. }
  64474. declare module "babylonjs/Materials/PBR/index" {
  64475. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64476. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64477. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64478. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64479. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64480. }
  64481. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64482. import { Nullable } from "babylonjs/types";
  64483. import { Scene } from "babylonjs/scene";
  64484. import { Matrix } from "babylonjs/Maths/math.vector";
  64485. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64486. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64487. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64488. /**
  64489. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64490. * It can help converting any input color in a desired output one. This can then be used to create effects
  64491. * from sepia, black and white to sixties or futuristic rendering...
  64492. *
  64493. * The only supported format is currently 3dl.
  64494. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64495. */
  64496. export class ColorGradingTexture extends BaseTexture {
  64497. /**
  64498. * The texture URL.
  64499. */
  64500. url: string;
  64501. /**
  64502. * Empty line regex stored for GC.
  64503. */
  64504. private static _noneEmptyLineRegex;
  64505. private _textureMatrix;
  64506. private _onLoad;
  64507. /**
  64508. * Instantiates a ColorGradingTexture from the following parameters.
  64509. *
  64510. * @param url The location of the color gradind data (currently only supporting 3dl)
  64511. * @param sceneOrEngine The scene or engine the texture will be used in
  64512. * @param onLoad defines a callback triggered when the texture has been loaded
  64513. */
  64514. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64515. /**
  64516. * Fires the onload event from the constructor if requested.
  64517. */
  64518. private _triggerOnLoad;
  64519. /**
  64520. * Returns the texture matrix used in most of the material.
  64521. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64522. */
  64523. getTextureMatrix(): Matrix;
  64524. /**
  64525. * Occurs when the file being loaded is a .3dl LUT file.
  64526. */
  64527. private load3dlTexture;
  64528. /**
  64529. * Starts the loading process of the texture.
  64530. */
  64531. private loadTexture;
  64532. /**
  64533. * Clones the color gradind texture.
  64534. */
  64535. clone(): ColorGradingTexture;
  64536. /**
  64537. * Called during delayed load for textures.
  64538. */
  64539. delayLoad(): void;
  64540. /**
  64541. * Parses a color grading texture serialized by Babylon.
  64542. * @param parsedTexture The texture information being parsedTexture
  64543. * @param scene The scene to load the texture in
  64544. * @param rootUrl The root url of the data assets to load
  64545. * @return A color gradind texture
  64546. */
  64547. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64548. /**
  64549. * Serializes the LUT texture to json format.
  64550. */
  64551. serialize(): any;
  64552. }
  64553. }
  64554. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64555. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64556. import { Scene } from "babylonjs/scene";
  64557. import { Nullable } from "babylonjs/types";
  64558. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64559. /**
  64560. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64561. */
  64562. export class EquiRectangularCubeTexture extends BaseTexture {
  64563. /** The six faces of the cube. */
  64564. private static _FacesMapping;
  64565. private _noMipmap;
  64566. private _onLoad;
  64567. private _onError;
  64568. /** The size of the cubemap. */
  64569. private _size;
  64570. /** The buffer of the image. */
  64571. private _buffer;
  64572. /** The width of the input image. */
  64573. private _width;
  64574. /** The height of the input image. */
  64575. private _height;
  64576. /** The URL to the image. */
  64577. url: string;
  64578. /**
  64579. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64580. * @param url The location of the image
  64581. * @param scene The scene the texture will be used in
  64582. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64583. * @param noMipmap Forces to not generate the mipmap if true
  64584. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64585. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64586. * @param onLoad — defines a callback called when texture is loaded
  64587. * @param onError — defines a callback called if there is an error
  64588. */
  64589. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64590. /**
  64591. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64592. */
  64593. private loadImage;
  64594. /**
  64595. * Convert the image buffer into a cubemap and create a CubeTexture.
  64596. */
  64597. private loadTexture;
  64598. /**
  64599. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64600. * @param buffer The ArrayBuffer that should be converted.
  64601. * @returns The buffer as Float32Array.
  64602. */
  64603. private getFloat32ArrayFromArrayBuffer;
  64604. /**
  64605. * Get the current class name of the texture useful for serialization or dynamic coding.
  64606. * @returns "EquiRectangularCubeTexture"
  64607. */
  64608. getClassName(): string;
  64609. /**
  64610. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64611. * @returns A clone of the current EquiRectangularCubeTexture.
  64612. */
  64613. clone(): EquiRectangularCubeTexture;
  64614. }
  64615. }
  64616. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64617. import { Nullable } from "babylonjs/types";
  64618. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64619. import { Matrix } from "babylonjs/Maths/math.vector";
  64620. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64621. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64622. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64623. import { Scene } from "babylonjs/scene";
  64624. /**
  64625. * Defines the options related to the creation of an HtmlElementTexture
  64626. */
  64627. export interface IHtmlElementTextureOptions {
  64628. /**
  64629. * Defines wether mip maps should be created or not.
  64630. */
  64631. generateMipMaps?: boolean;
  64632. /**
  64633. * Defines the sampling mode of the texture.
  64634. */
  64635. samplingMode?: number;
  64636. /**
  64637. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64638. */
  64639. engine: Nullable<ThinEngine>;
  64640. /**
  64641. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64642. */
  64643. scene: Nullable<Scene>;
  64644. }
  64645. /**
  64646. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64647. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64648. * is automatically managed.
  64649. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64650. * in your application.
  64651. *
  64652. * As the update is not automatic, you need to call them manually.
  64653. */
  64654. export class HtmlElementTexture extends BaseTexture {
  64655. /**
  64656. * The texture URL.
  64657. */
  64658. element: HTMLVideoElement | HTMLCanvasElement;
  64659. private static readonly DefaultOptions;
  64660. private _textureMatrix;
  64661. private _isVideo;
  64662. private _generateMipMaps;
  64663. private _samplingMode;
  64664. /**
  64665. * Instantiates a HtmlElementTexture from the following parameters.
  64666. *
  64667. * @param name Defines the name of the texture
  64668. * @param element Defines the video or canvas the texture is filled with
  64669. * @param options Defines the other none mandatory texture creation options
  64670. */
  64671. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64672. private _createInternalTexture;
  64673. /**
  64674. * Returns the texture matrix used in most of the material.
  64675. */
  64676. getTextureMatrix(): Matrix;
  64677. /**
  64678. * Updates the content of the texture.
  64679. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64680. */
  64681. update(invertY?: Nullable<boolean>): void;
  64682. }
  64683. }
  64684. declare module "babylonjs/Misc/tga" {
  64685. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64686. /**
  64687. * Based on jsTGALoader - Javascript loader for TGA file
  64688. * By Vincent Thibault
  64689. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64690. */
  64691. export class TGATools {
  64692. private static _TYPE_INDEXED;
  64693. private static _TYPE_RGB;
  64694. private static _TYPE_GREY;
  64695. private static _TYPE_RLE_INDEXED;
  64696. private static _TYPE_RLE_RGB;
  64697. private static _TYPE_RLE_GREY;
  64698. private static _ORIGIN_MASK;
  64699. private static _ORIGIN_SHIFT;
  64700. private static _ORIGIN_BL;
  64701. private static _ORIGIN_BR;
  64702. private static _ORIGIN_UL;
  64703. private static _ORIGIN_UR;
  64704. /**
  64705. * Gets the header of a TGA file
  64706. * @param data defines the TGA data
  64707. * @returns the header
  64708. */
  64709. static GetTGAHeader(data: Uint8Array): any;
  64710. /**
  64711. * Uploads TGA content to a Babylon Texture
  64712. * @hidden
  64713. */
  64714. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64715. /** @hidden */
  64716. 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;
  64717. /** @hidden */
  64718. 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;
  64719. /** @hidden */
  64720. 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;
  64721. /** @hidden */
  64722. 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;
  64723. /** @hidden */
  64724. 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;
  64725. /** @hidden */
  64726. 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;
  64727. }
  64728. }
  64729. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64730. import { Nullable } from "babylonjs/types";
  64731. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64732. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64733. /**
  64734. * Implementation of the TGA Texture Loader.
  64735. * @hidden
  64736. */
  64737. export class _TGATextureLoader implements IInternalTextureLoader {
  64738. /**
  64739. * Defines wether the loader supports cascade loading the different faces.
  64740. */
  64741. readonly supportCascades: boolean;
  64742. /**
  64743. * This returns if the loader support the current file information.
  64744. * @param extension defines the file extension of the file being loaded
  64745. * @returns true if the loader can load the specified file
  64746. */
  64747. canLoad(extension: string): boolean;
  64748. /**
  64749. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64750. * @param data contains the texture data
  64751. * @param texture defines the BabylonJS internal texture
  64752. * @param createPolynomials will be true if polynomials have been requested
  64753. * @param onLoad defines the callback to trigger once the texture is ready
  64754. * @param onError defines the callback to trigger in case of error
  64755. */
  64756. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64757. /**
  64758. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64759. * @param data contains the texture data
  64760. * @param texture defines the BabylonJS internal texture
  64761. * @param callback defines the method to call once ready to upload
  64762. */
  64763. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64764. }
  64765. }
  64766. declare module "babylonjs/Misc/basis" {
  64767. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64768. /**
  64769. * Info about the .basis files
  64770. */
  64771. class BasisFileInfo {
  64772. /**
  64773. * If the file has alpha
  64774. */
  64775. hasAlpha: boolean;
  64776. /**
  64777. * Info about each image of the basis file
  64778. */
  64779. images: Array<{
  64780. levels: Array<{
  64781. width: number;
  64782. height: number;
  64783. transcodedPixels: ArrayBufferView;
  64784. }>;
  64785. }>;
  64786. }
  64787. /**
  64788. * Result of transcoding a basis file
  64789. */
  64790. class TranscodeResult {
  64791. /**
  64792. * Info about the .basis file
  64793. */
  64794. fileInfo: BasisFileInfo;
  64795. /**
  64796. * Format to use when loading the file
  64797. */
  64798. format: number;
  64799. }
  64800. /**
  64801. * Configuration options for the Basis transcoder
  64802. */
  64803. export class BasisTranscodeConfiguration {
  64804. /**
  64805. * Supported compression formats used to determine the supported output format of the transcoder
  64806. */
  64807. supportedCompressionFormats?: {
  64808. /**
  64809. * etc1 compression format
  64810. */
  64811. etc1?: boolean;
  64812. /**
  64813. * s3tc compression format
  64814. */
  64815. s3tc?: boolean;
  64816. /**
  64817. * pvrtc compression format
  64818. */
  64819. pvrtc?: boolean;
  64820. /**
  64821. * etc2 compression format
  64822. */
  64823. etc2?: boolean;
  64824. };
  64825. /**
  64826. * If mipmap levels should be loaded for transcoded images (Default: true)
  64827. */
  64828. loadMipmapLevels?: boolean;
  64829. /**
  64830. * Index of a single image to load (Default: all images)
  64831. */
  64832. loadSingleImage?: number;
  64833. }
  64834. /**
  64835. * Used to load .Basis files
  64836. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64837. */
  64838. export class BasisTools {
  64839. private static _IgnoreSupportedFormats;
  64840. /**
  64841. * URL to use when loading the basis transcoder
  64842. */
  64843. static JSModuleURL: string;
  64844. /**
  64845. * URL to use when loading the wasm module for the transcoder
  64846. */
  64847. static WasmModuleURL: string;
  64848. /**
  64849. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64850. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64851. * @returns internal format corresponding to the Basis format
  64852. */
  64853. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64854. private static _WorkerPromise;
  64855. private static _Worker;
  64856. private static _actionId;
  64857. private static _CreateWorkerAsync;
  64858. /**
  64859. * Transcodes a loaded image file to compressed pixel data
  64860. * @param data image data to transcode
  64861. * @param config configuration options for the transcoding
  64862. * @returns a promise resulting in the transcoded image
  64863. */
  64864. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64865. /**
  64866. * Loads a texture from the transcode result
  64867. * @param texture texture load to
  64868. * @param transcodeResult the result of transcoding the basis file to load from
  64869. */
  64870. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64871. }
  64872. }
  64873. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64874. import { Nullable } from "babylonjs/types";
  64875. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64876. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64877. /**
  64878. * Loader for .basis file format
  64879. */
  64880. export class _BasisTextureLoader implements IInternalTextureLoader {
  64881. /**
  64882. * Defines whether the loader supports cascade loading the different faces.
  64883. */
  64884. readonly supportCascades: boolean;
  64885. /**
  64886. * This returns if the loader support the current file information.
  64887. * @param extension defines the file extension of the file being loaded
  64888. * @returns true if the loader can load the specified file
  64889. */
  64890. canLoad(extension: string): boolean;
  64891. /**
  64892. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64893. * @param data contains the texture data
  64894. * @param texture defines the BabylonJS internal texture
  64895. * @param createPolynomials will be true if polynomials have been requested
  64896. * @param onLoad defines the callback to trigger once the texture is ready
  64897. * @param onError defines the callback to trigger in case of error
  64898. */
  64899. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64900. /**
  64901. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64902. * @param data contains the texture data
  64903. * @param texture defines the BabylonJS internal texture
  64904. * @param callback defines the method to call once ready to upload
  64905. */
  64906. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64907. }
  64908. }
  64909. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64910. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64911. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64912. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64913. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64914. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64915. }
  64916. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64917. import { Vector2 } from "babylonjs/Maths/math.vector";
  64918. /**
  64919. * Defines the basic options interface of a TexturePacker Frame
  64920. */
  64921. export interface ITexturePackerFrame {
  64922. /**
  64923. * The frame ID
  64924. */
  64925. id: number;
  64926. /**
  64927. * The frames Scale
  64928. */
  64929. scale: Vector2;
  64930. /**
  64931. * The Frames offset
  64932. */
  64933. offset: Vector2;
  64934. }
  64935. /**
  64936. * This is a support class for frame Data on texture packer sets.
  64937. */
  64938. export class TexturePackerFrame implements ITexturePackerFrame {
  64939. /**
  64940. * The frame ID
  64941. */
  64942. id: number;
  64943. /**
  64944. * The frames Scale
  64945. */
  64946. scale: Vector2;
  64947. /**
  64948. * The Frames offset
  64949. */
  64950. offset: Vector2;
  64951. /**
  64952. * Initializes a texture package frame.
  64953. * @param id The numerical frame identifier
  64954. * @param scale Scalar Vector2 for UV frame
  64955. * @param offset Vector2 for the frame position in UV units.
  64956. * @returns TexturePackerFrame
  64957. */
  64958. constructor(id: number, scale: Vector2, offset: Vector2);
  64959. }
  64960. }
  64961. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64962. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64963. import { Scene } from "babylonjs/scene";
  64964. import { Nullable } from "babylonjs/types";
  64965. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64966. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64967. /**
  64968. * Defines the basic options interface of a TexturePacker
  64969. */
  64970. export interface ITexturePackerOptions {
  64971. /**
  64972. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64973. */
  64974. map?: string[];
  64975. /**
  64976. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64977. */
  64978. uvsIn?: string;
  64979. /**
  64980. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64981. */
  64982. uvsOut?: string;
  64983. /**
  64984. * number representing the layout style. Defaults to LAYOUT_STRIP
  64985. */
  64986. layout?: number;
  64987. /**
  64988. * number of columns if using custom column count layout(2). This defaults to 4.
  64989. */
  64990. colnum?: number;
  64991. /**
  64992. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64993. */
  64994. updateInputMeshes?: boolean;
  64995. /**
  64996. * boolean flag to dispose all the source textures. Defaults to true.
  64997. */
  64998. disposeSources?: boolean;
  64999. /**
  65000. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  65001. */
  65002. fillBlanks?: boolean;
  65003. /**
  65004. * string value representing the context fill style color. Defaults to 'black'.
  65005. */
  65006. customFillColor?: string;
  65007. /**
  65008. * Width and Height Value of each Frame in the TexturePacker Sets
  65009. */
  65010. frameSize?: number;
  65011. /**
  65012. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  65013. */
  65014. paddingRatio?: number;
  65015. /**
  65016. * Number that declares the fill method for the padding gutter.
  65017. */
  65018. paddingMode?: number;
  65019. /**
  65020. * If in SUBUV_COLOR padding mode what color to use.
  65021. */
  65022. paddingColor?: Color3 | Color4;
  65023. }
  65024. /**
  65025. * Defines the basic interface of a TexturePacker JSON File
  65026. */
  65027. export interface ITexturePackerJSON {
  65028. /**
  65029. * The frame ID
  65030. */
  65031. name: string;
  65032. /**
  65033. * The base64 channel data
  65034. */
  65035. sets: any;
  65036. /**
  65037. * The options of the Packer
  65038. */
  65039. options: ITexturePackerOptions;
  65040. /**
  65041. * The frame data of the Packer
  65042. */
  65043. frames: Array<number>;
  65044. }
  65045. /**
  65046. * This is a support class that generates a series of packed texture sets.
  65047. * @see https://doc.babylonjs.com/babylon101/materials
  65048. */
  65049. export class TexturePacker {
  65050. /** Packer Layout Constant 0 */
  65051. static readonly LAYOUT_STRIP: number;
  65052. /** Packer Layout Constant 1 */
  65053. static readonly LAYOUT_POWER2: number;
  65054. /** Packer Layout Constant 2 */
  65055. static readonly LAYOUT_COLNUM: number;
  65056. /** Packer Layout Constant 0 */
  65057. static readonly SUBUV_WRAP: number;
  65058. /** Packer Layout Constant 1 */
  65059. static readonly SUBUV_EXTEND: number;
  65060. /** Packer Layout Constant 2 */
  65061. static readonly SUBUV_COLOR: number;
  65062. /** The Name of the Texture Package */
  65063. name: string;
  65064. /** The scene scope of the TexturePacker */
  65065. scene: Scene;
  65066. /** The Meshes to target */
  65067. meshes: AbstractMesh[];
  65068. /** Arguments passed with the Constructor */
  65069. options: ITexturePackerOptions;
  65070. /** The promise that is started upon initialization */
  65071. promise: Nullable<Promise<TexturePacker | string>>;
  65072. /** The Container object for the channel sets that are generated */
  65073. sets: object;
  65074. /** The Container array for the frames that are generated */
  65075. frames: TexturePackerFrame[];
  65076. /** The expected number of textures the system is parsing. */
  65077. private _expecting;
  65078. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  65079. private _paddingValue;
  65080. /**
  65081. * Initializes a texture package series from an array of meshes or a single mesh.
  65082. * @param name The name of the package
  65083. * @param meshes The target meshes to compose the package from
  65084. * @param options The arguments that texture packer should follow while building.
  65085. * @param scene The scene which the textures are scoped to.
  65086. * @returns TexturePacker
  65087. */
  65088. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  65089. /**
  65090. * Starts the package process
  65091. * @param resolve The promises resolution function
  65092. * @returns TexturePacker
  65093. */
  65094. private _createFrames;
  65095. /**
  65096. * Calculates the Size of the Channel Sets
  65097. * @returns Vector2
  65098. */
  65099. private _calculateSize;
  65100. /**
  65101. * Calculates the UV data for the frames.
  65102. * @param baseSize the base frameSize
  65103. * @param padding the base frame padding
  65104. * @param dtSize size of the Dynamic Texture for that channel
  65105. * @param dtUnits is 1/dtSize
  65106. * @param update flag to update the input meshes
  65107. */
  65108. private _calculateMeshUVFrames;
  65109. /**
  65110. * Calculates the frames Offset.
  65111. * @param index of the frame
  65112. * @returns Vector2
  65113. */
  65114. private _getFrameOffset;
  65115. /**
  65116. * Updates a Mesh to the frame data
  65117. * @param mesh that is the target
  65118. * @param frameID or the frame index
  65119. */
  65120. private _updateMeshUV;
  65121. /**
  65122. * Updates a Meshes materials to use the texture packer channels
  65123. * @param m is the mesh to target
  65124. * @param force all channels on the packer to be set.
  65125. */
  65126. private _updateTextureReferences;
  65127. /**
  65128. * Public method to set a Mesh to a frame
  65129. * @param m that is the target
  65130. * @param frameID or the frame index
  65131. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  65132. */
  65133. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  65134. /**
  65135. * Starts the async promise to compile the texture packer.
  65136. * @returns Promise<void>
  65137. */
  65138. processAsync(): Promise<void>;
  65139. /**
  65140. * Disposes all textures associated with this packer
  65141. */
  65142. dispose(): void;
  65143. /**
  65144. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  65145. * @param imageType is the image type to use.
  65146. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  65147. */
  65148. download(imageType?: string, quality?: number): void;
  65149. /**
  65150. * Public method to load a texturePacker JSON file.
  65151. * @param data of the JSON file in string format.
  65152. */
  65153. updateFromJSON(data: string): void;
  65154. }
  65155. }
  65156. declare module "babylonjs/Materials/Textures/Packer/index" {
  65157. export * from "babylonjs/Materials/Textures/Packer/packer";
  65158. export * from "babylonjs/Materials/Textures/Packer/frame";
  65159. }
  65160. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  65161. import { Scene } from "babylonjs/scene";
  65162. import { Texture } from "babylonjs/Materials/Textures/texture";
  65163. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65164. /**
  65165. * 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.
  65166. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  65167. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  65168. */
  65169. export class CustomProceduralTexture extends ProceduralTexture {
  65170. private _animate;
  65171. private _time;
  65172. private _config;
  65173. private _texturePath;
  65174. /**
  65175. * Instantiates a new Custom Procedural Texture.
  65176. * 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.
  65177. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  65178. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  65179. * @param name Define the name of the texture
  65180. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  65181. * @param size Define the size of the texture to create
  65182. * @param scene Define the scene the texture belongs to
  65183. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  65184. * @param generateMipMaps Define if the texture should creates mip maps or not
  65185. */
  65186. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65187. private _loadJson;
  65188. /**
  65189. * Is the texture ready to be used ? (rendered at least once)
  65190. * @returns true if ready, otherwise, false.
  65191. */
  65192. isReady(): boolean;
  65193. /**
  65194. * Render the texture to its associated render target.
  65195. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  65196. */
  65197. render(useCameraPostProcess?: boolean): void;
  65198. /**
  65199. * Update the list of dependant textures samplers in the shader.
  65200. */
  65201. updateTextures(): void;
  65202. /**
  65203. * Update the uniform values of the procedural texture in the shader.
  65204. */
  65205. updateShaderUniforms(): void;
  65206. /**
  65207. * Define if the texture animates or not.
  65208. */
  65209. get animate(): boolean;
  65210. set animate(value: boolean);
  65211. }
  65212. }
  65213. declare module "babylonjs/Shaders/noise.fragment" {
  65214. /** @hidden */
  65215. export var noisePixelShader: {
  65216. name: string;
  65217. shader: string;
  65218. };
  65219. }
  65220. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  65221. import { Nullable } from "babylonjs/types";
  65222. import { Scene } from "babylonjs/scene";
  65223. import { Texture } from "babylonjs/Materials/Textures/texture";
  65224. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65225. import "babylonjs/Shaders/noise.fragment";
  65226. /**
  65227. * Class used to generate noise procedural textures
  65228. */
  65229. export class NoiseProceduralTexture extends ProceduralTexture {
  65230. /** Gets or sets the start time (default is 0) */
  65231. time: number;
  65232. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  65233. brightness: number;
  65234. /** Defines the number of octaves to process */
  65235. octaves: number;
  65236. /** Defines the level of persistence (0.8 by default) */
  65237. persistence: number;
  65238. /** Gets or sets animation speed factor (default is 1) */
  65239. animationSpeedFactor: number;
  65240. /**
  65241. * Creates a new NoiseProceduralTexture
  65242. * @param name defines the name fo the texture
  65243. * @param size defines the size of the texture (default is 256)
  65244. * @param scene defines the hosting scene
  65245. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  65246. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  65247. */
  65248. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65249. private _updateShaderUniforms;
  65250. protected _getDefines(): string;
  65251. /** Generate the current state of the procedural texture */
  65252. render(useCameraPostProcess?: boolean): void;
  65253. /**
  65254. * Serializes this noise procedural texture
  65255. * @returns a serialized noise procedural texture object
  65256. */
  65257. serialize(): any;
  65258. /**
  65259. * Clone the texture.
  65260. * @returns the cloned texture
  65261. */
  65262. clone(): NoiseProceduralTexture;
  65263. /**
  65264. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  65265. * @param parsedTexture defines parsed texture data
  65266. * @param scene defines the current scene
  65267. * @param rootUrl defines the root URL containing noise procedural texture information
  65268. * @returns a parsed NoiseProceduralTexture
  65269. */
  65270. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  65271. }
  65272. }
  65273. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  65274. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  65275. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  65276. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65277. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  65278. }
  65279. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  65280. import { Nullable } from "babylonjs/types";
  65281. import { Scene } from "babylonjs/scene";
  65282. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  65283. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65284. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65285. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65286. /**
  65287. * Raw cube texture where the raw buffers are passed in
  65288. */
  65289. export class RawCubeTexture extends CubeTexture {
  65290. /**
  65291. * Creates a cube texture where the raw buffers are passed in.
  65292. * @param scene defines the scene the texture is attached to
  65293. * @param data defines the array of data to use to create each face
  65294. * @param size defines the size of the textures
  65295. * @param format defines the format of the data
  65296. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  65297. * @param generateMipMaps defines if the engine should generate the mip levels
  65298. * @param invertY defines if data must be stored with Y axis inverted
  65299. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  65300. * @param compression defines the compression used (null by default)
  65301. */
  65302. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  65303. /**
  65304. * Updates the raw cube texture.
  65305. * @param data defines the data to store
  65306. * @param format defines the data format
  65307. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65308. * @param invertY defines if data must be stored with Y axis inverted
  65309. * @param compression defines the compression used (null by default)
  65310. * @param level defines which level of the texture to update
  65311. */
  65312. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  65313. /**
  65314. * Updates a raw cube texture with RGBD encoded data.
  65315. * @param data defines the array of data [mipmap][face] to use to create each face
  65316. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  65317. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  65318. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  65319. * @returns a promsie that resolves when the operation is complete
  65320. */
  65321. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  65322. /**
  65323. * Clones the raw cube texture.
  65324. * @return a new cube texture
  65325. */
  65326. clone(): CubeTexture;
  65327. /** @hidden */
  65328. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65329. }
  65330. }
  65331. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65332. import { Scene } from "babylonjs/scene";
  65333. import { Texture } from "babylonjs/Materials/Textures/texture";
  65334. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65335. /**
  65336. * Class used to store 2D array textures containing user data
  65337. */
  65338. export class RawTexture2DArray extends Texture {
  65339. /** Gets or sets the texture format to use */
  65340. format: number;
  65341. /**
  65342. * Create a new RawTexture2DArray
  65343. * @param data defines the data of the texture
  65344. * @param width defines the width of the texture
  65345. * @param height defines the height of the texture
  65346. * @param depth defines the number of layers of the texture
  65347. * @param format defines the texture format to use
  65348. * @param scene defines the hosting scene
  65349. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65350. * @param invertY defines if texture must be stored with Y axis inverted
  65351. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65352. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65353. */
  65354. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65355. /** Gets or sets the texture format to use */
  65356. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65357. /**
  65358. * Update the texture with new data
  65359. * @param data defines the data to store in the texture
  65360. */
  65361. update(data: ArrayBufferView): void;
  65362. }
  65363. }
  65364. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65365. import { Scene } from "babylonjs/scene";
  65366. import { Texture } from "babylonjs/Materials/Textures/texture";
  65367. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65368. /**
  65369. * Class used to store 3D textures containing user data
  65370. */
  65371. export class RawTexture3D extends Texture {
  65372. /** Gets or sets the texture format to use */
  65373. format: number;
  65374. /**
  65375. * Create a new RawTexture3D
  65376. * @param data defines the data of the texture
  65377. * @param width defines the width of the texture
  65378. * @param height defines the height of the texture
  65379. * @param depth defines the depth of the texture
  65380. * @param format defines the texture format to use
  65381. * @param scene defines the hosting scene
  65382. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65383. * @param invertY defines if texture must be stored with Y axis inverted
  65384. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65385. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65386. */
  65387. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65388. /** Gets or sets the texture format to use */
  65389. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65390. /**
  65391. * Update the texture with new data
  65392. * @param data defines the data to store in the texture
  65393. */
  65394. update(data: ArrayBufferView): void;
  65395. }
  65396. }
  65397. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65398. import { Scene } from "babylonjs/scene";
  65399. import { Plane } from "babylonjs/Maths/math.plane";
  65400. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65401. /**
  65402. * Creates a refraction texture used by refraction channel of the standard material.
  65403. * It is like a mirror but to see through a material.
  65404. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65405. */
  65406. export class RefractionTexture extends RenderTargetTexture {
  65407. /**
  65408. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65409. * 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.
  65410. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65411. */
  65412. refractionPlane: Plane;
  65413. /**
  65414. * Define how deep under the surface we should see.
  65415. */
  65416. depth: number;
  65417. /**
  65418. * Creates a refraction texture used by refraction channel of the standard material.
  65419. * It is like a mirror but to see through a material.
  65420. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65421. * @param name Define the texture name
  65422. * @param size Define the size of the underlying texture
  65423. * @param scene Define the scene the refraction belongs to
  65424. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65425. */
  65426. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65427. /**
  65428. * Clone the refraction texture.
  65429. * @returns the cloned texture
  65430. */
  65431. clone(): RefractionTexture;
  65432. /**
  65433. * Serialize the texture to a JSON representation you could use in Parse later on
  65434. * @returns the serialized JSON representation
  65435. */
  65436. serialize(): any;
  65437. }
  65438. }
  65439. declare module "babylonjs/Materials/Textures/index" {
  65440. export * from "babylonjs/Materials/Textures/baseTexture";
  65441. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65442. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65443. export * from "babylonjs/Materials/Textures/cubeTexture";
  65444. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65445. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65446. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65447. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65448. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65449. export * from "babylonjs/Materials/Textures/internalTexture";
  65450. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65451. export * from "babylonjs/Materials/Textures/Loaders/index";
  65452. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65453. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65454. export * from "babylonjs/Materials/Textures/Packer/index";
  65455. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65456. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65457. export * from "babylonjs/Materials/Textures/rawTexture";
  65458. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65459. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65460. export * from "babylonjs/Materials/Textures/refractionTexture";
  65461. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65462. export * from "babylonjs/Materials/Textures/texture";
  65463. export * from "babylonjs/Materials/Textures/videoTexture";
  65464. }
  65465. declare module "babylonjs/Materials/Node/Enums/index" {
  65466. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65467. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65468. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65469. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65470. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65471. }
  65472. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65473. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65474. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65475. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65476. import { Mesh } from "babylonjs/Meshes/mesh";
  65477. import { Effect } from "babylonjs/Materials/effect";
  65478. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65479. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65480. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65481. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65482. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65483. /**
  65484. * Block used to add support for vertex skinning (bones)
  65485. */
  65486. export class BonesBlock extends NodeMaterialBlock {
  65487. /**
  65488. * Creates a new BonesBlock
  65489. * @param name defines the block name
  65490. */
  65491. constructor(name: string);
  65492. /**
  65493. * Initialize the block and prepare the context for build
  65494. * @param state defines the state that will be used for the build
  65495. */
  65496. initialize(state: NodeMaterialBuildState): void;
  65497. /**
  65498. * Gets the current class name
  65499. * @returns the class name
  65500. */
  65501. getClassName(): string;
  65502. /**
  65503. * Gets the matrix indices input component
  65504. */
  65505. get matricesIndices(): NodeMaterialConnectionPoint;
  65506. /**
  65507. * Gets the matrix weights input component
  65508. */
  65509. get matricesWeights(): NodeMaterialConnectionPoint;
  65510. /**
  65511. * Gets the extra matrix indices input component
  65512. */
  65513. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65514. /**
  65515. * Gets the extra matrix weights input component
  65516. */
  65517. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65518. /**
  65519. * Gets the world input component
  65520. */
  65521. get world(): NodeMaterialConnectionPoint;
  65522. /**
  65523. * Gets the output component
  65524. */
  65525. get output(): NodeMaterialConnectionPoint;
  65526. autoConfigure(material: NodeMaterial): void;
  65527. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65528. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65529. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65530. protected _buildBlock(state: NodeMaterialBuildState): this;
  65531. }
  65532. }
  65533. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65534. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65535. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65536. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65537. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65538. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65539. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65540. /**
  65541. * Block used to add support for instances
  65542. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65543. */
  65544. export class InstancesBlock extends NodeMaterialBlock {
  65545. /**
  65546. * Creates a new InstancesBlock
  65547. * @param name defines the block name
  65548. */
  65549. constructor(name: string);
  65550. /**
  65551. * Gets the current class name
  65552. * @returns the class name
  65553. */
  65554. getClassName(): string;
  65555. /**
  65556. * Gets the first world row input component
  65557. */
  65558. get world0(): NodeMaterialConnectionPoint;
  65559. /**
  65560. * Gets the second world row input component
  65561. */
  65562. get world1(): NodeMaterialConnectionPoint;
  65563. /**
  65564. * Gets the third world row input component
  65565. */
  65566. get world2(): NodeMaterialConnectionPoint;
  65567. /**
  65568. * Gets the forth world row input component
  65569. */
  65570. get world3(): NodeMaterialConnectionPoint;
  65571. /**
  65572. * Gets the world input component
  65573. */
  65574. get world(): NodeMaterialConnectionPoint;
  65575. /**
  65576. * Gets the output component
  65577. */
  65578. get output(): NodeMaterialConnectionPoint;
  65579. /**
  65580. * Gets the isntanceID component
  65581. */
  65582. get instanceID(): NodeMaterialConnectionPoint;
  65583. autoConfigure(material: NodeMaterial): void;
  65584. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65585. protected _buildBlock(state: NodeMaterialBuildState): this;
  65586. }
  65587. }
  65588. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65589. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65590. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65592. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65593. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65594. import { Effect } from "babylonjs/Materials/effect";
  65595. import { Mesh } from "babylonjs/Meshes/mesh";
  65596. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65597. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65598. /**
  65599. * Block used to add morph targets support to vertex shader
  65600. */
  65601. export class MorphTargetsBlock extends NodeMaterialBlock {
  65602. private _repeatableContentAnchor;
  65603. /**
  65604. * Create a new MorphTargetsBlock
  65605. * @param name defines the block name
  65606. */
  65607. constructor(name: string);
  65608. /**
  65609. * Gets the current class name
  65610. * @returns the class name
  65611. */
  65612. getClassName(): string;
  65613. /**
  65614. * Gets the position input component
  65615. */
  65616. get position(): NodeMaterialConnectionPoint;
  65617. /**
  65618. * Gets the normal input component
  65619. */
  65620. get normal(): NodeMaterialConnectionPoint;
  65621. /**
  65622. * Gets the tangent input component
  65623. */
  65624. get tangent(): NodeMaterialConnectionPoint;
  65625. /**
  65626. * Gets the tangent input component
  65627. */
  65628. get uv(): NodeMaterialConnectionPoint;
  65629. /**
  65630. * Gets the position output component
  65631. */
  65632. get positionOutput(): NodeMaterialConnectionPoint;
  65633. /**
  65634. * Gets the normal output component
  65635. */
  65636. get normalOutput(): NodeMaterialConnectionPoint;
  65637. /**
  65638. * Gets the tangent output component
  65639. */
  65640. get tangentOutput(): NodeMaterialConnectionPoint;
  65641. /**
  65642. * Gets the tangent output component
  65643. */
  65644. get uvOutput(): NodeMaterialConnectionPoint;
  65645. initialize(state: NodeMaterialBuildState): void;
  65646. autoConfigure(material: NodeMaterial): void;
  65647. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65648. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65649. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65650. protected _buildBlock(state: NodeMaterialBuildState): this;
  65651. }
  65652. }
  65653. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65654. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65655. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65656. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65657. import { Nullable } from "babylonjs/types";
  65658. import { Scene } from "babylonjs/scene";
  65659. import { Effect } from "babylonjs/Materials/effect";
  65660. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65661. import { Mesh } from "babylonjs/Meshes/mesh";
  65662. import { Light } from "babylonjs/Lights/light";
  65663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65664. /**
  65665. * Block used to get data information from a light
  65666. */
  65667. export class LightInformationBlock extends NodeMaterialBlock {
  65668. private _lightDataUniformName;
  65669. private _lightColorUniformName;
  65670. private _lightTypeDefineName;
  65671. /**
  65672. * Gets or sets the light associated with this block
  65673. */
  65674. light: Nullable<Light>;
  65675. /**
  65676. * Creates a new LightInformationBlock
  65677. * @param name defines the block name
  65678. */
  65679. constructor(name: string);
  65680. /**
  65681. * Gets the current class name
  65682. * @returns the class name
  65683. */
  65684. getClassName(): string;
  65685. /**
  65686. * Gets the world position input component
  65687. */
  65688. get worldPosition(): NodeMaterialConnectionPoint;
  65689. /**
  65690. * Gets the direction output component
  65691. */
  65692. get direction(): NodeMaterialConnectionPoint;
  65693. /**
  65694. * Gets the direction output component
  65695. */
  65696. get color(): NodeMaterialConnectionPoint;
  65697. /**
  65698. * Gets the direction output component
  65699. */
  65700. get intensity(): NodeMaterialConnectionPoint;
  65701. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65702. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65703. protected _buildBlock(state: NodeMaterialBuildState): this;
  65704. serialize(): any;
  65705. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65706. }
  65707. }
  65708. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65709. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65710. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65711. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65712. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65713. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65714. }
  65715. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65716. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65717. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65718. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65719. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65720. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65721. import { Effect } from "babylonjs/Materials/effect";
  65722. import { Mesh } from "babylonjs/Meshes/mesh";
  65723. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65724. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65725. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65726. /**
  65727. * Block used to add image processing support to fragment shader
  65728. */
  65729. export class ImageProcessingBlock extends NodeMaterialBlock {
  65730. /**
  65731. * Create a new ImageProcessingBlock
  65732. * @param name defines the block name
  65733. */
  65734. constructor(name: string);
  65735. /**
  65736. * Gets the current class name
  65737. * @returns the class name
  65738. */
  65739. getClassName(): string;
  65740. /**
  65741. * Gets the color input component
  65742. */
  65743. get color(): NodeMaterialConnectionPoint;
  65744. /**
  65745. * Gets the output component
  65746. */
  65747. get output(): NodeMaterialConnectionPoint;
  65748. /**
  65749. * Initialize the block and prepare the context for build
  65750. * @param state defines the state that will be used for the build
  65751. */
  65752. initialize(state: NodeMaterialBuildState): void;
  65753. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65754. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65755. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65756. protected _buildBlock(state: NodeMaterialBuildState): this;
  65757. }
  65758. }
  65759. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65760. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65761. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65762. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65763. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65764. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65765. import { Effect } from "babylonjs/Materials/effect";
  65766. import { Mesh } from "babylonjs/Meshes/mesh";
  65767. import { Scene } from "babylonjs/scene";
  65768. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65769. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65770. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65771. /**
  65772. * Block used to pertub normals based on a normal map
  65773. */
  65774. export class PerturbNormalBlock extends NodeMaterialBlock {
  65775. private _tangentSpaceParameterName;
  65776. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65777. invertX: boolean;
  65778. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65779. invertY: boolean;
  65780. /**
  65781. * Create a new PerturbNormalBlock
  65782. * @param name defines the block name
  65783. */
  65784. constructor(name: string);
  65785. /**
  65786. * Gets the current class name
  65787. * @returns the class name
  65788. */
  65789. getClassName(): string;
  65790. /**
  65791. * Gets the world position input component
  65792. */
  65793. get worldPosition(): NodeMaterialConnectionPoint;
  65794. /**
  65795. * Gets the world normal input component
  65796. */
  65797. get worldNormal(): NodeMaterialConnectionPoint;
  65798. /**
  65799. * Gets the world tangent input component
  65800. */
  65801. get worldTangent(): NodeMaterialConnectionPoint;
  65802. /**
  65803. * Gets the uv input component
  65804. */
  65805. get uv(): NodeMaterialConnectionPoint;
  65806. /**
  65807. * Gets the normal map color input component
  65808. */
  65809. get normalMapColor(): NodeMaterialConnectionPoint;
  65810. /**
  65811. * Gets the strength input component
  65812. */
  65813. get strength(): NodeMaterialConnectionPoint;
  65814. /**
  65815. * Gets the output component
  65816. */
  65817. get output(): NodeMaterialConnectionPoint;
  65818. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65819. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65820. autoConfigure(material: NodeMaterial): void;
  65821. protected _buildBlock(state: NodeMaterialBuildState): this;
  65822. protected _dumpPropertiesCode(): string;
  65823. serialize(): any;
  65824. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65825. }
  65826. }
  65827. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65828. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65829. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65830. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65831. /**
  65832. * Block used to discard a pixel if a value is smaller than a cutoff
  65833. */
  65834. export class DiscardBlock extends NodeMaterialBlock {
  65835. /**
  65836. * Create a new DiscardBlock
  65837. * @param name defines the block name
  65838. */
  65839. constructor(name: string);
  65840. /**
  65841. * Gets the current class name
  65842. * @returns the class name
  65843. */
  65844. getClassName(): string;
  65845. /**
  65846. * Gets the color input component
  65847. */
  65848. get value(): NodeMaterialConnectionPoint;
  65849. /**
  65850. * Gets the cutoff input component
  65851. */
  65852. get cutoff(): NodeMaterialConnectionPoint;
  65853. protected _buildBlock(state: NodeMaterialBuildState): this;
  65854. }
  65855. }
  65856. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65857. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65858. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65859. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65860. /**
  65861. * Block used to test if the fragment shader is front facing
  65862. */
  65863. export class FrontFacingBlock extends NodeMaterialBlock {
  65864. /**
  65865. * Creates a new FrontFacingBlock
  65866. * @param name defines the block name
  65867. */
  65868. constructor(name: string);
  65869. /**
  65870. * Gets the current class name
  65871. * @returns the class name
  65872. */
  65873. getClassName(): string;
  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/Fragment/derivativeBlock" {
  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 get the derivative value on x and y of a given input
  65887. */
  65888. export class DerivativeBlock extends NodeMaterialBlock {
  65889. /**
  65890. * Create a new DerivativeBlock
  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 derivative output on x
  65905. */
  65906. get dx(): NodeMaterialConnectionPoint;
  65907. /**
  65908. * Gets the derivative output on y
  65909. */
  65910. get dy(): NodeMaterialConnectionPoint;
  65911. protected _buildBlock(state: NodeMaterialBuildState): this;
  65912. }
  65913. }
  65914. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  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. /**
  65919. * Block used to make gl_FragCoord available
  65920. */
  65921. export class FragCoordBlock extends NodeMaterialBlock {
  65922. /**
  65923. * Creates a new FragCoordBlock
  65924. * @param name defines the block name
  65925. */
  65926. constructor(name: string);
  65927. /**
  65928. * Gets the current class name
  65929. * @returns the class name
  65930. */
  65931. getClassName(): string;
  65932. /**
  65933. * Gets the xy component
  65934. */
  65935. get xy(): NodeMaterialConnectionPoint;
  65936. /**
  65937. * Gets the xyz component
  65938. */
  65939. get xyz(): NodeMaterialConnectionPoint;
  65940. /**
  65941. * Gets the xyzw component
  65942. */
  65943. get xyzw(): NodeMaterialConnectionPoint;
  65944. /**
  65945. * Gets the x component
  65946. */
  65947. get x(): NodeMaterialConnectionPoint;
  65948. /**
  65949. * Gets the y component
  65950. */
  65951. get y(): NodeMaterialConnectionPoint;
  65952. /**
  65953. * Gets the z component
  65954. */
  65955. get z(): NodeMaterialConnectionPoint;
  65956. /**
  65957. * Gets the w component
  65958. */
  65959. get output(): NodeMaterialConnectionPoint;
  65960. protected writeOutputs(state: NodeMaterialBuildState): string;
  65961. protected _buildBlock(state: NodeMaterialBuildState): this;
  65962. }
  65963. }
  65964. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65965. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65966. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65967. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65968. import { Effect } from "babylonjs/Materials/effect";
  65969. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65970. import { Mesh } from "babylonjs/Meshes/mesh";
  65971. /**
  65972. * Block used to get the screen sizes
  65973. */
  65974. export class ScreenSizeBlock extends NodeMaterialBlock {
  65975. private _varName;
  65976. private _scene;
  65977. /**
  65978. * Creates a new ScreenSizeBlock
  65979. * @param name defines the block name
  65980. */
  65981. constructor(name: string);
  65982. /**
  65983. * Gets the current class name
  65984. * @returns the class name
  65985. */
  65986. getClassName(): string;
  65987. /**
  65988. * Gets the xy component
  65989. */
  65990. get xy(): NodeMaterialConnectionPoint;
  65991. /**
  65992. * Gets the x component
  65993. */
  65994. get x(): NodeMaterialConnectionPoint;
  65995. /**
  65996. * Gets the y component
  65997. */
  65998. get y(): NodeMaterialConnectionPoint;
  65999. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66000. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  66001. protected _buildBlock(state: NodeMaterialBuildState): this;
  66002. }
  66003. }
  66004. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  66005. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  66006. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  66007. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  66008. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  66009. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  66010. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  66011. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  66012. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  66013. }
  66014. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  66015. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66016. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66017. import { Mesh } from "babylonjs/Meshes/mesh";
  66018. import { Effect } from "babylonjs/Materials/effect";
  66019. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66020. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66021. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66022. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  66023. /**
  66024. * Block used to add support for scene fog
  66025. */
  66026. export class FogBlock extends NodeMaterialBlock {
  66027. private _fogDistanceName;
  66028. private _fogParameters;
  66029. /**
  66030. * Create a new FogBlock
  66031. * @param name defines the block name
  66032. */
  66033. constructor(name: string);
  66034. /**
  66035. * Gets the current class name
  66036. * @returns the class name
  66037. */
  66038. getClassName(): string;
  66039. /**
  66040. * Gets the world position input component
  66041. */
  66042. get worldPosition(): NodeMaterialConnectionPoint;
  66043. /**
  66044. * Gets the view input component
  66045. */
  66046. get view(): NodeMaterialConnectionPoint;
  66047. /**
  66048. * Gets the color input component
  66049. */
  66050. get input(): NodeMaterialConnectionPoint;
  66051. /**
  66052. * Gets the fog color input component
  66053. */
  66054. get fogColor(): NodeMaterialConnectionPoint;
  66055. /**
  66056. * Gets the output component
  66057. */
  66058. get output(): NodeMaterialConnectionPoint;
  66059. autoConfigure(material: NodeMaterial): void;
  66060. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66061. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66062. protected _buildBlock(state: NodeMaterialBuildState): this;
  66063. }
  66064. }
  66065. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  66066. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66067. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66068. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66069. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66070. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66071. import { Effect } from "babylonjs/Materials/effect";
  66072. import { Mesh } from "babylonjs/Meshes/mesh";
  66073. import { Light } from "babylonjs/Lights/light";
  66074. import { Nullable } from "babylonjs/types";
  66075. import { Scene } from "babylonjs/scene";
  66076. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  66077. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  66078. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  66079. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66080. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  66081. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  66082. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  66083. /**
  66084. * Block used to add light in the fragment shader
  66085. */
  66086. export class LightBlock extends NodeMaterialBlock {
  66087. private _lightId;
  66088. /**
  66089. * Gets or sets the light associated with this block
  66090. */
  66091. light: Nullable<Light>;
  66092. /**
  66093. * Create a new LightBlock
  66094. * @param name defines the block name
  66095. */
  66096. constructor(name: string);
  66097. /**
  66098. * Gets the current class name
  66099. * @returns the class name
  66100. */
  66101. getClassName(): string;
  66102. /**
  66103. * Gets the world position input component
  66104. */
  66105. get worldPosition(): NodeMaterialConnectionPoint;
  66106. /**
  66107. * Gets the world normal input component
  66108. */
  66109. get worldNormal(): NodeMaterialConnectionPoint;
  66110. /**
  66111. * Gets the camera (or eye) position component
  66112. */
  66113. get cameraPosition(): NodeMaterialConnectionPoint;
  66114. /**
  66115. * Gets the glossiness component
  66116. */
  66117. get glossiness(): NodeMaterialConnectionPoint;
  66118. /**
  66119. * Gets the glossinness power component
  66120. */
  66121. get glossPower(): NodeMaterialConnectionPoint;
  66122. /**
  66123. * Gets the diffuse color component
  66124. */
  66125. get diffuseColor(): NodeMaterialConnectionPoint;
  66126. /**
  66127. * Gets the specular color component
  66128. */
  66129. get specularColor(): NodeMaterialConnectionPoint;
  66130. /**
  66131. * Gets the diffuse output component
  66132. */
  66133. get diffuseOutput(): NodeMaterialConnectionPoint;
  66134. /**
  66135. * Gets the specular output component
  66136. */
  66137. get specularOutput(): NodeMaterialConnectionPoint;
  66138. /**
  66139. * Gets the shadow output component
  66140. */
  66141. get shadow(): NodeMaterialConnectionPoint;
  66142. autoConfigure(material: NodeMaterial): void;
  66143. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66144. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  66145. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66146. private _injectVertexCode;
  66147. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66148. serialize(): any;
  66149. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66150. }
  66151. }
  66152. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  66153. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66154. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66155. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66156. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  66157. /**
  66158. * Block used to read a reflection texture from a sampler
  66159. */
  66160. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  66161. /**
  66162. * Create a new ReflectionTextureBlock
  66163. * @param name defines the block name
  66164. */
  66165. constructor(name: string);
  66166. /**
  66167. * Gets the current class name
  66168. * @returns the class name
  66169. */
  66170. getClassName(): string;
  66171. /**
  66172. * Gets the world position input component
  66173. */
  66174. get position(): NodeMaterialConnectionPoint;
  66175. /**
  66176. * Gets the world position input component
  66177. */
  66178. get worldPosition(): NodeMaterialConnectionPoint;
  66179. /**
  66180. * Gets the world normal input component
  66181. */
  66182. get worldNormal(): NodeMaterialConnectionPoint;
  66183. /**
  66184. * Gets the world input component
  66185. */
  66186. get world(): NodeMaterialConnectionPoint;
  66187. /**
  66188. * Gets the camera (or eye) position component
  66189. */
  66190. get cameraPosition(): NodeMaterialConnectionPoint;
  66191. /**
  66192. * Gets the view input component
  66193. */
  66194. get view(): NodeMaterialConnectionPoint;
  66195. /**
  66196. * Gets the rgb output component
  66197. */
  66198. get rgb(): NodeMaterialConnectionPoint;
  66199. /**
  66200. * Gets the rgba output component
  66201. */
  66202. get rgba(): NodeMaterialConnectionPoint;
  66203. /**
  66204. * Gets the r output component
  66205. */
  66206. get r(): NodeMaterialConnectionPoint;
  66207. /**
  66208. * Gets the g output component
  66209. */
  66210. get g(): NodeMaterialConnectionPoint;
  66211. /**
  66212. * Gets the b output component
  66213. */
  66214. get b(): NodeMaterialConnectionPoint;
  66215. /**
  66216. * Gets the a output component
  66217. */
  66218. get a(): NodeMaterialConnectionPoint;
  66219. autoConfigure(material: NodeMaterial): void;
  66220. protected _buildBlock(state: NodeMaterialBuildState): this;
  66221. }
  66222. }
  66223. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  66224. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  66225. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  66226. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  66227. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  66228. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  66229. }
  66230. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  66231. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  66232. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  66233. }
  66234. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  66235. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66236. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66237. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66238. /**
  66239. * Block used to add 2 vectors
  66240. */
  66241. export class AddBlock extends NodeMaterialBlock {
  66242. /**
  66243. * Creates a new AddBlock
  66244. * @param name defines the block name
  66245. */
  66246. constructor(name: string);
  66247. /**
  66248. * Gets the current class name
  66249. * @returns the class name
  66250. */
  66251. getClassName(): string;
  66252. /**
  66253. * Gets the left operand input component
  66254. */
  66255. get left(): NodeMaterialConnectionPoint;
  66256. /**
  66257. * Gets the right operand input component
  66258. */
  66259. get right(): NodeMaterialConnectionPoint;
  66260. /**
  66261. * Gets the output component
  66262. */
  66263. get output(): NodeMaterialConnectionPoint;
  66264. protected _buildBlock(state: NodeMaterialBuildState): this;
  66265. }
  66266. }
  66267. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  66268. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66269. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66270. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66271. /**
  66272. * Block used to scale a vector by a float
  66273. */
  66274. export class ScaleBlock extends NodeMaterialBlock {
  66275. /**
  66276. * Creates a new ScaleBlock
  66277. * @param name defines the block name
  66278. */
  66279. constructor(name: string);
  66280. /**
  66281. * Gets the current class name
  66282. * @returns the class name
  66283. */
  66284. getClassName(): string;
  66285. /**
  66286. * Gets the input component
  66287. */
  66288. get input(): NodeMaterialConnectionPoint;
  66289. /**
  66290. * Gets the factor input component
  66291. */
  66292. get factor(): NodeMaterialConnectionPoint;
  66293. /**
  66294. * Gets the output component
  66295. */
  66296. get output(): NodeMaterialConnectionPoint;
  66297. protected _buildBlock(state: NodeMaterialBuildState): this;
  66298. }
  66299. }
  66300. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  66301. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66302. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66303. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66304. import { Scene } from "babylonjs/scene";
  66305. /**
  66306. * Block used to clamp a float
  66307. */
  66308. export class ClampBlock extends NodeMaterialBlock {
  66309. /** Gets or sets the minimum range */
  66310. minimum: number;
  66311. /** Gets or sets the maximum range */
  66312. maximum: number;
  66313. /**
  66314. * Creates a new ClampBlock
  66315. * @param name defines the block name
  66316. */
  66317. constructor(name: string);
  66318. /**
  66319. * Gets the current class name
  66320. * @returns the class name
  66321. */
  66322. getClassName(): string;
  66323. /**
  66324. * Gets the value input component
  66325. */
  66326. get value(): NodeMaterialConnectionPoint;
  66327. /**
  66328. * Gets the output component
  66329. */
  66330. get output(): NodeMaterialConnectionPoint;
  66331. protected _buildBlock(state: NodeMaterialBuildState): this;
  66332. protected _dumpPropertiesCode(): string;
  66333. serialize(): any;
  66334. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66335. }
  66336. }
  66337. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66338. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66339. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66340. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66341. /**
  66342. * Block used to apply a cross product between 2 vectors
  66343. */
  66344. export class CrossBlock extends NodeMaterialBlock {
  66345. /**
  66346. * Creates a new CrossBlock
  66347. * @param name defines the block name
  66348. */
  66349. constructor(name: string);
  66350. /**
  66351. * Gets the current class name
  66352. * @returns the class name
  66353. */
  66354. getClassName(): string;
  66355. /**
  66356. * Gets the left operand input component
  66357. */
  66358. get left(): NodeMaterialConnectionPoint;
  66359. /**
  66360. * Gets the right operand input component
  66361. */
  66362. get right(): NodeMaterialConnectionPoint;
  66363. /**
  66364. * Gets the output component
  66365. */
  66366. get output(): NodeMaterialConnectionPoint;
  66367. protected _buildBlock(state: NodeMaterialBuildState): this;
  66368. }
  66369. }
  66370. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66371. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66372. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66373. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66374. /**
  66375. * Block used to apply a dot product between 2 vectors
  66376. */
  66377. export class DotBlock extends NodeMaterialBlock {
  66378. /**
  66379. * Creates a new DotBlock
  66380. * @param name defines the block name
  66381. */
  66382. constructor(name: string);
  66383. /**
  66384. * Gets the current class name
  66385. * @returns the class name
  66386. */
  66387. getClassName(): string;
  66388. /**
  66389. * Gets the left operand input component
  66390. */
  66391. get left(): NodeMaterialConnectionPoint;
  66392. /**
  66393. * Gets the right operand input component
  66394. */
  66395. get right(): NodeMaterialConnectionPoint;
  66396. /**
  66397. * Gets the output component
  66398. */
  66399. get output(): NodeMaterialConnectionPoint;
  66400. protected _buildBlock(state: NodeMaterialBuildState): this;
  66401. }
  66402. }
  66403. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66404. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66405. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66407. /**
  66408. * Block used to normalize a vector
  66409. */
  66410. export class NormalizeBlock extends NodeMaterialBlock {
  66411. /**
  66412. * Creates a new NormalizeBlock
  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 input component
  66423. */
  66424. get input(): NodeMaterialConnectionPoint;
  66425. /**
  66426. * Gets the output component
  66427. */
  66428. get output(): NodeMaterialConnectionPoint;
  66429. protected _buildBlock(state: NodeMaterialBuildState): this;
  66430. }
  66431. }
  66432. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66433. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66434. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66435. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66436. /**
  66437. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66438. */
  66439. export class ColorMergerBlock extends NodeMaterialBlock {
  66440. /**
  66441. * Create a new ColorMergerBlock
  66442. * @param name defines the block name
  66443. */
  66444. constructor(name: string);
  66445. /**
  66446. * Gets the current class name
  66447. * @returns the class name
  66448. */
  66449. getClassName(): string;
  66450. /**
  66451. * Gets the rgb component (input)
  66452. */
  66453. get rgbIn(): NodeMaterialConnectionPoint;
  66454. /**
  66455. * Gets the r component (input)
  66456. */
  66457. get r(): NodeMaterialConnectionPoint;
  66458. /**
  66459. * Gets the g component (input)
  66460. */
  66461. get g(): NodeMaterialConnectionPoint;
  66462. /**
  66463. * Gets the b component (input)
  66464. */
  66465. get b(): NodeMaterialConnectionPoint;
  66466. /**
  66467. * Gets the a component (input)
  66468. */
  66469. get a(): NodeMaterialConnectionPoint;
  66470. /**
  66471. * Gets the rgba component (output)
  66472. */
  66473. get rgba(): NodeMaterialConnectionPoint;
  66474. /**
  66475. * Gets the rgb component (output)
  66476. */
  66477. get rgbOut(): NodeMaterialConnectionPoint;
  66478. /**
  66479. * Gets the rgb component (output)
  66480. * @deprecated Please use rgbOut instead.
  66481. */
  66482. get rgb(): NodeMaterialConnectionPoint;
  66483. protected _buildBlock(state: NodeMaterialBuildState): this;
  66484. }
  66485. }
  66486. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66487. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66488. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66489. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66490. /**
  66491. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66492. */
  66493. export class VectorSplitterBlock extends NodeMaterialBlock {
  66494. /**
  66495. * Create a new VectorSplitterBlock
  66496. * @param name defines the block name
  66497. */
  66498. constructor(name: string);
  66499. /**
  66500. * Gets the current class name
  66501. * @returns the class name
  66502. */
  66503. getClassName(): string;
  66504. /**
  66505. * Gets the xyzw component (input)
  66506. */
  66507. get xyzw(): NodeMaterialConnectionPoint;
  66508. /**
  66509. * Gets the xyz component (input)
  66510. */
  66511. get xyzIn(): NodeMaterialConnectionPoint;
  66512. /**
  66513. * Gets the xy component (input)
  66514. */
  66515. get xyIn(): NodeMaterialConnectionPoint;
  66516. /**
  66517. * Gets the xyz component (output)
  66518. */
  66519. get xyzOut(): NodeMaterialConnectionPoint;
  66520. /**
  66521. * Gets the xy component (output)
  66522. */
  66523. get xyOut(): NodeMaterialConnectionPoint;
  66524. /**
  66525. * Gets the x component (output)
  66526. */
  66527. get x(): NodeMaterialConnectionPoint;
  66528. /**
  66529. * Gets the y component (output)
  66530. */
  66531. get y(): NodeMaterialConnectionPoint;
  66532. /**
  66533. * Gets the z component (output)
  66534. */
  66535. get z(): NodeMaterialConnectionPoint;
  66536. /**
  66537. * Gets the w component (output)
  66538. */
  66539. get w(): NodeMaterialConnectionPoint;
  66540. protected _inputRename(name: string): string;
  66541. protected _outputRename(name: string): string;
  66542. protected _buildBlock(state: NodeMaterialBuildState): this;
  66543. }
  66544. }
  66545. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66546. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66547. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66548. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66549. /**
  66550. * Block used to lerp between 2 values
  66551. */
  66552. export class LerpBlock extends NodeMaterialBlock {
  66553. /**
  66554. * Creates a new LerpBlock
  66555. * @param name defines the block name
  66556. */
  66557. constructor(name: string);
  66558. /**
  66559. * Gets the current class name
  66560. * @returns the class name
  66561. */
  66562. getClassName(): string;
  66563. /**
  66564. * Gets the left operand input component
  66565. */
  66566. get left(): NodeMaterialConnectionPoint;
  66567. /**
  66568. * Gets the right operand input component
  66569. */
  66570. get right(): NodeMaterialConnectionPoint;
  66571. /**
  66572. * Gets the gradient operand input component
  66573. */
  66574. get gradient(): NodeMaterialConnectionPoint;
  66575. /**
  66576. * Gets the output component
  66577. */
  66578. get output(): NodeMaterialConnectionPoint;
  66579. protected _buildBlock(state: NodeMaterialBuildState): this;
  66580. }
  66581. }
  66582. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66583. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66584. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66585. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66586. /**
  66587. * Block used to divide 2 vectors
  66588. */
  66589. export class DivideBlock extends NodeMaterialBlock {
  66590. /**
  66591. * Creates a new DivideBlock
  66592. * @param name defines the block name
  66593. */
  66594. constructor(name: string);
  66595. /**
  66596. * Gets the current class name
  66597. * @returns the class name
  66598. */
  66599. getClassName(): string;
  66600. /**
  66601. * Gets the left operand input component
  66602. */
  66603. get left(): NodeMaterialConnectionPoint;
  66604. /**
  66605. * Gets the right operand input component
  66606. */
  66607. get right(): NodeMaterialConnectionPoint;
  66608. /**
  66609. * Gets the output component
  66610. */
  66611. get output(): NodeMaterialConnectionPoint;
  66612. protected _buildBlock(state: NodeMaterialBuildState): this;
  66613. }
  66614. }
  66615. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66616. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66617. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66618. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66619. /**
  66620. * Block used to subtract 2 vectors
  66621. */
  66622. export class SubtractBlock extends NodeMaterialBlock {
  66623. /**
  66624. * Creates a new SubtractBlock
  66625. * @param name defines the block name
  66626. */
  66627. constructor(name: string);
  66628. /**
  66629. * Gets the current class name
  66630. * @returns the class name
  66631. */
  66632. getClassName(): string;
  66633. /**
  66634. * Gets the left operand input component
  66635. */
  66636. get left(): NodeMaterialConnectionPoint;
  66637. /**
  66638. * Gets the right operand input component
  66639. */
  66640. get right(): NodeMaterialConnectionPoint;
  66641. /**
  66642. * Gets the output component
  66643. */
  66644. get output(): NodeMaterialConnectionPoint;
  66645. protected _buildBlock(state: NodeMaterialBuildState): this;
  66646. }
  66647. }
  66648. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66649. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66650. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66651. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66652. /**
  66653. * Block used to step a value
  66654. */
  66655. export class StepBlock extends NodeMaterialBlock {
  66656. /**
  66657. * Creates a new StepBlock
  66658. * @param name defines the block name
  66659. */
  66660. constructor(name: string);
  66661. /**
  66662. * Gets the current class name
  66663. * @returns the class name
  66664. */
  66665. getClassName(): string;
  66666. /**
  66667. * Gets the value operand input component
  66668. */
  66669. get value(): NodeMaterialConnectionPoint;
  66670. /**
  66671. * Gets the edge operand input component
  66672. */
  66673. get edge(): NodeMaterialConnectionPoint;
  66674. /**
  66675. * Gets the output component
  66676. */
  66677. get output(): NodeMaterialConnectionPoint;
  66678. protected _buildBlock(state: NodeMaterialBuildState): this;
  66679. }
  66680. }
  66681. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66682. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66683. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66684. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66685. /**
  66686. * Block used to get the opposite (1 - x) of a value
  66687. */
  66688. export class OneMinusBlock extends NodeMaterialBlock {
  66689. /**
  66690. * Creates a new OneMinusBlock
  66691. * @param name defines the block name
  66692. */
  66693. constructor(name: string);
  66694. /**
  66695. * Gets the current class name
  66696. * @returns the class name
  66697. */
  66698. getClassName(): string;
  66699. /**
  66700. * Gets the input component
  66701. */
  66702. get input(): NodeMaterialConnectionPoint;
  66703. /**
  66704. * Gets the output component
  66705. */
  66706. get output(): NodeMaterialConnectionPoint;
  66707. protected _buildBlock(state: NodeMaterialBuildState): this;
  66708. }
  66709. }
  66710. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66714. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66715. /**
  66716. * Block used to get the view direction
  66717. */
  66718. export class ViewDirectionBlock extends NodeMaterialBlock {
  66719. /**
  66720. * Creates a new ViewDirectionBlock
  66721. * @param name defines the block name
  66722. */
  66723. constructor(name: string);
  66724. /**
  66725. * Gets the current class name
  66726. * @returns the class name
  66727. */
  66728. getClassName(): string;
  66729. /**
  66730. * Gets the world position component
  66731. */
  66732. get worldPosition(): NodeMaterialConnectionPoint;
  66733. /**
  66734. * Gets the camera position component
  66735. */
  66736. get cameraPosition(): NodeMaterialConnectionPoint;
  66737. /**
  66738. * Gets the output component
  66739. */
  66740. get output(): NodeMaterialConnectionPoint;
  66741. autoConfigure(material: NodeMaterial): void;
  66742. protected _buildBlock(state: NodeMaterialBuildState): this;
  66743. }
  66744. }
  66745. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66746. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66747. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66748. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66749. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66750. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66751. /**
  66752. * Block used to compute fresnel value
  66753. */
  66754. export class FresnelBlock extends NodeMaterialBlock {
  66755. /**
  66756. * Create a new FresnelBlock
  66757. * @param name defines the block name
  66758. */
  66759. constructor(name: string);
  66760. /**
  66761. * Gets the current class name
  66762. * @returns the class name
  66763. */
  66764. getClassName(): string;
  66765. /**
  66766. * Gets the world normal input component
  66767. */
  66768. get worldNormal(): NodeMaterialConnectionPoint;
  66769. /**
  66770. * Gets the view direction input component
  66771. */
  66772. get viewDirection(): NodeMaterialConnectionPoint;
  66773. /**
  66774. * Gets the bias input component
  66775. */
  66776. get bias(): NodeMaterialConnectionPoint;
  66777. /**
  66778. * Gets the camera (or eye) position component
  66779. */
  66780. get power(): NodeMaterialConnectionPoint;
  66781. /**
  66782. * Gets the fresnel output component
  66783. */
  66784. get fresnel(): NodeMaterialConnectionPoint;
  66785. autoConfigure(material: NodeMaterial): void;
  66786. protected _buildBlock(state: NodeMaterialBuildState): this;
  66787. }
  66788. }
  66789. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66790. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66791. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66792. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66793. /**
  66794. * Block used to get the max of 2 values
  66795. */
  66796. export class MaxBlock extends NodeMaterialBlock {
  66797. /**
  66798. * Creates a new MaxBlock
  66799. * @param name defines the block name
  66800. */
  66801. constructor(name: string);
  66802. /**
  66803. * Gets the current class name
  66804. * @returns the class name
  66805. */
  66806. getClassName(): string;
  66807. /**
  66808. * Gets the left operand input component
  66809. */
  66810. get left(): NodeMaterialConnectionPoint;
  66811. /**
  66812. * Gets the right operand input component
  66813. */
  66814. get right(): NodeMaterialConnectionPoint;
  66815. /**
  66816. * Gets the output component
  66817. */
  66818. get output(): NodeMaterialConnectionPoint;
  66819. protected _buildBlock(state: NodeMaterialBuildState): this;
  66820. }
  66821. }
  66822. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66823. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66824. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66825. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66826. /**
  66827. * Block used to get the min of 2 values
  66828. */
  66829. export class MinBlock extends NodeMaterialBlock {
  66830. /**
  66831. * Creates a new MinBlock
  66832. * @param name defines the block name
  66833. */
  66834. constructor(name: string);
  66835. /**
  66836. * Gets the current class name
  66837. * @returns the class name
  66838. */
  66839. getClassName(): string;
  66840. /**
  66841. * Gets the left operand input component
  66842. */
  66843. get left(): NodeMaterialConnectionPoint;
  66844. /**
  66845. * Gets the right operand input component
  66846. */
  66847. get right(): NodeMaterialConnectionPoint;
  66848. /**
  66849. * Gets the output component
  66850. */
  66851. get output(): NodeMaterialConnectionPoint;
  66852. protected _buildBlock(state: NodeMaterialBuildState): this;
  66853. }
  66854. }
  66855. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66856. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66857. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66858. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66859. /**
  66860. * Block used to get the distance between 2 values
  66861. */
  66862. export class DistanceBlock extends NodeMaterialBlock {
  66863. /**
  66864. * Creates a new DistanceBlock
  66865. * @param name defines the block name
  66866. */
  66867. constructor(name: string);
  66868. /**
  66869. * Gets the current class name
  66870. * @returns the class name
  66871. */
  66872. getClassName(): string;
  66873. /**
  66874. * Gets the left operand input component
  66875. */
  66876. get left(): NodeMaterialConnectionPoint;
  66877. /**
  66878. * Gets the right operand input component
  66879. */
  66880. get right(): NodeMaterialConnectionPoint;
  66881. /**
  66882. * Gets the output component
  66883. */
  66884. get output(): NodeMaterialConnectionPoint;
  66885. protected _buildBlock(state: NodeMaterialBuildState): this;
  66886. }
  66887. }
  66888. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66889. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66890. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66891. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66892. /**
  66893. * Block used to get the length of a vector
  66894. */
  66895. export class LengthBlock extends NodeMaterialBlock {
  66896. /**
  66897. * Creates a new LengthBlock
  66898. * @param name defines the block name
  66899. */
  66900. constructor(name: string);
  66901. /**
  66902. * Gets the current class name
  66903. * @returns the class name
  66904. */
  66905. getClassName(): string;
  66906. /**
  66907. * Gets the value input component
  66908. */
  66909. get value(): NodeMaterialConnectionPoint;
  66910. /**
  66911. * Gets the output component
  66912. */
  66913. get output(): NodeMaterialConnectionPoint;
  66914. protected _buildBlock(state: NodeMaterialBuildState): this;
  66915. }
  66916. }
  66917. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66918. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66919. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66920. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66921. /**
  66922. * Block used to get negative version of a value (i.e. x * -1)
  66923. */
  66924. export class NegateBlock extends NodeMaterialBlock {
  66925. /**
  66926. * Creates a new NegateBlock
  66927. * @param name defines the block name
  66928. */
  66929. constructor(name: string);
  66930. /**
  66931. * Gets the current class name
  66932. * @returns the class name
  66933. */
  66934. getClassName(): string;
  66935. /**
  66936. * Gets the value input component
  66937. */
  66938. get value(): NodeMaterialConnectionPoint;
  66939. /**
  66940. * Gets the output component
  66941. */
  66942. get output(): NodeMaterialConnectionPoint;
  66943. protected _buildBlock(state: NodeMaterialBuildState): this;
  66944. }
  66945. }
  66946. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66947. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66948. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66949. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66950. /**
  66951. * Block used to get the value of the first parameter raised to the power of the second
  66952. */
  66953. export class PowBlock extends NodeMaterialBlock {
  66954. /**
  66955. * Creates a new PowBlock
  66956. * @param name defines the block name
  66957. */
  66958. constructor(name: string);
  66959. /**
  66960. * Gets the current class name
  66961. * @returns the class name
  66962. */
  66963. getClassName(): string;
  66964. /**
  66965. * Gets the value operand input component
  66966. */
  66967. get value(): NodeMaterialConnectionPoint;
  66968. /**
  66969. * Gets the power operand input component
  66970. */
  66971. get power(): NodeMaterialConnectionPoint;
  66972. /**
  66973. * Gets the output component
  66974. */
  66975. get output(): NodeMaterialConnectionPoint;
  66976. protected _buildBlock(state: NodeMaterialBuildState): this;
  66977. }
  66978. }
  66979. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66980. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66981. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66982. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66983. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66984. /**
  66985. * Block used to get a random number
  66986. */
  66987. export class RandomNumberBlock extends NodeMaterialBlock {
  66988. /**
  66989. * Creates a new RandomNumberBlock
  66990. * @param name defines the block name
  66991. */
  66992. constructor(name: string);
  66993. /**
  66994. * Gets the current class name
  66995. * @returns the class name
  66996. */
  66997. getClassName(): string;
  66998. /**
  66999. * Gets the seed input component
  67000. */
  67001. get seed(): NodeMaterialConnectionPoint;
  67002. /**
  67003. * Gets the output component
  67004. */
  67005. get output(): NodeMaterialConnectionPoint;
  67006. protected _buildBlock(state: NodeMaterialBuildState): this;
  67007. }
  67008. }
  67009. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  67010. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67011. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67012. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67013. /**
  67014. * Block used to compute arc tangent of 2 values
  67015. */
  67016. export class ArcTan2Block extends NodeMaterialBlock {
  67017. /**
  67018. * Creates a new ArcTan2Block
  67019. * @param name defines the block name
  67020. */
  67021. constructor(name: string);
  67022. /**
  67023. * Gets the current class name
  67024. * @returns the class name
  67025. */
  67026. getClassName(): string;
  67027. /**
  67028. * Gets the x operand input component
  67029. */
  67030. get x(): NodeMaterialConnectionPoint;
  67031. /**
  67032. * Gets the y operand input component
  67033. */
  67034. get y(): NodeMaterialConnectionPoint;
  67035. /**
  67036. * Gets the output component
  67037. */
  67038. get output(): NodeMaterialConnectionPoint;
  67039. protected _buildBlock(state: NodeMaterialBuildState): this;
  67040. }
  67041. }
  67042. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  67043. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67044. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67045. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67046. /**
  67047. * Block used to smooth step a value
  67048. */
  67049. export class SmoothStepBlock extends NodeMaterialBlock {
  67050. /**
  67051. * Creates a new SmoothStepBlock
  67052. * @param name defines the block name
  67053. */
  67054. constructor(name: string);
  67055. /**
  67056. * Gets the current class name
  67057. * @returns the class name
  67058. */
  67059. getClassName(): string;
  67060. /**
  67061. * Gets the value operand input component
  67062. */
  67063. get value(): NodeMaterialConnectionPoint;
  67064. /**
  67065. * Gets the first edge operand input component
  67066. */
  67067. get edge0(): NodeMaterialConnectionPoint;
  67068. /**
  67069. * Gets the second edge operand input component
  67070. */
  67071. get edge1(): NodeMaterialConnectionPoint;
  67072. /**
  67073. * Gets the output component
  67074. */
  67075. get output(): NodeMaterialConnectionPoint;
  67076. protected _buildBlock(state: NodeMaterialBuildState): this;
  67077. }
  67078. }
  67079. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  67080. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67081. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67082. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67083. /**
  67084. * Block used to get the reciprocal (1 / x) of a value
  67085. */
  67086. export class ReciprocalBlock extends NodeMaterialBlock {
  67087. /**
  67088. * Creates a new ReciprocalBlock
  67089. * @param name defines the block name
  67090. */
  67091. constructor(name: string);
  67092. /**
  67093. * Gets the current class name
  67094. * @returns the class name
  67095. */
  67096. getClassName(): string;
  67097. /**
  67098. * Gets the input component
  67099. */
  67100. get input(): NodeMaterialConnectionPoint;
  67101. /**
  67102. * Gets the output component
  67103. */
  67104. get output(): NodeMaterialConnectionPoint;
  67105. protected _buildBlock(state: NodeMaterialBuildState): this;
  67106. }
  67107. }
  67108. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  67109. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67110. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67111. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67112. /**
  67113. * Block used to replace a color by another one
  67114. */
  67115. export class ReplaceColorBlock extends NodeMaterialBlock {
  67116. /**
  67117. * Creates a new ReplaceColorBlock
  67118. * @param name defines the block name
  67119. */
  67120. constructor(name: string);
  67121. /**
  67122. * Gets the current class name
  67123. * @returns the class name
  67124. */
  67125. getClassName(): string;
  67126. /**
  67127. * Gets the value input component
  67128. */
  67129. get value(): NodeMaterialConnectionPoint;
  67130. /**
  67131. * Gets the reference input component
  67132. */
  67133. get reference(): NodeMaterialConnectionPoint;
  67134. /**
  67135. * Gets the distance input component
  67136. */
  67137. get distance(): NodeMaterialConnectionPoint;
  67138. /**
  67139. * Gets the replacement input component
  67140. */
  67141. get replacement(): NodeMaterialConnectionPoint;
  67142. /**
  67143. * Gets the output component
  67144. */
  67145. get output(): NodeMaterialConnectionPoint;
  67146. protected _buildBlock(state: NodeMaterialBuildState): this;
  67147. }
  67148. }
  67149. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  67150. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67151. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67152. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67153. /**
  67154. * Block used to posterize a value
  67155. * @see https://en.wikipedia.org/wiki/Posterization
  67156. */
  67157. export class PosterizeBlock extends NodeMaterialBlock {
  67158. /**
  67159. * Creates a new PosterizeBlock
  67160. * @param name defines the block name
  67161. */
  67162. constructor(name: string);
  67163. /**
  67164. * Gets the current class name
  67165. * @returns the class name
  67166. */
  67167. getClassName(): string;
  67168. /**
  67169. * Gets the value input component
  67170. */
  67171. get value(): NodeMaterialConnectionPoint;
  67172. /**
  67173. * Gets the steps input component
  67174. */
  67175. get steps(): NodeMaterialConnectionPoint;
  67176. /**
  67177. * Gets the output component
  67178. */
  67179. get output(): NodeMaterialConnectionPoint;
  67180. protected _buildBlock(state: NodeMaterialBuildState): this;
  67181. }
  67182. }
  67183. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  67184. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67185. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67186. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67187. import { Scene } from "babylonjs/scene";
  67188. /**
  67189. * Operations supported by the Wave block
  67190. */
  67191. export enum WaveBlockKind {
  67192. /** SawTooth */
  67193. SawTooth = 0,
  67194. /** Square */
  67195. Square = 1,
  67196. /** Triangle */
  67197. Triangle = 2
  67198. }
  67199. /**
  67200. * Block used to apply wave operation to floats
  67201. */
  67202. export class WaveBlock extends NodeMaterialBlock {
  67203. /**
  67204. * Gets or sets the kibnd of wave to be applied by the block
  67205. */
  67206. kind: WaveBlockKind;
  67207. /**
  67208. * Creates a new WaveBlock
  67209. * @param name defines the block name
  67210. */
  67211. constructor(name: string);
  67212. /**
  67213. * Gets the current class name
  67214. * @returns the class name
  67215. */
  67216. getClassName(): string;
  67217. /**
  67218. * Gets the input component
  67219. */
  67220. get input(): NodeMaterialConnectionPoint;
  67221. /**
  67222. * Gets the output component
  67223. */
  67224. get output(): NodeMaterialConnectionPoint;
  67225. protected _buildBlock(state: NodeMaterialBuildState): this;
  67226. serialize(): any;
  67227. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67228. }
  67229. }
  67230. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  67231. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67232. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67233. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67234. import { Color3 } from "babylonjs/Maths/math.color";
  67235. import { Scene } from "babylonjs/scene";
  67236. import { Observable } from "babylonjs/Misc/observable";
  67237. /**
  67238. * Class used to store a color step for the GradientBlock
  67239. */
  67240. export class GradientBlockColorStep {
  67241. private _step;
  67242. /**
  67243. * Gets value indicating which step this color is associated with (between 0 and 1)
  67244. */
  67245. get step(): number;
  67246. /**
  67247. * Sets a value indicating which step this color is associated with (between 0 and 1)
  67248. */
  67249. set step(val: number);
  67250. private _color;
  67251. /**
  67252. * Gets the color associated with this step
  67253. */
  67254. get color(): Color3;
  67255. /**
  67256. * Sets the color associated with this step
  67257. */
  67258. set color(val: Color3);
  67259. /**
  67260. * Creates a new GradientBlockColorStep
  67261. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67262. * @param color defines the color associated with this step
  67263. */
  67264. constructor(step: number, color: Color3);
  67265. }
  67266. /**
  67267. * Block used to return a color from a gradient based on an input value between 0 and 1
  67268. */
  67269. export class GradientBlock extends NodeMaterialBlock {
  67270. /**
  67271. * Gets or sets the list of color steps
  67272. */
  67273. colorSteps: GradientBlockColorStep[];
  67274. /** Gets an observable raised when the value is changed */
  67275. onValueChangedObservable: Observable<GradientBlock>;
  67276. /** calls observable when the value is changed*/
  67277. colorStepsUpdated(): void;
  67278. /**
  67279. * Creates a new GradientBlock
  67280. * @param name defines the block name
  67281. */
  67282. constructor(name: string);
  67283. /**
  67284. * Gets the current class name
  67285. * @returns the class name
  67286. */
  67287. getClassName(): string;
  67288. /**
  67289. * Gets the gradient input component
  67290. */
  67291. get gradient(): NodeMaterialConnectionPoint;
  67292. /**
  67293. * Gets the output component
  67294. */
  67295. get output(): NodeMaterialConnectionPoint;
  67296. private _writeColorConstant;
  67297. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67298. serialize(): any;
  67299. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67300. protected _dumpPropertiesCode(): string;
  67301. }
  67302. }
  67303. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67304. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67305. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67306. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67307. /**
  67308. * Block used to normalize lerp between 2 values
  67309. */
  67310. export class NLerpBlock extends NodeMaterialBlock {
  67311. /**
  67312. * Creates a new NLerpBlock
  67313. * @param name defines the block name
  67314. */
  67315. constructor(name: string);
  67316. /**
  67317. * Gets the current class name
  67318. * @returns the class name
  67319. */
  67320. getClassName(): string;
  67321. /**
  67322. * Gets the left operand input component
  67323. */
  67324. get left(): NodeMaterialConnectionPoint;
  67325. /**
  67326. * Gets the right operand input component
  67327. */
  67328. get right(): NodeMaterialConnectionPoint;
  67329. /**
  67330. * Gets the gradient operand input component
  67331. */
  67332. get gradient(): NodeMaterialConnectionPoint;
  67333. /**
  67334. * Gets the output component
  67335. */
  67336. get output(): NodeMaterialConnectionPoint;
  67337. protected _buildBlock(state: NodeMaterialBuildState): this;
  67338. }
  67339. }
  67340. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67341. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67342. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67343. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67344. import { Scene } from "babylonjs/scene";
  67345. /**
  67346. * block used to Generate a Worley Noise 3D Noise Pattern
  67347. */
  67348. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67349. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67350. manhattanDistance: boolean;
  67351. /**
  67352. * Creates a new WorleyNoise3DBlock
  67353. * @param name defines the block name
  67354. */
  67355. constructor(name: string);
  67356. /**
  67357. * Gets the current class name
  67358. * @returns the class name
  67359. */
  67360. getClassName(): string;
  67361. /**
  67362. * Gets the seed input component
  67363. */
  67364. get seed(): NodeMaterialConnectionPoint;
  67365. /**
  67366. * Gets the jitter input component
  67367. */
  67368. get jitter(): NodeMaterialConnectionPoint;
  67369. /**
  67370. * Gets the output component
  67371. */
  67372. get output(): NodeMaterialConnectionPoint;
  67373. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67374. /**
  67375. * Exposes the properties to the UI?
  67376. */
  67377. protected _dumpPropertiesCode(): string;
  67378. /**
  67379. * Exposes the properties to the Seralize?
  67380. */
  67381. serialize(): any;
  67382. /**
  67383. * Exposes the properties to the deseralize?
  67384. */
  67385. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67386. }
  67387. }
  67388. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67389. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67390. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67391. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67392. /**
  67393. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67394. */
  67395. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67396. /**
  67397. * Creates a new SimplexPerlin3DBlock
  67398. * @param name defines the block name
  67399. */
  67400. constructor(name: string);
  67401. /**
  67402. * Gets the current class name
  67403. * @returns the class name
  67404. */
  67405. getClassName(): string;
  67406. /**
  67407. * Gets the seed operand input component
  67408. */
  67409. get seed(): NodeMaterialConnectionPoint;
  67410. /**
  67411. * Gets the output component
  67412. */
  67413. get output(): NodeMaterialConnectionPoint;
  67414. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67415. }
  67416. }
  67417. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67418. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67419. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67420. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67421. /**
  67422. * Block used to blend normals
  67423. */
  67424. export class NormalBlendBlock extends NodeMaterialBlock {
  67425. /**
  67426. * Creates a new NormalBlendBlock
  67427. * @param name defines the block name
  67428. */
  67429. constructor(name: string);
  67430. /**
  67431. * Gets the current class name
  67432. * @returns the class name
  67433. */
  67434. getClassName(): string;
  67435. /**
  67436. * Gets the first input component
  67437. */
  67438. get normalMap0(): NodeMaterialConnectionPoint;
  67439. /**
  67440. * Gets the second input component
  67441. */
  67442. get normalMap1(): NodeMaterialConnectionPoint;
  67443. /**
  67444. * Gets the output component
  67445. */
  67446. get output(): NodeMaterialConnectionPoint;
  67447. protected _buildBlock(state: NodeMaterialBuildState): this;
  67448. }
  67449. }
  67450. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67451. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67452. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67453. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67454. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67455. /**
  67456. * Block used to rotate a 2d vector by a given angle
  67457. */
  67458. export class Rotate2dBlock extends NodeMaterialBlock {
  67459. /**
  67460. * Creates a new Rotate2dBlock
  67461. * @param name defines the block name
  67462. */
  67463. constructor(name: string);
  67464. /**
  67465. * Gets the current class name
  67466. * @returns the class name
  67467. */
  67468. getClassName(): string;
  67469. /**
  67470. * Gets the input vector
  67471. */
  67472. get input(): NodeMaterialConnectionPoint;
  67473. /**
  67474. * Gets the input angle
  67475. */
  67476. get angle(): NodeMaterialConnectionPoint;
  67477. /**
  67478. * Gets the output component
  67479. */
  67480. get output(): NodeMaterialConnectionPoint;
  67481. autoConfigure(material: NodeMaterial): void;
  67482. protected _buildBlock(state: NodeMaterialBuildState): this;
  67483. }
  67484. }
  67485. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67486. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67487. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67488. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67489. /**
  67490. * Block used to get the reflected vector from a direction and a normal
  67491. */
  67492. export class ReflectBlock extends NodeMaterialBlock {
  67493. /**
  67494. * Creates a new ReflectBlock
  67495. * @param name defines the block name
  67496. */
  67497. constructor(name: string);
  67498. /**
  67499. * Gets the current class name
  67500. * @returns the class name
  67501. */
  67502. getClassName(): string;
  67503. /**
  67504. * Gets the incident component
  67505. */
  67506. get incident(): NodeMaterialConnectionPoint;
  67507. /**
  67508. * Gets the normal component
  67509. */
  67510. get normal(): NodeMaterialConnectionPoint;
  67511. /**
  67512. * Gets the output component
  67513. */
  67514. get output(): NodeMaterialConnectionPoint;
  67515. protected _buildBlock(state: NodeMaterialBuildState): this;
  67516. }
  67517. }
  67518. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67519. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67520. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67521. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67522. /**
  67523. * Block used to get the refracted vector from a direction and a normal
  67524. */
  67525. export class RefractBlock extends NodeMaterialBlock {
  67526. /**
  67527. * Creates a new RefractBlock
  67528. * @param name defines the block name
  67529. */
  67530. constructor(name: string);
  67531. /**
  67532. * Gets the current class name
  67533. * @returns the class name
  67534. */
  67535. getClassName(): string;
  67536. /**
  67537. * Gets the incident component
  67538. */
  67539. get incident(): NodeMaterialConnectionPoint;
  67540. /**
  67541. * Gets the normal component
  67542. */
  67543. get normal(): NodeMaterialConnectionPoint;
  67544. /**
  67545. * Gets the index of refraction component
  67546. */
  67547. get ior(): NodeMaterialConnectionPoint;
  67548. /**
  67549. * Gets the output component
  67550. */
  67551. get output(): NodeMaterialConnectionPoint;
  67552. protected _buildBlock(state: NodeMaterialBuildState): this;
  67553. }
  67554. }
  67555. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67556. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67557. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67558. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67559. /**
  67560. * Block used to desaturate a color
  67561. */
  67562. export class DesaturateBlock extends NodeMaterialBlock {
  67563. /**
  67564. * Creates a new DesaturateBlock
  67565. * @param name defines the block name
  67566. */
  67567. constructor(name: string);
  67568. /**
  67569. * Gets the current class name
  67570. * @returns the class name
  67571. */
  67572. getClassName(): string;
  67573. /**
  67574. * Gets the color operand input component
  67575. */
  67576. get color(): NodeMaterialConnectionPoint;
  67577. /**
  67578. * Gets the level operand input component
  67579. */
  67580. get level(): NodeMaterialConnectionPoint;
  67581. /**
  67582. * Gets the output component
  67583. */
  67584. get output(): NodeMaterialConnectionPoint;
  67585. protected _buildBlock(state: NodeMaterialBuildState): this;
  67586. }
  67587. }
  67588. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67589. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67590. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67592. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67593. import { Nullable } from "babylonjs/types";
  67594. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67595. import { Scene } from "babylonjs/scene";
  67596. /**
  67597. * Block used to implement the ambient occlusion module of the PBR material
  67598. */
  67599. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67600. /**
  67601. * Create a new AmbientOcclusionBlock
  67602. * @param name defines the block name
  67603. */
  67604. constructor(name: string);
  67605. /**
  67606. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67607. */
  67608. useAmbientInGrayScale: boolean;
  67609. /**
  67610. * Initialize the block and prepare the context for build
  67611. * @param state defines the state that will be used for the build
  67612. */
  67613. initialize(state: NodeMaterialBuildState): void;
  67614. /**
  67615. * Gets the current class name
  67616. * @returns the class name
  67617. */
  67618. getClassName(): string;
  67619. /**
  67620. * Gets the texture input component
  67621. */
  67622. get texture(): NodeMaterialConnectionPoint;
  67623. /**
  67624. * Gets the texture intensity component
  67625. */
  67626. get intensity(): NodeMaterialConnectionPoint;
  67627. /**
  67628. * Gets the direct light intensity input component
  67629. */
  67630. get directLightIntensity(): NodeMaterialConnectionPoint;
  67631. /**
  67632. * Gets the ambient occlusion object output component
  67633. */
  67634. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67635. /**
  67636. * Gets the main code of the block (fragment side)
  67637. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67638. * @returns the shader code
  67639. */
  67640. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67641. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67642. protected _buildBlock(state: NodeMaterialBuildState): this;
  67643. protected _dumpPropertiesCode(): string;
  67644. serialize(): any;
  67645. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67646. }
  67647. }
  67648. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67649. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67650. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67651. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67652. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67653. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67654. import { Nullable } from "babylonjs/types";
  67655. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67656. import { Mesh } from "babylonjs/Meshes/mesh";
  67657. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67658. import { Effect } from "babylonjs/Materials/effect";
  67659. import { Scene } from "babylonjs/scene";
  67660. /**
  67661. * Block used to implement the reflection module of the PBR material
  67662. */
  67663. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67664. /** @hidden */
  67665. _defineLODReflectionAlpha: string;
  67666. /** @hidden */
  67667. _defineLinearSpecularReflection: string;
  67668. private _vEnvironmentIrradianceName;
  67669. /** @hidden */
  67670. _vReflectionMicrosurfaceInfosName: string;
  67671. /** @hidden */
  67672. _vReflectionInfosName: string;
  67673. /** @hidden */
  67674. _vReflectionFilteringInfoName: string;
  67675. private _scene;
  67676. /**
  67677. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67678. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67679. * It's less burden on the user side in the editor part.
  67680. */
  67681. /** @hidden */
  67682. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67683. /** @hidden */
  67684. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67685. /** @hidden */
  67686. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67687. /**
  67688. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67689. * diffuse part of the IBL.
  67690. */
  67691. useSphericalHarmonics: boolean;
  67692. /**
  67693. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67694. */
  67695. forceIrradianceInFragment: boolean;
  67696. /**
  67697. * Create a new ReflectionBlock
  67698. * @param name defines the block name
  67699. */
  67700. constructor(name: string);
  67701. /**
  67702. * Gets the current class name
  67703. * @returns the class name
  67704. */
  67705. getClassName(): string;
  67706. /**
  67707. * Gets the position input component
  67708. */
  67709. get position(): NodeMaterialConnectionPoint;
  67710. /**
  67711. * Gets the world position input component
  67712. */
  67713. get worldPosition(): NodeMaterialConnectionPoint;
  67714. /**
  67715. * Gets the world normal input component
  67716. */
  67717. get worldNormal(): NodeMaterialConnectionPoint;
  67718. /**
  67719. * Gets the world input component
  67720. */
  67721. get world(): NodeMaterialConnectionPoint;
  67722. /**
  67723. * Gets the camera (or eye) position component
  67724. */
  67725. get cameraPosition(): NodeMaterialConnectionPoint;
  67726. /**
  67727. * Gets the view input component
  67728. */
  67729. get view(): NodeMaterialConnectionPoint;
  67730. /**
  67731. * Gets the color input component
  67732. */
  67733. get color(): NodeMaterialConnectionPoint;
  67734. /**
  67735. * Gets the reflection object output component
  67736. */
  67737. get reflection(): NodeMaterialConnectionPoint;
  67738. /**
  67739. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67740. */
  67741. get hasTexture(): boolean;
  67742. /**
  67743. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67744. */
  67745. get reflectionColor(): string;
  67746. protected _getTexture(): Nullable<BaseTexture>;
  67747. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67748. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67749. /**
  67750. * Gets the code to inject in the vertex shader
  67751. * @param state current state of the node material building
  67752. * @returns the shader code
  67753. */
  67754. handleVertexSide(state: NodeMaterialBuildState): string;
  67755. /**
  67756. * Gets the main code of the block (fragment side)
  67757. * @param state current state of the node material building
  67758. * @param normalVarName name of the existing variable corresponding to the normal
  67759. * @returns the shader code
  67760. */
  67761. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67762. protected _buildBlock(state: NodeMaterialBuildState): this;
  67763. protected _dumpPropertiesCode(): string;
  67764. serialize(): any;
  67765. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67766. }
  67767. }
  67768. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67769. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67770. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67771. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67772. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67773. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67774. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67775. import { Scene } from "babylonjs/scene";
  67776. import { Nullable } from "babylonjs/types";
  67777. /**
  67778. * Block used to implement the sheen module of the PBR material
  67779. */
  67780. export class SheenBlock extends NodeMaterialBlock {
  67781. /**
  67782. * Create a new SheenBlock
  67783. * @param name defines the block name
  67784. */
  67785. constructor(name: string);
  67786. /**
  67787. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67788. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67789. * making it easier to setup and tweak the effect
  67790. */
  67791. albedoScaling: boolean;
  67792. /**
  67793. * Defines if the sheen is linked to the sheen color.
  67794. */
  67795. linkSheenWithAlbedo: boolean;
  67796. /**
  67797. * Initialize the block and prepare the context for build
  67798. * @param state defines the state that will be used for the build
  67799. */
  67800. initialize(state: NodeMaterialBuildState): void;
  67801. /**
  67802. * Gets the current class name
  67803. * @returns the class name
  67804. */
  67805. getClassName(): string;
  67806. /**
  67807. * Gets the intensity input component
  67808. */
  67809. get intensity(): NodeMaterialConnectionPoint;
  67810. /**
  67811. * Gets the color input component
  67812. */
  67813. get color(): NodeMaterialConnectionPoint;
  67814. /**
  67815. * Gets the roughness input component
  67816. */
  67817. get roughness(): NodeMaterialConnectionPoint;
  67818. /**
  67819. * Gets the sheen object output component
  67820. */
  67821. get sheen(): NodeMaterialConnectionPoint;
  67822. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67823. /**
  67824. * Gets the main code of the block (fragment side)
  67825. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67826. * @returns the shader code
  67827. */
  67828. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67829. protected _buildBlock(state: NodeMaterialBuildState): this;
  67830. protected _dumpPropertiesCode(): string;
  67831. serialize(): any;
  67832. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67833. }
  67834. }
  67835. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67836. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67837. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67838. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67839. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67840. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67841. import { Scene } from "babylonjs/scene";
  67842. import { Nullable } from "babylonjs/types";
  67843. import { Mesh } from "babylonjs/Meshes/mesh";
  67844. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67845. import { Effect } from "babylonjs/Materials/effect";
  67846. /**
  67847. * Block used to implement the reflectivity module of the PBR material
  67848. */
  67849. export class ReflectivityBlock extends NodeMaterialBlock {
  67850. private _metallicReflectanceColor;
  67851. private _metallicF0Factor;
  67852. /** @hidden */
  67853. _vMetallicReflectanceFactorsName: string;
  67854. /**
  67855. * The property below is set by the main PBR block prior to calling methods of this class.
  67856. */
  67857. /** @hidden */
  67858. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67859. /**
  67860. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67861. */
  67862. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67863. /**
  67864. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67865. */
  67866. useMetallnessFromMetallicTextureBlue: boolean;
  67867. /**
  67868. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67869. */
  67870. useRoughnessFromMetallicTextureAlpha: boolean;
  67871. /**
  67872. * Specifies if the metallic texture contains the roughness information in its green channel.
  67873. */
  67874. useRoughnessFromMetallicTextureGreen: boolean;
  67875. /**
  67876. * Create a new ReflectivityBlock
  67877. * @param name defines the block name
  67878. */
  67879. constructor(name: string);
  67880. /**
  67881. * Initialize the block and prepare the context for build
  67882. * @param state defines the state that will be used for the build
  67883. */
  67884. initialize(state: NodeMaterialBuildState): void;
  67885. /**
  67886. * Gets the current class name
  67887. * @returns the class name
  67888. */
  67889. getClassName(): string;
  67890. /**
  67891. * Gets the metallic input component
  67892. */
  67893. get metallic(): NodeMaterialConnectionPoint;
  67894. /**
  67895. * Gets the roughness input component
  67896. */
  67897. get roughness(): NodeMaterialConnectionPoint;
  67898. /**
  67899. * Gets the texture input component
  67900. */
  67901. get texture(): NodeMaterialConnectionPoint;
  67902. /**
  67903. * Gets the reflectivity object output component
  67904. */
  67905. get reflectivity(): NodeMaterialConnectionPoint;
  67906. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67907. /**
  67908. * Gets the main code of the block (fragment side)
  67909. * @param state current state of the node material building
  67910. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67911. * @returns the shader code
  67912. */
  67913. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67914. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67915. protected _buildBlock(state: NodeMaterialBuildState): this;
  67916. protected _dumpPropertiesCode(): string;
  67917. serialize(): any;
  67918. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67919. }
  67920. }
  67921. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67922. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67923. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67924. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67925. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67927. /**
  67928. * Block used to implement the anisotropy module of the PBR material
  67929. */
  67930. export class AnisotropyBlock extends NodeMaterialBlock {
  67931. /**
  67932. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67933. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67934. * It's less burden on the user side in the editor part.
  67935. */
  67936. /** @hidden */
  67937. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67938. /** @hidden */
  67939. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67940. /**
  67941. * Create a new AnisotropyBlock
  67942. * @param name defines the block name
  67943. */
  67944. constructor(name: string);
  67945. /**
  67946. * Initialize the block and prepare the context for build
  67947. * @param state defines the state that will be used for the build
  67948. */
  67949. initialize(state: NodeMaterialBuildState): void;
  67950. /**
  67951. * Gets the current class name
  67952. * @returns the class name
  67953. */
  67954. getClassName(): string;
  67955. /**
  67956. * Gets the intensity input component
  67957. */
  67958. get intensity(): NodeMaterialConnectionPoint;
  67959. /**
  67960. * Gets the direction input component
  67961. */
  67962. get direction(): NodeMaterialConnectionPoint;
  67963. /**
  67964. * Gets the texture input component
  67965. */
  67966. get texture(): NodeMaterialConnectionPoint;
  67967. /**
  67968. * Gets the uv input component
  67969. */
  67970. get uv(): NodeMaterialConnectionPoint;
  67971. /**
  67972. * Gets the worldTangent input component
  67973. */
  67974. get worldTangent(): NodeMaterialConnectionPoint;
  67975. /**
  67976. * Gets the anisotropy object output component
  67977. */
  67978. get anisotropy(): NodeMaterialConnectionPoint;
  67979. private _generateTBNSpace;
  67980. /**
  67981. * Gets the main code of the block (fragment side)
  67982. * @param state current state of the node material building
  67983. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67984. * @returns the shader code
  67985. */
  67986. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67987. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67988. protected _buildBlock(state: NodeMaterialBuildState): this;
  67989. }
  67990. }
  67991. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67992. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67993. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67994. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67995. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67996. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67997. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67998. import { Nullable } from "babylonjs/types";
  67999. import { Mesh } from "babylonjs/Meshes/mesh";
  68000. import { SubMesh } from "babylonjs/Meshes/subMesh";
  68001. import { Effect } from "babylonjs/Materials/effect";
  68002. /**
  68003. * Block used to implement the clear coat module of the PBR material
  68004. */
  68005. export class ClearCoatBlock extends NodeMaterialBlock {
  68006. private _scene;
  68007. /**
  68008. * Create a new ClearCoatBlock
  68009. * @param name defines the block name
  68010. */
  68011. constructor(name: string);
  68012. /**
  68013. * Initialize the block and prepare the context for build
  68014. * @param state defines the state that will be used for the build
  68015. */
  68016. initialize(state: NodeMaterialBuildState): void;
  68017. /**
  68018. * Gets the current class name
  68019. * @returns the class name
  68020. */
  68021. getClassName(): string;
  68022. /**
  68023. * Gets the intensity input component
  68024. */
  68025. get intensity(): NodeMaterialConnectionPoint;
  68026. /**
  68027. * Gets the roughness input component
  68028. */
  68029. get roughness(): NodeMaterialConnectionPoint;
  68030. /**
  68031. * Gets the ior input component
  68032. */
  68033. get ior(): NodeMaterialConnectionPoint;
  68034. /**
  68035. * Gets the texture input component
  68036. */
  68037. get texture(): NodeMaterialConnectionPoint;
  68038. /**
  68039. * Gets the bump texture input component
  68040. */
  68041. get bumpTexture(): NodeMaterialConnectionPoint;
  68042. /**
  68043. * Gets the uv input component
  68044. */
  68045. get uv(): NodeMaterialConnectionPoint;
  68046. /**
  68047. * Gets the tint color input component
  68048. */
  68049. get tintColor(): NodeMaterialConnectionPoint;
  68050. /**
  68051. * Gets the tint "at distance" input component
  68052. */
  68053. get tintAtDistance(): NodeMaterialConnectionPoint;
  68054. /**
  68055. * Gets the tint thickness input component
  68056. */
  68057. get tintThickness(): NodeMaterialConnectionPoint;
  68058. /**
  68059. * Gets the world tangent input component
  68060. */
  68061. get worldTangent(): NodeMaterialConnectionPoint;
  68062. /**
  68063. * Gets the clear coat object output component
  68064. */
  68065. get clearcoat(): NodeMaterialConnectionPoint;
  68066. autoConfigure(material: NodeMaterial): void;
  68067. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68068. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  68069. private _generateTBNSpace;
  68070. /**
  68071. * Gets the main code of the block (fragment side)
  68072. * @param state current state of the node material building
  68073. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  68074. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68075. * @param worldPosVarName name of the variable holding the world position
  68076. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  68077. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  68078. * @param worldNormalVarName name of the variable holding the world normal
  68079. * @returns the shader code
  68080. */
  68081. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  68082. protected _buildBlock(state: NodeMaterialBuildState): this;
  68083. }
  68084. }
  68085. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  68086. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68087. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68088. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68089. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68090. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68091. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68092. import { Nullable } from "babylonjs/types";
  68093. /**
  68094. * Block used to implement the sub surface module of the PBR material
  68095. */
  68096. export class SubSurfaceBlock extends NodeMaterialBlock {
  68097. /**
  68098. * Create a new SubSurfaceBlock
  68099. * @param name defines the block name
  68100. */
  68101. constructor(name: string);
  68102. /**
  68103. * Stores the intensity of the different subsurface effects in the thickness texture.
  68104. * * the green channel is the translucency intensity.
  68105. * * the blue channel is the scattering intensity.
  68106. * * the alpha channel is the refraction intensity.
  68107. */
  68108. useMaskFromThicknessTexture: boolean;
  68109. /**
  68110. * Initialize the block and prepare the context for build
  68111. * @param state defines the state that will be used for the build
  68112. */
  68113. initialize(state: NodeMaterialBuildState): void;
  68114. /**
  68115. * Gets the current class name
  68116. * @returns the class name
  68117. */
  68118. getClassName(): string;
  68119. /**
  68120. * Gets the min thickness input component
  68121. */
  68122. get minThickness(): NodeMaterialConnectionPoint;
  68123. /**
  68124. * Gets the max thickness input component
  68125. */
  68126. get maxThickness(): NodeMaterialConnectionPoint;
  68127. /**
  68128. * Gets the thickness texture component
  68129. */
  68130. get thicknessTexture(): NodeMaterialConnectionPoint;
  68131. /**
  68132. * Gets the tint color input component
  68133. */
  68134. get tintColor(): NodeMaterialConnectionPoint;
  68135. /**
  68136. * Gets the translucency intensity input component
  68137. */
  68138. get translucencyIntensity(): NodeMaterialConnectionPoint;
  68139. /**
  68140. * Gets the translucency diffusion distance input component
  68141. */
  68142. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  68143. /**
  68144. * Gets the refraction object parameters
  68145. */
  68146. get refraction(): NodeMaterialConnectionPoint;
  68147. /**
  68148. * Gets the sub surface object output component
  68149. */
  68150. get subsurface(): NodeMaterialConnectionPoint;
  68151. autoConfigure(material: NodeMaterial): void;
  68152. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68153. /**
  68154. * Gets the main code of the block (fragment side)
  68155. * @param state current state of the node material building
  68156. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  68157. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68158. * @param worldPosVarName name of the variable holding the world position
  68159. * @returns the shader code
  68160. */
  68161. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  68162. protected _buildBlock(state: NodeMaterialBuildState): this;
  68163. }
  68164. }
  68165. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  68166. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68167. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68168. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68169. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68170. import { Light } from "babylonjs/Lights/light";
  68171. import { Nullable } from "babylonjs/types";
  68172. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68173. import { Effect } from "babylonjs/Materials/effect";
  68174. import { Mesh } from "babylonjs/Meshes/mesh";
  68175. import { Scene } from "babylonjs/scene";
  68176. /**
  68177. * Block used to implement the PBR metallic/roughness model
  68178. */
  68179. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  68180. /**
  68181. * Gets or sets the light associated with this block
  68182. */
  68183. light: Nullable<Light>;
  68184. private _lightId;
  68185. private _scene;
  68186. private _environmentBRDFTexture;
  68187. private _environmentBrdfSamplerName;
  68188. private _vNormalWName;
  68189. private _invertNormalName;
  68190. /**
  68191. * Create a new ReflectionBlock
  68192. * @param name defines the block name
  68193. */
  68194. constructor(name: string);
  68195. /**
  68196. * Intensity of the direct lights e.g. the four lights available in your scene.
  68197. * This impacts both the direct diffuse and specular highlights.
  68198. */
  68199. directIntensity: number;
  68200. /**
  68201. * Intensity of the environment e.g. how much the environment will light the object
  68202. * either through harmonics for rough material or through the refelction for shiny ones.
  68203. */
  68204. environmentIntensity: number;
  68205. /**
  68206. * This is a special control allowing the reduction of the specular highlights coming from the
  68207. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  68208. */
  68209. specularIntensity: number;
  68210. /**
  68211. * Defines the falloff type used in this material.
  68212. * It by default is Physical.
  68213. */
  68214. lightFalloff: number;
  68215. /**
  68216. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  68217. */
  68218. useAlphaFromAlbedoTexture: boolean;
  68219. /**
  68220. * Specifies that alpha test should be used
  68221. */
  68222. useAlphaTest: boolean;
  68223. /**
  68224. * Defines the alpha limits in alpha test mode.
  68225. */
  68226. alphaTestCutoff: number;
  68227. /**
  68228. * Specifies that alpha blending should be used
  68229. */
  68230. useAlphaBlending: boolean;
  68231. /**
  68232. * Defines if the alpha value should be determined via the rgb values.
  68233. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  68234. */
  68235. opacityRGB: boolean;
  68236. /**
  68237. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  68238. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  68239. */
  68240. useRadianceOverAlpha: boolean;
  68241. /**
  68242. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  68243. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  68244. */
  68245. useSpecularOverAlpha: boolean;
  68246. /**
  68247. * Enables specular anti aliasing in the PBR shader.
  68248. * It will both interacts on the Geometry for analytical and IBL lighting.
  68249. * It also prefilter the roughness map based on the bump values.
  68250. */
  68251. enableSpecularAntiAliasing: boolean;
  68252. /**
  68253. * Enables realtime filtering on the texture.
  68254. */
  68255. realTimeFiltering: boolean;
  68256. /**
  68257. * Quality switch for realtime filtering
  68258. */
  68259. realTimeFilteringQuality: number;
  68260. /**
  68261. * Defines if the material uses energy conservation.
  68262. */
  68263. useEnergyConservation: boolean;
  68264. /**
  68265. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68266. * too much the area relying on ambient texture to define their ambient occlusion.
  68267. */
  68268. useRadianceOcclusion: boolean;
  68269. /**
  68270. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68271. * makes the reflect vector face the model (under horizon).
  68272. */
  68273. useHorizonOcclusion: boolean;
  68274. /**
  68275. * If set to true, no lighting calculations will be applied.
  68276. */
  68277. unlit: boolean;
  68278. /**
  68279. * Force normal to face away from face.
  68280. */
  68281. forceNormalForward: boolean;
  68282. /**
  68283. * Defines the material debug mode.
  68284. * It helps seeing only some components of the material while troubleshooting.
  68285. */
  68286. debugMode: number;
  68287. /**
  68288. * Specify from where on screen the debug mode should start.
  68289. * The value goes from -1 (full screen) to 1 (not visible)
  68290. * It helps with side by side comparison against the final render
  68291. * This defaults to 0
  68292. */
  68293. debugLimit: number;
  68294. /**
  68295. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68296. * You can use the factor to better multiply the final value.
  68297. */
  68298. debugFactor: number;
  68299. /**
  68300. * Initialize the block and prepare the context for build
  68301. * @param state defines the state that will be used for the build
  68302. */
  68303. initialize(state: NodeMaterialBuildState): void;
  68304. /**
  68305. * Gets the current class name
  68306. * @returns the class name
  68307. */
  68308. getClassName(): string;
  68309. /**
  68310. * Gets the world position input component
  68311. */
  68312. get worldPosition(): NodeMaterialConnectionPoint;
  68313. /**
  68314. * Gets the world normal input component
  68315. */
  68316. get worldNormal(): NodeMaterialConnectionPoint;
  68317. /**
  68318. * Gets the perturbed normal input component
  68319. */
  68320. get perturbedNormal(): NodeMaterialConnectionPoint;
  68321. /**
  68322. * Gets the camera position input component
  68323. */
  68324. get cameraPosition(): NodeMaterialConnectionPoint;
  68325. /**
  68326. * Gets the base color input component
  68327. */
  68328. get baseColor(): NodeMaterialConnectionPoint;
  68329. /**
  68330. * Gets the opacity texture input component
  68331. */
  68332. get opacityTexture(): NodeMaterialConnectionPoint;
  68333. /**
  68334. * Gets the ambient color input component
  68335. */
  68336. get ambientColor(): NodeMaterialConnectionPoint;
  68337. /**
  68338. * Gets the reflectivity object parameters
  68339. */
  68340. get reflectivity(): NodeMaterialConnectionPoint;
  68341. /**
  68342. * Gets the ambient occlusion object parameters
  68343. */
  68344. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68345. /**
  68346. * Gets the reflection object parameters
  68347. */
  68348. get reflection(): NodeMaterialConnectionPoint;
  68349. /**
  68350. * Gets the sheen object parameters
  68351. */
  68352. get sheen(): NodeMaterialConnectionPoint;
  68353. /**
  68354. * Gets the clear coat object parameters
  68355. */
  68356. get clearcoat(): NodeMaterialConnectionPoint;
  68357. /**
  68358. * Gets the sub surface object parameters
  68359. */
  68360. get subsurface(): NodeMaterialConnectionPoint;
  68361. /**
  68362. * Gets the anisotropy object parameters
  68363. */
  68364. get anisotropy(): NodeMaterialConnectionPoint;
  68365. /**
  68366. * Gets the ambient output component
  68367. */
  68368. get ambient(): NodeMaterialConnectionPoint;
  68369. /**
  68370. * Gets the diffuse output component
  68371. */
  68372. get diffuse(): NodeMaterialConnectionPoint;
  68373. /**
  68374. * Gets the specular output component
  68375. */
  68376. get specular(): NodeMaterialConnectionPoint;
  68377. /**
  68378. * Gets the sheen output component
  68379. */
  68380. get sheenDir(): NodeMaterialConnectionPoint;
  68381. /**
  68382. * Gets the clear coat output component
  68383. */
  68384. get clearcoatDir(): NodeMaterialConnectionPoint;
  68385. /**
  68386. * Gets the indirect diffuse output component
  68387. */
  68388. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68389. /**
  68390. * Gets the indirect specular output component
  68391. */
  68392. get specularIndirect(): NodeMaterialConnectionPoint;
  68393. /**
  68394. * Gets the indirect sheen output component
  68395. */
  68396. get sheenIndirect(): NodeMaterialConnectionPoint;
  68397. /**
  68398. * Gets the indirect clear coat output component
  68399. */
  68400. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68401. /**
  68402. * Gets the refraction output component
  68403. */
  68404. get refraction(): NodeMaterialConnectionPoint;
  68405. /**
  68406. * Gets the global lighting output component
  68407. */
  68408. get lighting(): NodeMaterialConnectionPoint;
  68409. /**
  68410. * Gets the shadow output component
  68411. */
  68412. get shadow(): NodeMaterialConnectionPoint;
  68413. /**
  68414. * Gets the alpha output component
  68415. */
  68416. get alpha(): NodeMaterialConnectionPoint;
  68417. autoConfigure(material: NodeMaterial): void;
  68418. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68419. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68420. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68421. private _injectVertexCode;
  68422. /**
  68423. * Gets the code corresponding to the albedo/opacity module
  68424. * @returns the shader code
  68425. */
  68426. getAlbedoOpacityCode(): string;
  68427. protected _buildBlock(state: NodeMaterialBuildState): this;
  68428. protected _dumpPropertiesCode(): string;
  68429. serialize(): any;
  68430. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68431. }
  68432. }
  68433. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68434. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68435. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68436. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68437. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68438. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68439. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68440. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68441. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68442. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68443. }
  68444. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68445. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68446. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68447. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68448. }
  68449. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68450. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68451. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68452. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68453. /**
  68454. * Block used to compute value of one parameter modulo another
  68455. */
  68456. export class ModBlock extends NodeMaterialBlock {
  68457. /**
  68458. * Creates a new ModBlock
  68459. * @param name defines the block name
  68460. */
  68461. constructor(name: string);
  68462. /**
  68463. * Gets the current class name
  68464. * @returns the class name
  68465. */
  68466. getClassName(): string;
  68467. /**
  68468. * Gets the left operand input component
  68469. */
  68470. get left(): NodeMaterialConnectionPoint;
  68471. /**
  68472. * Gets the right operand input component
  68473. */
  68474. get right(): NodeMaterialConnectionPoint;
  68475. /**
  68476. * Gets the output component
  68477. */
  68478. get output(): NodeMaterialConnectionPoint;
  68479. protected _buildBlock(state: NodeMaterialBuildState): this;
  68480. }
  68481. }
  68482. declare module "babylonjs/Materials/Node/Blocks/index" {
  68483. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68484. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68485. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68486. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68487. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68488. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68489. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68490. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68491. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68492. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68493. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68494. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68495. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68496. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68497. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68498. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68499. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68500. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68501. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68502. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68503. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68504. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68505. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68506. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68507. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68508. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68509. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68510. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68511. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68512. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68513. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68514. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68515. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68516. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68517. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68518. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68519. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68520. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68521. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68522. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68523. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68524. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68525. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68526. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68527. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68528. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68529. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68530. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68531. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68532. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68533. }
  68534. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68535. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68536. }
  68537. declare module "babylonjs/Materials/Node/index" {
  68538. export * from "babylonjs/Materials/Node/Enums/index";
  68539. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68540. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68541. export * from "babylonjs/Materials/Node/nodeMaterial";
  68542. export * from "babylonjs/Materials/Node/Blocks/index";
  68543. export * from "babylonjs/Materials/Node/Optimizers/index";
  68544. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68545. }
  68546. declare module "babylonjs/Materials/index" {
  68547. export * from "babylonjs/Materials/Background/index";
  68548. export * from "babylonjs/Materials/colorCurves";
  68549. export * from "babylonjs/Materials/iEffectFallbacks";
  68550. export * from "babylonjs/Materials/effectFallbacks";
  68551. export * from "babylonjs/Materials/effect";
  68552. export * from "babylonjs/Materials/fresnelParameters";
  68553. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68554. export * from "babylonjs/Materials/material";
  68555. export * from "babylonjs/Materials/materialDefines";
  68556. export * from "babylonjs/Materials/thinMaterialHelper";
  68557. export * from "babylonjs/Materials/materialHelper";
  68558. export * from "babylonjs/Materials/multiMaterial";
  68559. export * from "babylonjs/Materials/PBR/index";
  68560. export * from "babylonjs/Materials/pushMaterial";
  68561. export * from "babylonjs/Materials/shaderMaterial";
  68562. export * from "babylonjs/Materials/standardMaterial";
  68563. export * from "babylonjs/Materials/Textures/index";
  68564. export * from "babylonjs/Materials/uniformBuffer";
  68565. export * from "babylonjs/Materials/materialFlags";
  68566. export * from "babylonjs/Materials/Node/index";
  68567. export * from "babylonjs/Materials/effectRenderer";
  68568. export * from "babylonjs/Materials/shadowDepthWrapper";
  68569. }
  68570. declare module "babylonjs/Maths/index" {
  68571. export * from "babylonjs/Maths/math.scalar";
  68572. export * from "babylonjs/Maths/math";
  68573. export * from "babylonjs/Maths/sphericalPolynomial";
  68574. }
  68575. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68576. import { IDisposable } from "babylonjs/scene";
  68577. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68578. /**
  68579. * Configuration for Draco compression
  68580. */
  68581. export interface IDracoCompressionConfiguration {
  68582. /**
  68583. * Configuration for the decoder.
  68584. */
  68585. decoder: {
  68586. /**
  68587. * The url to the WebAssembly module.
  68588. */
  68589. wasmUrl?: string;
  68590. /**
  68591. * The url to the WebAssembly binary.
  68592. */
  68593. wasmBinaryUrl?: string;
  68594. /**
  68595. * The url to the fallback JavaScript module.
  68596. */
  68597. fallbackUrl?: string;
  68598. };
  68599. }
  68600. /**
  68601. * Draco compression (https://google.github.io/draco/)
  68602. *
  68603. * This class wraps the Draco module.
  68604. *
  68605. * **Encoder**
  68606. *
  68607. * The encoder is not currently implemented.
  68608. *
  68609. * **Decoder**
  68610. *
  68611. * 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.
  68612. *
  68613. * To update the configuration, use the following code:
  68614. * ```javascript
  68615. * DracoCompression.Configuration = {
  68616. * decoder: {
  68617. * wasmUrl: "<url to the WebAssembly library>",
  68618. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68619. * fallbackUrl: "<url to the fallback JavaScript library>",
  68620. * }
  68621. * };
  68622. * ```
  68623. *
  68624. * 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.
  68625. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68626. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68627. *
  68628. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68629. * ```javascript
  68630. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68631. * ```
  68632. *
  68633. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68634. */
  68635. export class DracoCompression implements IDisposable {
  68636. private _workerPoolPromise?;
  68637. private _decoderModulePromise?;
  68638. /**
  68639. * The configuration. Defaults to the following urls:
  68640. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68641. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68642. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68643. */
  68644. static Configuration: IDracoCompressionConfiguration;
  68645. /**
  68646. * Returns true if the decoder configuration is available.
  68647. */
  68648. static get DecoderAvailable(): boolean;
  68649. /**
  68650. * Default number of workers to create when creating the draco compression object.
  68651. */
  68652. static DefaultNumWorkers: number;
  68653. private static GetDefaultNumWorkers;
  68654. private static _Default;
  68655. /**
  68656. * Default instance for the draco compression object.
  68657. */
  68658. static get Default(): DracoCompression;
  68659. /**
  68660. * Constructor
  68661. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68662. */
  68663. constructor(numWorkers?: number);
  68664. /**
  68665. * Stop all async operations and release resources.
  68666. */
  68667. dispose(): void;
  68668. /**
  68669. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68670. * @returns a promise that resolves when ready
  68671. */
  68672. whenReadyAsync(): Promise<void>;
  68673. /**
  68674. * Decode Draco compressed mesh data to vertex data.
  68675. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68676. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68677. * @returns A promise that resolves with the decoded vertex data
  68678. */
  68679. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68680. [kind: string]: number;
  68681. }): Promise<VertexData>;
  68682. }
  68683. }
  68684. declare module "babylonjs/Meshes/Compression/index" {
  68685. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68686. }
  68687. declare module "babylonjs/Meshes/csg" {
  68688. import { Nullable } from "babylonjs/types";
  68689. import { Scene } from "babylonjs/scene";
  68690. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68691. import { Mesh } from "babylonjs/Meshes/mesh";
  68692. import { Material } from "babylonjs/Materials/material";
  68693. /**
  68694. * Class for building Constructive Solid Geometry
  68695. */
  68696. export class CSG {
  68697. private polygons;
  68698. /**
  68699. * The world matrix
  68700. */
  68701. matrix: Matrix;
  68702. /**
  68703. * Stores the position
  68704. */
  68705. position: Vector3;
  68706. /**
  68707. * Stores the rotation
  68708. */
  68709. rotation: Vector3;
  68710. /**
  68711. * Stores the rotation quaternion
  68712. */
  68713. rotationQuaternion: Nullable<Quaternion>;
  68714. /**
  68715. * Stores the scaling vector
  68716. */
  68717. scaling: Vector3;
  68718. /**
  68719. * Convert the Mesh to CSG
  68720. * @param mesh The Mesh to convert to CSG
  68721. * @returns A new CSG from the Mesh
  68722. */
  68723. static FromMesh(mesh: Mesh): CSG;
  68724. /**
  68725. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68726. * @param polygons Polygons used to construct a CSG solid
  68727. */
  68728. private static FromPolygons;
  68729. /**
  68730. * Clones, or makes a deep copy, of the CSG
  68731. * @returns A new CSG
  68732. */
  68733. clone(): CSG;
  68734. /**
  68735. * Unions this CSG with another CSG
  68736. * @param csg The CSG to union against this CSG
  68737. * @returns The unioned CSG
  68738. */
  68739. union(csg: CSG): CSG;
  68740. /**
  68741. * Unions this CSG with another CSG in place
  68742. * @param csg The CSG to union against this CSG
  68743. */
  68744. unionInPlace(csg: CSG): void;
  68745. /**
  68746. * Subtracts this CSG with another CSG
  68747. * @param csg The CSG to subtract against this CSG
  68748. * @returns A new CSG
  68749. */
  68750. subtract(csg: CSG): CSG;
  68751. /**
  68752. * Subtracts this CSG with another CSG in place
  68753. * @param csg The CSG to subtact against this CSG
  68754. */
  68755. subtractInPlace(csg: CSG): void;
  68756. /**
  68757. * Intersect this CSG with another CSG
  68758. * @param csg The CSG to intersect against this CSG
  68759. * @returns A new CSG
  68760. */
  68761. intersect(csg: CSG): CSG;
  68762. /**
  68763. * Intersects this CSG with another CSG in place
  68764. * @param csg The CSG to intersect against this CSG
  68765. */
  68766. intersectInPlace(csg: CSG): void;
  68767. /**
  68768. * Return a new CSG solid with solid and empty space switched. This solid is
  68769. * not modified.
  68770. * @returns A new CSG solid with solid and empty space switched
  68771. */
  68772. inverse(): CSG;
  68773. /**
  68774. * Inverses the CSG in place
  68775. */
  68776. inverseInPlace(): void;
  68777. /**
  68778. * This is used to keep meshes transformations so they can be restored
  68779. * when we build back a Babylon Mesh
  68780. * NB : All CSG operations are performed in world coordinates
  68781. * @param csg The CSG to copy the transform attributes from
  68782. * @returns This CSG
  68783. */
  68784. copyTransformAttributes(csg: CSG): CSG;
  68785. /**
  68786. * Build Raw mesh from CSG
  68787. * Coordinates here are in world space
  68788. * @param name The name of the mesh geometry
  68789. * @param scene The Scene
  68790. * @param keepSubMeshes Specifies if the submeshes should be kept
  68791. * @returns A new Mesh
  68792. */
  68793. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68794. /**
  68795. * Build Mesh from CSG taking material and transforms into account
  68796. * @param name The name of the Mesh
  68797. * @param material The material of the Mesh
  68798. * @param scene The Scene
  68799. * @param keepSubMeshes Specifies if submeshes should be kept
  68800. * @returns The new Mesh
  68801. */
  68802. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68803. }
  68804. }
  68805. declare module "babylonjs/Meshes/trailMesh" {
  68806. import { Mesh } from "babylonjs/Meshes/mesh";
  68807. import { Scene } from "babylonjs/scene";
  68808. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68809. /**
  68810. * Class used to create a trail following a mesh
  68811. */
  68812. export class TrailMesh extends Mesh {
  68813. private _generator;
  68814. private _autoStart;
  68815. private _running;
  68816. private _diameter;
  68817. private _length;
  68818. private _sectionPolygonPointsCount;
  68819. private _sectionVectors;
  68820. private _sectionNormalVectors;
  68821. private _beforeRenderObserver;
  68822. /**
  68823. * @constructor
  68824. * @param name The value used by scene.getMeshByName() to do a lookup.
  68825. * @param generator The mesh or transform node to generate a trail.
  68826. * @param scene The scene to add this mesh to.
  68827. * @param diameter Diameter of trailing mesh. Default is 1.
  68828. * @param length Length of trailing mesh. Default is 60.
  68829. * @param autoStart Automatically start trailing mesh. Default true.
  68830. */
  68831. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68832. /**
  68833. * "TrailMesh"
  68834. * @returns "TrailMesh"
  68835. */
  68836. getClassName(): string;
  68837. private _createMesh;
  68838. /**
  68839. * Start trailing mesh.
  68840. */
  68841. start(): void;
  68842. /**
  68843. * Stop trailing mesh.
  68844. */
  68845. stop(): void;
  68846. /**
  68847. * Update trailing mesh geometry.
  68848. */
  68849. update(): void;
  68850. /**
  68851. * Returns a new TrailMesh object.
  68852. * @param name is a string, the name given to the new mesh
  68853. * @param newGenerator use new generator object for cloned trail mesh
  68854. * @returns a new mesh
  68855. */
  68856. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68857. /**
  68858. * Serializes this trail mesh
  68859. * @param serializationObject object to write serialization to
  68860. */
  68861. serialize(serializationObject: any): void;
  68862. /**
  68863. * Parses a serialized trail mesh
  68864. * @param parsedMesh the serialized mesh
  68865. * @param scene the scene to create the trail mesh in
  68866. * @returns the created trail mesh
  68867. */
  68868. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68869. }
  68870. }
  68871. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68872. import { Nullable } from "babylonjs/types";
  68873. import { Scene } from "babylonjs/scene";
  68874. import { Vector4 } from "babylonjs/Maths/math.vector";
  68875. import { Color4 } from "babylonjs/Maths/math.color";
  68876. import { Mesh } from "babylonjs/Meshes/mesh";
  68877. /**
  68878. * Class containing static functions to help procedurally build meshes
  68879. */
  68880. export class TiledBoxBuilder {
  68881. /**
  68882. * Creates a box mesh
  68883. * 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)
  68884. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68885. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68886. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68887. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  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 CreateTiledBox(name: string, options: {
  68894. pattern?: number;
  68895. width?: number;
  68896. height?: number;
  68897. depth?: number;
  68898. tileSize?: number;
  68899. tileWidth?: number;
  68900. tileHeight?: number;
  68901. alignHorizontal?: number;
  68902. alignVertical?: number;
  68903. faceUV?: Vector4[];
  68904. faceColors?: Color4[];
  68905. sideOrientation?: number;
  68906. updatable?: boolean;
  68907. }, scene?: Nullable<Scene>): Mesh;
  68908. }
  68909. }
  68910. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68911. import { Vector4 } from "babylonjs/Maths/math.vector";
  68912. import { Mesh } from "babylonjs/Meshes/mesh";
  68913. /**
  68914. * Class containing static functions to help procedurally build meshes
  68915. */
  68916. export class TorusKnotBuilder {
  68917. /**
  68918. * Creates a torus knot mesh
  68919. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68920. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68921. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68922. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68923. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68924. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68925. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68926. * @param name defines the name of the mesh
  68927. * @param options defines the options used to create the mesh
  68928. * @param scene defines the hosting scene
  68929. * @returns the torus knot mesh
  68930. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68931. */
  68932. static CreateTorusKnot(name: string, options: {
  68933. radius?: number;
  68934. tube?: number;
  68935. radialSegments?: number;
  68936. tubularSegments?: number;
  68937. p?: number;
  68938. q?: number;
  68939. updatable?: boolean;
  68940. sideOrientation?: number;
  68941. frontUVs?: Vector4;
  68942. backUVs?: Vector4;
  68943. }, scene: any): Mesh;
  68944. }
  68945. }
  68946. declare module "babylonjs/Meshes/polygonMesh" {
  68947. import { Scene } from "babylonjs/scene";
  68948. import { Vector2 } from "babylonjs/Maths/math.vector";
  68949. import { Mesh } from "babylonjs/Meshes/mesh";
  68950. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68951. import { Path2 } from "babylonjs/Maths/math.path";
  68952. /**
  68953. * Polygon
  68954. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68955. */
  68956. export class Polygon {
  68957. /**
  68958. * Creates a rectangle
  68959. * @param xmin bottom X coord
  68960. * @param ymin bottom Y coord
  68961. * @param xmax top X coord
  68962. * @param ymax top Y coord
  68963. * @returns points that make the resulting rectation
  68964. */
  68965. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68966. /**
  68967. * Creates a circle
  68968. * @param radius radius of circle
  68969. * @param cx scale in x
  68970. * @param cy scale in y
  68971. * @param numberOfSides number of sides that make up the circle
  68972. * @returns points that make the resulting circle
  68973. */
  68974. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68975. /**
  68976. * Creates a polygon from input string
  68977. * @param input Input polygon data
  68978. * @returns the parsed points
  68979. */
  68980. static Parse(input: string): Vector2[];
  68981. /**
  68982. * Starts building a polygon from x and y coordinates
  68983. * @param x x coordinate
  68984. * @param y y coordinate
  68985. * @returns the started path2
  68986. */
  68987. static StartingAt(x: number, y: number): Path2;
  68988. }
  68989. /**
  68990. * Builds a polygon
  68991. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68992. */
  68993. export class PolygonMeshBuilder {
  68994. private _points;
  68995. private _outlinepoints;
  68996. private _holes;
  68997. private _name;
  68998. private _scene;
  68999. private _epoints;
  69000. private _eholes;
  69001. private _addToepoint;
  69002. /**
  69003. * Babylon reference to the earcut plugin.
  69004. */
  69005. bjsEarcut: any;
  69006. /**
  69007. * Creates a PolygonMeshBuilder
  69008. * @param name name of the builder
  69009. * @param contours Path of the polygon
  69010. * @param scene scene to add to when creating the mesh
  69011. * @param earcutInjection can be used to inject your own earcut reference
  69012. */
  69013. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  69014. /**
  69015. * Adds a whole within the polygon
  69016. * @param hole Array of points defining the hole
  69017. * @returns this
  69018. */
  69019. addHole(hole: Vector2[]): PolygonMeshBuilder;
  69020. /**
  69021. * Creates the polygon
  69022. * @param updatable If the mesh should be updatable
  69023. * @param depth The depth of the mesh created
  69024. * @returns the created mesh
  69025. */
  69026. build(updatable?: boolean, depth?: number): Mesh;
  69027. /**
  69028. * Creates the polygon
  69029. * @param depth The depth of the mesh created
  69030. * @returns the created VertexData
  69031. */
  69032. buildVertexData(depth?: number): VertexData;
  69033. /**
  69034. * Adds a side to the polygon
  69035. * @param positions points that make the polygon
  69036. * @param normals normals of the polygon
  69037. * @param uvs uvs of the polygon
  69038. * @param indices indices of the polygon
  69039. * @param bounds bounds of the polygon
  69040. * @param points points of the polygon
  69041. * @param depth depth of the polygon
  69042. * @param flip flip of the polygon
  69043. */
  69044. private addSide;
  69045. }
  69046. }
  69047. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  69048. import { Scene } from "babylonjs/scene";
  69049. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69050. import { Color4 } from "babylonjs/Maths/math.color";
  69051. import { Mesh } from "babylonjs/Meshes/mesh";
  69052. import { Nullable } from "babylonjs/types";
  69053. /**
  69054. * Class containing static functions to help procedurally build meshes
  69055. */
  69056. export class PolygonBuilder {
  69057. /**
  69058. * Creates a polygon mesh
  69059. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69060. * * 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
  69061. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69062. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69063. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69064. * * Remember you can only change the shape positions, not their number when updating a polygon
  69065. * @param name defines the name of the mesh
  69066. * @param options defines the options used to create the mesh
  69067. * @param scene defines the hosting scene
  69068. * @param earcutInjection can be used to inject your own earcut reference
  69069. * @returns the polygon mesh
  69070. */
  69071. static CreatePolygon(name: string, options: {
  69072. shape: Vector3[];
  69073. holes?: Vector3[][];
  69074. depth?: number;
  69075. faceUV?: Vector4[];
  69076. faceColors?: Color4[];
  69077. updatable?: boolean;
  69078. sideOrientation?: number;
  69079. frontUVs?: Vector4;
  69080. backUVs?: Vector4;
  69081. wrap?: boolean;
  69082. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69083. /**
  69084. * Creates an extruded polygon mesh, with depth in the Y direction.
  69085. * * 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)
  69086. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69087. * @param name defines the name of the mesh
  69088. * @param options defines the options used to create the mesh
  69089. * @param scene defines the hosting scene
  69090. * @param earcutInjection can be used to inject your own earcut reference
  69091. * @returns the polygon mesh
  69092. */
  69093. static ExtrudePolygon(name: string, options: {
  69094. shape: Vector3[];
  69095. holes?: Vector3[][];
  69096. depth?: number;
  69097. faceUV?: Vector4[];
  69098. faceColors?: Color4[];
  69099. updatable?: boolean;
  69100. sideOrientation?: number;
  69101. frontUVs?: Vector4;
  69102. backUVs?: Vector4;
  69103. wrap?: boolean;
  69104. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69105. }
  69106. }
  69107. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  69108. import { Scene } from "babylonjs/scene";
  69109. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69110. import { Mesh } from "babylonjs/Meshes/mesh";
  69111. import { Nullable } from "babylonjs/types";
  69112. /**
  69113. * Class containing static functions to help procedurally build meshes
  69114. */
  69115. export class LatheBuilder {
  69116. /**
  69117. * Creates lathe mesh.
  69118. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69119. * * 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
  69120. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69121. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69122. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69123. * * 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
  69124. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69125. * * 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
  69126. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69127. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69128. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69129. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69130. * @param name defines the name of the mesh
  69131. * @param options defines the options used to create the mesh
  69132. * @param scene defines the hosting scene
  69133. * @returns the lathe mesh
  69134. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69135. */
  69136. static CreateLathe(name: string, options: {
  69137. shape: Vector3[];
  69138. radius?: number;
  69139. tessellation?: number;
  69140. clip?: number;
  69141. arc?: number;
  69142. closed?: boolean;
  69143. updatable?: boolean;
  69144. sideOrientation?: number;
  69145. frontUVs?: Vector4;
  69146. backUVs?: Vector4;
  69147. cap?: number;
  69148. invertUV?: boolean;
  69149. }, scene?: Nullable<Scene>): Mesh;
  69150. }
  69151. }
  69152. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  69153. import { Nullable } from "babylonjs/types";
  69154. import { Scene } from "babylonjs/scene";
  69155. import { Vector4 } from "babylonjs/Maths/math.vector";
  69156. import { Mesh } from "babylonjs/Meshes/mesh";
  69157. /**
  69158. * Class containing static functions to help procedurally build meshes
  69159. */
  69160. export class TiledPlaneBuilder {
  69161. /**
  69162. * Creates a tiled plane mesh
  69163. * * The parameter `pattern` will, depending on value, do nothing or
  69164. * * * flip (reflect about central vertical) alternate tiles across and up
  69165. * * * flip every tile on alternate rows
  69166. * * * rotate (180 degs) alternate tiles across and up
  69167. * * * rotate every tile on alternate rows
  69168. * * * flip and rotate alternate tiles across and up
  69169. * * * flip and rotate every tile on alternate rows
  69170. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  69171. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  69172. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69173. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69174. * * 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)
  69175. * * 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)
  69176. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69177. * @param name defines the name of the mesh
  69178. * @param options defines the options used to create the mesh
  69179. * @param scene defines the hosting scene
  69180. * @returns the box mesh
  69181. */
  69182. static CreateTiledPlane(name: string, options: {
  69183. pattern?: number;
  69184. tileSize?: number;
  69185. tileWidth?: number;
  69186. tileHeight?: number;
  69187. size?: number;
  69188. width?: number;
  69189. height?: number;
  69190. alignHorizontal?: number;
  69191. alignVertical?: number;
  69192. sideOrientation?: number;
  69193. frontUVs?: Vector4;
  69194. backUVs?: Vector4;
  69195. updatable?: boolean;
  69196. }, scene?: Nullable<Scene>): Mesh;
  69197. }
  69198. }
  69199. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  69200. import { Nullable } from "babylonjs/types";
  69201. import { Scene } from "babylonjs/scene";
  69202. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69203. import { Mesh } from "babylonjs/Meshes/mesh";
  69204. /**
  69205. * Class containing static functions to help procedurally build meshes
  69206. */
  69207. export class TubeBuilder {
  69208. /**
  69209. * Creates a tube mesh.
  69210. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69211. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69212. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69213. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69214. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69215. * * 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)
  69216. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69217. * * 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
  69218. * * 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
  69219. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69220. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69221. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69222. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69223. * @param name defines the name of the mesh
  69224. * @param options defines the options used to create the mesh
  69225. * @param scene defines the hosting scene
  69226. * @returns the tube mesh
  69227. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69228. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69229. */
  69230. static CreateTube(name: string, options: {
  69231. path: Vector3[];
  69232. radius?: number;
  69233. tessellation?: number;
  69234. radiusFunction?: {
  69235. (i: number, distance: number): number;
  69236. };
  69237. cap?: number;
  69238. arc?: number;
  69239. updatable?: boolean;
  69240. sideOrientation?: number;
  69241. frontUVs?: Vector4;
  69242. backUVs?: Vector4;
  69243. instance?: Mesh;
  69244. invertUV?: boolean;
  69245. }, scene?: Nullable<Scene>): Mesh;
  69246. }
  69247. }
  69248. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69249. import { Scene } from "babylonjs/scene";
  69250. import { Vector4 } from "babylonjs/Maths/math.vector";
  69251. import { Mesh } from "babylonjs/Meshes/mesh";
  69252. import { Nullable } from "babylonjs/types";
  69253. /**
  69254. * Class containing static functions to help procedurally build meshes
  69255. */
  69256. export class IcoSphereBuilder {
  69257. /**
  69258. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69259. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69260. * * 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`)
  69261. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69262. * * 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
  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 icosahedron mesh
  69270. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69271. */
  69272. static CreateIcoSphere(name: string, options: {
  69273. radius?: number;
  69274. radiusX?: number;
  69275. radiusY?: number;
  69276. radiusZ?: number;
  69277. flat?: boolean;
  69278. subdivisions?: number;
  69279. sideOrientation?: number;
  69280. frontUVs?: Vector4;
  69281. backUVs?: Vector4;
  69282. updatable?: boolean;
  69283. }, scene?: Nullable<Scene>): Mesh;
  69284. }
  69285. }
  69286. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69287. import { Vector3 } from "babylonjs/Maths/math.vector";
  69288. import { Mesh } from "babylonjs/Meshes/mesh";
  69289. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69290. /**
  69291. * Class containing static functions to help procedurally build meshes
  69292. */
  69293. export class DecalBuilder {
  69294. /**
  69295. * Creates a decal mesh.
  69296. * 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
  69297. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69298. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69299. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69300. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69301. * @param name defines the name of the mesh
  69302. * @param sourceMesh defines the mesh where the decal must be applied
  69303. * @param options defines the options used to create the mesh
  69304. * @param scene defines the hosting scene
  69305. * @returns the decal mesh
  69306. * @see https://doc.babylonjs.com/how_to/decals
  69307. */
  69308. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69309. position?: Vector3;
  69310. normal?: Vector3;
  69311. size?: Vector3;
  69312. angle?: number;
  69313. }): Mesh;
  69314. }
  69315. }
  69316. declare module "babylonjs/Meshes/meshBuilder" {
  69317. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  69318. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69319. import { Nullable } from "babylonjs/types";
  69320. import { Scene } from "babylonjs/scene";
  69321. import { Mesh } from "babylonjs/Meshes/mesh";
  69322. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69323. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69324. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69325. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69326. import { Plane } from "babylonjs/Maths/math.plane";
  69327. /**
  69328. * Class containing static functions to help procedurally build meshes
  69329. */
  69330. export class MeshBuilder {
  69331. /**
  69332. * Creates a box mesh
  69333. * * The parameter `size` sets the size (float) of each box side (default 1)
  69334. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69335. * * 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)
  69336. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69337. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69338. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69339. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69340. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69341. * @param name defines the name of the mesh
  69342. * @param options defines the options used to create the mesh
  69343. * @param scene defines the hosting scene
  69344. * @returns the box mesh
  69345. */
  69346. static CreateBox(name: string, options: {
  69347. size?: number;
  69348. width?: number;
  69349. height?: number;
  69350. depth?: number;
  69351. faceUV?: Vector4[];
  69352. faceColors?: Color4[];
  69353. sideOrientation?: number;
  69354. frontUVs?: Vector4;
  69355. backUVs?: Vector4;
  69356. wrap?: boolean;
  69357. topBaseAt?: number;
  69358. bottomBaseAt?: number;
  69359. updatable?: boolean;
  69360. }, scene?: Nullable<Scene>): Mesh;
  69361. /**
  69362. * Creates a tiled box mesh
  69363. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69364. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69365. * @param name defines the name of the mesh
  69366. * @param options defines the options used to create the mesh
  69367. * @param scene defines the hosting scene
  69368. * @returns the tiled box mesh
  69369. */
  69370. static CreateTiledBox(name: string, options: {
  69371. pattern?: number;
  69372. size?: number;
  69373. width?: number;
  69374. height?: number;
  69375. depth: number;
  69376. tileSize?: number;
  69377. tileWidth?: number;
  69378. tileHeight?: number;
  69379. faceUV?: Vector4[];
  69380. faceColors?: Color4[];
  69381. alignHorizontal?: number;
  69382. alignVertical?: number;
  69383. sideOrientation?: number;
  69384. updatable?: boolean;
  69385. }, scene?: Nullable<Scene>): Mesh;
  69386. /**
  69387. * Creates a sphere mesh
  69388. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69389. * * 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`)
  69390. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69391. * * 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
  69392. * * 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)
  69393. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69394. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69395. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69396. * @param name defines the name of the mesh
  69397. * @param options defines the options used to create the mesh
  69398. * @param scene defines the hosting scene
  69399. * @returns the sphere mesh
  69400. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69401. */
  69402. static CreateSphere(name: string, options: {
  69403. segments?: number;
  69404. diameter?: number;
  69405. diameterX?: number;
  69406. diameterY?: number;
  69407. diameterZ?: number;
  69408. arc?: number;
  69409. slice?: number;
  69410. sideOrientation?: number;
  69411. frontUVs?: Vector4;
  69412. backUVs?: Vector4;
  69413. updatable?: boolean;
  69414. }, scene?: Nullable<Scene>): Mesh;
  69415. /**
  69416. * Creates a plane polygonal mesh. By default, this is a disc
  69417. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69418. * * 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
  69419. * * 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
  69420. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69421. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69422. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69423. * @param name defines the name of the mesh
  69424. * @param options defines the options used to create the mesh
  69425. * @param scene defines the hosting scene
  69426. * @returns the plane polygonal mesh
  69427. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69428. */
  69429. static CreateDisc(name: string, options: {
  69430. radius?: number;
  69431. tessellation?: number;
  69432. arc?: number;
  69433. updatable?: boolean;
  69434. sideOrientation?: number;
  69435. frontUVs?: Vector4;
  69436. backUVs?: Vector4;
  69437. }, scene?: Nullable<Scene>): Mesh;
  69438. /**
  69439. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69440. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69441. * * 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`)
  69442. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69443. * * 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
  69444. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69445. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69446. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69447. * @param name defines the name of the mesh
  69448. * @param options defines the options used to create the mesh
  69449. * @param scene defines the hosting scene
  69450. * @returns the icosahedron mesh
  69451. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69452. */
  69453. static CreateIcoSphere(name: string, options: {
  69454. radius?: number;
  69455. radiusX?: number;
  69456. radiusY?: number;
  69457. radiusZ?: number;
  69458. flat?: boolean;
  69459. subdivisions?: number;
  69460. sideOrientation?: number;
  69461. frontUVs?: Vector4;
  69462. backUVs?: Vector4;
  69463. updatable?: boolean;
  69464. }, scene?: Nullable<Scene>): Mesh;
  69465. /**
  69466. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69467. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69468. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69469. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69470. * * 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
  69471. * * 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
  69472. * * 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
  69473. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69474. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69475. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69476. * * 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
  69477. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69478. * * 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
  69479. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69480. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69481. * @param name defines the name of the mesh
  69482. * @param options defines the options used to create the mesh
  69483. * @param scene defines the hosting scene
  69484. * @returns the ribbon mesh
  69485. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69486. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69487. */
  69488. static CreateRibbon(name: string, options: {
  69489. pathArray: Vector3[][];
  69490. closeArray?: boolean;
  69491. closePath?: boolean;
  69492. offset?: number;
  69493. updatable?: boolean;
  69494. sideOrientation?: number;
  69495. frontUVs?: Vector4;
  69496. backUVs?: Vector4;
  69497. instance?: Mesh;
  69498. invertUV?: boolean;
  69499. uvs?: Vector2[];
  69500. colors?: Color4[];
  69501. }, scene?: Nullable<Scene>): Mesh;
  69502. /**
  69503. * Creates a cylinder or a cone mesh
  69504. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69505. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69506. * * 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.
  69507. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69508. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69509. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69510. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69511. * * 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).
  69512. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69513. * * 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).
  69514. * * 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
  69515. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69516. * * 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
  69517. * * 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.
  69518. * * If `enclose` is false, a ring surface is one element.
  69519. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69520. * * 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
  69521. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69522. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69523. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69524. * @param name defines the name of the mesh
  69525. * @param options defines the options used to create the mesh
  69526. * @param scene defines the hosting scene
  69527. * @returns the cylinder mesh
  69528. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69529. */
  69530. static CreateCylinder(name: string, options: {
  69531. height?: number;
  69532. diameterTop?: number;
  69533. diameterBottom?: number;
  69534. diameter?: number;
  69535. tessellation?: number;
  69536. subdivisions?: number;
  69537. arc?: number;
  69538. faceColors?: Color4[];
  69539. faceUV?: Vector4[];
  69540. updatable?: boolean;
  69541. hasRings?: boolean;
  69542. enclose?: boolean;
  69543. cap?: number;
  69544. sideOrientation?: number;
  69545. frontUVs?: Vector4;
  69546. backUVs?: Vector4;
  69547. }, scene?: Nullable<Scene>): Mesh;
  69548. /**
  69549. * Creates a torus mesh
  69550. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69551. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69552. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69553. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69554. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69555. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69556. * @param name defines the name of the mesh
  69557. * @param options defines the options used to create the mesh
  69558. * @param scene defines the hosting scene
  69559. * @returns the torus mesh
  69560. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69561. */
  69562. static CreateTorus(name: string, options: {
  69563. diameter?: number;
  69564. thickness?: number;
  69565. tessellation?: number;
  69566. updatable?: boolean;
  69567. sideOrientation?: number;
  69568. frontUVs?: Vector4;
  69569. backUVs?: Vector4;
  69570. }, scene?: Nullable<Scene>): Mesh;
  69571. /**
  69572. * Creates a torus knot mesh
  69573. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69574. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69575. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69576. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69577. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69578. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69579. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69580. * @param name defines the name of the mesh
  69581. * @param options defines the options used to create the mesh
  69582. * @param scene defines the hosting scene
  69583. * @returns the torus knot mesh
  69584. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69585. */
  69586. static CreateTorusKnot(name: string, options: {
  69587. radius?: number;
  69588. tube?: number;
  69589. radialSegments?: number;
  69590. tubularSegments?: number;
  69591. p?: number;
  69592. q?: number;
  69593. updatable?: boolean;
  69594. sideOrientation?: number;
  69595. frontUVs?: Vector4;
  69596. backUVs?: Vector4;
  69597. }, scene?: Nullable<Scene>): Mesh;
  69598. /**
  69599. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69600. * * 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
  69601. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69602. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69603. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69604. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69605. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69606. * * 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
  69607. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69608. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69609. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69610. * @param name defines the name of the new line system
  69611. * @param options defines the options used to create the line system
  69612. * @param scene defines the hosting scene
  69613. * @returns a new line system mesh
  69614. */
  69615. static CreateLineSystem(name: string, options: {
  69616. lines: Vector3[][];
  69617. updatable?: boolean;
  69618. instance?: Nullable<LinesMesh>;
  69619. colors?: Nullable<Color4[][]>;
  69620. useVertexAlpha?: boolean;
  69621. }, scene: Nullable<Scene>): LinesMesh;
  69622. /**
  69623. * Creates a line mesh
  69624. * 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
  69625. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69626. * * The parameter `points` is an array successive Vector3
  69627. * * 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
  69628. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69629. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69630. * * When updating an instance, remember that only point positions can change, not the number of points
  69631. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69632. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69633. * @param name defines the name of the new line system
  69634. * @param options defines the options used to create the line system
  69635. * @param scene defines the hosting scene
  69636. * @returns a new line mesh
  69637. */
  69638. static CreateLines(name: string, options: {
  69639. points: Vector3[];
  69640. updatable?: boolean;
  69641. instance?: Nullable<LinesMesh>;
  69642. colors?: Color4[];
  69643. useVertexAlpha?: boolean;
  69644. }, scene?: Nullable<Scene>): LinesMesh;
  69645. /**
  69646. * Creates a dashed line mesh
  69647. * * 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
  69648. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69649. * * The parameter `points` is an array successive Vector3
  69650. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69651. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69652. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69653. * * 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
  69654. * * When updating an instance, remember that only point positions can change, not the number of points
  69655. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69656. * @param name defines the name of the mesh
  69657. * @param options defines the options used to create the mesh
  69658. * @param scene defines the hosting scene
  69659. * @returns the dashed line mesh
  69660. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69661. */
  69662. static CreateDashedLines(name: string, options: {
  69663. points: Vector3[];
  69664. dashSize?: number;
  69665. gapSize?: number;
  69666. dashNb?: number;
  69667. updatable?: boolean;
  69668. instance?: LinesMesh;
  69669. }, scene?: Nullable<Scene>): LinesMesh;
  69670. /**
  69671. * 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.
  69672. * * 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.
  69673. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69674. * * 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.
  69675. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69676. * * 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
  69677. * * 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
  69678. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69679. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69680. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69681. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69683. * @param name defines the name of the mesh
  69684. * @param options defines the options used to create the mesh
  69685. * @param scene defines the hosting scene
  69686. * @returns the extruded shape mesh
  69687. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69688. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69689. */
  69690. static ExtrudeShape(name: string, options: {
  69691. shape: Vector3[];
  69692. path: Vector3[];
  69693. scale?: number;
  69694. rotation?: number;
  69695. cap?: number;
  69696. updatable?: boolean;
  69697. sideOrientation?: number;
  69698. frontUVs?: Vector4;
  69699. backUVs?: Vector4;
  69700. instance?: Mesh;
  69701. invertUV?: boolean;
  69702. }, scene?: Nullable<Scene>): Mesh;
  69703. /**
  69704. * Creates an custom extruded shape mesh.
  69705. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69706. * * 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.
  69707. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69708. * * 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
  69709. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69710. * * 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
  69711. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69712. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69713. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69714. * * 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
  69715. * * 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
  69716. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69717. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69718. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69719. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69720. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69721. * @param name defines the name of the mesh
  69722. * @param options defines the options used to create the mesh
  69723. * @param scene defines the hosting scene
  69724. * @returns the custom extruded shape mesh
  69725. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69726. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69727. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69728. */
  69729. static ExtrudeShapeCustom(name: string, options: {
  69730. shape: Vector3[];
  69731. path: Vector3[];
  69732. scaleFunction?: any;
  69733. rotationFunction?: any;
  69734. ribbonCloseArray?: boolean;
  69735. ribbonClosePath?: boolean;
  69736. cap?: number;
  69737. updatable?: boolean;
  69738. sideOrientation?: number;
  69739. frontUVs?: Vector4;
  69740. backUVs?: Vector4;
  69741. instance?: Mesh;
  69742. invertUV?: boolean;
  69743. }, scene?: Nullable<Scene>): Mesh;
  69744. /**
  69745. * Creates lathe mesh.
  69746. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69747. * * 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
  69748. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69749. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69750. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69751. * * 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
  69752. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69753. * * 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
  69754. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69755. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69756. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69757. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69758. * @param name defines the name of the mesh
  69759. * @param options defines the options used to create the mesh
  69760. * @param scene defines the hosting scene
  69761. * @returns the lathe mesh
  69762. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69763. */
  69764. static CreateLathe(name: string, options: {
  69765. shape: Vector3[];
  69766. radius?: number;
  69767. tessellation?: number;
  69768. clip?: number;
  69769. arc?: number;
  69770. closed?: boolean;
  69771. updatable?: boolean;
  69772. sideOrientation?: number;
  69773. frontUVs?: Vector4;
  69774. backUVs?: Vector4;
  69775. cap?: number;
  69776. invertUV?: boolean;
  69777. }, scene?: Nullable<Scene>): Mesh;
  69778. /**
  69779. * Creates a tiled plane mesh
  69780. * * You can set a limited pattern arrangement with the tiles
  69781. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69782. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69783. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69784. * @param name defines the name of the mesh
  69785. * @param options defines the options used to create the mesh
  69786. * @param scene defines the hosting scene
  69787. * @returns the plane mesh
  69788. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69789. */
  69790. static CreateTiledPlane(name: string, options: {
  69791. pattern?: number;
  69792. tileSize?: number;
  69793. tileWidth?: number;
  69794. tileHeight?: number;
  69795. size?: number;
  69796. width?: number;
  69797. height?: number;
  69798. alignHorizontal?: number;
  69799. alignVertical?: number;
  69800. sideOrientation?: number;
  69801. frontUVs?: Vector4;
  69802. backUVs?: Vector4;
  69803. updatable?: boolean;
  69804. }, scene?: Nullable<Scene>): Mesh;
  69805. /**
  69806. * Creates a plane mesh
  69807. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69808. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69809. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69810. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69811. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69812. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69813. * @param name defines the name of the mesh
  69814. * @param options defines the options used to create the mesh
  69815. * @param scene defines the hosting scene
  69816. * @returns the plane mesh
  69817. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69818. */
  69819. static CreatePlane(name: string, options: {
  69820. size?: number;
  69821. width?: number;
  69822. height?: number;
  69823. sideOrientation?: number;
  69824. frontUVs?: Vector4;
  69825. backUVs?: Vector4;
  69826. updatable?: boolean;
  69827. sourcePlane?: Plane;
  69828. }, scene?: Nullable<Scene>): Mesh;
  69829. /**
  69830. * Creates a ground mesh
  69831. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69832. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69833. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69834. * @param name defines the name of the mesh
  69835. * @param options defines the options used to create the mesh
  69836. * @param scene defines the hosting scene
  69837. * @returns the ground mesh
  69838. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69839. */
  69840. static CreateGround(name: string, options: {
  69841. width?: number;
  69842. height?: number;
  69843. subdivisions?: number;
  69844. subdivisionsX?: number;
  69845. subdivisionsY?: number;
  69846. updatable?: boolean;
  69847. }, scene?: Nullable<Scene>): Mesh;
  69848. /**
  69849. * Creates a tiled ground mesh
  69850. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69851. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69852. * * 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
  69853. * * 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
  69854. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69855. * @param name defines the name of the mesh
  69856. * @param options defines the options used to create the mesh
  69857. * @param scene defines the hosting scene
  69858. * @returns the tiled ground mesh
  69859. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69860. */
  69861. static CreateTiledGround(name: string, options: {
  69862. xmin: number;
  69863. zmin: number;
  69864. xmax: number;
  69865. zmax: number;
  69866. subdivisions?: {
  69867. w: number;
  69868. h: number;
  69869. };
  69870. precision?: {
  69871. w: number;
  69872. h: number;
  69873. };
  69874. updatable?: boolean;
  69875. }, scene?: Nullable<Scene>): Mesh;
  69876. /**
  69877. * Creates a ground mesh from a height map
  69878. * * The parameter `url` sets the URL of the height map image resource.
  69879. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69880. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69881. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69882. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69883. * * 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.
  69884. * * 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).
  69885. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69886. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69887. * @param name defines the name of the mesh
  69888. * @param url defines the url to the height map
  69889. * @param options defines the options used to create the mesh
  69890. * @param scene defines the hosting scene
  69891. * @returns the ground mesh
  69892. * @see https://doc.babylonjs.com/babylon101/height_map
  69893. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69894. */
  69895. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69896. width?: number;
  69897. height?: number;
  69898. subdivisions?: number;
  69899. minHeight?: number;
  69900. maxHeight?: number;
  69901. colorFilter?: Color3;
  69902. alphaFilter?: number;
  69903. updatable?: boolean;
  69904. onReady?: (mesh: GroundMesh) => void;
  69905. }, scene?: Nullable<Scene>): GroundMesh;
  69906. /**
  69907. * Creates a polygon mesh
  69908. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69909. * * 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
  69910. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69911. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69912. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69913. * * Remember you can only change the shape positions, not their number when updating a polygon
  69914. * @param name defines the name of the mesh
  69915. * @param options defines the options used to create the mesh
  69916. * @param scene defines the hosting scene
  69917. * @param earcutInjection can be used to inject your own earcut reference
  69918. * @returns the polygon mesh
  69919. */
  69920. static CreatePolygon(name: string, options: {
  69921. shape: Vector3[];
  69922. holes?: Vector3[][];
  69923. depth?: number;
  69924. faceUV?: Vector4[];
  69925. faceColors?: Color4[];
  69926. updatable?: boolean;
  69927. sideOrientation?: number;
  69928. frontUVs?: Vector4;
  69929. backUVs?: Vector4;
  69930. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69931. /**
  69932. * Creates an extruded polygon mesh, with depth in the Y direction.
  69933. * * 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)
  69934. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69935. * @param name defines the name of the mesh
  69936. * @param options defines the options used to create the mesh
  69937. * @param scene defines the hosting scene
  69938. * @param earcutInjection can be used to inject your own earcut reference
  69939. * @returns the polygon mesh
  69940. */
  69941. static ExtrudePolygon(name: string, options: {
  69942. shape: Vector3[];
  69943. holes?: Vector3[][];
  69944. depth?: number;
  69945. faceUV?: Vector4[];
  69946. faceColors?: Color4[];
  69947. updatable?: boolean;
  69948. sideOrientation?: number;
  69949. frontUVs?: Vector4;
  69950. backUVs?: Vector4;
  69951. wrap?: boolean;
  69952. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69953. /**
  69954. * Creates a tube mesh.
  69955. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69956. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69957. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69958. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69959. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69960. * * 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)
  69961. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69962. * * 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
  69963. * * 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
  69964. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69965. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69966. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69967. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69968. * @param name defines the name of the mesh
  69969. * @param options defines the options used to create the mesh
  69970. * @param scene defines the hosting scene
  69971. * @returns the tube mesh
  69972. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69973. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69974. */
  69975. static CreateTube(name: string, options: {
  69976. path: Vector3[];
  69977. radius?: number;
  69978. tessellation?: number;
  69979. radiusFunction?: {
  69980. (i: number, distance: number): number;
  69981. };
  69982. cap?: number;
  69983. arc?: number;
  69984. updatable?: boolean;
  69985. sideOrientation?: number;
  69986. frontUVs?: Vector4;
  69987. backUVs?: Vector4;
  69988. instance?: Mesh;
  69989. invertUV?: boolean;
  69990. }, scene?: Nullable<Scene>): Mesh;
  69991. /**
  69992. * Creates a polyhedron mesh
  69993. * * 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
  69994. * * The parameter `size` (positive float, default 1) sets the polygon size
  69995. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69996. * * 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`
  69997. * * 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
  69998. * * 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)`)
  69999. * * 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
  70000. * * 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
  70001. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70002. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70003. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70004. * @param name defines the name of the mesh
  70005. * @param options defines the options used to create the mesh
  70006. * @param scene defines the hosting scene
  70007. * @returns the polyhedron mesh
  70008. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  70009. */
  70010. static CreatePolyhedron(name: string, options: {
  70011. type?: number;
  70012. size?: number;
  70013. sizeX?: number;
  70014. sizeY?: number;
  70015. sizeZ?: number;
  70016. custom?: any;
  70017. faceUV?: Vector4[];
  70018. faceColors?: Color4[];
  70019. flat?: boolean;
  70020. updatable?: boolean;
  70021. sideOrientation?: number;
  70022. frontUVs?: Vector4;
  70023. backUVs?: Vector4;
  70024. }, scene?: Nullable<Scene>): Mesh;
  70025. /**
  70026. * Creates a decal mesh.
  70027. * 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
  70028. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  70029. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  70030. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  70031. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  70032. * @param name defines the name of the mesh
  70033. * @param sourceMesh defines the mesh where the decal must be applied
  70034. * @param options defines the options used to create the mesh
  70035. * @param scene defines the hosting scene
  70036. * @returns the decal mesh
  70037. * @see https://doc.babylonjs.com/how_to/decals
  70038. */
  70039. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  70040. position?: Vector3;
  70041. normal?: Vector3;
  70042. size?: Vector3;
  70043. angle?: number;
  70044. }): Mesh;
  70045. /**
  70046. * Creates a Capsule Mesh
  70047. * @param name defines the name of the mesh.
  70048. * @param options the constructors options used to shape the mesh.
  70049. * @param scene defines the scene the mesh is scoped to.
  70050. * @returns the capsule mesh
  70051. * @see https://doc.babylonjs.com/how_to/capsule_shape
  70052. */
  70053. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  70054. }
  70055. }
  70056. declare module "babylonjs/Meshes/meshSimplification" {
  70057. import { Mesh } from "babylonjs/Meshes/mesh";
  70058. /**
  70059. * A simplifier interface for future simplification implementations
  70060. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70061. */
  70062. export interface ISimplifier {
  70063. /**
  70064. * Simplification of a given mesh according to the given settings.
  70065. * Since this requires computation, it is assumed that the function runs async.
  70066. * @param settings The settings of the simplification, including quality and distance
  70067. * @param successCallback A callback that will be called after the mesh was simplified.
  70068. * @param errorCallback in case of an error, this callback will be called. optional.
  70069. */
  70070. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  70071. }
  70072. /**
  70073. * Expected simplification settings.
  70074. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  70075. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70076. */
  70077. export interface ISimplificationSettings {
  70078. /**
  70079. * Gets or sets the expected quality
  70080. */
  70081. quality: number;
  70082. /**
  70083. * Gets or sets the distance when this optimized version should be used
  70084. */
  70085. distance: number;
  70086. /**
  70087. * Gets an already optimized mesh
  70088. */
  70089. optimizeMesh?: boolean;
  70090. }
  70091. /**
  70092. * Class used to specify simplification options
  70093. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70094. */
  70095. export class SimplificationSettings implements ISimplificationSettings {
  70096. /** expected quality */
  70097. quality: number;
  70098. /** distance when this optimized version should be used */
  70099. distance: number;
  70100. /** already optimized mesh */
  70101. optimizeMesh?: boolean | undefined;
  70102. /**
  70103. * Creates a SimplificationSettings
  70104. * @param quality expected quality
  70105. * @param distance distance when this optimized version should be used
  70106. * @param optimizeMesh already optimized mesh
  70107. */
  70108. constructor(
  70109. /** expected quality */
  70110. quality: number,
  70111. /** distance when this optimized version should be used */
  70112. distance: number,
  70113. /** already optimized mesh */
  70114. optimizeMesh?: boolean | undefined);
  70115. }
  70116. /**
  70117. * Interface used to define a simplification task
  70118. */
  70119. export interface ISimplificationTask {
  70120. /**
  70121. * Array of settings
  70122. */
  70123. settings: Array<ISimplificationSettings>;
  70124. /**
  70125. * Simplification type
  70126. */
  70127. simplificationType: SimplificationType;
  70128. /**
  70129. * Mesh to simplify
  70130. */
  70131. mesh: Mesh;
  70132. /**
  70133. * Callback called on success
  70134. */
  70135. successCallback?: () => void;
  70136. /**
  70137. * Defines if parallel processing can be used
  70138. */
  70139. parallelProcessing: boolean;
  70140. }
  70141. /**
  70142. * Queue used to order the simplification tasks
  70143. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70144. */
  70145. export class SimplificationQueue {
  70146. private _simplificationArray;
  70147. /**
  70148. * Gets a boolean indicating that the process is still running
  70149. */
  70150. running: boolean;
  70151. /**
  70152. * Creates a new queue
  70153. */
  70154. constructor();
  70155. /**
  70156. * Adds a new simplification task
  70157. * @param task defines a task to add
  70158. */
  70159. addTask(task: ISimplificationTask): void;
  70160. /**
  70161. * Execute next task
  70162. */
  70163. executeNext(): void;
  70164. /**
  70165. * Execute a simplification task
  70166. * @param task defines the task to run
  70167. */
  70168. runSimplification(task: ISimplificationTask): void;
  70169. private getSimplifier;
  70170. }
  70171. /**
  70172. * The implemented types of simplification
  70173. * At the moment only Quadratic Error Decimation is implemented
  70174. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70175. */
  70176. export enum SimplificationType {
  70177. /** Quadratic error decimation */
  70178. QUADRATIC = 0
  70179. }
  70180. /**
  70181. * An implementation of the Quadratic Error simplification algorithm.
  70182. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  70183. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  70184. * @author RaananW
  70185. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70186. */
  70187. export class QuadraticErrorSimplification implements ISimplifier {
  70188. private _mesh;
  70189. private triangles;
  70190. private vertices;
  70191. private references;
  70192. private _reconstructedMesh;
  70193. /** Gets or sets the number pf sync interations */
  70194. syncIterations: number;
  70195. /** Gets or sets the aggressiveness of the simplifier */
  70196. aggressiveness: number;
  70197. /** Gets or sets the number of allowed iterations for decimation */
  70198. decimationIterations: number;
  70199. /** Gets or sets the espilon to use for bounding box computation */
  70200. boundingBoxEpsilon: number;
  70201. /**
  70202. * Creates a new QuadraticErrorSimplification
  70203. * @param _mesh defines the target mesh
  70204. */
  70205. constructor(_mesh: Mesh);
  70206. /**
  70207. * Simplification of a given mesh according to the given settings.
  70208. * Since this requires computation, it is assumed that the function runs async.
  70209. * @param settings The settings of the simplification, including quality and distance
  70210. * @param successCallback A callback that will be called after the mesh was simplified.
  70211. */
  70212. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  70213. private runDecimation;
  70214. private initWithMesh;
  70215. private init;
  70216. private reconstructMesh;
  70217. private initDecimatedMesh;
  70218. private isFlipped;
  70219. private updateTriangles;
  70220. private identifyBorder;
  70221. private updateMesh;
  70222. private vertexError;
  70223. private calculateError;
  70224. }
  70225. }
  70226. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  70227. import { Scene } from "babylonjs/scene";
  70228. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  70229. import { ISceneComponent } from "babylonjs/sceneComponent";
  70230. module "babylonjs/scene" {
  70231. interface Scene {
  70232. /** @hidden (Backing field) */
  70233. _simplificationQueue: SimplificationQueue;
  70234. /**
  70235. * Gets or sets the simplification queue attached to the scene
  70236. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70237. */
  70238. simplificationQueue: SimplificationQueue;
  70239. }
  70240. }
  70241. module "babylonjs/Meshes/mesh" {
  70242. interface Mesh {
  70243. /**
  70244. * Simplify the mesh according to the given array of settings.
  70245. * Function will return immediately and will simplify async
  70246. * @param settings a collection of simplification settings
  70247. * @param parallelProcessing should all levels calculate parallel or one after the other
  70248. * @param simplificationType the type of simplification to run
  70249. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70250. * @returns the current mesh
  70251. */
  70252. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70253. }
  70254. }
  70255. /**
  70256. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70257. * created in a scene
  70258. */
  70259. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70260. /**
  70261. * The component name helpfull to identify the component in the list of scene components.
  70262. */
  70263. readonly name: string;
  70264. /**
  70265. * The scene the component belongs to.
  70266. */
  70267. scene: Scene;
  70268. /**
  70269. * Creates a new instance of the component for the given scene
  70270. * @param scene Defines the scene to register the component in
  70271. */
  70272. constructor(scene: Scene);
  70273. /**
  70274. * Registers the component in a given scene
  70275. */
  70276. register(): void;
  70277. /**
  70278. * Rebuilds the elements related to this component in case of
  70279. * context lost for instance.
  70280. */
  70281. rebuild(): void;
  70282. /**
  70283. * Disposes the component and the associated ressources
  70284. */
  70285. dispose(): void;
  70286. private _beforeCameraUpdate;
  70287. }
  70288. }
  70289. declare module "babylonjs/Meshes/Builders/index" {
  70290. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70291. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70292. export * from "babylonjs/Meshes/Builders/discBuilder";
  70293. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70294. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70295. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70296. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70297. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70298. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70299. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70300. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70301. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70302. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70303. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70304. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70305. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70306. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70307. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70308. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70309. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70310. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70311. export * from "babylonjs/Meshes/Builders/capsuleBuilder";
  70312. }
  70313. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70314. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70315. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70316. import { Matrix } from "babylonjs/Maths/math.vector";
  70317. module "babylonjs/Meshes/mesh" {
  70318. interface Mesh {
  70319. /**
  70320. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70321. */
  70322. thinInstanceEnablePicking: boolean;
  70323. /**
  70324. * Creates a new thin instance
  70325. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70326. * @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
  70327. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70328. */
  70329. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70330. /**
  70331. * Adds the transformation (matrix) of the current mesh as a thin instance
  70332. * @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
  70333. * @returns the thin instance index number
  70334. */
  70335. thinInstanceAddSelf(refresh: boolean): number;
  70336. /**
  70337. * Registers a custom attribute to be used with thin instances
  70338. * @param kind name of the attribute
  70339. * @param stride size in floats of the attribute
  70340. */
  70341. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70342. /**
  70343. * Sets the matrix of a thin instance
  70344. * @param index index of the thin instance
  70345. * @param matrix matrix to set
  70346. * @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
  70347. */
  70348. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70349. /**
  70350. * Sets the value of a custom attribute for a thin instance
  70351. * @param kind name of the attribute
  70352. * @param index index of the thin instance
  70353. * @param value value to set
  70354. * @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
  70355. */
  70356. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70357. /**
  70358. * 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.
  70359. */
  70360. thinInstanceCount: number;
  70361. /**
  70362. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70363. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70364. * @param buffer buffer to set
  70365. * @param stride size in floats of each value of the buffer
  70366. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70367. */
  70368. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70369. /**
  70370. * Gets the list of world matrices
  70371. * @return an array containing all the world matrices from the thin instances
  70372. */
  70373. thinInstanceGetWorldMatrices(): Matrix[];
  70374. /**
  70375. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70376. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70377. */
  70378. thinInstanceBufferUpdated(kind: string): void;
  70379. /**
  70380. * Applies a partial update to a buffer directly on the GPU
  70381. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  70382. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70383. * @param data the data to set in the GPU buffer
  70384. * @param offset the offset in the GPU buffer where to update the data
  70385. */
  70386. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  70387. /**
  70388. * Refreshes the bounding info, taking into account all the thin instances defined
  70389. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70390. */
  70391. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70392. /** @hidden */
  70393. _thinInstanceInitializeUserStorage(): void;
  70394. /** @hidden */
  70395. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70396. /** @hidden */
  70397. _userThinInstanceBuffersStorage: {
  70398. data: {
  70399. [key: string]: Float32Array;
  70400. };
  70401. sizes: {
  70402. [key: string]: number;
  70403. };
  70404. vertexBuffers: {
  70405. [key: string]: Nullable<VertexBuffer>;
  70406. };
  70407. strides: {
  70408. [key: string]: number;
  70409. };
  70410. };
  70411. }
  70412. }
  70413. }
  70414. declare module "babylonjs/Meshes/index" {
  70415. export * from "babylonjs/Meshes/abstractMesh";
  70416. export * from "babylonjs/Meshes/buffer";
  70417. export * from "babylonjs/Meshes/Compression/index";
  70418. export * from "babylonjs/Meshes/csg";
  70419. export * from "babylonjs/Meshes/geometry";
  70420. export * from "babylonjs/Meshes/groundMesh";
  70421. export * from "babylonjs/Meshes/trailMesh";
  70422. export * from "babylonjs/Meshes/instancedMesh";
  70423. export * from "babylonjs/Meshes/linesMesh";
  70424. export * from "babylonjs/Meshes/mesh";
  70425. export * from "babylonjs/Meshes/mesh.vertexData";
  70426. export * from "babylonjs/Meshes/meshBuilder";
  70427. export * from "babylonjs/Meshes/meshSimplification";
  70428. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70429. export * from "babylonjs/Meshes/polygonMesh";
  70430. export * from "babylonjs/Meshes/subMesh";
  70431. export * from "babylonjs/Meshes/meshLODLevel";
  70432. export * from "babylonjs/Meshes/transformNode";
  70433. export * from "babylonjs/Meshes/Builders/index";
  70434. export * from "babylonjs/Meshes/dataBuffer";
  70435. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70436. import "babylonjs/Meshes/thinInstanceMesh";
  70437. export * from "babylonjs/Meshes/thinInstanceMesh";
  70438. }
  70439. declare module "babylonjs/Morph/index" {
  70440. export * from "babylonjs/Morph/morphTarget";
  70441. export * from "babylonjs/Morph/morphTargetManager";
  70442. }
  70443. declare module "babylonjs/Navigation/INavigationEngine" {
  70444. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70445. import { Vector3 } from "babylonjs/Maths/math";
  70446. import { Mesh } from "babylonjs/Meshes/mesh";
  70447. import { Scene } from "babylonjs/scene";
  70448. /**
  70449. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70450. */
  70451. export interface INavigationEnginePlugin {
  70452. /**
  70453. * plugin name
  70454. */
  70455. name: string;
  70456. /**
  70457. * Creates a navigation mesh
  70458. * @param meshes array of all the geometry used to compute the navigatio mesh
  70459. * @param parameters bunch of parameters used to filter geometry
  70460. */
  70461. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70462. /**
  70463. * Create a navigation mesh debug mesh
  70464. * @param scene is where the mesh will be added
  70465. * @returns debug display mesh
  70466. */
  70467. createDebugNavMesh(scene: Scene): Mesh;
  70468. /**
  70469. * Get a navigation mesh constrained position, closest to the parameter position
  70470. * @param position world position
  70471. * @returns the closest point to position constrained by the navigation mesh
  70472. */
  70473. getClosestPoint(position: Vector3): Vector3;
  70474. /**
  70475. * Get a navigation mesh constrained position, closest to the parameter position
  70476. * @param position world position
  70477. * @param result output the closest point to position constrained by the navigation mesh
  70478. */
  70479. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70480. /**
  70481. * Get a navigation mesh constrained position, within a particular radius
  70482. * @param position world position
  70483. * @param maxRadius the maximum distance to the constrained world position
  70484. * @returns the closest point to position constrained by the navigation mesh
  70485. */
  70486. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70487. /**
  70488. * Get a navigation mesh constrained position, within a particular radius
  70489. * @param position world position
  70490. * @param maxRadius the maximum distance to the constrained world position
  70491. * @param result output the closest point to position constrained by the navigation mesh
  70492. */
  70493. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70494. /**
  70495. * Compute the final position from a segment made of destination-position
  70496. * @param position world position
  70497. * @param destination world position
  70498. * @returns the resulting point along the navmesh
  70499. */
  70500. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70501. /**
  70502. * Compute the final position from a segment made of destination-position
  70503. * @param position world position
  70504. * @param destination world position
  70505. * @param result output the resulting point along the navmesh
  70506. */
  70507. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70508. /**
  70509. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70510. * @param start world position
  70511. * @param end world position
  70512. * @returns array containing world position composing the path
  70513. */
  70514. computePath(start: Vector3, end: Vector3): Vector3[];
  70515. /**
  70516. * If this plugin is supported
  70517. * @returns true if plugin is supported
  70518. */
  70519. isSupported(): boolean;
  70520. /**
  70521. * Create a new Crowd so you can add agents
  70522. * @param maxAgents the maximum agent count in the crowd
  70523. * @param maxAgentRadius the maximum radius an agent can have
  70524. * @param scene to attach the crowd to
  70525. * @returns the crowd you can add agents to
  70526. */
  70527. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70528. /**
  70529. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70530. * The queries will try to find a solution within those bounds
  70531. * default is (1,1,1)
  70532. * @param extent x,y,z value that define the extent around the queries point of reference
  70533. */
  70534. setDefaultQueryExtent(extent: Vector3): void;
  70535. /**
  70536. * Get the Bounding box extent specified by setDefaultQueryExtent
  70537. * @returns the box extent values
  70538. */
  70539. getDefaultQueryExtent(): Vector3;
  70540. /**
  70541. * build the navmesh from a previously saved state using getNavmeshData
  70542. * @param data the Uint8Array returned by getNavmeshData
  70543. */
  70544. buildFromNavmeshData(data: Uint8Array): void;
  70545. /**
  70546. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70547. * @returns data the Uint8Array that can be saved and reused
  70548. */
  70549. getNavmeshData(): Uint8Array;
  70550. /**
  70551. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70552. * @param result output the box extent values
  70553. */
  70554. getDefaultQueryExtentToRef(result: Vector3): void;
  70555. /**
  70556. * Release all resources
  70557. */
  70558. dispose(): void;
  70559. }
  70560. /**
  70561. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70562. */
  70563. export interface ICrowd {
  70564. /**
  70565. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70566. * You can attach anything to that node. The node position is updated in the scene update tick.
  70567. * @param pos world position that will be constrained by the navigation mesh
  70568. * @param parameters agent parameters
  70569. * @param transform hooked to the agent that will be update by the scene
  70570. * @returns agent index
  70571. */
  70572. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70573. /**
  70574. * Returns the agent position in world space
  70575. * @param index agent index returned by addAgent
  70576. * @returns world space position
  70577. */
  70578. getAgentPosition(index: number): Vector3;
  70579. /**
  70580. * Gets the agent position result in world space
  70581. * @param index agent index returned by addAgent
  70582. * @param result output world space position
  70583. */
  70584. getAgentPositionToRef(index: number, result: Vector3): void;
  70585. /**
  70586. * Gets the agent velocity in world space
  70587. * @param index agent index returned by addAgent
  70588. * @returns world space velocity
  70589. */
  70590. getAgentVelocity(index: number): Vector3;
  70591. /**
  70592. * Gets the agent velocity result in world space
  70593. * @param index agent index returned by addAgent
  70594. * @param result output world space velocity
  70595. */
  70596. getAgentVelocityToRef(index: number, result: Vector3): void;
  70597. /**
  70598. * remove a particular agent previously created
  70599. * @param index agent index returned by addAgent
  70600. */
  70601. removeAgent(index: number): void;
  70602. /**
  70603. * get the list of all agents attached to this crowd
  70604. * @returns list of agent indices
  70605. */
  70606. getAgents(): number[];
  70607. /**
  70608. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70609. * @param deltaTime in seconds
  70610. */
  70611. update(deltaTime: number): void;
  70612. /**
  70613. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70614. * @param index agent index returned by addAgent
  70615. * @param destination targeted world position
  70616. */
  70617. agentGoto(index: number, destination: Vector3): void;
  70618. /**
  70619. * Teleport the agent to a new position
  70620. * @param index agent index returned by addAgent
  70621. * @param destination targeted world position
  70622. */
  70623. agentTeleport(index: number, destination: Vector3): void;
  70624. /**
  70625. * Update agent parameters
  70626. * @param index agent index returned by addAgent
  70627. * @param parameters agent parameters
  70628. */
  70629. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70630. /**
  70631. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70632. * The queries will try to find a solution within those bounds
  70633. * default is (1,1,1)
  70634. * @param extent x,y,z value that define the extent around the queries point of reference
  70635. */
  70636. setDefaultQueryExtent(extent: Vector3): void;
  70637. /**
  70638. * Get the Bounding box extent specified by setDefaultQueryExtent
  70639. * @returns the box extent values
  70640. */
  70641. getDefaultQueryExtent(): Vector3;
  70642. /**
  70643. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70644. * @param result output the box extent values
  70645. */
  70646. getDefaultQueryExtentToRef(result: Vector3): void;
  70647. /**
  70648. * Release all resources
  70649. */
  70650. dispose(): void;
  70651. }
  70652. /**
  70653. * Configures an agent
  70654. */
  70655. export interface IAgentParameters {
  70656. /**
  70657. * Agent radius. [Limit: >= 0]
  70658. */
  70659. radius: number;
  70660. /**
  70661. * Agent height. [Limit: > 0]
  70662. */
  70663. height: number;
  70664. /**
  70665. * Maximum allowed acceleration. [Limit: >= 0]
  70666. */
  70667. maxAcceleration: number;
  70668. /**
  70669. * Maximum allowed speed. [Limit: >= 0]
  70670. */
  70671. maxSpeed: number;
  70672. /**
  70673. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70674. */
  70675. collisionQueryRange: number;
  70676. /**
  70677. * The path visibility optimization range. [Limit: > 0]
  70678. */
  70679. pathOptimizationRange: number;
  70680. /**
  70681. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70682. */
  70683. separationWeight: number;
  70684. }
  70685. /**
  70686. * Configures the navigation mesh creation
  70687. */
  70688. export interface INavMeshParameters {
  70689. /**
  70690. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70691. */
  70692. cs: number;
  70693. /**
  70694. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70695. */
  70696. ch: number;
  70697. /**
  70698. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70699. */
  70700. walkableSlopeAngle: number;
  70701. /**
  70702. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70703. * be considered walkable. [Limit: >= 3] [Units: vx]
  70704. */
  70705. walkableHeight: number;
  70706. /**
  70707. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70708. */
  70709. walkableClimb: number;
  70710. /**
  70711. * The distance to erode/shrink the walkable area of the heightfield away from
  70712. * obstructions. [Limit: >=0] [Units: vx]
  70713. */
  70714. walkableRadius: number;
  70715. /**
  70716. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70717. */
  70718. maxEdgeLen: number;
  70719. /**
  70720. * The maximum distance a simplfied contour's border edges should deviate
  70721. * the original raw contour. [Limit: >=0] [Units: vx]
  70722. */
  70723. maxSimplificationError: number;
  70724. /**
  70725. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70726. */
  70727. minRegionArea: number;
  70728. /**
  70729. * Any regions with a span count smaller than this value will, if possible,
  70730. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70731. */
  70732. mergeRegionArea: number;
  70733. /**
  70734. * The maximum number of vertices allowed for polygons generated during the
  70735. * contour to polygon conversion process. [Limit: >= 3]
  70736. */
  70737. maxVertsPerPoly: number;
  70738. /**
  70739. * Sets the sampling distance to use when generating the detail mesh.
  70740. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70741. */
  70742. detailSampleDist: number;
  70743. /**
  70744. * The maximum distance the detail mesh surface should deviate from heightfield
  70745. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70746. */
  70747. detailSampleMaxError: number;
  70748. }
  70749. }
  70750. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70751. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70752. import { Mesh } from "babylonjs/Meshes/mesh";
  70753. import { Scene } from "babylonjs/scene";
  70754. import { Vector3 } from "babylonjs/Maths/math";
  70755. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70756. /**
  70757. * RecastJS navigation plugin
  70758. */
  70759. export class RecastJSPlugin implements INavigationEnginePlugin {
  70760. /**
  70761. * Reference to the Recast library
  70762. */
  70763. bjsRECAST: any;
  70764. /**
  70765. * plugin name
  70766. */
  70767. name: string;
  70768. /**
  70769. * the first navmesh created. We might extend this to support multiple navmeshes
  70770. */
  70771. navMesh: any;
  70772. /**
  70773. * Initializes the recastJS plugin
  70774. * @param recastInjection can be used to inject your own recast reference
  70775. */
  70776. constructor(recastInjection?: any);
  70777. /**
  70778. * Creates a navigation mesh
  70779. * @param meshes array of all the geometry used to compute the navigatio mesh
  70780. * @param parameters bunch of parameters used to filter geometry
  70781. */
  70782. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70783. /**
  70784. * Create a navigation mesh debug mesh
  70785. * @param scene is where the mesh will be added
  70786. * @returns debug display mesh
  70787. */
  70788. createDebugNavMesh(scene: Scene): Mesh;
  70789. /**
  70790. * Get a navigation mesh constrained position, closest to the parameter position
  70791. * @param position world position
  70792. * @returns the closest point to position constrained by the navigation mesh
  70793. */
  70794. getClosestPoint(position: Vector3): Vector3;
  70795. /**
  70796. * Get a navigation mesh constrained position, closest to the parameter position
  70797. * @param position world position
  70798. * @param result output the closest point to position constrained by the navigation mesh
  70799. */
  70800. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70801. /**
  70802. * Get a navigation mesh constrained position, within a particular radius
  70803. * @param position world position
  70804. * @param maxRadius the maximum distance to the constrained world position
  70805. * @returns the closest point to position constrained by the navigation mesh
  70806. */
  70807. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70808. /**
  70809. * Get a navigation mesh constrained position, within a particular radius
  70810. * @param position world position
  70811. * @param maxRadius the maximum distance to the constrained world position
  70812. * @param result output the closest point to position constrained by the navigation mesh
  70813. */
  70814. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70815. /**
  70816. * Compute the final position from a segment made of destination-position
  70817. * @param position world position
  70818. * @param destination world position
  70819. * @returns the resulting point along the navmesh
  70820. */
  70821. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70822. /**
  70823. * Compute the final position from a segment made of destination-position
  70824. * @param position world position
  70825. * @param destination world position
  70826. * @param result output the resulting point along the navmesh
  70827. */
  70828. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70829. /**
  70830. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70831. * @param start world position
  70832. * @param end world position
  70833. * @returns array containing world position composing the path
  70834. */
  70835. computePath(start: Vector3, end: Vector3): Vector3[];
  70836. /**
  70837. * Create a new Crowd so you can add agents
  70838. * @param maxAgents the maximum agent count in the crowd
  70839. * @param maxAgentRadius the maximum radius an agent can have
  70840. * @param scene to attach the crowd to
  70841. * @returns the crowd you can add agents to
  70842. */
  70843. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70844. /**
  70845. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70846. * The queries will try to find a solution within those bounds
  70847. * default is (1,1,1)
  70848. * @param extent x,y,z value that define the extent around the queries point of reference
  70849. */
  70850. setDefaultQueryExtent(extent: Vector3): void;
  70851. /**
  70852. * Get the Bounding box extent specified by setDefaultQueryExtent
  70853. * @returns the box extent values
  70854. */
  70855. getDefaultQueryExtent(): Vector3;
  70856. /**
  70857. * build the navmesh from a previously saved state using getNavmeshData
  70858. * @param data the Uint8Array returned by getNavmeshData
  70859. */
  70860. buildFromNavmeshData(data: Uint8Array): void;
  70861. /**
  70862. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70863. * @returns data the Uint8Array that can be saved and reused
  70864. */
  70865. getNavmeshData(): Uint8Array;
  70866. /**
  70867. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70868. * @param result output the box extent values
  70869. */
  70870. getDefaultQueryExtentToRef(result: Vector3): void;
  70871. /**
  70872. * Disposes
  70873. */
  70874. dispose(): void;
  70875. /**
  70876. * If this plugin is supported
  70877. * @returns true if plugin is supported
  70878. */
  70879. isSupported(): boolean;
  70880. }
  70881. /**
  70882. * Recast detour crowd implementation
  70883. */
  70884. export class RecastJSCrowd implements ICrowd {
  70885. /**
  70886. * Recast/detour plugin
  70887. */
  70888. bjsRECASTPlugin: RecastJSPlugin;
  70889. /**
  70890. * Link to the detour crowd
  70891. */
  70892. recastCrowd: any;
  70893. /**
  70894. * One transform per agent
  70895. */
  70896. transforms: TransformNode[];
  70897. /**
  70898. * All agents created
  70899. */
  70900. agents: number[];
  70901. /**
  70902. * Link to the scene is kept to unregister the crowd from the scene
  70903. */
  70904. private _scene;
  70905. /**
  70906. * Observer for crowd updates
  70907. */
  70908. private _onBeforeAnimationsObserver;
  70909. /**
  70910. * Constructor
  70911. * @param plugin recastJS plugin
  70912. * @param maxAgents the maximum agent count in the crowd
  70913. * @param maxAgentRadius the maximum radius an agent can have
  70914. * @param scene to attach the crowd to
  70915. * @returns the crowd you can add agents to
  70916. */
  70917. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70918. /**
  70919. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70920. * You can attach anything to that node. The node position is updated in the scene update tick.
  70921. * @param pos world position that will be constrained by the navigation mesh
  70922. * @param parameters agent parameters
  70923. * @param transform hooked to the agent that will be update by the scene
  70924. * @returns agent index
  70925. */
  70926. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70927. /**
  70928. * Returns the agent position in world space
  70929. * @param index agent index returned by addAgent
  70930. * @returns world space position
  70931. */
  70932. getAgentPosition(index: number): Vector3;
  70933. /**
  70934. * Returns the agent position result in world space
  70935. * @param index agent index returned by addAgent
  70936. * @param result output world space position
  70937. */
  70938. getAgentPositionToRef(index: number, result: Vector3): void;
  70939. /**
  70940. * Returns the agent velocity in world space
  70941. * @param index agent index returned by addAgent
  70942. * @returns world space velocity
  70943. */
  70944. getAgentVelocity(index: number): Vector3;
  70945. /**
  70946. * Returns the agent velocity result in world space
  70947. * @param index agent index returned by addAgent
  70948. * @param result output world space velocity
  70949. */
  70950. getAgentVelocityToRef(index: number, result: Vector3): void;
  70951. /**
  70952. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70953. * @param index agent index returned by addAgent
  70954. * @param destination targeted world position
  70955. */
  70956. agentGoto(index: number, destination: Vector3): void;
  70957. /**
  70958. * Teleport the agent to a new position
  70959. * @param index agent index returned by addAgent
  70960. * @param destination targeted world position
  70961. */
  70962. agentTeleport(index: number, destination: Vector3): void;
  70963. /**
  70964. * Update agent parameters
  70965. * @param index agent index returned by addAgent
  70966. * @param parameters agent parameters
  70967. */
  70968. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70969. /**
  70970. * remove a particular agent previously created
  70971. * @param index agent index returned by addAgent
  70972. */
  70973. removeAgent(index: number): void;
  70974. /**
  70975. * get the list of all agents attached to this crowd
  70976. * @returns list of agent indices
  70977. */
  70978. getAgents(): number[];
  70979. /**
  70980. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70981. * @param deltaTime in seconds
  70982. */
  70983. update(deltaTime: number): void;
  70984. /**
  70985. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70986. * The queries will try to find a solution within those bounds
  70987. * default is (1,1,1)
  70988. * @param extent x,y,z value that define the extent around the queries point of reference
  70989. */
  70990. setDefaultQueryExtent(extent: Vector3): void;
  70991. /**
  70992. * Get the Bounding box extent specified by setDefaultQueryExtent
  70993. * @returns the box extent values
  70994. */
  70995. getDefaultQueryExtent(): Vector3;
  70996. /**
  70997. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70998. * @param result output the box extent values
  70999. */
  71000. getDefaultQueryExtentToRef(result: Vector3): void;
  71001. /**
  71002. * Release all resources
  71003. */
  71004. dispose(): void;
  71005. }
  71006. }
  71007. declare module "babylonjs/Navigation/Plugins/index" {
  71008. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  71009. }
  71010. declare module "babylonjs/Navigation/index" {
  71011. export * from "babylonjs/Navigation/INavigationEngine";
  71012. export * from "babylonjs/Navigation/Plugins/index";
  71013. }
  71014. declare module "babylonjs/Offline/database" {
  71015. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  71016. /**
  71017. * Class used to enable access to IndexedDB
  71018. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  71019. */
  71020. export class Database implements IOfflineProvider {
  71021. private _callbackManifestChecked;
  71022. private _currentSceneUrl;
  71023. private _db;
  71024. private _enableSceneOffline;
  71025. private _enableTexturesOffline;
  71026. private _manifestVersionFound;
  71027. private _mustUpdateRessources;
  71028. private _hasReachedQuota;
  71029. private _isSupported;
  71030. private _idbFactory;
  71031. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  71032. private static IsUASupportingBlobStorage;
  71033. /**
  71034. * Gets a boolean indicating if Database storate is enabled (off by default)
  71035. */
  71036. static IDBStorageEnabled: boolean;
  71037. /**
  71038. * Gets a boolean indicating if scene must be saved in the database
  71039. */
  71040. get enableSceneOffline(): boolean;
  71041. /**
  71042. * Gets a boolean indicating if textures must be saved in the database
  71043. */
  71044. get enableTexturesOffline(): boolean;
  71045. /**
  71046. * Creates a new Database
  71047. * @param urlToScene defines the url to load the scene
  71048. * @param callbackManifestChecked defines the callback to use when manifest is checked
  71049. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  71050. */
  71051. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  71052. private static _ParseURL;
  71053. private static _ReturnFullUrlLocation;
  71054. private _checkManifestFile;
  71055. /**
  71056. * Open the database and make it available
  71057. * @param successCallback defines the callback to call on success
  71058. * @param errorCallback defines the callback to call on error
  71059. */
  71060. open(successCallback: () => void, errorCallback: () => void): void;
  71061. /**
  71062. * Loads an image from the database
  71063. * @param url defines the url to load from
  71064. * @param image defines the target DOM image
  71065. */
  71066. loadImage(url: string, image: HTMLImageElement): void;
  71067. private _loadImageFromDBAsync;
  71068. private _saveImageIntoDBAsync;
  71069. private _checkVersionFromDB;
  71070. private _loadVersionFromDBAsync;
  71071. private _saveVersionIntoDBAsync;
  71072. /**
  71073. * Loads a file from database
  71074. * @param url defines the URL to load from
  71075. * @param sceneLoaded defines a callback to call on success
  71076. * @param progressCallBack defines a callback to call when progress changed
  71077. * @param errorCallback defines a callback to call on error
  71078. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  71079. */
  71080. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  71081. private _loadFileAsync;
  71082. private _saveFileAsync;
  71083. /**
  71084. * Validates if xhr data is correct
  71085. * @param xhr defines the request to validate
  71086. * @param dataType defines the expected data type
  71087. * @returns true if data is correct
  71088. */
  71089. private static _ValidateXHRData;
  71090. }
  71091. }
  71092. declare module "babylonjs/Offline/index" {
  71093. export * from "babylonjs/Offline/database";
  71094. export * from "babylonjs/Offline/IOfflineProvider";
  71095. }
  71096. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  71097. /** @hidden */
  71098. export var gpuUpdateParticlesPixelShader: {
  71099. name: string;
  71100. shader: string;
  71101. };
  71102. }
  71103. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  71104. /** @hidden */
  71105. export var gpuUpdateParticlesVertexShader: {
  71106. name: string;
  71107. shader: string;
  71108. };
  71109. }
  71110. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  71111. /** @hidden */
  71112. export var clipPlaneFragmentDeclaration2: {
  71113. name: string;
  71114. shader: string;
  71115. };
  71116. }
  71117. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  71118. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  71119. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  71120. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  71121. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  71122. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  71123. /** @hidden */
  71124. export var gpuRenderParticlesPixelShader: {
  71125. name: string;
  71126. shader: string;
  71127. };
  71128. }
  71129. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  71130. /** @hidden */
  71131. export var clipPlaneVertexDeclaration2: {
  71132. name: string;
  71133. shader: string;
  71134. };
  71135. }
  71136. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  71137. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  71138. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  71139. /** @hidden */
  71140. export var gpuRenderParticlesVertexShader: {
  71141. name: string;
  71142. shader: string;
  71143. };
  71144. }
  71145. declare module "babylonjs/Particles/gpuParticleSystem" {
  71146. import { Nullable } from "babylonjs/types";
  71147. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  71148. import { Observable } from "babylonjs/Misc/observable";
  71149. import { Matrix } from "babylonjs/Maths/math.vector";
  71150. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  71151. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71152. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  71153. import { IDisposable } from "babylonjs/scene";
  71154. import { Effect } from "babylonjs/Materials/effect";
  71155. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  71156. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  71157. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  71158. import { Scene } from "babylonjs/scene";
  71159. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  71160. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  71161. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  71162. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  71163. /**
  71164. * This represents a GPU particle system in Babylon
  71165. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  71166. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  71167. */
  71168. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  71169. /**
  71170. * The layer mask we are rendering the particles through.
  71171. */
  71172. layerMask: number;
  71173. private _capacity;
  71174. private _activeCount;
  71175. private _currentActiveCount;
  71176. private _accumulatedCount;
  71177. private _renderEffect;
  71178. private _updateEffect;
  71179. private _buffer0;
  71180. private _buffer1;
  71181. private _spriteBuffer;
  71182. private _updateVAO;
  71183. private _renderVAO;
  71184. private _targetIndex;
  71185. private _sourceBuffer;
  71186. private _targetBuffer;
  71187. private _currentRenderId;
  71188. private _started;
  71189. private _stopped;
  71190. private _timeDelta;
  71191. private _randomTexture;
  71192. private _randomTexture2;
  71193. private _attributesStrideSize;
  71194. private _updateEffectOptions;
  71195. private _randomTextureSize;
  71196. private _actualFrame;
  71197. private _customEffect;
  71198. private readonly _rawTextureWidth;
  71199. /**
  71200. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  71201. */
  71202. static get IsSupported(): boolean;
  71203. /**
  71204. * An event triggered when the system is disposed.
  71205. */
  71206. onDisposeObservable: Observable<IParticleSystem>;
  71207. /**
  71208. * Gets the maximum number of particles active at the same time.
  71209. * @returns The max number of active particles.
  71210. */
  71211. getCapacity(): number;
  71212. /**
  71213. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  71214. * to override the particles.
  71215. */
  71216. forceDepthWrite: boolean;
  71217. /**
  71218. * Gets or set the number of active particles
  71219. */
  71220. get activeParticleCount(): number;
  71221. set activeParticleCount(value: number);
  71222. private _preWarmDone;
  71223. /**
  71224. * Specifies if the particles are updated in emitter local space or world space.
  71225. */
  71226. isLocal: boolean;
  71227. /** Gets or sets a matrix to use to compute projection */
  71228. defaultProjectionMatrix: Matrix;
  71229. /**
  71230. * Is this system ready to be used/rendered
  71231. * @return true if the system is ready
  71232. */
  71233. isReady(): boolean;
  71234. /**
  71235. * Gets if the system has been started. (Note: this will still be true after stop is called)
  71236. * @returns True if it has been started, otherwise false.
  71237. */
  71238. isStarted(): boolean;
  71239. /**
  71240. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71241. * @returns True if it has been stopped, otherwise false.
  71242. */
  71243. isStopped(): boolean;
  71244. /**
  71245. * Gets a boolean indicating that the system is stopping
  71246. * @returns true if the system is currently stopping
  71247. */
  71248. isStopping(): boolean;
  71249. /**
  71250. * Gets the number of particles active at the same time.
  71251. * @returns The number of active particles.
  71252. */
  71253. getActiveCount(): number;
  71254. /**
  71255. * Starts the particle system and begins to emit
  71256. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71257. */
  71258. start(delay?: number): void;
  71259. /**
  71260. * Stops the particle system.
  71261. */
  71262. stop(): void;
  71263. /**
  71264. * Remove all active particles
  71265. */
  71266. reset(): void;
  71267. /**
  71268. * Returns the string "GPUParticleSystem"
  71269. * @returns a string containing the class name
  71270. */
  71271. getClassName(): string;
  71272. /**
  71273. * Gets the custom effect used to render the particles
  71274. * @param blendMode Blend mode for which the effect should be retrieved
  71275. * @returns The effect
  71276. */
  71277. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71278. /**
  71279. * Sets the custom effect used to render the particles
  71280. * @param effect The effect to set
  71281. * @param blendMode Blend mode for which the effect should be set
  71282. */
  71283. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71284. /** @hidden */
  71285. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71286. /**
  71287. * Observable that will be called just before the particles are drawn
  71288. */
  71289. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71290. /**
  71291. * Gets the name of the particle vertex shader
  71292. */
  71293. get vertexShaderName(): string;
  71294. private _colorGradientsTexture;
  71295. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71296. /**
  71297. * Adds a new color gradient
  71298. * @param gradient defines the gradient to use (between 0 and 1)
  71299. * @param color1 defines the color to affect to the specified gradient
  71300. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71301. * @returns the current particle system
  71302. */
  71303. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71304. private _refreshColorGradient;
  71305. /** Force the system to rebuild all gradients that need to be resync */
  71306. forceRefreshGradients(): void;
  71307. /**
  71308. * Remove a specific color gradient
  71309. * @param gradient defines the gradient to remove
  71310. * @returns the current particle system
  71311. */
  71312. removeColorGradient(gradient: number): GPUParticleSystem;
  71313. private _angularSpeedGradientsTexture;
  71314. private _sizeGradientsTexture;
  71315. private _velocityGradientsTexture;
  71316. private _limitVelocityGradientsTexture;
  71317. private _dragGradientsTexture;
  71318. private _addFactorGradient;
  71319. /**
  71320. * Adds a new size gradient
  71321. * @param gradient defines the gradient to use (between 0 and 1)
  71322. * @param factor defines the size factor to affect to the specified gradient
  71323. * @returns the current particle system
  71324. */
  71325. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71326. /**
  71327. * Remove a specific size gradient
  71328. * @param gradient defines the gradient to remove
  71329. * @returns the current particle system
  71330. */
  71331. removeSizeGradient(gradient: number): GPUParticleSystem;
  71332. private _refreshFactorGradient;
  71333. /**
  71334. * Adds a new angular speed gradient
  71335. * @param gradient defines the gradient to use (between 0 and 1)
  71336. * @param factor defines the angular speed to affect to the specified gradient
  71337. * @returns the current particle system
  71338. */
  71339. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71340. /**
  71341. * Remove a specific angular speed gradient
  71342. * @param gradient defines the gradient to remove
  71343. * @returns the current particle system
  71344. */
  71345. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71346. /**
  71347. * Adds a new velocity gradient
  71348. * @param gradient defines the gradient to use (between 0 and 1)
  71349. * @param factor defines the velocity to affect to the specified gradient
  71350. * @returns the current particle system
  71351. */
  71352. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71353. /**
  71354. * Remove a specific velocity gradient
  71355. * @param gradient defines the gradient to remove
  71356. * @returns the current particle system
  71357. */
  71358. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71359. /**
  71360. * Adds a new limit velocity gradient
  71361. * @param gradient defines the gradient to use (between 0 and 1)
  71362. * @param factor defines the limit velocity value to affect to the specified gradient
  71363. * @returns the current particle system
  71364. */
  71365. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71366. /**
  71367. * Remove a specific limit velocity gradient
  71368. * @param gradient defines the gradient to remove
  71369. * @returns the current particle system
  71370. */
  71371. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71372. /**
  71373. * Adds a new drag gradient
  71374. * @param gradient defines the gradient to use (between 0 and 1)
  71375. * @param factor defines the drag value to affect to the specified gradient
  71376. * @returns the current particle system
  71377. */
  71378. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71379. /**
  71380. * Remove a specific drag gradient
  71381. * @param gradient defines the gradient to remove
  71382. * @returns the current particle system
  71383. */
  71384. removeDragGradient(gradient: number): GPUParticleSystem;
  71385. /**
  71386. * Not supported by GPUParticleSystem
  71387. * @param gradient defines the gradient to use (between 0 and 1)
  71388. * @param factor defines the emit rate value to affect to the specified gradient
  71389. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71390. * @returns the current particle system
  71391. */
  71392. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71393. /**
  71394. * Not supported by GPUParticleSystem
  71395. * @param gradient defines the gradient to remove
  71396. * @returns the current particle system
  71397. */
  71398. removeEmitRateGradient(gradient: number): IParticleSystem;
  71399. /**
  71400. * Not supported by GPUParticleSystem
  71401. * @param gradient defines the gradient to use (between 0 and 1)
  71402. * @param factor defines the start size value to affect to the specified gradient
  71403. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71404. * @returns the current particle system
  71405. */
  71406. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71407. /**
  71408. * Not supported by GPUParticleSystem
  71409. * @param gradient defines the gradient to remove
  71410. * @returns the current particle system
  71411. */
  71412. removeStartSizeGradient(gradient: number): IParticleSystem;
  71413. /**
  71414. * Not supported by GPUParticleSystem
  71415. * @param gradient defines the gradient to use (between 0 and 1)
  71416. * @param min defines the color remap minimal range
  71417. * @param max defines the color remap maximal range
  71418. * @returns the current particle system
  71419. */
  71420. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71421. /**
  71422. * Not supported by GPUParticleSystem
  71423. * @param gradient defines the gradient to remove
  71424. * @returns the current particle system
  71425. */
  71426. removeColorRemapGradient(): IParticleSystem;
  71427. /**
  71428. * Not supported by GPUParticleSystem
  71429. * @param gradient defines the gradient to use (between 0 and 1)
  71430. * @param min defines the alpha remap minimal range
  71431. * @param max defines the alpha remap maximal range
  71432. * @returns the current particle system
  71433. */
  71434. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71435. /**
  71436. * Not supported by GPUParticleSystem
  71437. * @param gradient defines the gradient to remove
  71438. * @returns the current particle system
  71439. */
  71440. removeAlphaRemapGradient(): IParticleSystem;
  71441. /**
  71442. * Not supported by GPUParticleSystem
  71443. * @param gradient defines the gradient to use (between 0 and 1)
  71444. * @param color defines the color to affect to the specified gradient
  71445. * @returns the current particle system
  71446. */
  71447. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71448. /**
  71449. * Not supported by GPUParticleSystem
  71450. * @param gradient defines the gradient to remove
  71451. * @returns the current particle system
  71452. */
  71453. removeRampGradient(): IParticleSystem;
  71454. /**
  71455. * Not supported by GPUParticleSystem
  71456. * @returns the list of ramp gradients
  71457. */
  71458. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71459. /**
  71460. * Not supported by GPUParticleSystem
  71461. * Gets or sets a boolean indicating that ramp gradients must be used
  71462. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71463. */
  71464. get useRampGradients(): boolean;
  71465. set useRampGradients(value: boolean);
  71466. /**
  71467. * Not supported by GPUParticleSystem
  71468. * @param gradient defines the gradient to use (between 0 and 1)
  71469. * @param factor defines the life time factor to affect to the specified gradient
  71470. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71471. * @returns the current particle system
  71472. */
  71473. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71474. /**
  71475. * Not supported by GPUParticleSystem
  71476. * @param gradient defines the gradient to remove
  71477. * @returns the current particle system
  71478. */
  71479. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71480. /**
  71481. * Instantiates a GPU particle system.
  71482. * 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.
  71483. * @param name The name of the particle system
  71484. * @param options The options used to create the system
  71485. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71486. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71487. * @param customEffect a custom effect used to change the way particles are rendered by default
  71488. */
  71489. constructor(name: string, options: Partial<{
  71490. capacity: number;
  71491. randomTextureSize: number;
  71492. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71493. protected _reset(): void;
  71494. private _createUpdateVAO;
  71495. private _createRenderVAO;
  71496. private _initialize;
  71497. /** @hidden */
  71498. _recreateUpdateEffect(): void;
  71499. private _getEffect;
  71500. /**
  71501. * Fill the defines array according to the current settings of the particle system
  71502. * @param defines Array to be updated
  71503. * @param blendMode blend mode to take into account when updating the array
  71504. */
  71505. fillDefines(defines: Array<string>, blendMode?: number): void;
  71506. /**
  71507. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71508. * @param uniforms Uniforms array to fill
  71509. * @param attributes Attributes array to fill
  71510. * @param samplers Samplers array to fill
  71511. */
  71512. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71513. /** @hidden */
  71514. _recreateRenderEffect(): Effect;
  71515. /**
  71516. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71517. * @param preWarm defines if we are in the pre-warmimg phase
  71518. */
  71519. animate(preWarm?: boolean): void;
  71520. private _createFactorGradientTexture;
  71521. private _createSizeGradientTexture;
  71522. private _createAngularSpeedGradientTexture;
  71523. private _createVelocityGradientTexture;
  71524. private _createLimitVelocityGradientTexture;
  71525. private _createDragGradientTexture;
  71526. private _createColorGradientTexture;
  71527. /**
  71528. * Renders the particle system in its current state
  71529. * @param preWarm defines if the system should only update the particles but not render them
  71530. * @returns the current number of particles
  71531. */
  71532. render(preWarm?: boolean): number;
  71533. /**
  71534. * Rebuilds the particle system
  71535. */
  71536. rebuild(): void;
  71537. private _releaseBuffers;
  71538. private _releaseVAOs;
  71539. /**
  71540. * Disposes the particle system and free the associated resources
  71541. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71542. */
  71543. dispose(disposeTexture?: boolean): void;
  71544. /**
  71545. * Clones the particle system.
  71546. * @param name The name of the cloned object
  71547. * @param newEmitter The new emitter to use
  71548. * @returns the cloned particle system
  71549. */
  71550. clone(name: string, newEmitter: any): GPUParticleSystem;
  71551. /**
  71552. * Serializes the particle system to a JSON object
  71553. * @param serializeTexture defines if the texture must be serialized as well
  71554. * @returns the JSON object
  71555. */
  71556. serialize(serializeTexture?: boolean): any;
  71557. /**
  71558. * Parses a JSON object to create a GPU particle system.
  71559. * @param parsedParticleSystem The JSON object to parse
  71560. * @param sceneOrEngine The scene or the engine to create the particle system in
  71561. * @param rootUrl The root url to use to load external dependencies like texture
  71562. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71563. * @returns the parsed GPU particle system
  71564. */
  71565. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71566. }
  71567. }
  71568. declare module "babylonjs/Particles/particleSystemSet" {
  71569. import { Nullable } from "babylonjs/types";
  71570. import { Color3 } from "babylonjs/Maths/math.color";
  71571. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71572. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71573. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71574. import { Scene, IDisposable } from "babylonjs/scene";
  71575. /**
  71576. * Represents a set of particle systems working together to create a specific effect
  71577. */
  71578. export class ParticleSystemSet implements IDisposable {
  71579. /**
  71580. * Gets or sets base Assets URL
  71581. */
  71582. static BaseAssetsUrl: string;
  71583. private _emitterCreationOptions;
  71584. private _emitterNode;
  71585. /**
  71586. * Gets the particle system list
  71587. */
  71588. systems: IParticleSystem[];
  71589. /**
  71590. * Gets the emitter node used with this set
  71591. */
  71592. get emitterNode(): Nullable<TransformNode>;
  71593. /**
  71594. * Creates a new emitter mesh as a sphere
  71595. * @param options defines the options used to create the sphere
  71596. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71597. * @param scene defines the hosting scene
  71598. */
  71599. setEmitterAsSphere(options: {
  71600. diameter: number;
  71601. segments: number;
  71602. color: Color3;
  71603. }, renderingGroupId: number, scene: Scene): void;
  71604. /**
  71605. * Starts all particle systems of the set
  71606. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71607. */
  71608. start(emitter?: AbstractMesh): void;
  71609. /**
  71610. * Release all associated resources
  71611. */
  71612. dispose(): void;
  71613. /**
  71614. * Serialize the set into a JSON compatible object
  71615. * @param serializeTexture defines if the texture must be serialized as well
  71616. * @returns a JSON compatible representation of the set
  71617. */
  71618. serialize(serializeTexture?: boolean): any;
  71619. /**
  71620. * Parse a new ParticleSystemSet from a serialized source
  71621. * @param data defines a JSON compatible representation of the set
  71622. * @param scene defines the hosting scene
  71623. * @param gpu defines if we want GPU particles or CPU particles
  71624. * @returns a new ParticleSystemSet
  71625. */
  71626. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71627. }
  71628. }
  71629. declare module "babylonjs/Particles/particleHelper" {
  71630. import { Nullable } from "babylonjs/types";
  71631. import { Scene } from "babylonjs/scene";
  71632. import { Vector3 } from "babylonjs/Maths/math.vector";
  71633. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71634. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71635. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71636. /**
  71637. * This class is made for on one-liner static method to help creating particle system set.
  71638. */
  71639. export class ParticleHelper {
  71640. /**
  71641. * Gets or sets base Assets URL
  71642. */
  71643. static BaseAssetsUrl: string;
  71644. /** Define the Url to load snippets */
  71645. static SnippetUrl: string;
  71646. /**
  71647. * Create a default particle system that you can tweak
  71648. * @param emitter defines the emitter to use
  71649. * @param capacity defines the system capacity (default is 500 particles)
  71650. * @param scene defines the hosting scene
  71651. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71652. * @returns the new Particle system
  71653. */
  71654. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71655. /**
  71656. * This is the main static method (one-liner) of this helper to create different particle systems
  71657. * @param type This string represents the type to the particle system to create
  71658. * @param scene The scene where the particle system should live
  71659. * @param gpu If the system will use gpu
  71660. * @returns the ParticleSystemSet created
  71661. */
  71662. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71663. /**
  71664. * Static function used to export a particle system to a ParticleSystemSet variable.
  71665. * Please note that the emitter shape is not exported
  71666. * @param systems defines the particle systems to export
  71667. * @returns the created particle system set
  71668. */
  71669. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71670. /**
  71671. * Creates a particle system from a snippet saved in a remote file
  71672. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71673. * @param url defines the url to load from
  71674. * @param scene defines the hosting scene
  71675. * @param gpu If the system will use gpu
  71676. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71677. * @returns a promise that will resolve to the new particle system
  71678. */
  71679. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71680. /**
  71681. * Creates a particle system from a snippet saved by the particle system editor
  71682. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71683. * @param scene defines the hosting scene
  71684. * @param gpu If the system will use gpu
  71685. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71686. * @returns a promise that will resolve to the new particle system
  71687. */
  71688. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71689. }
  71690. }
  71691. declare module "babylonjs/Particles/particleSystemComponent" {
  71692. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71693. import { Effect } from "babylonjs/Materials/effect";
  71694. import "babylonjs/Shaders/particles.vertex";
  71695. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71696. module "babylonjs/Engines/engine" {
  71697. interface Engine {
  71698. /**
  71699. * Create an effect to use with particle systems.
  71700. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71701. * the particle system for which you want to create a custom effect in the last parameter
  71702. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71703. * @param uniformsNames defines a list of attribute names
  71704. * @param samplers defines an array of string used to represent textures
  71705. * @param defines defines the string containing the defines to use to compile the shaders
  71706. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71707. * @param onCompiled defines a function to call when the effect creation is successful
  71708. * @param onError defines a function to call when the effect creation has failed
  71709. * @param particleSystem the particle system you want to create the effect for
  71710. * @returns the new Effect
  71711. */
  71712. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71713. }
  71714. }
  71715. module "babylonjs/Meshes/mesh" {
  71716. interface Mesh {
  71717. /**
  71718. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71719. * @returns an array of IParticleSystem
  71720. */
  71721. getEmittedParticleSystems(): IParticleSystem[];
  71722. /**
  71723. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71724. * @returns an array of IParticleSystem
  71725. */
  71726. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71727. }
  71728. }
  71729. }
  71730. declare module "babylonjs/Particles/pointsCloudSystem" {
  71731. import { Color4 } from "babylonjs/Maths/math";
  71732. import { Mesh } from "babylonjs/Meshes/mesh";
  71733. import { Scene, IDisposable } from "babylonjs/scene";
  71734. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71735. /** Defines the 4 color options */
  71736. export enum PointColor {
  71737. /** color value */
  71738. Color = 2,
  71739. /** uv value */
  71740. UV = 1,
  71741. /** random value */
  71742. Random = 0,
  71743. /** stated value */
  71744. Stated = 3
  71745. }
  71746. /**
  71747. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71748. * 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.
  71749. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71750. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71751. *
  71752. * Full documentation here : TO BE ENTERED
  71753. */
  71754. export class PointsCloudSystem implements IDisposable {
  71755. /**
  71756. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71757. * Example : var p = SPS.particles[i];
  71758. */
  71759. particles: CloudPoint[];
  71760. /**
  71761. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71762. */
  71763. nbParticles: number;
  71764. /**
  71765. * This a counter for your own usage. It's not set by any SPS functions.
  71766. */
  71767. counter: number;
  71768. /**
  71769. * The PCS name. This name is also given to the underlying mesh.
  71770. */
  71771. name: string;
  71772. /**
  71773. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71774. */
  71775. mesh: Mesh;
  71776. /**
  71777. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71778. * Please read :
  71779. */
  71780. vars: any;
  71781. /**
  71782. * @hidden
  71783. */
  71784. _size: number;
  71785. private _scene;
  71786. private _promises;
  71787. private _positions;
  71788. private _indices;
  71789. private _normals;
  71790. private _colors;
  71791. private _uvs;
  71792. private _indices32;
  71793. private _positions32;
  71794. private _colors32;
  71795. private _uvs32;
  71796. private _updatable;
  71797. private _isVisibilityBoxLocked;
  71798. private _alwaysVisible;
  71799. private _groups;
  71800. private _groupCounter;
  71801. private _computeParticleColor;
  71802. private _computeParticleTexture;
  71803. private _computeParticleRotation;
  71804. private _computeBoundingBox;
  71805. private _isReady;
  71806. /**
  71807. * Creates a PCS (Points Cloud System) object
  71808. * @param name (String) is the PCS name, this will be the underlying mesh name
  71809. * @param pointSize (number) is the size for each point
  71810. * @param scene (Scene) is the scene in which the PCS is added
  71811. * @param options defines the options of the PCS e.g.
  71812. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71813. */
  71814. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71815. updatable?: boolean;
  71816. });
  71817. /**
  71818. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71819. * If no points were added to the PCS, the returned mesh is just a single point.
  71820. * @returns a promise for the created mesh
  71821. */
  71822. buildMeshAsync(): Promise<Mesh>;
  71823. /**
  71824. * @hidden
  71825. */
  71826. private _buildMesh;
  71827. private _addParticle;
  71828. private _randomUnitVector;
  71829. private _getColorIndicesForCoord;
  71830. private _setPointsColorOrUV;
  71831. private _colorFromTexture;
  71832. private _calculateDensity;
  71833. /**
  71834. * Adds points to the PCS in random positions within a unit sphere
  71835. * @param nb (positive integer) the number of particles to be created from this model
  71836. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71837. * @returns the number of groups in the system
  71838. */
  71839. addPoints(nb: number, pointFunction?: any): number;
  71840. /**
  71841. * Adds points to the PCS from the surface of the model shape
  71842. * @param mesh is any Mesh object that will be used as a surface model for the points
  71843. * @param nb (positive integer) the number of particles to be created from this model
  71844. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71845. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71846. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71847. * @returns the number of groups in the system
  71848. */
  71849. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71850. /**
  71851. * Adds points to the PCS inside the model shape
  71852. * @param mesh is any Mesh object that will be used as a surface model for the points
  71853. * @param nb (positive integer) the number of particles to be created from this model
  71854. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71855. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71856. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71857. * @returns the number of groups in the system
  71858. */
  71859. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71860. /**
  71861. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71862. * This method calls `updateParticle()` for each particle of the SPS.
  71863. * For an animated SPS, it is usually called within the render loop.
  71864. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71865. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71866. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71867. * @returns the PCS.
  71868. */
  71869. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71870. /**
  71871. * Disposes the PCS.
  71872. */
  71873. dispose(): void;
  71874. /**
  71875. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71876. * doc :
  71877. * @returns the PCS.
  71878. */
  71879. refreshVisibleSize(): PointsCloudSystem;
  71880. /**
  71881. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71882. * @param size the size (float) of the visibility box
  71883. * note : this doesn't lock the PCS mesh bounding box.
  71884. * doc :
  71885. */
  71886. setVisibilityBox(size: number): void;
  71887. /**
  71888. * Gets whether the PCS is always visible or not
  71889. * doc :
  71890. */
  71891. get isAlwaysVisible(): boolean;
  71892. /**
  71893. * Sets the PCS as always visible or not
  71894. * doc :
  71895. */
  71896. set isAlwaysVisible(val: boolean);
  71897. /**
  71898. * Tells to `setParticles()` to compute the particle rotations or not
  71899. * Default value : false. The PCS is faster when it's set to false
  71900. * Note : particle rotations are only applied to parent particles
  71901. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71902. */
  71903. set computeParticleRotation(val: boolean);
  71904. /**
  71905. * Tells to `setParticles()` to compute the particle colors or not.
  71906. * Default value : true. The PCS is faster when it's set to false.
  71907. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71908. */
  71909. set computeParticleColor(val: boolean);
  71910. set computeParticleTexture(val: boolean);
  71911. /**
  71912. * Gets if `setParticles()` computes the particle colors or not.
  71913. * Default value : false. The PCS is faster when it's set to false.
  71914. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71915. */
  71916. get computeParticleColor(): boolean;
  71917. /**
  71918. * Gets if `setParticles()` computes the particle textures or not.
  71919. * Default value : false. The PCS is faster when it's set to false.
  71920. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71921. */
  71922. get computeParticleTexture(): boolean;
  71923. /**
  71924. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71925. */
  71926. set computeBoundingBox(val: boolean);
  71927. /**
  71928. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71929. */
  71930. get computeBoundingBox(): boolean;
  71931. /**
  71932. * This function does nothing. It may be overwritten to set all the particle first values.
  71933. * The PCS doesn't call this function, you may have to call it by your own.
  71934. * doc :
  71935. */
  71936. initParticles(): void;
  71937. /**
  71938. * This function does nothing. It may be overwritten to recycle a particle
  71939. * The PCS doesn't call this function, you can to call it
  71940. * doc :
  71941. * @param particle The particle to recycle
  71942. * @returns the recycled particle
  71943. */
  71944. recycleParticle(particle: CloudPoint): CloudPoint;
  71945. /**
  71946. * Updates a particle : this function should be overwritten by the user.
  71947. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71948. * doc :
  71949. * @example : just set a particle position or velocity and recycle conditions
  71950. * @param particle The particle to update
  71951. * @returns the updated particle
  71952. */
  71953. updateParticle(particle: CloudPoint): CloudPoint;
  71954. /**
  71955. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71956. * This does nothing and may be overwritten by the user.
  71957. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71958. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71959. * @param update the boolean update value actually passed to setParticles()
  71960. */
  71961. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71962. /**
  71963. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71964. * This will be passed three parameters.
  71965. * This does nothing and may be overwritten by the user.
  71966. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71967. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71968. * @param update the boolean update value actually passed to setParticles()
  71969. */
  71970. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71971. }
  71972. }
  71973. declare module "babylonjs/Particles/cloudPoint" {
  71974. import { Nullable } from "babylonjs/types";
  71975. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71976. import { Mesh } from "babylonjs/Meshes/mesh";
  71977. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71978. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71979. /**
  71980. * Represents one particle of a points cloud system.
  71981. */
  71982. export class CloudPoint {
  71983. /**
  71984. * particle global index
  71985. */
  71986. idx: number;
  71987. /**
  71988. * The color of the particle
  71989. */
  71990. color: Nullable<Color4>;
  71991. /**
  71992. * The world space position of the particle.
  71993. */
  71994. position: Vector3;
  71995. /**
  71996. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71997. */
  71998. rotation: Vector3;
  71999. /**
  72000. * The world space rotation quaternion of the particle.
  72001. */
  72002. rotationQuaternion: Nullable<Quaternion>;
  72003. /**
  72004. * The uv of the particle.
  72005. */
  72006. uv: Nullable<Vector2>;
  72007. /**
  72008. * The current speed of the particle.
  72009. */
  72010. velocity: Vector3;
  72011. /**
  72012. * The pivot point in the particle local space.
  72013. */
  72014. pivot: Vector3;
  72015. /**
  72016. * Must the particle be translated from its pivot point in its local space ?
  72017. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  72018. * Default : false
  72019. */
  72020. translateFromPivot: boolean;
  72021. /**
  72022. * Index of this particle in the global "positions" array (Internal use)
  72023. * @hidden
  72024. */
  72025. _pos: number;
  72026. /**
  72027. * @hidden Index of this particle in the global "indices" array (Internal use)
  72028. */
  72029. _ind: number;
  72030. /**
  72031. * Group this particle belongs to
  72032. */
  72033. _group: PointsGroup;
  72034. /**
  72035. * Group id of this particle
  72036. */
  72037. groupId: number;
  72038. /**
  72039. * Index of the particle in its group id (Internal use)
  72040. */
  72041. idxInGroup: number;
  72042. /**
  72043. * @hidden Particle BoundingInfo object (Internal use)
  72044. */
  72045. _boundingInfo: BoundingInfo;
  72046. /**
  72047. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  72048. */
  72049. _pcs: PointsCloudSystem;
  72050. /**
  72051. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  72052. */
  72053. _stillInvisible: boolean;
  72054. /**
  72055. * @hidden Last computed particle rotation matrix
  72056. */
  72057. _rotationMatrix: number[];
  72058. /**
  72059. * Parent particle Id, if any.
  72060. * Default null.
  72061. */
  72062. parentId: Nullable<number>;
  72063. /**
  72064. * @hidden Internal global position in the PCS.
  72065. */
  72066. _globalPosition: Vector3;
  72067. /**
  72068. * Creates a Point Cloud object.
  72069. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  72070. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  72071. * @param group (PointsGroup) is the group the particle belongs to
  72072. * @param groupId (integer) is the group identifier in the PCS.
  72073. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  72074. * @param pcs defines the PCS it is associated to
  72075. */
  72076. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  72077. /**
  72078. * get point size
  72079. */
  72080. get size(): Vector3;
  72081. /**
  72082. * Set point size
  72083. */
  72084. set size(scale: Vector3);
  72085. /**
  72086. * Legacy support, changed quaternion to rotationQuaternion
  72087. */
  72088. get quaternion(): Nullable<Quaternion>;
  72089. /**
  72090. * Legacy support, changed quaternion to rotationQuaternion
  72091. */
  72092. set quaternion(q: Nullable<Quaternion>);
  72093. /**
  72094. * Returns a boolean. True if the particle intersects a mesh, else false
  72095. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  72096. * @param target is the object (point or mesh) what the intersection is computed against
  72097. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  72098. * @returns true if it intersects
  72099. */
  72100. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  72101. /**
  72102. * get the rotation matrix of the particle
  72103. * @hidden
  72104. */
  72105. getRotationMatrix(m: Matrix): void;
  72106. }
  72107. /**
  72108. * Represents a group of points in a points cloud system
  72109. * * PCS internal tool, don't use it manually.
  72110. */
  72111. export class PointsGroup {
  72112. /**
  72113. * The group id
  72114. * @hidden
  72115. */
  72116. groupID: number;
  72117. /**
  72118. * image data for group (internal use)
  72119. * @hidden
  72120. */
  72121. _groupImageData: Nullable<ArrayBufferView>;
  72122. /**
  72123. * Image Width (internal use)
  72124. * @hidden
  72125. */
  72126. _groupImgWidth: number;
  72127. /**
  72128. * Image Height (internal use)
  72129. * @hidden
  72130. */
  72131. _groupImgHeight: number;
  72132. /**
  72133. * Custom position function (internal use)
  72134. * @hidden
  72135. */
  72136. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  72137. /**
  72138. * density per facet for surface points
  72139. * @hidden
  72140. */
  72141. _groupDensity: number[];
  72142. /**
  72143. * Only when points are colored by texture carries pointer to texture list array
  72144. * @hidden
  72145. */
  72146. _textureNb: number;
  72147. /**
  72148. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  72149. * PCS internal tool, don't use it manually.
  72150. * @hidden
  72151. */
  72152. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  72153. }
  72154. }
  72155. declare module "babylonjs/Particles/index" {
  72156. export * from "babylonjs/Particles/baseParticleSystem";
  72157. export * from "babylonjs/Particles/EmitterTypes/index";
  72158. export * from "babylonjs/Particles/gpuParticleSystem";
  72159. export * from "babylonjs/Particles/IParticleSystem";
  72160. export * from "babylonjs/Particles/particle";
  72161. export * from "babylonjs/Particles/particleHelper";
  72162. export * from "babylonjs/Particles/particleSystem";
  72163. import "babylonjs/Particles/particleSystemComponent";
  72164. export * from "babylonjs/Particles/particleSystemComponent";
  72165. export * from "babylonjs/Particles/particleSystemSet";
  72166. export * from "babylonjs/Particles/solidParticle";
  72167. export * from "babylonjs/Particles/solidParticleSystem";
  72168. export * from "babylonjs/Particles/cloudPoint";
  72169. export * from "babylonjs/Particles/pointsCloudSystem";
  72170. export * from "babylonjs/Particles/subEmitter";
  72171. }
  72172. declare module "babylonjs/Physics/physicsEngineComponent" {
  72173. import { Nullable } from "babylonjs/types";
  72174. import { Observable, Observer } from "babylonjs/Misc/observable";
  72175. import { Vector3 } from "babylonjs/Maths/math.vector";
  72176. import { Mesh } from "babylonjs/Meshes/mesh";
  72177. import { ISceneComponent } from "babylonjs/sceneComponent";
  72178. import { Scene } from "babylonjs/scene";
  72179. import { Node } from "babylonjs/node";
  72180. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  72181. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72182. module "babylonjs/scene" {
  72183. interface Scene {
  72184. /** @hidden (Backing field) */
  72185. _physicsEngine: Nullable<IPhysicsEngine>;
  72186. /** @hidden */
  72187. _physicsTimeAccumulator: number;
  72188. /**
  72189. * Gets the current physics engine
  72190. * @returns a IPhysicsEngine or null if none attached
  72191. */
  72192. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  72193. /**
  72194. * Enables physics to the current scene
  72195. * @param gravity defines the scene's gravity for the physics engine
  72196. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  72197. * @return a boolean indicating if the physics engine was initialized
  72198. */
  72199. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  72200. /**
  72201. * Disables and disposes the physics engine associated with the scene
  72202. */
  72203. disablePhysicsEngine(): void;
  72204. /**
  72205. * Gets a boolean indicating if there is an active physics engine
  72206. * @returns a boolean indicating if there is an active physics engine
  72207. */
  72208. isPhysicsEnabled(): boolean;
  72209. /**
  72210. * Deletes a physics compound impostor
  72211. * @param compound defines the compound to delete
  72212. */
  72213. deleteCompoundImpostor(compound: any): void;
  72214. /**
  72215. * An event triggered when physic simulation is about to be run
  72216. */
  72217. onBeforePhysicsObservable: Observable<Scene>;
  72218. /**
  72219. * An event triggered when physic simulation has been done
  72220. */
  72221. onAfterPhysicsObservable: Observable<Scene>;
  72222. }
  72223. }
  72224. module "babylonjs/Meshes/abstractMesh" {
  72225. interface AbstractMesh {
  72226. /** @hidden */
  72227. _physicsImpostor: Nullable<PhysicsImpostor>;
  72228. /**
  72229. * Gets or sets impostor used for physic simulation
  72230. * @see https://doc.babylonjs.com/features/physics_engine
  72231. */
  72232. physicsImpostor: Nullable<PhysicsImpostor>;
  72233. /**
  72234. * Gets the current physics impostor
  72235. * @see https://doc.babylonjs.com/features/physics_engine
  72236. * @returns a physics impostor or null
  72237. */
  72238. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  72239. /** Apply a physic impulse to the mesh
  72240. * @param force defines the force to apply
  72241. * @param contactPoint defines where to apply the force
  72242. * @returns the current mesh
  72243. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72244. */
  72245. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72246. /**
  72247. * Creates a physic joint between two meshes
  72248. * @param otherMesh defines the other mesh to use
  72249. * @param pivot1 defines the pivot to use on this mesh
  72250. * @param pivot2 defines the pivot to use on the other mesh
  72251. * @param options defines additional options (can be plugin dependent)
  72252. * @returns the current mesh
  72253. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72254. */
  72255. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72256. /** @hidden */
  72257. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72258. }
  72259. }
  72260. /**
  72261. * Defines the physics engine scene component responsible to manage a physics engine
  72262. */
  72263. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72264. /**
  72265. * The component name helpful to identify the component in the list of scene components.
  72266. */
  72267. readonly name: string;
  72268. /**
  72269. * The scene the component belongs to.
  72270. */
  72271. scene: Scene;
  72272. /**
  72273. * Creates a new instance of the component for the given scene
  72274. * @param scene Defines the scene to register the component in
  72275. */
  72276. constructor(scene: Scene);
  72277. /**
  72278. * Registers the component in a given scene
  72279. */
  72280. register(): void;
  72281. /**
  72282. * Rebuilds the elements related to this component in case of
  72283. * context lost for instance.
  72284. */
  72285. rebuild(): void;
  72286. /**
  72287. * Disposes the component and the associated ressources
  72288. */
  72289. dispose(): void;
  72290. }
  72291. }
  72292. declare module "babylonjs/Physics/physicsHelper" {
  72293. import { Nullable } from "babylonjs/types";
  72294. import { Vector3 } from "babylonjs/Maths/math.vector";
  72295. import { Mesh } from "babylonjs/Meshes/mesh";
  72296. import { Scene } from "babylonjs/scene";
  72297. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72298. /**
  72299. * A helper for physics simulations
  72300. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72301. */
  72302. export class PhysicsHelper {
  72303. private _scene;
  72304. private _physicsEngine;
  72305. /**
  72306. * Initializes the Physics helper
  72307. * @param scene Babylon.js scene
  72308. */
  72309. constructor(scene: Scene);
  72310. /**
  72311. * Applies a radial explosion impulse
  72312. * @param origin the origin of the explosion
  72313. * @param radiusOrEventOptions the radius or the options of radial explosion
  72314. * @param strength the explosion strength
  72315. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72316. * @returns A physics radial explosion event, or null
  72317. */
  72318. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72319. /**
  72320. * Applies a radial explosion force
  72321. * @param origin the origin of the explosion
  72322. * @param radiusOrEventOptions the radius or the options of radial explosion
  72323. * @param strength the explosion strength
  72324. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72325. * @returns A physics radial explosion event, or null
  72326. */
  72327. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72328. /**
  72329. * Creates a gravitational field
  72330. * @param origin the origin of the explosion
  72331. * @param radiusOrEventOptions the radius or the options of radial explosion
  72332. * @param strength the explosion strength
  72333. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72334. * @returns A physics gravitational field event, or null
  72335. */
  72336. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72337. /**
  72338. * Creates a physics updraft event
  72339. * @param origin the origin of the updraft
  72340. * @param radiusOrEventOptions the radius or the options of the updraft
  72341. * @param strength the strength of the updraft
  72342. * @param height the height of the updraft
  72343. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72344. * @returns A physics updraft event, or null
  72345. */
  72346. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72347. /**
  72348. * Creates a physics vortex event
  72349. * @param origin the of the vortex
  72350. * @param radiusOrEventOptions the radius or the options of the vortex
  72351. * @param strength the strength of the vortex
  72352. * @param height the height of the vortex
  72353. * @returns a Physics vortex event, or null
  72354. * A physics vortex event or null
  72355. */
  72356. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72357. }
  72358. /**
  72359. * Represents a physics radial explosion event
  72360. */
  72361. class PhysicsRadialExplosionEvent {
  72362. private _scene;
  72363. private _options;
  72364. private _sphere;
  72365. private _dataFetched;
  72366. /**
  72367. * Initializes a radial explosioin event
  72368. * @param _scene BabylonJS scene
  72369. * @param _options The options for the vortex event
  72370. */
  72371. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72372. /**
  72373. * Returns the data related to the radial explosion event (sphere).
  72374. * @returns The radial explosion event data
  72375. */
  72376. getData(): PhysicsRadialExplosionEventData;
  72377. /**
  72378. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72379. * @param impostor A physics imposter
  72380. * @param origin the origin of the explosion
  72381. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72382. */
  72383. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72384. /**
  72385. * Triggers affecterd impostors callbacks
  72386. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72387. */
  72388. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72389. /**
  72390. * Disposes the sphere.
  72391. * @param force Specifies if the sphere should be disposed by force
  72392. */
  72393. dispose(force?: boolean): void;
  72394. /*** Helpers ***/
  72395. private _prepareSphere;
  72396. private _intersectsWithSphere;
  72397. }
  72398. /**
  72399. * Represents a gravitational field event
  72400. */
  72401. class PhysicsGravitationalFieldEvent {
  72402. private _physicsHelper;
  72403. private _scene;
  72404. private _origin;
  72405. private _options;
  72406. private _tickCallback;
  72407. private _sphere;
  72408. private _dataFetched;
  72409. /**
  72410. * Initializes the physics gravitational field event
  72411. * @param _physicsHelper A physics helper
  72412. * @param _scene BabylonJS scene
  72413. * @param _origin The origin position of the gravitational field event
  72414. * @param _options The options for the vortex event
  72415. */
  72416. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72417. /**
  72418. * Returns the data related to the gravitational field event (sphere).
  72419. * @returns A gravitational field event
  72420. */
  72421. getData(): PhysicsGravitationalFieldEventData;
  72422. /**
  72423. * Enables the gravitational field.
  72424. */
  72425. enable(): void;
  72426. /**
  72427. * Disables the gravitational field.
  72428. */
  72429. disable(): void;
  72430. /**
  72431. * Disposes the sphere.
  72432. * @param force The force to dispose from the gravitational field event
  72433. */
  72434. dispose(force?: boolean): void;
  72435. private _tick;
  72436. }
  72437. /**
  72438. * Represents a physics updraft event
  72439. */
  72440. class PhysicsUpdraftEvent {
  72441. private _scene;
  72442. private _origin;
  72443. private _options;
  72444. private _physicsEngine;
  72445. private _originTop;
  72446. private _originDirection;
  72447. private _tickCallback;
  72448. private _cylinder;
  72449. private _cylinderPosition;
  72450. private _dataFetched;
  72451. /**
  72452. * Initializes the physics updraft event
  72453. * @param _scene BabylonJS scene
  72454. * @param _origin The origin position of the updraft
  72455. * @param _options The options for the updraft event
  72456. */
  72457. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72458. /**
  72459. * Returns the data related to the updraft event (cylinder).
  72460. * @returns A physics updraft event
  72461. */
  72462. getData(): PhysicsUpdraftEventData;
  72463. /**
  72464. * Enables the updraft.
  72465. */
  72466. enable(): void;
  72467. /**
  72468. * Disables the updraft.
  72469. */
  72470. disable(): void;
  72471. /**
  72472. * Disposes the cylinder.
  72473. * @param force Specifies if the updraft should be disposed by force
  72474. */
  72475. dispose(force?: boolean): void;
  72476. private getImpostorHitData;
  72477. private _tick;
  72478. /*** Helpers ***/
  72479. private _prepareCylinder;
  72480. private _intersectsWithCylinder;
  72481. }
  72482. /**
  72483. * Represents a physics vortex event
  72484. */
  72485. class PhysicsVortexEvent {
  72486. private _scene;
  72487. private _origin;
  72488. private _options;
  72489. private _physicsEngine;
  72490. private _originTop;
  72491. private _tickCallback;
  72492. private _cylinder;
  72493. private _cylinderPosition;
  72494. private _dataFetched;
  72495. /**
  72496. * Initializes the physics vortex event
  72497. * @param _scene The BabylonJS scene
  72498. * @param _origin The origin position of the vortex
  72499. * @param _options The options for the vortex event
  72500. */
  72501. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72502. /**
  72503. * Returns the data related to the vortex event (cylinder).
  72504. * @returns The physics vortex event data
  72505. */
  72506. getData(): PhysicsVortexEventData;
  72507. /**
  72508. * Enables the vortex.
  72509. */
  72510. enable(): void;
  72511. /**
  72512. * Disables the cortex.
  72513. */
  72514. disable(): void;
  72515. /**
  72516. * Disposes the sphere.
  72517. * @param force
  72518. */
  72519. dispose(force?: boolean): void;
  72520. private getImpostorHitData;
  72521. private _tick;
  72522. /*** Helpers ***/
  72523. private _prepareCylinder;
  72524. private _intersectsWithCylinder;
  72525. }
  72526. /**
  72527. * Options fot the radial explosion event
  72528. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72529. */
  72530. export class PhysicsRadialExplosionEventOptions {
  72531. /**
  72532. * The radius of the sphere for the radial explosion.
  72533. */
  72534. radius: number;
  72535. /**
  72536. * The strenth of the explosion.
  72537. */
  72538. strength: number;
  72539. /**
  72540. * The strenght of the force in correspondence to the distance of the affected object
  72541. */
  72542. falloff: PhysicsRadialImpulseFalloff;
  72543. /**
  72544. * Sphere options for the radial explosion.
  72545. */
  72546. sphere: {
  72547. segments: number;
  72548. diameter: number;
  72549. };
  72550. /**
  72551. * Sphere options for the radial explosion.
  72552. */
  72553. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72554. }
  72555. /**
  72556. * Options fot the updraft event
  72557. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72558. */
  72559. export class PhysicsUpdraftEventOptions {
  72560. /**
  72561. * The radius of the cylinder for the vortex
  72562. */
  72563. radius: number;
  72564. /**
  72565. * The strenth of the updraft.
  72566. */
  72567. strength: number;
  72568. /**
  72569. * The height of the cylinder for the updraft.
  72570. */
  72571. height: number;
  72572. /**
  72573. * The mode for the the updraft.
  72574. */
  72575. updraftMode: PhysicsUpdraftMode;
  72576. }
  72577. /**
  72578. * Options fot the vortex event
  72579. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72580. */
  72581. export class PhysicsVortexEventOptions {
  72582. /**
  72583. * The radius of the cylinder for the vortex
  72584. */
  72585. radius: number;
  72586. /**
  72587. * The strenth of the vortex.
  72588. */
  72589. strength: number;
  72590. /**
  72591. * The height of the cylinder for the vortex.
  72592. */
  72593. height: number;
  72594. /**
  72595. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72596. */
  72597. centripetalForceThreshold: number;
  72598. /**
  72599. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72600. */
  72601. centripetalForceMultiplier: number;
  72602. /**
  72603. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72604. */
  72605. centrifugalForceMultiplier: number;
  72606. /**
  72607. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72608. */
  72609. updraftForceMultiplier: number;
  72610. }
  72611. /**
  72612. * The strenght of the force in correspondence to the distance of the affected object
  72613. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72614. */
  72615. export enum PhysicsRadialImpulseFalloff {
  72616. /** Defines that impulse is constant in strength across it's whole radius */
  72617. Constant = 0,
  72618. /** Defines that impulse gets weaker if it's further from the origin */
  72619. Linear = 1
  72620. }
  72621. /**
  72622. * The strength of the force in correspondence to the distance of the affected object
  72623. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72624. */
  72625. export enum PhysicsUpdraftMode {
  72626. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72627. Center = 0,
  72628. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72629. Perpendicular = 1
  72630. }
  72631. /**
  72632. * Interface for a physics hit data
  72633. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72634. */
  72635. export interface PhysicsHitData {
  72636. /**
  72637. * The force applied at the contact point
  72638. */
  72639. force: Vector3;
  72640. /**
  72641. * The contact point
  72642. */
  72643. contactPoint: Vector3;
  72644. /**
  72645. * The distance from the origin to the contact point
  72646. */
  72647. distanceFromOrigin: number;
  72648. }
  72649. /**
  72650. * Interface for radial explosion event data
  72651. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72652. */
  72653. export interface PhysicsRadialExplosionEventData {
  72654. /**
  72655. * A sphere used for the radial explosion event
  72656. */
  72657. sphere: Mesh;
  72658. }
  72659. /**
  72660. * Interface for gravitational field event data
  72661. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72662. */
  72663. export interface PhysicsGravitationalFieldEventData {
  72664. /**
  72665. * A sphere mesh used for the gravitational field event
  72666. */
  72667. sphere: Mesh;
  72668. }
  72669. /**
  72670. * Interface for updraft event data
  72671. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72672. */
  72673. export interface PhysicsUpdraftEventData {
  72674. /**
  72675. * A cylinder used for the updraft event
  72676. */
  72677. cylinder: Mesh;
  72678. }
  72679. /**
  72680. * Interface for vortex event data
  72681. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72682. */
  72683. export interface PhysicsVortexEventData {
  72684. /**
  72685. * A cylinder used for the vortex event
  72686. */
  72687. cylinder: Mesh;
  72688. }
  72689. /**
  72690. * Interface for an affected physics impostor
  72691. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72692. */
  72693. export interface PhysicsAffectedImpostorWithData {
  72694. /**
  72695. * The impostor affected by the effect
  72696. */
  72697. impostor: PhysicsImpostor;
  72698. /**
  72699. * The data about the hit/horce from the explosion
  72700. */
  72701. hitData: PhysicsHitData;
  72702. }
  72703. }
  72704. declare module "babylonjs/Physics/Plugins/index" {
  72705. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72706. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72707. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72708. }
  72709. declare module "babylonjs/Physics/index" {
  72710. export * from "babylonjs/Physics/IPhysicsEngine";
  72711. export * from "babylonjs/Physics/physicsEngine";
  72712. export * from "babylonjs/Physics/physicsEngineComponent";
  72713. export * from "babylonjs/Physics/physicsHelper";
  72714. export * from "babylonjs/Physics/physicsImpostor";
  72715. export * from "babylonjs/Physics/physicsJoint";
  72716. export * from "babylonjs/Physics/Plugins/index";
  72717. }
  72718. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72719. /** @hidden */
  72720. export var blackAndWhitePixelShader: {
  72721. name: string;
  72722. shader: string;
  72723. };
  72724. }
  72725. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72726. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72727. import { Camera } from "babylonjs/Cameras/camera";
  72728. import { Engine } from "babylonjs/Engines/engine";
  72729. import "babylonjs/Shaders/blackAndWhite.fragment";
  72730. import { Nullable } from "babylonjs/types";
  72731. import { Scene } from "babylonjs/scene";
  72732. /**
  72733. * Post process used to render in black and white
  72734. */
  72735. export class BlackAndWhitePostProcess extends PostProcess {
  72736. /**
  72737. * Linear about to convert he result to black and white (default: 1)
  72738. */
  72739. degree: number;
  72740. /**
  72741. * Gets a string identifying the name of the class
  72742. * @returns "BlackAndWhitePostProcess" string
  72743. */
  72744. getClassName(): string;
  72745. /**
  72746. * Creates a black and white post process
  72747. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72748. * @param name The name of the effect.
  72749. * @param options The required width/height ratio to downsize to before computing the render pass.
  72750. * @param camera The camera to apply the render pass to.
  72751. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72752. * @param engine The engine which the post process will be applied. (default: current engine)
  72753. * @param reusable If the post process can be reused on the same frame. (default: false)
  72754. */
  72755. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72756. /** @hidden */
  72757. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72758. }
  72759. }
  72760. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72761. import { Nullable } from "babylonjs/types";
  72762. import { Camera } from "babylonjs/Cameras/camera";
  72763. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72764. import { Engine } from "babylonjs/Engines/engine";
  72765. /**
  72766. * This represents a set of one or more post processes in Babylon.
  72767. * A post process can be used to apply a shader to a texture after it is rendered.
  72768. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72769. */
  72770. export class PostProcessRenderEffect {
  72771. private _postProcesses;
  72772. private _getPostProcesses;
  72773. private _singleInstance;
  72774. private _cameras;
  72775. private _indicesForCamera;
  72776. /**
  72777. * Name of the effect
  72778. * @hidden
  72779. */
  72780. _name: string;
  72781. /**
  72782. * Instantiates a post process render effect.
  72783. * A post process can be used to apply a shader to a texture after it is rendered.
  72784. * @param engine The engine the effect is tied to
  72785. * @param name The name of the effect
  72786. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72787. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72788. */
  72789. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72790. /**
  72791. * Checks if all the post processes in the effect are supported.
  72792. */
  72793. get isSupported(): boolean;
  72794. /**
  72795. * Updates the current state of the effect
  72796. * @hidden
  72797. */
  72798. _update(): void;
  72799. /**
  72800. * Attaches the effect on cameras
  72801. * @param cameras The camera to attach to.
  72802. * @hidden
  72803. */
  72804. _attachCameras(cameras: Camera): void;
  72805. /**
  72806. * Attaches the effect on cameras
  72807. * @param cameras The camera to attach to.
  72808. * @hidden
  72809. */
  72810. _attachCameras(cameras: Camera[]): void;
  72811. /**
  72812. * Detaches the effect on cameras
  72813. * @param cameras The camera to detatch from.
  72814. * @hidden
  72815. */
  72816. _detachCameras(cameras: Camera): void;
  72817. /**
  72818. * Detatches the effect on cameras
  72819. * @param cameras The camera to detatch from.
  72820. * @hidden
  72821. */
  72822. _detachCameras(cameras: Camera[]): void;
  72823. /**
  72824. * Enables the effect on given cameras
  72825. * @param cameras The camera to enable.
  72826. * @hidden
  72827. */
  72828. _enable(cameras: Camera): void;
  72829. /**
  72830. * Enables the effect on given cameras
  72831. * @param cameras The camera to enable.
  72832. * @hidden
  72833. */
  72834. _enable(cameras: Nullable<Camera[]>): void;
  72835. /**
  72836. * Disables the effect on the given cameras
  72837. * @param cameras The camera to disable.
  72838. * @hidden
  72839. */
  72840. _disable(cameras: Camera): void;
  72841. /**
  72842. * Disables the effect on the given cameras
  72843. * @param cameras The camera to disable.
  72844. * @hidden
  72845. */
  72846. _disable(cameras: Nullable<Camera[]>): void;
  72847. /**
  72848. * Gets a list of the post processes contained in the effect.
  72849. * @param camera The camera to get the post processes on.
  72850. * @returns The list of the post processes in the effect.
  72851. */
  72852. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72853. }
  72854. }
  72855. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72856. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72857. /** @hidden */
  72858. export var extractHighlightsPixelShader: {
  72859. name: string;
  72860. shader: string;
  72861. };
  72862. }
  72863. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72864. import { Nullable } from "babylonjs/types";
  72865. import { Camera } from "babylonjs/Cameras/camera";
  72866. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72867. import { Engine } from "babylonjs/Engines/engine";
  72868. import "babylonjs/Shaders/extractHighlights.fragment";
  72869. /**
  72870. * 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.
  72871. */
  72872. export class ExtractHighlightsPostProcess extends PostProcess {
  72873. /**
  72874. * The luminance threshold, pixels below this value will be set to black.
  72875. */
  72876. threshold: number;
  72877. /** @hidden */
  72878. _exposure: number;
  72879. /**
  72880. * Post process which has the input texture to be used when performing highlight extraction
  72881. * @hidden
  72882. */
  72883. _inputPostProcess: Nullable<PostProcess>;
  72884. /**
  72885. * Gets a string identifying the name of the class
  72886. * @returns "ExtractHighlightsPostProcess" string
  72887. */
  72888. getClassName(): string;
  72889. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72890. }
  72891. }
  72892. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72893. /** @hidden */
  72894. export var bloomMergePixelShader: {
  72895. name: string;
  72896. shader: string;
  72897. };
  72898. }
  72899. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72900. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72901. import { Nullable } from "babylonjs/types";
  72902. import { Engine } from "babylonjs/Engines/engine";
  72903. import { Camera } from "babylonjs/Cameras/camera";
  72904. import "babylonjs/Shaders/bloomMerge.fragment";
  72905. /**
  72906. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72907. */
  72908. export class BloomMergePostProcess extends PostProcess {
  72909. /** Weight of the bloom to be added to the original input. */
  72910. weight: number;
  72911. /**
  72912. * Gets a string identifying the name of the class
  72913. * @returns "BloomMergePostProcess" string
  72914. */
  72915. getClassName(): string;
  72916. /**
  72917. * Creates a new instance of @see BloomMergePostProcess
  72918. * @param name The name of the effect.
  72919. * @param originalFromInput Post process which's input will be used for the merge.
  72920. * @param blurred Blurred highlights post process which's output will be used.
  72921. * @param weight Weight of the bloom to be added to the original input.
  72922. * @param options The required width/height ratio to downsize to before computing the render pass.
  72923. * @param camera The camera to apply the render pass to.
  72924. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72925. * @param engine The engine which the post process will be applied. (default: current engine)
  72926. * @param reusable If the post process can be reused on the same frame. (default: false)
  72927. * @param textureType Type of textures used when performing the post process. (default: 0)
  72928. * @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)
  72929. */
  72930. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72931. /** Weight of the bloom to be added to the original input. */
  72932. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72933. }
  72934. }
  72935. declare module "babylonjs/PostProcesses/bloomEffect" {
  72936. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72937. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72938. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72939. import { Camera } from "babylonjs/Cameras/camera";
  72940. import { Scene } from "babylonjs/scene";
  72941. /**
  72942. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72943. */
  72944. export class BloomEffect extends PostProcessRenderEffect {
  72945. private bloomScale;
  72946. /**
  72947. * @hidden Internal
  72948. */
  72949. _effects: Array<PostProcess>;
  72950. /**
  72951. * @hidden Internal
  72952. */
  72953. _downscale: ExtractHighlightsPostProcess;
  72954. private _blurX;
  72955. private _blurY;
  72956. private _merge;
  72957. /**
  72958. * The luminance threshold to find bright areas of the image to bloom.
  72959. */
  72960. get threshold(): number;
  72961. set threshold(value: number);
  72962. /**
  72963. * The strength of the bloom.
  72964. */
  72965. get weight(): number;
  72966. set weight(value: number);
  72967. /**
  72968. * Specifies the size of the bloom blur kernel, relative to the final output size
  72969. */
  72970. get kernel(): number;
  72971. set kernel(value: number);
  72972. /**
  72973. * Creates a new instance of @see BloomEffect
  72974. * @param scene The scene the effect belongs to.
  72975. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72976. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72977. * @param bloomWeight The the strength of bloom.
  72978. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72979. * @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)
  72980. */
  72981. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72982. /**
  72983. * Disposes each of the internal effects for a given camera.
  72984. * @param camera The camera to dispose the effect on.
  72985. */
  72986. disposeEffects(camera: Camera): void;
  72987. /**
  72988. * @hidden Internal
  72989. */
  72990. _updateEffects(): void;
  72991. /**
  72992. * Internal
  72993. * @returns if all the contained post processes are ready.
  72994. * @hidden
  72995. */
  72996. _isReady(): boolean;
  72997. }
  72998. }
  72999. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  73000. /** @hidden */
  73001. export var chromaticAberrationPixelShader: {
  73002. name: string;
  73003. shader: string;
  73004. };
  73005. }
  73006. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  73007. import { Vector2 } from "babylonjs/Maths/math.vector";
  73008. import { Nullable } from "babylonjs/types";
  73009. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73010. import { Camera } from "babylonjs/Cameras/camera";
  73011. import { Engine } from "babylonjs/Engines/engine";
  73012. import "babylonjs/Shaders/chromaticAberration.fragment";
  73013. import { Scene } from "babylonjs/scene";
  73014. /**
  73015. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  73016. */
  73017. export class ChromaticAberrationPostProcess extends PostProcess {
  73018. /**
  73019. * The amount of seperation of rgb channels (default: 30)
  73020. */
  73021. aberrationAmount: number;
  73022. /**
  73023. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  73024. */
  73025. radialIntensity: number;
  73026. /**
  73027. * 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))
  73028. */
  73029. direction: Vector2;
  73030. /**
  73031. * 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))
  73032. */
  73033. centerPosition: Vector2;
  73034. /** The width of the screen to apply the effect on */
  73035. screenWidth: number;
  73036. /** The height of the screen to apply the effect on */
  73037. screenHeight: number;
  73038. /**
  73039. * Gets a string identifying the name of the class
  73040. * @returns "ChromaticAberrationPostProcess" string
  73041. */
  73042. getClassName(): string;
  73043. /**
  73044. * Creates a new instance ChromaticAberrationPostProcess
  73045. * @param name The name of the effect.
  73046. * @param screenWidth The width of the screen to apply the effect on.
  73047. * @param screenHeight The height of the screen to apply the effect on.
  73048. * @param options The required width/height ratio to downsize to before computing the render pass.
  73049. * @param camera The camera to apply the render pass to.
  73050. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73051. * @param engine The engine which the post process will be applied. (default: current engine)
  73052. * @param reusable If the post process can be reused on the same frame. (default: false)
  73053. * @param textureType Type of textures used when performing the post process. (default: 0)
  73054. * @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)
  73055. */
  73056. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73057. /** @hidden */
  73058. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  73059. }
  73060. }
  73061. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  73062. /** @hidden */
  73063. export var circleOfConfusionPixelShader: {
  73064. name: string;
  73065. shader: string;
  73066. };
  73067. }
  73068. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  73069. import { Nullable } from "babylonjs/types";
  73070. import { Engine } from "babylonjs/Engines/engine";
  73071. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73072. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73073. import { Camera } from "babylonjs/Cameras/camera";
  73074. import "babylonjs/Shaders/circleOfConfusion.fragment";
  73075. /**
  73076. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  73077. */
  73078. export class CircleOfConfusionPostProcess extends PostProcess {
  73079. /**
  73080. * 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.
  73081. */
  73082. lensSize: number;
  73083. /**
  73084. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73085. */
  73086. fStop: number;
  73087. /**
  73088. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73089. */
  73090. focusDistance: number;
  73091. /**
  73092. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  73093. */
  73094. focalLength: number;
  73095. /**
  73096. * Gets a string identifying the name of the class
  73097. * @returns "CircleOfConfusionPostProcess" string
  73098. */
  73099. getClassName(): string;
  73100. private _depthTexture;
  73101. /**
  73102. * Creates a new instance CircleOfConfusionPostProcess
  73103. * @param name The name of the effect.
  73104. * @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.
  73105. * @param options The required width/height ratio to downsize to before computing the render pass.
  73106. * @param camera The camera to apply the render pass to.
  73107. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73108. * @param engine The engine which the post process will be applied. (default: current engine)
  73109. * @param reusable If the post process can be reused on the same frame. (default: false)
  73110. * @param textureType Type of textures used when performing the post process. (default: 0)
  73111. * @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)
  73112. */
  73113. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73114. /**
  73115. * 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.
  73116. */
  73117. set depthTexture(value: RenderTargetTexture);
  73118. }
  73119. }
  73120. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  73121. /** @hidden */
  73122. export var colorCorrectionPixelShader: {
  73123. name: string;
  73124. shader: string;
  73125. };
  73126. }
  73127. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  73128. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73129. import { Engine } from "babylonjs/Engines/engine";
  73130. import { Camera } from "babylonjs/Cameras/camera";
  73131. import "babylonjs/Shaders/colorCorrection.fragment";
  73132. import { Nullable } from "babylonjs/types";
  73133. import { Scene } from "babylonjs/scene";
  73134. /**
  73135. *
  73136. * This post-process allows the modification of rendered colors by using
  73137. * a 'look-up table' (LUT). This effect is also called Color Grading.
  73138. *
  73139. * The object needs to be provided an url to a texture containing the color
  73140. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  73141. * Use an image editing software to tweak the LUT to match your needs.
  73142. *
  73143. * For an example of a color LUT, see here:
  73144. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  73145. * For explanations on color grading, see here:
  73146. * @see http://udn.epicgames.com/Three/ColorGrading.html
  73147. *
  73148. */
  73149. export class ColorCorrectionPostProcess extends PostProcess {
  73150. private _colorTableTexture;
  73151. /**
  73152. * Gets the color table url used to create the LUT texture
  73153. */
  73154. colorTableUrl: string;
  73155. /**
  73156. * Gets a string identifying the name of the class
  73157. * @returns "ColorCorrectionPostProcess" string
  73158. */
  73159. getClassName(): string;
  73160. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73161. /** @hidden */
  73162. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  73163. }
  73164. }
  73165. declare module "babylonjs/Shaders/convolution.fragment" {
  73166. /** @hidden */
  73167. export var convolutionPixelShader: {
  73168. name: string;
  73169. shader: string;
  73170. };
  73171. }
  73172. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  73173. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73174. import { Nullable } from "babylonjs/types";
  73175. import { Camera } from "babylonjs/Cameras/camera";
  73176. import { Engine } from "babylonjs/Engines/engine";
  73177. import "babylonjs/Shaders/convolution.fragment";
  73178. import { Scene } from "babylonjs/scene";
  73179. /**
  73180. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  73181. * input texture to perform effects such as edge detection or sharpening
  73182. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73183. */
  73184. export class ConvolutionPostProcess extends PostProcess {
  73185. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  73186. kernel: number[];
  73187. /**
  73188. * Gets a string identifying the name of the class
  73189. * @returns "ConvolutionPostProcess" string
  73190. */
  73191. getClassName(): string;
  73192. /**
  73193. * Creates a new instance ConvolutionPostProcess
  73194. * @param name The name of the effect.
  73195. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  73196. * @param options The required width/height ratio to downsize to before computing the render pass.
  73197. * @param camera The camera to apply the render pass to.
  73198. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73199. * @param engine The engine which the post process will be applied. (default: current engine)
  73200. * @param reusable If the post process can be reused on the same frame. (default: false)
  73201. * @param textureType Type of textures used when performing the post process. (default: 0)
  73202. */
  73203. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73204. /** @hidden */
  73205. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  73206. /**
  73207. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73208. */
  73209. static EdgeDetect0Kernel: number[];
  73210. /**
  73211. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73212. */
  73213. static EdgeDetect1Kernel: number[];
  73214. /**
  73215. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73216. */
  73217. static EdgeDetect2Kernel: number[];
  73218. /**
  73219. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73220. */
  73221. static SharpenKernel: number[];
  73222. /**
  73223. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73224. */
  73225. static EmbossKernel: number[];
  73226. /**
  73227. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73228. */
  73229. static GaussianKernel: number[];
  73230. }
  73231. }
  73232. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  73233. import { Nullable } from "babylonjs/types";
  73234. import { Vector2 } from "babylonjs/Maths/math.vector";
  73235. import { Camera } from "babylonjs/Cameras/camera";
  73236. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73237. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73238. import { Engine } from "babylonjs/Engines/engine";
  73239. import { Scene } from "babylonjs/scene";
  73240. /**
  73241. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73242. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73243. * based on samples that have a large difference in distance than the center pixel.
  73244. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73245. */
  73246. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73247. /**
  73248. * The direction the blur should be applied
  73249. */
  73250. direction: Vector2;
  73251. /**
  73252. * Gets a string identifying the name of the class
  73253. * @returns "DepthOfFieldBlurPostProcess" string
  73254. */
  73255. getClassName(): string;
  73256. /**
  73257. * Creates a new instance CircleOfConfusionPostProcess
  73258. * @param name The name of the effect.
  73259. * @param scene The scene the effect belongs to.
  73260. * @param direction The direction the blur should be applied.
  73261. * @param kernel The size of the kernel used to blur.
  73262. * @param options The required width/height ratio to downsize to before computing the render pass.
  73263. * @param camera The camera to apply the render pass to.
  73264. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73265. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73266. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73267. * @param engine The engine which the post process will be applied. (default: current engine)
  73268. * @param reusable If the post process can be reused on the same frame. (default: false)
  73269. * @param textureType Type of textures used when performing the post process. (default: 0)
  73270. * @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)
  73271. */
  73272. 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);
  73273. }
  73274. }
  73275. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73276. /** @hidden */
  73277. export var depthOfFieldMergePixelShader: {
  73278. name: string;
  73279. shader: string;
  73280. };
  73281. }
  73282. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73283. import { Nullable } from "babylonjs/types";
  73284. import { Camera } from "babylonjs/Cameras/camera";
  73285. import { Effect } from "babylonjs/Materials/effect";
  73286. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73287. import { Engine } from "babylonjs/Engines/engine";
  73288. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73289. /**
  73290. * Options to be set when merging outputs from the default pipeline.
  73291. */
  73292. export class DepthOfFieldMergePostProcessOptions {
  73293. /**
  73294. * The original image to merge on top of
  73295. */
  73296. originalFromInput: PostProcess;
  73297. /**
  73298. * Parameters to perform the merge of the depth of field effect
  73299. */
  73300. depthOfField?: {
  73301. circleOfConfusion: PostProcess;
  73302. blurSteps: Array<PostProcess>;
  73303. };
  73304. /**
  73305. * Parameters to perform the merge of bloom effect
  73306. */
  73307. bloom?: {
  73308. blurred: PostProcess;
  73309. weight: number;
  73310. };
  73311. }
  73312. /**
  73313. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73314. */
  73315. export class DepthOfFieldMergePostProcess extends PostProcess {
  73316. private blurSteps;
  73317. /**
  73318. * Gets a string identifying the name of the class
  73319. * @returns "DepthOfFieldMergePostProcess" string
  73320. */
  73321. getClassName(): string;
  73322. /**
  73323. * Creates a new instance of DepthOfFieldMergePostProcess
  73324. * @param name The name of the effect.
  73325. * @param originalFromInput Post process which's input will be used for the merge.
  73326. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73327. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73328. * @param options The required width/height ratio to downsize to before computing the render pass.
  73329. * @param camera The camera to apply the render pass to.
  73330. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73331. * @param engine The engine which the post process will be applied. (default: current engine)
  73332. * @param reusable If the post process can be reused on the same frame. (default: false)
  73333. * @param textureType Type of textures used when performing the post process. (default: 0)
  73334. * @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)
  73335. */
  73336. 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);
  73337. /**
  73338. * Updates the effect with the current post process compile time values and recompiles the shader.
  73339. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73340. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73341. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73342. * @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
  73343. * @param onCompiled Called when the shader has been compiled.
  73344. * @param onError Called if there is an error when compiling a shader.
  73345. */
  73346. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73347. }
  73348. }
  73349. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73350. import { Nullable } from "babylonjs/types";
  73351. import { Camera } from "babylonjs/Cameras/camera";
  73352. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73353. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73354. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73355. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73356. import { Scene } from "babylonjs/scene";
  73357. /**
  73358. * Specifies the level of max blur that should be applied when using the depth of field effect
  73359. */
  73360. export enum DepthOfFieldEffectBlurLevel {
  73361. /**
  73362. * Subtle blur
  73363. */
  73364. Low = 0,
  73365. /**
  73366. * Medium blur
  73367. */
  73368. Medium = 1,
  73369. /**
  73370. * Large blur
  73371. */
  73372. High = 2
  73373. }
  73374. /**
  73375. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73376. */
  73377. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73378. private _circleOfConfusion;
  73379. /**
  73380. * @hidden Internal, blurs from high to low
  73381. */
  73382. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73383. private _depthOfFieldBlurY;
  73384. private _dofMerge;
  73385. /**
  73386. * @hidden Internal post processes in depth of field effect
  73387. */
  73388. _effects: Array<PostProcess>;
  73389. /**
  73390. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73391. */
  73392. set focalLength(value: number);
  73393. get focalLength(): number;
  73394. /**
  73395. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73396. */
  73397. set fStop(value: number);
  73398. get fStop(): number;
  73399. /**
  73400. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73401. */
  73402. set focusDistance(value: number);
  73403. get focusDistance(): number;
  73404. /**
  73405. * 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.
  73406. */
  73407. set lensSize(value: number);
  73408. get lensSize(): number;
  73409. /**
  73410. * Creates a new instance DepthOfFieldEffect
  73411. * @param scene The scene the effect belongs to.
  73412. * @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.
  73413. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73414. * @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)
  73415. */
  73416. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73417. /**
  73418. * Get the current class name of the current effet
  73419. * @returns "DepthOfFieldEffect"
  73420. */
  73421. getClassName(): string;
  73422. /**
  73423. * 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.
  73424. */
  73425. set depthTexture(value: RenderTargetTexture);
  73426. /**
  73427. * Disposes each of the internal effects for a given camera.
  73428. * @param camera The camera to dispose the effect on.
  73429. */
  73430. disposeEffects(camera: Camera): void;
  73431. /**
  73432. * @hidden Internal
  73433. */
  73434. _updateEffects(): void;
  73435. /**
  73436. * Internal
  73437. * @returns if all the contained post processes are ready.
  73438. * @hidden
  73439. */
  73440. _isReady(): boolean;
  73441. }
  73442. }
  73443. declare module "babylonjs/Shaders/displayPass.fragment" {
  73444. /** @hidden */
  73445. export var displayPassPixelShader: {
  73446. name: string;
  73447. shader: string;
  73448. };
  73449. }
  73450. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73451. import { Nullable } from "babylonjs/types";
  73452. import { Camera } from "babylonjs/Cameras/camera";
  73453. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73454. import { Engine } from "babylonjs/Engines/engine";
  73455. import "babylonjs/Shaders/displayPass.fragment";
  73456. import { Scene } from "babylonjs/scene";
  73457. /**
  73458. * DisplayPassPostProcess which produces an output the same as it's input
  73459. */
  73460. export class DisplayPassPostProcess extends PostProcess {
  73461. /**
  73462. * Gets a string identifying the name of the class
  73463. * @returns "DisplayPassPostProcess" string
  73464. */
  73465. getClassName(): string;
  73466. /**
  73467. * Creates the DisplayPassPostProcess
  73468. * @param name The name of the effect.
  73469. * @param options The required width/height ratio to downsize to before computing the render pass.
  73470. * @param camera The camera to apply the render pass to.
  73471. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73472. * @param engine The engine which the post process will be applied. (default: current engine)
  73473. * @param reusable If the post process can be reused on the same frame. (default: false)
  73474. */
  73475. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73476. /** @hidden */
  73477. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73478. }
  73479. }
  73480. declare module "babylonjs/Shaders/filter.fragment" {
  73481. /** @hidden */
  73482. export var filterPixelShader: {
  73483. name: string;
  73484. shader: string;
  73485. };
  73486. }
  73487. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73488. import { Nullable } from "babylonjs/types";
  73489. import { Matrix } from "babylonjs/Maths/math.vector";
  73490. import { Camera } from "babylonjs/Cameras/camera";
  73491. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73492. import { Engine } from "babylonjs/Engines/engine";
  73493. import "babylonjs/Shaders/filter.fragment";
  73494. import { Scene } from "babylonjs/scene";
  73495. /**
  73496. * Applies a kernel filter to the image
  73497. */
  73498. export class FilterPostProcess extends PostProcess {
  73499. /** The matrix to be applied to the image */
  73500. kernelMatrix: Matrix;
  73501. /**
  73502. * Gets a string identifying the name of the class
  73503. * @returns "FilterPostProcess" string
  73504. */
  73505. getClassName(): string;
  73506. /**
  73507. *
  73508. * @param name The name of the effect.
  73509. * @param kernelMatrix The matrix to be applied to the image
  73510. * @param options The required width/height ratio to downsize to before computing the render pass.
  73511. * @param camera The camera to apply the render pass to.
  73512. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73513. * @param engine The engine which the post process will be applied. (default: current engine)
  73514. * @param reusable If the post process can be reused on the same frame. (default: false)
  73515. */
  73516. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73517. /** @hidden */
  73518. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73519. }
  73520. }
  73521. declare module "babylonjs/Shaders/fxaa.fragment" {
  73522. /** @hidden */
  73523. export var fxaaPixelShader: {
  73524. name: string;
  73525. shader: string;
  73526. };
  73527. }
  73528. declare module "babylonjs/Shaders/fxaa.vertex" {
  73529. /** @hidden */
  73530. export var fxaaVertexShader: {
  73531. name: string;
  73532. shader: string;
  73533. };
  73534. }
  73535. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73536. import { Nullable } from "babylonjs/types";
  73537. import { Camera } from "babylonjs/Cameras/camera";
  73538. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73539. import { Engine } from "babylonjs/Engines/engine";
  73540. import "babylonjs/Shaders/fxaa.fragment";
  73541. import "babylonjs/Shaders/fxaa.vertex";
  73542. import { Scene } from "babylonjs/scene";
  73543. /**
  73544. * Fxaa post process
  73545. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73546. */
  73547. export class FxaaPostProcess extends PostProcess {
  73548. /**
  73549. * Gets a string identifying the name of the class
  73550. * @returns "FxaaPostProcess" string
  73551. */
  73552. getClassName(): string;
  73553. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73554. private _getDefines;
  73555. /** @hidden */
  73556. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73557. }
  73558. }
  73559. declare module "babylonjs/Shaders/grain.fragment" {
  73560. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73561. /** @hidden */
  73562. export var grainPixelShader: {
  73563. name: string;
  73564. shader: string;
  73565. };
  73566. }
  73567. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73568. import { Nullable } from "babylonjs/types";
  73569. import { Camera } from "babylonjs/Cameras/camera";
  73570. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73571. import { Engine } from "babylonjs/Engines/engine";
  73572. import "babylonjs/Shaders/grain.fragment";
  73573. import { Scene } from "babylonjs/scene";
  73574. /**
  73575. * The GrainPostProcess adds noise to the image at mid luminance levels
  73576. */
  73577. export class GrainPostProcess extends PostProcess {
  73578. /**
  73579. * The intensity of the grain added (default: 30)
  73580. */
  73581. intensity: number;
  73582. /**
  73583. * If the grain should be randomized on every frame
  73584. */
  73585. animated: boolean;
  73586. /**
  73587. * Gets a string identifying the name of the class
  73588. * @returns "GrainPostProcess" string
  73589. */
  73590. getClassName(): string;
  73591. /**
  73592. * Creates a new instance of @see GrainPostProcess
  73593. * @param name The name of the effect.
  73594. * @param options The required width/height ratio to downsize to before computing the render pass.
  73595. * @param camera The camera to apply the render pass to.
  73596. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73597. * @param engine The engine which the post process will be applied. (default: current engine)
  73598. * @param reusable If the post process can be reused on the same frame. (default: false)
  73599. * @param textureType Type of textures used when performing the post process. (default: 0)
  73600. * @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)
  73601. */
  73602. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73603. /** @hidden */
  73604. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73605. }
  73606. }
  73607. declare module "babylonjs/Shaders/highlights.fragment" {
  73608. /** @hidden */
  73609. export var highlightsPixelShader: {
  73610. name: string;
  73611. shader: string;
  73612. };
  73613. }
  73614. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73615. import { Nullable } from "babylonjs/types";
  73616. import { Camera } from "babylonjs/Cameras/camera";
  73617. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73618. import { Engine } from "babylonjs/Engines/engine";
  73619. import "babylonjs/Shaders/highlights.fragment";
  73620. /**
  73621. * Extracts highlights from the image
  73622. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73623. */
  73624. export class HighlightsPostProcess extends PostProcess {
  73625. /**
  73626. * Gets a string identifying the name of the class
  73627. * @returns "HighlightsPostProcess" string
  73628. */
  73629. getClassName(): string;
  73630. /**
  73631. * Extracts highlights from the image
  73632. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73633. * @param name The name of the effect.
  73634. * @param options The required width/height ratio to downsize to before computing the render pass.
  73635. * @param camera The camera to apply the render pass to.
  73636. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73637. * @param engine The engine which the post process will be applied. (default: current engine)
  73638. * @param reusable If the post process can be reused on the same frame. (default: false)
  73639. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73640. */
  73641. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73642. }
  73643. }
  73644. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73645. /** @hidden */
  73646. export var mrtFragmentDeclaration: {
  73647. name: string;
  73648. shader: string;
  73649. };
  73650. }
  73651. declare module "babylonjs/Shaders/geometry.fragment" {
  73652. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73653. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73654. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73655. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73656. /** @hidden */
  73657. export var geometryPixelShader: {
  73658. name: string;
  73659. shader: string;
  73660. };
  73661. }
  73662. declare module "babylonjs/Shaders/geometry.vertex" {
  73663. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73664. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73665. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73666. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73667. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73668. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73669. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73670. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73671. /** @hidden */
  73672. export var geometryVertexShader: {
  73673. name: string;
  73674. shader: string;
  73675. };
  73676. }
  73677. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73678. import { Matrix } from "babylonjs/Maths/math.vector";
  73679. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73680. import { Mesh } from "babylonjs/Meshes/mesh";
  73681. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73682. import { Effect } from "babylonjs/Materials/effect";
  73683. import { Scene } from "babylonjs/scene";
  73684. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73685. import "babylonjs/Shaders/geometry.fragment";
  73686. import "babylonjs/Shaders/geometry.vertex";
  73687. /** @hidden */
  73688. interface ISavedTransformationMatrix {
  73689. world: Matrix;
  73690. viewProjection: Matrix;
  73691. }
  73692. /**
  73693. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73694. */
  73695. export class GeometryBufferRenderer {
  73696. /**
  73697. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73698. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73699. */
  73700. static readonly POSITION_TEXTURE_TYPE: number;
  73701. /**
  73702. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73703. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73704. */
  73705. static readonly VELOCITY_TEXTURE_TYPE: number;
  73706. /**
  73707. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73708. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73709. */
  73710. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73711. /**
  73712. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73713. * in order to compute objects velocities when enableVelocity is set to "true"
  73714. * @hidden
  73715. */
  73716. _previousTransformationMatrices: {
  73717. [index: number]: ISavedTransformationMatrix;
  73718. };
  73719. /**
  73720. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73721. * in order to compute objects velocities when enableVelocity is set to "true"
  73722. * @hidden
  73723. */
  73724. _previousBonesTransformationMatrices: {
  73725. [index: number]: Float32Array;
  73726. };
  73727. /**
  73728. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73729. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73730. */
  73731. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73732. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73733. renderTransparentMeshes: boolean;
  73734. private _scene;
  73735. private _resizeObserver;
  73736. private _multiRenderTarget;
  73737. private _ratio;
  73738. private _enablePosition;
  73739. private _enableVelocity;
  73740. private _enableReflectivity;
  73741. private _positionIndex;
  73742. private _velocityIndex;
  73743. private _reflectivityIndex;
  73744. protected _effect: Effect;
  73745. protected _cachedDefines: string;
  73746. /**
  73747. * Set the render list (meshes to be rendered) used in the G buffer.
  73748. */
  73749. set renderList(meshes: Mesh[]);
  73750. /**
  73751. * Gets wether or not G buffer are supported by the running hardware.
  73752. * This requires draw buffer supports
  73753. */
  73754. get isSupported(): boolean;
  73755. /**
  73756. * Returns the index of the given texture type in the G-Buffer textures array
  73757. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73758. * @returns the index of the given texture type in the G-Buffer textures array
  73759. */
  73760. getTextureIndex(textureType: number): number;
  73761. /**
  73762. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73763. */
  73764. get enablePosition(): boolean;
  73765. /**
  73766. * Sets whether or not objects positions are enabled for the G buffer.
  73767. */
  73768. set enablePosition(enable: boolean);
  73769. /**
  73770. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73771. */
  73772. get enableVelocity(): boolean;
  73773. /**
  73774. * Sets wether or not objects velocities are enabled for the G buffer.
  73775. */
  73776. set enableVelocity(enable: boolean);
  73777. /**
  73778. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73779. */
  73780. get enableReflectivity(): boolean;
  73781. /**
  73782. * Sets wether or not objects roughness are enabled for the G buffer.
  73783. */
  73784. set enableReflectivity(enable: boolean);
  73785. /**
  73786. * Gets the scene associated with the buffer.
  73787. */
  73788. get scene(): Scene;
  73789. /**
  73790. * Gets the ratio used by the buffer during its creation.
  73791. * How big is the buffer related to the main canvas.
  73792. */
  73793. get ratio(): number;
  73794. /** @hidden */
  73795. static _SceneComponentInitialization: (scene: Scene) => void;
  73796. /**
  73797. * Creates a new G Buffer for the scene
  73798. * @param scene The scene the buffer belongs to
  73799. * @param ratio How big is the buffer related to the main canvas.
  73800. */
  73801. constructor(scene: Scene, ratio?: number);
  73802. /**
  73803. * Checks wether everything is ready to render a submesh to the G buffer.
  73804. * @param subMesh the submesh to check readiness for
  73805. * @param useInstances is the mesh drawn using instance or not
  73806. * @returns true if ready otherwise false
  73807. */
  73808. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73809. /**
  73810. * Gets the current underlying G Buffer.
  73811. * @returns the buffer
  73812. */
  73813. getGBuffer(): MultiRenderTarget;
  73814. /**
  73815. * Gets the number of samples used to render the buffer (anti aliasing).
  73816. */
  73817. get samples(): number;
  73818. /**
  73819. * Sets the number of samples used to render the buffer (anti aliasing).
  73820. */
  73821. set samples(value: number);
  73822. /**
  73823. * Disposes the renderer and frees up associated resources.
  73824. */
  73825. dispose(): void;
  73826. protected _createRenderTargets(): void;
  73827. private _copyBonesTransformationMatrices;
  73828. }
  73829. }
  73830. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73831. import { Nullable } from "babylonjs/types";
  73832. import { Scene } from "babylonjs/scene";
  73833. import { ISceneComponent } from "babylonjs/sceneComponent";
  73834. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73835. module "babylonjs/scene" {
  73836. interface Scene {
  73837. /** @hidden (Backing field) */
  73838. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73839. /**
  73840. * Gets or Sets the current geometry buffer associated to the scene.
  73841. */
  73842. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73843. /**
  73844. * Enables a GeometryBufferRender and associates it with the scene
  73845. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73846. * @returns the GeometryBufferRenderer
  73847. */
  73848. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73849. /**
  73850. * Disables the GeometryBufferRender associated with the scene
  73851. */
  73852. disableGeometryBufferRenderer(): void;
  73853. }
  73854. }
  73855. /**
  73856. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73857. * in several rendering techniques.
  73858. */
  73859. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73860. /**
  73861. * The component name helpful to identify the component in the list of scene components.
  73862. */
  73863. readonly name: string;
  73864. /**
  73865. * The scene the component belongs to.
  73866. */
  73867. scene: Scene;
  73868. /**
  73869. * Creates a new instance of the component for the given scene
  73870. * @param scene Defines the scene to register the component in
  73871. */
  73872. constructor(scene: Scene);
  73873. /**
  73874. * Registers the component in a given scene
  73875. */
  73876. register(): void;
  73877. /**
  73878. * Rebuilds the elements related to this component in case of
  73879. * context lost for instance.
  73880. */
  73881. rebuild(): void;
  73882. /**
  73883. * Disposes the component and the associated ressources
  73884. */
  73885. dispose(): void;
  73886. private _gatherRenderTargets;
  73887. }
  73888. }
  73889. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73890. /** @hidden */
  73891. export var motionBlurPixelShader: {
  73892. name: string;
  73893. shader: string;
  73894. };
  73895. }
  73896. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73897. import { Nullable } from "babylonjs/types";
  73898. import { Camera } from "babylonjs/Cameras/camera";
  73899. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73900. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73901. import "babylonjs/Animations/animatable";
  73902. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73903. import "babylonjs/Shaders/motionBlur.fragment";
  73904. import { Engine } from "babylonjs/Engines/engine";
  73905. import { Scene } from "babylonjs/scene";
  73906. /**
  73907. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73908. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73909. * As an example, all you have to do is to create the post-process:
  73910. * var mb = new BABYLON.MotionBlurPostProcess(
  73911. * 'mb', // The name of the effect.
  73912. * scene, // The scene containing the objects to blur according to their velocity.
  73913. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73914. * camera // The camera to apply the render pass to.
  73915. * );
  73916. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73917. */
  73918. export class MotionBlurPostProcess extends PostProcess {
  73919. /**
  73920. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73921. */
  73922. motionStrength: number;
  73923. /**
  73924. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73925. */
  73926. get motionBlurSamples(): number;
  73927. /**
  73928. * Sets the number of iterations to be used for motion blur quality
  73929. */
  73930. set motionBlurSamples(samples: number);
  73931. private _motionBlurSamples;
  73932. private _geometryBufferRenderer;
  73933. /**
  73934. * Gets a string identifying the name of the class
  73935. * @returns "MotionBlurPostProcess" string
  73936. */
  73937. getClassName(): string;
  73938. /**
  73939. * Creates a new instance MotionBlurPostProcess
  73940. * @param name The name of the effect.
  73941. * @param scene The scene containing the objects to blur according to their velocity.
  73942. * @param options The required width/height ratio to downsize to before computing the render pass.
  73943. * @param camera The camera to apply the render pass to.
  73944. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73945. * @param engine The engine which the post process will be applied. (default: current engine)
  73946. * @param reusable If the post process can be reused on the same frame. (default: false)
  73947. * @param textureType Type of textures used when performing the post process. (default: 0)
  73948. * @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)
  73949. */
  73950. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73951. /**
  73952. * Excludes the given skinned mesh from computing bones velocities.
  73953. * 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.
  73954. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73955. */
  73956. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73957. /**
  73958. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73959. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73960. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73961. */
  73962. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73963. /**
  73964. * Disposes the post process.
  73965. * @param camera The camera to dispose the post process on.
  73966. */
  73967. dispose(camera?: Camera): void;
  73968. /** @hidden */
  73969. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73970. }
  73971. }
  73972. declare module "babylonjs/Shaders/refraction.fragment" {
  73973. /** @hidden */
  73974. export var refractionPixelShader: {
  73975. name: string;
  73976. shader: string;
  73977. };
  73978. }
  73979. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73980. import { Color3 } from "babylonjs/Maths/math.color";
  73981. import { Camera } from "babylonjs/Cameras/camera";
  73982. import { Texture } from "babylonjs/Materials/Textures/texture";
  73983. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73984. import { Engine } from "babylonjs/Engines/engine";
  73985. import "babylonjs/Shaders/refraction.fragment";
  73986. import { Scene } from "babylonjs/scene";
  73987. /**
  73988. * Post process which applies a refractin texture
  73989. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73990. */
  73991. export class RefractionPostProcess extends PostProcess {
  73992. private _refTexture;
  73993. private _ownRefractionTexture;
  73994. /** the base color of the refraction (used to taint the rendering) */
  73995. color: Color3;
  73996. /** simulated refraction depth */
  73997. depth: number;
  73998. /** the coefficient of the base color (0 to remove base color tainting) */
  73999. colorLevel: number;
  74000. /** Gets the url used to load the refraction texture */
  74001. refractionTextureUrl: string;
  74002. /**
  74003. * Gets or sets the refraction texture
  74004. * Please note that you are responsible for disposing the texture if you set it manually
  74005. */
  74006. get refractionTexture(): Texture;
  74007. set refractionTexture(value: Texture);
  74008. /**
  74009. * Gets a string identifying the name of the class
  74010. * @returns "RefractionPostProcess" string
  74011. */
  74012. getClassName(): string;
  74013. /**
  74014. * Initializes the RefractionPostProcess
  74015. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  74016. * @param name The name of the effect.
  74017. * @param refractionTextureUrl Url of the refraction texture to use
  74018. * @param color the base color of the refraction (used to taint the rendering)
  74019. * @param depth simulated refraction depth
  74020. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  74021. * @param camera The camera to apply the render pass to.
  74022. * @param options The required width/height ratio to downsize to before computing the render pass.
  74023. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74024. * @param engine The engine which the post process will be applied. (default: current engine)
  74025. * @param reusable If the post process can be reused on the same frame. (default: false)
  74026. */
  74027. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74028. /**
  74029. * Disposes of the post process
  74030. * @param camera Camera to dispose post process on
  74031. */
  74032. dispose(camera: Camera): void;
  74033. /** @hidden */
  74034. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  74035. }
  74036. }
  74037. declare module "babylonjs/Shaders/sharpen.fragment" {
  74038. /** @hidden */
  74039. export var sharpenPixelShader: {
  74040. name: string;
  74041. shader: string;
  74042. };
  74043. }
  74044. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  74045. import { Nullable } from "babylonjs/types";
  74046. import { Camera } from "babylonjs/Cameras/camera";
  74047. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74048. import "babylonjs/Shaders/sharpen.fragment";
  74049. import { Engine } from "babylonjs/Engines/engine";
  74050. import { Scene } from "babylonjs/scene";
  74051. /**
  74052. * The SharpenPostProcess applies a sharpen kernel to every pixel
  74053. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  74054. */
  74055. export class SharpenPostProcess extends PostProcess {
  74056. /**
  74057. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  74058. */
  74059. colorAmount: number;
  74060. /**
  74061. * How much sharpness should be applied (default: 0.3)
  74062. */
  74063. edgeAmount: number;
  74064. /**
  74065. * Gets a string identifying the name of the class
  74066. * @returns "SharpenPostProcess" string
  74067. */
  74068. getClassName(): string;
  74069. /**
  74070. * Creates a new instance ConvolutionPostProcess
  74071. * @param name The name of the effect.
  74072. * @param options The required width/height ratio to downsize to before computing the render pass.
  74073. * @param camera The camera to apply the render pass to.
  74074. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74075. * @param engine The engine which the post process will be applied. (default: current engine)
  74076. * @param reusable If the post process can be reused on the same frame. (default: false)
  74077. * @param textureType Type of textures used when performing the post process. (default: 0)
  74078. * @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)
  74079. */
  74080. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74081. /** @hidden */
  74082. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  74083. }
  74084. }
  74085. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  74086. import { Nullable } from "babylonjs/types";
  74087. import { Camera } from "babylonjs/Cameras/camera";
  74088. import { Engine } from "babylonjs/Engines/engine";
  74089. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74090. import { IInspectable } from "babylonjs/Misc/iInspectable";
  74091. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74092. /**
  74093. * PostProcessRenderPipeline
  74094. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74095. */
  74096. export class PostProcessRenderPipeline {
  74097. private engine;
  74098. private _renderEffects;
  74099. private _renderEffectsForIsolatedPass;
  74100. /**
  74101. * List of inspectable custom properties (used by the Inspector)
  74102. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  74103. */
  74104. inspectableCustomProperties: IInspectable[];
  74105. /**
  74106. * @hidden
  74107. */
  74108. protected _cameras: Camera[];
  74109. /** @hidden */
  74110. _name: string;
  74111. /**
  74112. * Gets pipeline name
  74113. */
  74114. get name(): string;
  74115. /** Gets the list of attached cameras */
  74116. get cameras(): Camera[];
  74117. /**
  74118. * Initializes a PostProcessRenderPipeline
  74119. * @param engine engine to add the pipeline to
  74120. * @param name name of the pipeline
  74121. */
  74122. constructor(engine: Engine, name: string);
  74123. /**
  74124. * Gets the class name
  74125. * @returns "PostProcessRenderPipeline"
  74126. */
  74127. getClassName(): string;
  74128. /**
  74129. * If all the render effects in the pipeline are supported
  74130. */
  74131. get isSupported(): boolean;
  74132. /**
  74133. * Adds an effect to the pipeline
  74134. * @param renderEffect the effect to add
  74135. */
  74136. addEffect(renderEffect: PostProcessRenderEffect): void;
  74137. /** @hidden */
  74138. _rebuild(): void;
  74139. /** @hidden */
  74140. _enableEffect(renderEffectName: string, cameras: Camera): void;
  74141. /** @hidden */
  74142. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  74143. /** @hidden */
  74144. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74145. /** @hidden */
  74146. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74147. /** @hidden */
  74148. _attachCameras(cameras: Camera, unique: boolean): void;
  74149. /** @hidden */
  74150. _attachCameras(cameras: Camera[], unique: boolean): void;
  74151. /** @hidden */
  74152. _detachCameras(cameras: Camera): void;
  74153. /** @hidden */
  74154. _detachCameras(cameras: Nullable<Camera[]>): void;
  74155. /** @hidden */
  74156. _update(): void;
  74157. /** @hidden */
  74158. _reset(): void;
  74159. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  74160. /**
  74161. * Sets the required values to the prepass renderer.
  74162. * @param prePassRenderer defines the prepass renderer to setup.
  74163. * @returns true if the pre pass is needed.
  74164. */
  74165. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74166. /**
  74167. * Disposes of the pipeline
  74168. */
  74169. dispose(): void;
  74170. }
  74171. }
  74172. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  74173. import { Camera } from "babylonjs/Cameras/camera";
  74174. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74175. /**
  74176. * PostProcessRenderPipelineManager class
  74177. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74178. */
  74179. export class PostProcessRenderPipelineManager {
  74180. private _renderPipelines;
  74181. /**
  74182. * Initializes a PostProcessRenderPipelineManager
  74183. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74184. */
  74185. constructor();
  74186. /**
  74187. * Gets the list of supported render pipelines
  74188. */
  74189. get supportedPipelines(): PostProcessRenderPipeline[];
  74190. /**
  74191. * Adds a pipeline to the manager
  74192. * @param renderPipeline The pipeline to add
  74193. */
  74194. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  74195. /**
  74196. * Attaches a camera to the pipeline
  74197. * @param renderPipelineName The name of the pipeline to attach to
  74198. * @param cameras the camera to attach
  74199. * @param unique if the camera can be attached multiple times to the pipeline
  74200. */
  74201. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  74202. /**
  74203. * Detaches a camera from the pipeline
  74204. * @param renderPipelineName The name of the pipeline to detach from
  74205. * @param cameras the camera to detach
  74206. */
  74207. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  74208. /**
  74209. * Enables an effect by name on a pipeline
  74210. * @param renderPipelineName the name of the pipeline to enable the effect in
  74211. * @param renderEffectName the name of the effect to enable
  74212. * @param cameras the cameras that the effect should be enabled on
  74213. */
  74214. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74215. /**
  74216. * Disables an effect by name on a pipeline
  74217. * @param renderPipelineName the name of the pipeline to disable the effect in
  74218. * @param renderEffectName the name of the effect to disable
  74219. * @param cameras the cameras that the effect should be disabled on
  74220. */
  74221. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74222. /**
  74223. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  74224. */
  74225. update(): void;
  74226. /** @hidden */
  74227. _rebuild(): void;
  74228. /**
  74229. * Disposes of the manager and pipelines
  74230. */
  74231. dispose(): void;
  74232. }
  74233. }
  74234. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  74235. import { ISceneComponent } from "babylonjs/sceneComponent";
  74236. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74237. import { Scene } from "babylonjs/scene";
  74238. module "babylonjs/scene" {
  74239. interface Scene {
  74240. /** @hidden (Backing field) */
  74241. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74242. /**
  74243. * Gets the postprocess render pipeline manager
  74244. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74245. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74246. */
  74247. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74248. }
  74249. }
  74250. /**
  74251. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74252. */
  74253. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74254. /**
  74255. * The component name helpfull to identify the component in the list of scene components.
  74256. */
  74257. readonly name: string;
  74258. /**
  74259. * The scene the component belongs to.
  74260. */
  74261. scene: Scene;
  74262. /**
  74263. * Creates a new instance of the component for the given scene
  74264. * @param scene Defines the scene to register the component in
  74265. */
  74266. constructor(scene: Scene);
  74267. /**
  74268. * Registers the component in a given scene
  74269. */
  74270. register(): void;
  74271. /**
  74272. * Rebuilds the elements related to this component in case of
  74273. * context lost for instance.
  74274. */
  74275. rebuild(): void;
  74276. /**
  74277. * Disposes the component and the associated ressources
  74278. */
  74279. dispose(): void;
  74280. private _gatherRenderTargets;
  74281. }
  74282. }
  74283. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74284. import { Nullable } from "babylonjs/types";
  74285. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74286. import { Camera } from "babylonjs/Cameras/camera";
  74287. import { IDisposable } from "babylonjs/scene";
  74288. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74289. import { Scene } from "babylonjs/scene";
  74290. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74291. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74292. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74293. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74294. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74295. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74296. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74297. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74298. import { Animation } from "babylonjs/Animations/animation";
  74299. /**
  74300. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74301. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74302. */
  74303. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74304. private _scene;
  74305. private _camerasToBeAttached;
  74306. /**
  74307. * ID of the sharpen post process,
  74308. */
  74309. private readonly SharpenPostProcessId;
  74310. /**
  74311. * @ignore
  74312. * ID of the image processing post process;
  74313. */
  74314. readonly ImageProcessingPostProcessId: string;
  74315. /**
  74316. * @ignore
  74317. * ID of the Fast Approximate Anti-Aliasing post process;
  74318. */
  74319. readonly FxaaPostProcessId: string;
  74320. /**
  74321. * ID of the chromatic aberration post process,
  74322. */
  74323. private readonly ChromaticAberrationPostProcessId;
  74324. /**
  74325. * ID of the grain post process
  74326. */
  74327. private readonly GrainPostProcessId;
  74328. /**
  74329. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74330. */
  74331. sharpen: SharpenPostProcess;
  74332. private _sharpenEffect;
  74333. private bloom;
  74334. /**
  74335. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74336. */
  74337. depthOfField: DepthOfFieldEffect;
  74338. /**
  74339. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74340. */
  74341. fxaa: FxaaPostProcess;
  74342. /**
  74343. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74344. */
  74345. imageProcessing: ImageProcessingPostProcess;
  74346. /**
  74347. * Chromatic aberration post process which will shift rgb colors in the image
  74348. */
  74349. chromaticAberration: ChromaticAberrationPostProcess;
  74350. private _chromaticAberrationEffect;
  74351. /**
  74352. * Grain post process which add noise to the image
  74353. */
  74354. grain: GrainPostProcess;
  74355. private _grainEffect;
  74356. /**
  74357. * Glow post process which adds a glow to emissive areas of the image
  74358. */
  74359. private _glowLayer;
  74360. /**
  74361. * Animations which can be used to tweak settings over a period of time
  74362. */
  74363. animations: Animation[];
  74364. private _imageProcessingConfigurationObserver;
  74365. private _sharpenEnabled;
  74366. private _bloomEnabled;
  74367. private _depthOfFieldEnabled;
  74368. private _depthOfFieldBlurLevel;
  74369. private _fxaaEnabled;
  74370. private _imageProcessingEnabled;
  74371. private _defaultPipelineTextureType;
  74372. private _bloomScale;
  74373. private _chromaticAberrationEnabled;
  74374. private _grainEnabled;
  74375. private _buildAllowed;
  74376. /**
  74377. * Gets active scene
  74378. */
  74379. get scene(): Scene;
  74380. /**
  74381. * Enable or disable the sharpen process from the pipeline
  74382. */
  74383. set sharpenEnabled(enabled: boolean);
  74384. get sharpenEnabled(): boolean;
  74385. private _resizeObserver;
  74386. private _hardwareScaleLevel;
  74387. private _bloomKernel;
  74388. /**
  74389. * Specifies the size of the bloom blur kernel, relative to the final output size
  74390. */
  74391. get bloomKernel(): number;
  74392. set bloomKernel(value: number);
  74393. /**
  74394. * Specifies the weight of the bloom in the final rendering
  74395. */
  74396. private _bloomWeight;
  74397. /**
  74398. * Specifies the luma threshold for the area that will be blurred by the bloom
  74399. */
  74400. private _bloomThreshold;
  74401. private _hdr;
  74402. /**
  74403. * The strength of the bloom.
  74404. */
  74405. set bloomWeight(value: number);
  74406. get bloomWeight(): number;
  74407. /**
  74408. * The strength of the bloom.
  74409. */
  74410. set bloomThreshold(value: number);
  74411. get bloomThreshold(): number;
  74412. /**
  74413. * The scale of the bloom, lower value will provide better performance.
  74414. */
  74415. set bloomScale(value: number);
  74416. get bloomScale(): number;
  74417. /**
  74418. * Enable or disable the bloom from the pipeline
  74419. */
  74420. set bloomEnabled(enabled: boolean);
  74421. get bloomEnabled(): boolean;
  74422. private _rebuildBloom;
  74423. /**
  74424. * If the depth of field is enabled.
  74425. */
  74426. get depthOfFieldEnabled(): boolean;
  74427. set depthOfFieldEnabled(enabled: boolean);
  74428. /**
  74429. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74430. */
  74431. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74432. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74433. /**
  74434. * If the anti aliasing is enabled.
  74435. */
  74436. set fxaaEnabled(enabled: boolean);
  74437. get fxaaEnabled(): boolean;
  74438. private _samples;
  74439. /**
  74440. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74441. */
  74442. set samples(sampleCount: number);
  74443. get samples(): number;
  74444. /**
  74445. * If image processing is enabled.
  74446. */
  74447. set imageProcessingEnabled(enabled: boolean);
  74448. get imageProcessingEnabled(): boolean;
  74449. /**
  74450. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74451. */
  74452. set glowLayerEnabled(enabled: boolean);
  74453. get glowLayerEnabled(): boolean;
  74454. /**
  74455. * Gets the glow layer (or null if not defined)
  74456. */
  74457. get glowLayer(): Nullable<GlowLayer>;
  74458. /**
  74459. * Enable or disable the chromaticAberration process from the pipeline
  74460. */
  74461. set chromaticAberrationEnabled(enabled: boolean);
  74462. get chromaticAberrationEnabled(): boolean;
  74463. /**
  74464. * Enable or disable the grain process from the pipeline
  74465. */
  74466. set grainEnabled(enabled: boolean);
  74467. get grainEnabled(): boolean;
  74468. /**
  74469. * @constructor
  74470. * @param name - The rendering pipeline name (default: "")
  74471. * @param hdr - If high dynamic range textures should be used (default: true)
  74472. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74473. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74474. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74475. */
  74476. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74477. /**
  74478. * Get the class name
  74479. * @returns "DefaultRenderingPipeline"
  74480. */
  74481. getClassName(): string;
  74482. /**
  74483. * Force the compilation of the entire pipeline.
  74484. */
  74485. prepare(): void;
  74486. private _hasCleared;
  74487. private _prevPostProcess;
  74488. private _prevPrevPostProcess;
  74489. private _setAutoClearAndTextureSharing;
  74490. private _depthOfFieldSceneObserver;
  74491. private _buildPipeline;
  74492. private _disposePostProcesses;
  74493. /**
  74494. * Adds a camera to the pipeline
  74495. * @param camera the camera to be added
  74496. */
  74497. addCamera(camera: Camera): void;
  74498. /**
  74499. * Removes a camera from the pipeline
  74500. * @param camera the camera to remove
  74501. */
  74502. removeCamera(camera: Camera): void;
  74503. /**
  74504. * Dispose of the pipeline and stop all post processes
  74505. */
  74506. dispose(): void;
  74507. /**
  74508. * Serialize the rendering pipeline (Used when exporting)
  74509. * @returns the serialized object
  74510. */
  74511. serialize(): any;
  74512. /**
  74513. * Parse the serialized pipeline
  74514. * @param source Source pipeline.
  74515. * @param scene The scene to load the pipeline to.
  74516. * @param rootUrl The URL of the serialized pipeline.
  74517. * @returns An instantiated pipeline from the serialized object.
  74518. */
  74519. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74520. }
  74521. }
  74522. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74523. /** @hidden */
  74524. export var lensHighlightsPixelShader: {
  74525. name: string;
  74526. shader: string;
  74527. };
  74528. }
  74529. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74530. /** @hidden */
  74531. export var depthOfFieldPixelShader: {
  74532. name: string;
  74533. shader: string;
  74534. };
  74535. }
  74536. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74537. import { Camera } from "babylonjs/Cameras/camera";
  74538. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74539. import { Scene } from "babylonjs/scene";
  74540. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74541. import "babylonjs/Shaders/chromaticAberration.fragment";
  74542. import "babylonjs/Shaders/lensHighlights.fragment";
  74543. import "babylonjs/Shaders/depthOfField.fragment";
  74544. /**
  74545. * BABYLON.JS Chromatic Aberration GLSL Shader
  74546. * Author: Olivier Guyot
  74547. * Separates very slightly R, G and B colors on the edges of the screen
  74548. * Inspired by Francois Tarlier & Martins Upitis
  74549. */
  74550. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74551. /**
  74552. * @ignore
  74553. * The chromatic aberration PostProcess id in the pipeline
  74554. */
  74555. LensChromaticAberrationEffect: string;
  74556. /**
  74557. * @ignore
  74558. * The highlights enhancing PostProcess id in the pipeline
  74559. */
  74560. HighlightsEnhancingEffect: string;
  74561. /**
  74562. * @ignore
  74563. * The depth-of-field PostProcess id in the pipeline
  74564. */
  74565. LensDepthOfFieldEffect: string;
  74566. private _scene;
  74567. private _depthTexture;
  74568. private _grainTexture;
  74569. private _chromaticAberrationPostProcess;
  74570. private _highlightsPostProcess;
  74571. private _depthOfFieldPostProcess;
  74572. private _edgeBlur;
  74573. private _grainAmount;
  74574. private _chromaticAberration;
  74575. private _distortion;
  74576. private _highlightsGain;
  74577. private _highlightsThreshold;
  74578. private _dofDistance;
  74579. private _dofAperture;
  74580. private _dofDarken;
  74581. private _dofPentagon;
  74582. private _blurNoise;
  74583. /**
  74584. * @constructor
  74585. *
  74586. * Effect parameters are as follow:
  74587. * {
  74588. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74589. * edge_blur: number; // from 0 to x (1 for realism)
  74590. * distortion: number; // from 0 to x (1 for realism)
  74591. * grain_amount: number; // from 0 to 1
  74592. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74593. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74594. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74595. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74596. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74597. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74598. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74599. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74600. * }
  74601. * Note: if an effect parameter is unset, effect is disabled
  74602. *
  74603. * @param name The rendering pipeline name
  74604. * @param parameters - An object containing all parameters (see above)
  74605. * @param scene The scene linked to this pipeline
  74606. * @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)
  74607. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74608. */
  74609. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74610. /**
  74611. * Get the class name
  74612. * @returns "LensRenderingPipeline"
  74613. */
  74614. getClassName(): string;
  74615. /**
  74616. * Gets associated scene
  74617. */
  74618. get scene(): Scene;
  74619. /**
  74620. * Gets or sets the edge blur
  74621. */
  74622. get edgeBlur(): number;
  74623. set edgeBlur(value: number);
  74624. /**
  74625. * Gets or sets the grain amount
  74626. */
  74627. get grainAmount(): number;
  74628. set grainAmount(value: number);
  74629. /**
  74630. * Gets or sets the chromatic aberration amount
  74631. */
  74632. get chromaticAberration(): number;
  74633. set chromaticAberration(value: number);
  74634. /**
  74635. * Gets or sets the depth of field aperture
  74636. */
  74637. get dofAperture(): number;
  74638. set dofAperture(value: number);
  74639. /**
  74640. * Gets or sets the edge distortion
  74641. */
  74642. get edgeDistortion(): number;
  74643. set edgeDistortion(value: number);
  74644. /**
  74645. * Gets or sets the depth of field distortion
  74646. */
  74647. get dofDistortion(): number;
  74648. set dofDistortion(value: number);
  74649. /**
  74650. * Gets or sets the darken out of focus amount
  74651. */
  74652. get darkenOutOfFocus(): number;
  74653. set darkenOutOfFocus(value: number);
  74654. /**
  74655. * Gets or sets a boolean indicating if blur noise is enabled
  74656. */
  74657. get blurNoise(): boolean;
  74658. set blurNoise(value: boolean);
  74659. /**
  74660. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74661. */
  74662. get pentagonBokeh(): boolean;
  74663. set pentagonBokeh(value: boolean);
  74664. /**
  74665. * Gets or sets the highlight grain amount
  74666. */
  74667. get highlightsGain(): number;
  74668. set highlightsGain(value: number);
  74669. /**
  74670. * Gets or sets the highlight threshold
  74671. */
  74672. get highlightsThreshold(): number;
  74673. set highlightsThreshold(value: number);
  74674. /**
  74675. * Sets the amount of blur at the edges
  74676. * @param amount blur amount
  74677. */
  74678. setEdgeBlur(amount: number): void;
  74679. /**
  74680. * Sets edge blur to 0
  74681. */
  74682. disableEdgeBlur(): void;
  74683. /**
  74684. * Sets the amout of grain
  74685. * @param amount Amount of grain
  74686. */
  74687. setGrainAmount(amount: number): void;
  74688. /**
  74689. * Set grain amount to 0
  74690. */
  74691. disableGrain(): void;
  74692. /**
  74693. * Sets the chromatic aberration amount
  74694. * @param amount amount of chromatic aberration
  74695. */
  74696. setChromaticAberration(amount: number): void;
  74697. /**
  74698. * Sets chromatic aberration amount to 0
  74699. */
  74700. disableChromaticAberration(): void;
  74701. /**
  74702. * Sets the EdgeDistortion amount
  74703. * @param amount amount of EdgeDistortion
  74704. */
  74705. setEdgeDistortion(amount: number): void;
  74706. /**
  74707. * Sets edge distortion to 0
  74708. */
  74709. disableEdgeDistortion(): void;
  74710. /**
  74711. * Sets the FocusDistance amount
  74712. * @param amount amount of FocusDistance
  74713. */
  74714. setFocusDistance(amount: number): void;
  74715. /**
  74716. * Disables depth of field
  74717. */
  74718. disableDepthOfField(): void;
  74719. /**
  74720. * Sets the Aperture amount
  74721. * @param amount amount of Aperture
  74722. */
  74723. setAperture(amount: number): void;
  74724. /**
  74725. * Sets the DarkenOutOfFocus amount
  74726. * @param amount amount of DarkenOutOfFocus
  74727. */
  74728. setDarkenOutOfFocus(amount: number): void;
  74729. private _pentagonBokehIsEnabled;
  74730. /**
  74731. * Creates a pentagon bokeh effect
  74732. */
  74733. enablePentagonBokeh(): void;
  74734. /**
  74735. * Disables the pentagon bokeh effect
  74736. */
  74737. disablePentagonBokeh(): void;
  74738. /**
  74739. * Enables noise blur
  74740. */
  74741. enableNoiseBlur(): void;
  74742. /**
  74743. * Disables noise blur
  74744. */
  74745. disableNoiseBlur(): void;
  74746. /**
  74747. * Sets the HighlightsGain amount
  74748. * @param amount amount of HighlightsGain
  74749. */
  74750. setHighlightsGain(amount: number): void;
  74751. /**
  74752. * Sets the HighlightsThreshold amount
  74753. * @param amount amount of HighlightsThreshold
  74754. */
  74755. setHighlightsThreshold(amount: number): void;
  74756. /**
  74757. * Disables highlights
  74758. */
  74759. disableHighlights(): void;
  74760. /**
  74761. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74762. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74763. */
  74764. dispose(disableDepthRender?: boolean): void;
  74765. private _createChromaticAberrationPostProcess;
  74766. private _createHighlightsPostProcess;
  74767. private _createDepthOfFieldPostProcess;
  74768. private _createGrainTexture;
  74769. }
  74770. }
  74771. declare module "babylonjs/Rendering/ssao2Configuration" {
  74772. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  74773. /**
  74774. * Contains all parameters needed for the prepass to perform
  74775. * screen space subsurface scattering
  74776. */
  74777. export class SSAO2Configuration implements PrePassEffectConfiguration {
  74778. /**
  74779. * Is subsurface enabled
  74780. */
  74781. enabled: boolean;
  74782. /**
  74783. * Name of the configuration
  74784. */
  74785. name: string;
  74786. /**
  74787. * Textures that should be present in the MRT for this effect to work
  74788. */
  74789. readonly texturesRequired: number[];
  74790. /**
  74791. * Builds a ssao2 configuration object
  74792. * @param scene The scene
  74793. */
  74794. constructor();
  74795. /**
  74796. * Disposes the configuration
  74797. */
  74798. dispose(): void;
  74799. }
  74800. }
  74801. declare module "babylonjs/Shaders/ssao2.fragment" {
  74802. /** @hidden */
  74803. export var ssao2PixelShader: {
  74804. name: string;
  74805. shader: string;
  74806. };
  74807. }
  74808. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74809. /** @hidden */
  74810. export var ssaoCombinePixelShader: {
  74811. name: string;
  74812. shader: string;
  74813. };
  74814. }
  74815. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74816. import { Camera } from "babylonjs/Cameras/camera";
  74817. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74818. import { Scene } from "babylonjs/scene";
  74819. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74820. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74821. import "babylonjs/Shaders/ssao2.fragment";
  74822. import "babylonjs/Shaders/ssaoCombine.fragment";
  74823. /**
  74824. * Render pipeline to produce ssao effect
  74825. */
  74826. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74827. /**
  74828. * @ignore
  74829. * The PassPostProcess id in the pipeline that contains the original scene color
  74830. */
  74831. SSAOOriginalSceneColorEffect: string;
  74832. /**
  74833. * @ignore
  74834. * The SSAO PostProcess id in the pipeline
  74835. */
  74836. SSAORenderEffect: string;
  74837. /**
  74838. * @ignore
  74839. * The horizontal blur PostProcess id in the pipeline
  74840. */
  74841. SSAOBlurHRenderEffect: string;
  74842. /**
  74843. * @ignore
  74844. * The vertical blur PostProcess id in the pipeline
  74845. */
  74846. SSAOBlurVRenderEffect: string;
  74847. /**
  74848. * @ignore
  74849. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74850. */
  74851. SSAOCombineRenderEffect: string;
  74852. /**
  74853. * The output strength of the SSAO post-process. Default value is 1.0.
  74854. */
  74855. totalStrength: number;
  74856. /**
  74857. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74858. */
  74859. maxZ: number;
  74860. /**
  74861. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74862. */
  74863. minZAspect: number;
  74864. private _samples;
  74865. /**
  74866. * Number of samples used for the SSAO calculations. Default value is 8
  74867. */
  74868. set samples(n: number);
  74869. get samples(): number;
  74870. private _textureSamples;
  74871. /**
  74872. * Number of samples to use for antialiasing
  74873. */
  74874. set textureSamples(n: number);
  74875. get textureSamples(): number;
  74876. /**
  74877. * Force rendering the geometry through geometry buffer
  74878. */
  74879. private _forceGeometryBuffer;
  74880. /**
  74881. * Ratio object used for SSAO ratio and blur ratio
  74882. */
  74883. private _ratio;
  74884. /**
  74885. * Dynamically generated sphere sampler.
  74886. */
  74887. private _sampleSphere;
  74888. private _ssao2PrePassConfiguration;
  74889. /**
  74890. * Blur filter offsets
  74891. */
  74892. private _samplerOffsets;
  74893. private _expensiveBlur;
  74894. /**
  74895. * If bilateral blur should be used
  74896. */
  74897. set expensiveBlur(b: boolean);
  74898. get expensiveBlur(): boolean;
  74899. /**
  74900. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74901. */
  74902. radius: number;
  74903. /**
  74904. * The base color of the SSAO post-process
  74905. * The final result is "base + ssao" between [0, 1]
  74906. */
  74907. base: number;
  74908. /**
  74909. * Support test.
  74910. */
  74911. static get IsSupported(): boolean;
  74912. private _scene;
  74913. private _randomTexture;
  74914. private _originalColorPostProcess;
  74915. private _ssaoPostProcess;
  74916. private _blurHPostProcess;
  74917. private _blurVPostProcess;
  74918. private _ssaoCombinePostProcess;
  74919. private _prePassRenderer;
  74920. /**
  74921. * Gets active scene
  74922. */
  74923. get scene(): Scene;
  74924. /**
  74925. * @constructor
  74926. * @param name The rendering pipeline name
  74927. * @param scene The scene linked to this pipeline
  74928. * @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 }
  74929. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74930. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74931. */
  74932. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74933. /**
  74934. * Get the class name
  74935. * @returns "SSAO2RenderingPipeline"
  74936. */
  74937. getClassName(): string;
  74938. /**
  74939. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74940. */
  74941. dispose(disableGeometryBufferRenderer?: boolean): void;
  74942. private _createBlurPostProcess;
  74943. /** @hidden */
  74944. _rebuild(): void;
  74945. private _bits;
  74946. private _radicalInverse_VdC;
  74947. private _hammersley;
  74948. private _hemisphereSample_uniform;
  74949. private _generateHemisphere;
  74950. private _getDefinesForSSAO;
  74951. private _createSSAOPostProcess;
  74952. private _createSSAOCombinePostProcess;
  74953. private _createRandomTexture;
  74954. /**
  74955. * Serialize the rendering pipeline (Used when exporting)
  74956. * @returns the serialized object
  74957. */
  74958. serialize(): any;
  74959. /**
  74960. * Parse the serialized pipeline
  74961. * @param source Source pipeline.
  74962. * @param scene The scene to load the pipeline to.
  74963. * @param rootUrl The URL of the serialized pipeline.
  74964. * @returns An instantiated pipeline from the serialized object.
  74965. */
  74966. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74967. /**
  74968. * Sets the required values to the prepass renderer.
  74969. * @param prePassRenderer defines the prepass renderer to setup
  74970. * @returns true if the pre pass is needed.
  74971. */
  74972. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74973. }
  74974. }
  74975. declare module "babylonjs/Shaders/ssao.fragment" {
  74976. /** @hidden */
  74977. export var ssaoPixelShader: {
  74978. name: string;
  74979. shader: string;
  74980. };
  74981. }
  74982. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74983. import { Camera } from "babylonjs/Cameras/camera";
  74984. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74985. import { Scene } from "babylonjs/scene";
  74986. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74987. import "babylonjs/Shaders/ssao.fragment";
  74988. import "babylonjs/Shaders/ssaoCombine.fragment";
  74989. /**
  74990. * Render pipeline to produce ssao effect
  74991. */
  74992. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74993. /**
  74994. * @ignore
  74995. * The PassPostProcess id in the pipeline that contains the original scene color
  74996. */
  74997. SSAOOriginalSceneColorEffect: string;
  74998. /**
  74999. * @ignore
  75000. * The SSAO PostProcess id in the pipeline
  75001. */
  75002. SSAORenderEffect: string;
  75003. /**
  75004. * @ignore
  75005. * The horizontal blur PostProcess id in the pipeline
  75006. */
  75007. SSAOBlurHRenderEffect: string;
  75008. /**
  75009. * @ignore
  75010. * The vertical blur PostProcess id in the pipeline
  75011. */
  75012. SSAOBlurVRenderEffect: string;
  75013. /**
  75014. * @ignore
  75015. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  75016. */
  75017. SSAOCombineRenderEffect: string;
  75018. /**
  75019. * The output strength of the SSAO post-process. Default value is 1.0.
  75020. */
  75021. totalStrength: number;
  75022. /**
  75023. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  75024. */
  75025. radius: number;
  75026. /**
  75027. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  75028. * Must not be equal to fallOff and superior to fallOff.
  75029. * Default value is 0.0075
  75030. */
  75031. area: number;
  75032. /**
  75033. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  75034. * Must not be equal to area and inferior to area.
  75035. * Default value is 0.000001
  75036. */
  75037. fallOff: number;
  75038. /**
  75039. * The base color of the SSAO post-process
  75040. * The final result is "base + ssao" between [0, 1]
  75041. */
  75042. base: number;
  75043. private _scene;
  75044. private _depthTexture;
  75045. private _randomTexture;
  75046. private _originalColorPostProcess;
  75047. private _ssaoPostProcess;
  75048. private _blurHPostProcess;
  75049. private _blurVPostProcess;
  75050. private _ssaoCombinePostProcess;
  75051. private _firstUpdate;
  75052. /**
  75053. * Gets active scene
  75054. */
  75055. get scene(): Scene;
  75056. /**
  75057. * @constructor
  75058. * @param name - The rendering pipeline name
  75059. * @param scene - The scene linked to this pipeline
  75060. * @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 }
  75061. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  75062. */
  75063. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  75064. /**
  75065. * Get the class name
  75066. * @returns "SSAORenderingPipeline"
  75067. */
  75068. getClassName(): string;
  75069. /**
  75070. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  75071. */
  75072. dispose(disableDepthRender?: boolean): void;
  75073. private _createBlurPostProcess;
  75074. /** @hidden */
  75075. _rebuild(): void;
  75076. private _createSSAOPostProcess;
  75077. private _createSSAOCombinePostProcess;
  75078. private _createRandomTexture;
  75079. }
  75080. }
  75081. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  75082. /** @hidden */
  75083. export var screenSpaceReflectionPixelShader: {
  75084. name: string;
  75085. shader: string;
  75086. };
  75087. }
  75088. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  75089. import { Nullable } from "babylonjs/types";
  75090. import { Camera } from "babylonjs/Cameras/camera";
  75091. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75092. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  75093. import { Engine } from "babylonjs/Engines/engine";
  75094. import { Scene } from "babylonjs/scene";
  75095. /**
  75096. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  75097. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  75098. */
  75099. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  75100. /**
  75101. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  75102. */
  75103. threshold: number;
  75104. /**
  75105. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  75106. */
  75107. strength: number;
  75108. /**
  75109. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  75110. */
  75111. reflectionSpecularFalloffExponent: number;
  75112. /**
  75113. * 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]
  75114. */
  75115. step: number;
  75116. /**
  75117. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  75118. */
  75119. roughnessFactor: number;
  75120. private _geometryBufferRenderer;
  75121. private _enableSmoothReflections;
  75122. private _reflectionSamples;
  75123. private _smoothSteps;
  75124. /**
  75125. * Gets a string identifying the name of the class
  75126. * @returns "ScreenSpaceReflectionPostProcess" string
  75127. */
  75128. getClassName(): string;
  75129. /**
  75130. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  75131. * @param name The name of the effect.
  75132. * @param scene The scene containing the objects to calculate reflections.
  75133. * @param options The required width/height ratio to downsize to before computing the render pass.
  75134. * @param camera The camera to apply the render pass to.
  75135. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75136. * @param engine The engine which the post process will be applied. (default: current engine)
  75137. * @param reusable If the post process can be reused on the same frame. (default: false)
  75138. * @param textureType Type of textures used when performing the post process. (default: 0)
  75139. * @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)
  75140. */
  75141. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75142. /**
  75143. * Gets wether or not smoothing reflections is enabled.
  75144. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  75145. */
  75146. get enableSmoothReflections(): boolean;
  75147. /**
  75148. * Sets wether or not smoothing reflections is enabled.
  75149. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  75150. */
  75151. set enableSmoothReflections(enabled: boolean);
  75152. /**
  75153. * Gets the number of samples taken while computing reflections. More samples count is high,
  75154. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75155. */
  75156. get reflectionSamples(): number;
  75157. /**
  75158. * Sets the number of samples taken while computing reflections. More samples count is high,
  75159. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75160. */
  75161. set reflectionSamples(samples: number);
  75162. /**
  75163. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  75164. * more the post-process will require GPU power and can generate a drop in FPS.
  75165. * Default value (5.0) work pretty well in all cases but can be adjusted.
  75166. */
  75167. get smoothSteps(): number;
  75168. set smoothSteps(steps: number);
  75169. private _updateEffectDefines;
  75170. /** @hidden */
  75171. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  75172. }
  75173. }
  75174. declare module "babylonjs/Shaders/standard.fragment" {
  75175. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  75176. /** @hidden */
  75177. export var standardPixelShader: {
  75178. name: string;
  75179. shader: string;
  75180. };
  75181. }
  75182. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  75183. import { Nullable } from "babylonjs/types";
  75184. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  75185. import { Camera } from "babylonjs/Cameras/camera";
  75186. import { Texture } from "babylonjs/Materials/Textures/texture";
  75187. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75188. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75189. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  75190. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  75191. import { IDisposable } from "babylonjs/scene";
  75192. import { SpotLight } from "babylonjs/Lights/spotLight";
  75193. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  75194. import { Scene } from "babylonjs/scene";
  75195. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75196. import { Animation } from "babylonjs/Animations/animation";
  75197. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75198. import "babylonjs/Shaders/standard.fragment";
  75199. /**
  75200. * Standard rendering pipeline
  75201. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75202. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  75203. */
  75204. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  75205. /**
  75206. * Public members
  75207. */
  75208. /**
  75209. * Post-process which contains the original scene color before the pipeline applies all the effects
  75210. */
  75211. originalPostProcess: Nullable<PostProcess>;
  75212. /**
  75213. * Post-process used to down scale an image x4
  75214. */
  75215. downSampleX4PostProcess: Nullable<PostProcess>;
  75216. /**
  75217. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  75218. */
  75219. brightPassPostProcess: Nullable<PostProcess>;
  75220. /**
  75221. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  75222. */
  75223. blurHPostProcesses: PostProcess[];
  75224. /**
  75225. * Post-process array storing all the vertical blur post-processes used by the pipeline
  75226. */
  75227. blurVPostProcesses: PostProcess[];
  75228. /**
  75229. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  75230. */
  75231. textureAdderPostProcess: Nullable<PostProcess>;
  75232. /**
  75233. * Post-process used to create volumetric lighting effect
  75234. */
  75235. volumetricLightPostProcess: Nullable<PostProcess>;
  75236. /**
  75237. * Post-process used to smooth the previous volumetric light post-process on the X axis
  75238. */
  75239. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  75240. /**
  75241. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  75242. */
  75243. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  75244. /**
  75245. * Post-process used to merge the volumetric light effect and the real scene color
  75246. */
  75247. volumetricLightMergePostProces: Nullable<PostProcess>;
  75248. /**
  75249. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  75250. */
  75251. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  75252. /**
  75253. * Base post-process used to calculate the average luminance of the final image for HDR
  75254. */
  75255. luminancePostProcess: Nullable<PostProcess>;
  75256. /**
  75257. * Post-processes used to create down sample post-processes in order to get
  75258. * the average luminance of the final image for HDR
  75259. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  75260. */
  75261. luminanceDownSamplePostProcesses: PostProcess[];
  75262. /**
  75263. * Post-process used to create a HDR effect (light adaptation)
  75264. */
  75265. hdrPostProcess: Nullable<PostProcess>;
  75266. /**
  75267. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  75268. */
  75269. textureAdderFinalPostProcess: Nullable<PostProcess>;
  75270. /**
  75271. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75272. */
  75273. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75274. /**
  75275. * Post-process used to merge the final HDR post-process and the real scene color
  75276. */
  75277. hdrFinalPostProcess: Nullable<PostProcess>;
  75278. /**
  75279. * Post-process used to create a lens flare effect
  75280. */
  75281. lensFlarePostProcess: Nullable<PostProcess>;
  75282. /**
  75283. * Post-process that merges the result of the lens flare post-process and the real scene color
  75284. */
  75285. lensFlareComposePostProcess: Nullable<PostProcess>;
  75286. /**
  75287. * Post-process used to create a motion blur effect
  75288. */
  75289. motionBlurPostProcess: Nullable<PostProcess>;
  75290. /**
  75291. * Post-process used to create a depth of field effect
  75292. */
  75293. depthOfFieldPostProcess: Nullable<PostProcess>;
  75294. /**
  75295. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75296. */
  75297. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75298. /**
  75299. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75300. */
  75301. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75302. /**
  75303. * Represents the brightness threshold in order to configure the illuminated surfaces
  75304. */
  75305. brightThreshold: number;
  75306. /**
  75307. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75308. */
  75309. blurWidth: number;
  75310. /**
  75311. * Sets if the blur for highlighted surfaces must be only horizontal
  75312. */
  75313. horizontalBlur: boolean;
  75314. /**
  75315. * Gets the overall exposure used by the pipeline
  75316. */
  75317. get exposure(): number;
  75318. /**
  75319. * Sets the overall exposure used by the pipeline
  75320. */
  75321. set exposure(value: number);
  75322. /**
  75323. * Texture used typically to simulate "dirty" on camera lens
  75324. */
  75325. lensTexture: Nullable<Texture>;
  75326. /**
  75327. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75328. */
  75329. volumetricLightCoefficient: number;
  75330. /**
  75331. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75332. */
  75333. volumetricLightPower: number;
  75334. /**
  75335. * Used the set the blur intensity to smooth the volumetric lights
  75336. */
  75337. volumetricLightBlurScale: number;
  75338. /**
  75339. * Light (spot or directional) used to generate the volumetric lights rays
  75340. * The source light must have a shadow generate so the pipeline can get its
  75341. * depth map
  75342. */
  75343. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75344. /**
  75345. * For eye adaptation, represents the minimum luminance the eye can see
  75346. */
  75347. hdrMinimumLuminance: number;
  75348. /**
  75349. * For eye adaptation, represents the decrease luminance speed
  75350. */
  75351. hdrDecreaseRate: number;
  75352. /**
  75353. * For eye adaptation, represents the increase luminance speed
  75354. */
  75355. hdrIncreaseRate: number;
  75356. /**
  75357. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75358. */
  75359. get hdrAutoExposure(): boolean;
  75360. /**
  75361. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75362. */
  75363. set hdrAutoExposure(value: boolean);
  75364. /**
  75365. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75366. */
  75367. lensColorTexture: Nullable<Texture>;
  75368. /**
  75369. * The overall strengh for the lens flare effect
  75370. */
  75371. lensFlareStrength: number;
  75372. /**
  75373. * Dispersion coefficient for lens flare ghosts
  75374. */
  75375. lensFlareGhostDispersal: number;
  75376. /**
  75377. * Main lens flare halo width
  75378. */
  75379. lensFlareHaloWidth: number;
  75380. /**
  75381. * Based on the lens distortion effect, defines how much the lens flare result
  75382. * is distorted
  75383. */
  75384. lensFlareDistortionStrength: number;
  75385. /**
  75386. * Configures the blur intensity used for for lens flare (halo)
  75387. */
  75388. lensFlareBlurWidth: number;
  75389. /**
  75390. * Lens star texture must be used to simulate rays on the flares and is available
  75391. * in the documentation
  75392. */
  75393. lensStarTexture: Nullable<Texture>;
  75394. /**
  75395. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75396. * flare effect by taking account of the dirt texture
  75397. */
  75398. lensFlareDirtTexture: Nullable<Texture>;
  75399. /**
  75400. * Represents the focal length for the depth of field effect
  75401. */
  75402. depthOfFieldDistance: number;
  75403. /**
  75404. * Represents the blur intensity for the blurred part of the depth of field effect
  75405. */
  75406. depthOfFieldBlurWidth: number;
  75407. /**
  75408. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75409. */
  75410. get motionStrength(): number;
  75411. /**
  75412. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75413. */
  75414. set motionStrength(strength: number);
  75415. /**
  75416. * Gets wether or not the motion blur post-process is object based or screen based.
  75417. */
  75418. get objectBasedMotionBlur(): boolean;
  75419. /**
  75420. * Sets wether or not the motion blur post-process should be object based or screen based
  75421. */
  75422. set objectBasedMotionBlur(value: boolean);
  75423. /**
  75424. * List of animations for the pipeline (IAnimatable implementation)
  75425. */
  75426. animations: Animation[];
  75427. /**
  75428. * Private members
  75429. */
  75430. private _scene;
  75431. private _currentDepthOfFieldSource;
  75432. private _basePostProcess;
  75433. private _fixedExposure;
  75434. private _currentExposure;
  75435. private _hdrAutoExposure;
  75436. private _hdrCurrentLuminance;
  75437. private _motionStrength;
  75438. private _isObjectBasedMotionBlur;
  75439. private _floatTextureType;
  75440. private _camerasToBeAttached;
  75441. private _ratio;
  75442. private _bloomEnabled;
  75443. private _depthOfFieldEnabled;
  75444. private _vlsEnabled;
  75445. private _lensFlareEnabled;
  75446. private _hdrEnabled;
  75447. private _motionBlurEnabled;
  75448. private _fxaaEnabled;
  75449. private _screenSpaceReflectionsEnabled;
  75450. private _motionBlurSamples;
  75451. private _volumetricLightStepsCount;
  75452. private _samples;
  75453. /**
  75454. * @ignore
  75455. * Specifies if the bloom pipeline is enabled
  75456. */
  75457. get BloomEnabled(): boolean;
  75458. set BloomEnabled(enabled: boolean);
  75459. /**
  75460. * @ignore
  75461. * Specifies if the depth of field pipeline is enabed
  75462. */
  75463. get DepthOfFieldEnabled(): boolean;
  75464. set DepthOfFieldEnabled(enabled: boolean);
  75465. /**
  75466. * @ignore
  75467. * Specifies if the lens flare pipeline is enabed
  75468. */
  75469. get LensFlareEnabled(): boolean;
  75470. set LensFlareEnabled(enabled: boolean);
  75471. /**
  75472. * @ignore
  75473. * Specifies if the HDR pipeline is enabled
  75474. */
  75475. get HDREnabled(): boolean;
  75476. set HDREnabled(enabled: boolean);
  75477. /**
  75478. * @ignore
  75479. * Specifies if the volumetric lights scattering effect is enabled
  75480. */
  75481. get VLSEnabled(): boolean;
  75482. set VLSEnabled(enabled: boolean);
  75483. /**
  75484. * @ignore
  75485. * Specifies if the motion blur effect is enabled
  75486. */
  75487. get MotionBlurEnabled(): boolean;
  75488. set MotionBlurEnabled(enabled: boolean);
  75489. /**
  75490. * Specifies if anti-aliasing is enabled
  75491. */
  75492. get fxaaEnabled(): boolean;
  75493. set fxaaEnabled(enabled: boolean);
  75494. /**
  75495. * Specifies if screen space reflections are enabled.
  75496. */
  75497. get screenSpaceReflectionsEnabled(): boolean;
  75498. set screenSpaceReflectionsEnabled(enabled: boolean);
  75499. /**
  75500. * Specifies the number of steps used to calculate the volumetric lights
  75501. * Typically in interval [50, 200]
  75502. */
  75503. get volumetricLightStepsCount(): number;
  75504. set volumetricLightStepsCount(count: number);
  75505. /**
  75506. * Specifies the number of samples used for the motion blur effect
  75507. * Typically in interval [16, 64]
  75508. */
  75509. get motionBlurSamples(): number;
  75510. set motionBlurSamples(samples: number);
  75511. /**
  75512. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75513. */
  75514. get samples(): number;
  75515. set samples(sampleCount: number);
  75516. /**
  75517. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75518. * @constructor
  75519. * @param name The rendering pipeline name
  75520. * @param scene The scene linked to this pipeline
  75521. * @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)
  75522. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75523. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75524. */
  75525. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75526. private _buildPipeline;
  75527. private _createDownSampleX4PostProcess;
  75528. private _createBrightPassPostProcess;
  75529. private _createBlurPostProcesses;
  75530. private _createTextureAdderPostProcess;
  75531. private _createVolumetricLightPostProcess;
  75532. private _createLuminancePostProcesses;
  75533. private _createHdrPostProcess;
  75534. private _createLensFlarePostProcess;
  75535. private _createDepthOfFieldPostProcess;
  75536. private _createMotionBlurPostProcess;
  75537. private _getDepthTexture;
  75538. private _disposePostProcesses;
  75539. /**
  75540. * Dispose of the pipeline and stop all post processes
  75541. */
  75542. dispose(): void;
  75543. /**
  75544. * Serialize the rendering pipeline (Used when exporting)
  75545. * @returns the serialized object
  75546. */
  75547. serialize(): any;
  75548. /**
  75549. * Parse the serialized pipeline
  75550. * @param source Source pipeline.
  75551. * @param scene The scene to load the pipeline to.
  75552. * @param rootUrl The URL of the serialized pipeline.
  75553. * @returns An instantiated pipeline from the serialized object.
  75554. */
  75555. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75556. /**
  75557. * Luminance steps
  75558. */
  75559. static LuminanceSteps: number;
  75560. }
  75561. }
  75562. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75563. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75564. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75565. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75566. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75567. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75568. }
  75569. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75570. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75571. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75572. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75573. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75574. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75575. }
  75576. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75577. /** @hidden */
  75578. export var stereoscopicInterlacePixelShader: {
  75579. name: string;
  75580. shader: string;
  75581. };
  75582. }
  75583. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75584. import { Camera } from "babylonjs/Cameras/camera";
  75585. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75586. import { Engine } from "babylonjs/Engines/engine";
  75587. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75588. /**
  75589. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75590. */
  75591. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75592. private _stepSize;
  75593. private _passedProcess;
  75594. /**
  75595. * Gets a string identifying the name of the class
  75596. * @returns "StereoscopicInterlacePostProcessI" string
  75597. */
  75598. getClassName(): string;
  75599. /**
  75600. * Initializes a StereoscopicInterlacePostProcessI
  75601. * @param name The name of the effect.
  75602. * @param rigCameras The rig cameras to be appled to the post process
  75603. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75604. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75605. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75606. * @param engine The engine which the post process will be applied. (default: current engine)
  75607. * @param reusable If the post process can be reused on the same frame. (default: false)
  75608. */
  75609. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75610. }
  75611. /**
  75612. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75613. */
  75614. export class StereoscopicInterlacePostProcess extends PostProcess {
  75615. private _stepSize;
  75616. private _passedProcess;
  75617. /**
  75618. * Gets a string identifying the name of the class
  75619. * @returns "StereoscopicInterlacePostProcess" string
  75620. */
  75621. getClassName(): string;
  75622. /**
  75623. * Initializes a StereoscopicInterlacePostProcess
  75624. * @param name The name of the effect.
  75625. * @param rigCameras The rig cameras to be appled to the post process
  75626. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75627. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75628. * @param engine The engine which the post process will be applied. (default: current engine)
  75629. * @param reusable If the post process can be reused on the same frame. (default: false)
  75630. */
  75631. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75632. }
  75633. }
  75634. declare module "babylonjs/Shaders/tonemap.fragment" {
  75635. /** @hidden */
  75636. export var tonemapPixelShader: {
  75637. name: string;
  75638. shader: string;
  75639. };
  75640. }
  75641. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75642. import { Camera } from "babylonjs/Cameras/camera";
  75643. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75644. import "babylonjs/Shaders/tonemap.fragment";
  75645. import { Engine } from "babylonjs/Engines/engine";
  75646. /** Defines operator used for tonemapping */
  75647. export enum TonemappingOperator {
  75648. /** Hable */
  75649. Hable = 0,
  75650. /** Reinhard */
  75651. Reinhard = 1,
  75652. /** HejiDawson */
  75653. HejiDawson = 2,
  75654. /** Photographic */
  75655. Photographic = 3
  75656. }
  75657. /**
  75658. * Defines a post process to apply tone mapping
  75659. */
  75660. export class TonemapPostProcess extends PostProcess {
  75661. private _operator;
  75662. /** Defines the required exposure adjustement */
  75663. exposureAdjustment: number;
  75664. /**
  75665. * Gets a string identifying the name of the class
  75666. * @returns "TonemapPostProcess" string
  75667. */
  75668. getClassName(): string;
  75669. /**
  75670. * Creates a new TonemapPostProcess
  75671. * @param name defines the name of the postprocess
  75672. * @param _operator defines the operator to use
  75673. * @param exposureAdjustment defines the required exposure adjustement
  75674. * @param camera defines the camera to use (can be null)
  75675. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75676. * @param engine defines the hosting engine (can be ignore if camera is set)
  75677. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75678. */
  75679. constructor(name: string, _operator: TonemappingOperator,
  75680. /** Defines the required exposure adjustement */
  75681. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75682. }
  75683. }
  75684. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75685. /** @hidden */
  75686. export var volumetricLightScatteringPixelShader: {
  75687. name: string;
  75688. shader: string;
  75689. };
  75690. }
  75691. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75692. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75693. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75694. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75695. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75696. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75697. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75698. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75699. /** @hidden */
  75700. export var volumetricLightScatteringPassVertexShader: {
  75701. name: string;
  75702. shader: string;
  75703. };
  75704. }
  75705. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75706. /** @hidden */
  75707. export var volumetricLightScatteringPassPixelShader: {
  75708. name: string;
  75709. shader: string;
  75710. };
  75711. }
  75712. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75713. import { Vector3 } from "babylonjs/Maths/math.vector";
  75714. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75715. import { Mesh } from "babylonjs/Meshes/mesh";
  75716. import { Camera } from "babylonjs/Cameras/camera";
  75717. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75718. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75719. import { Scene } from "babylonjs/scene";
  75720. import "babylonjs/Meshes/Builders/planeBuilder";
  75721. import "babylonjs/Shaders/depth.vertex";
  75722. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75723. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75724. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75725. import { Engine } from "babylonjs/Engines/engine";
  75726. /**
  75727. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75728. */
  75729. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75730. private _volumetricLightScatteringPass;
  75731. private _volumetricLightScatteringRTT;
  75732. private _viewPort;
  75733. private _screenCoordinates;
  75734. private _cachedDefines;
  75735. /**
  75736. * If not undefined, the mesh position is computed from the attached node position
  75737. */
  75738. attachedNode: {
  75739. position: Vector3;
  75740. };
  75741. /**
  75742. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75743. */
  75744. customMeshPosition: Vector3;
  75745. /**
  75746. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75747. */
  75748. useCustomMeshPosition: boolean;
  75749. /**
  75750. * If the post-process should inverse the light scattering direction
  75751. */
  75752. invert: boolean;
  75753. /**
  75754. * The internal mesh used by the post-process
  75755. */
  75756. mesh: Mesh;
  75757. /**
  75758. * @hidden
  75759. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75760. */
  75761. get useDiffuseColor(): boolean;
  75762. set useDiffuseColor(useDiffuseColor: boolean);
  75763. /**
  75764. * Array containing the excluded meshes not rendered in the internal pass
  75765. */
  75766. excludedMeshes: AbstractMesh[];
  75767. /**
  75768. * Controls the overall intensity of the post-process
  75769. */
  75770. exposure: number;
  75771. /**
  75772. * Dissipates each sample's contribution in range [0, 1]
  75773. */
  75774. decay: number;
  75775. /**
  75776. * Controls the overall intensity of each sample
  75777. */
  75778. weight: number;
  75779. /**
  75780. * Controls the density of each sample
  75781. */
  75782. density: number;
  75783. /**
  75784. * @constructor
  75785. * @param name The post-process name
  75786. * @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)
  75787. * @param camera The camera that the post-process will be attached to
  75788. * @param mesh The mesh used to create the light scattering
  75789. * @param samples The post-process quality, default 100
  75790. * @param samplingModeThe post-process filtering mode
  75791. * @param engine The babylon engine
  75792. * @param reusable If the post-process is reusable
  75793. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75794. */
  75795. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75796. /**
  75797. * Returns the string "VolumetricLightScatteringPostProcess"
  75798. * @returns "VolumetricLightScatteringPostProcess"
  75799. */
  75800. getClassName(): string;
  75801. private _isReady;
  75802. /**
  75803. * Sets the new light position for light scattering effect
  75804. * @param position The new custom light position
  75805. */
  75806. setCustomMeshPosition(position: Vector3): void;
  75807. /**
  75808. * Returns the light position for light scattering effect
  75809. * @return Vector3 The custom light position
  75810. */
  75811. getCustomMeshPosition(): Vector3;
  75812. /**
  75813. * Disposes the internal assets and detaches the post-process from the camera
  75814. */
  75815. dispose(camera: Camera): void;
  75816. /**
  75817. * Returns the render target texture used by the post-process
  75818. * @return the render target texture used by the post-process
  75819. */
  75820. getPass(): RenderTargetTexture;
  75821. private _meshExcluded;
  75822. private _createPass;
  75823. private _updateMeshScreenCoordinates;
  75824. /**
  75825. * Creates a default mesh for the Volumeric Light Scattering post-process
  75826. * @param name The mesh name
  75827. * @param scene The scene where to create the mesh
  75828. * @return the default mesh
  75829. */
  75830. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75831. }
  75832. }
  75833. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75834. /** @hidden */
  75835. export var screenSpaceCurvaturePixelShader: {
  75836. name: string;
  75837. shader: string;
  75838. };
  75839. }
  75840. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75841. import { Nullable } from "babylonjs/types";
  75842. import { Camera } from "babylonjs/Cameras/camera";
  75843. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75844. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75845. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75846. import { Engine } from "babylonjs/Engines/engine";
  75847. import { Scene } from "babylonjs/scene";
  75848. /**
  75849. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75850. */
  75851. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75852. /**
  75853. * Defines how much ridge the curvature effect displays.
  75854. */
  75855. ridge: number;
  75856. /**
  75857. * Defines how much valley the curvature effect displays.
  75858. */
  75859. valley: number;
  75860. private _geometryBufferRenderer;
  75861. /**
  75862. * Gets a string identifying the name of the class
  75863. * @returns "ScreenSpaceCurvaturePostProcess" string
  75864. */
  75865. getClassName(): string;
  75866. /**
  75867. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75868. * @param name The name of the effect.
  75869. * @param scene The scene containing the objects to blur according to their velocity.
  75870. * @param options The required width/height ratio to downsize to before computing the render pass.
  75871. * @param camera The camera to apply the render pass to.
  75872. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75873. * @param engine The engine which the post process will be applied. (default: current engine)
  75874. * @param reusable If the post process can be reused on the same frame. (default: false)
  75875. * @param textureType Type of textures used when performing the post process. (default: 0)
  75876. * @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)
  75877. */
  75878. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75879. /**
  75880. * Support test.
  75881. */
  75882. static get IsSupported(): boolean;
  75883. /** @hidden */
  75884. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75885. }
  75886. }
  75887. declare module "babylonjs/PostProcesses/index" {
  75888. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75889. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75890. export * from "babylonjs/PostProcesses/bloomEffect";
  75891. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75892. export * from "babylonjs/PostProcesses/blurPostProcess";
  75893. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75894. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75895. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75896. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75897. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75898. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75899. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75900. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75901. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75902. export * from "babylonjs/PostProcesses/filterPostProcess";
  75903. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75904. export * from "babylonjs/PostProcesses/grainPostProcess";
  75905. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75906. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75907. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75908. export * from "babylonjs/PostProcesses/passPostProcess";
  75909. export * from "babylonjs/PostProcesses/postProcess";
  75910. export * from "babylonjs/PostProcesses/postProcessManager";
  75911. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75912. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75913. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75914. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75915. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75916. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75917. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75918. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75919. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75920. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75921. }
  75922. declare module "babylonjs/Probes/index" {
  75923. export * from "babylonjs/Probes/reflectionProbe";
  75924. }
  75925. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75926. import { Scene } from "babylonjs/scene";
  75927. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75928. import { SmartArray } from "babylonjs/Misc/smartArray";
  75929. import { ISceneComponent } from "babylonjs/sceneComponent";
  75930. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75931. import "babylonjs/Meshes/Builders/boxBuilder";
  75932. import "babylonjs/Shaders/color.fragment";
  75933. import "babylonjs/Shaders/color.vertex";
  75934. import { Color3 } from "babylonjs/Maths/math.color";
  75935. import { Observable } from "babylonjs/Misc/observable";
  75936. module "babylonjs/scene" {
  75937. interface Scene {
  75938. /** @hidden (Backing field) */
  75939. _boundingBoxRenderer: BoundingBoxRenderer;
  75940. /** @hidden (Backing field) */
  75941. _forceShowBoundingBoxes: boolean;
  75942. /**
  75943. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75944. */
  75945. forceShowBoundingBoxes: boolean;
  75946. /**
  75947. * Gets the bounding box renderer associated with the scene
  75948. * @returns a BoundingBoxRenderer
  75949. */
  75950. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75951. }
  75952. }
  75953. module "babylonjs/Meshes/abstractMesh" {
  75954. interface AbstractMesh {
  75955. /** @hidden (Backing field) */
  75956. _showBoundingBox: boolean;
  75957. /**
  75958. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75959. */
  75960. showBoundingBox: boolean;
  75961. }
  75962. }
  75963. /**
  75964. * Component responsible of rendering the bounding box of the meshes in a scene.
  75965. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75966. */
  75967. export class BoundingBoxRenderer implements ISceneComponent {
  75968. /**
  75969. * The component name helpfull to identify the component in the list of scene components.
  75970. */
  75971. readonly name: string;
  75972. /**
  75973. * The scene the component belongs to.
  75974. */
  75975. scene: Scene;
  75976. /**
  75977. * Color of the bounding box lines placed in front of an object
  75978. */
  75979. frontColor: Color3;
  75980. /**
  75981. * Color of the bounding box lines placed behind an object
  75982. */
  75983. backColor: Color3;
  75984. /**
  75985. * Defines if the renderer should show the back lines or not
  75986. */
  75987. showBackLines: boolean;
  75988. /**
  75989. * Observable raised before rendering a bounding box
  75990. */
  75991. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75992. /**
  75993. * Observable raised after rendering a bounding box
  75994. */
  75995. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75996. /**
  75997. * @hidden
  75998. */
  75999. renderList: SmartArray<BoundingBox>;
  76000. private _colorShader;
  76001. private _vertexBuffers;
  76002. private _indexBuffer;
  76003. private _fillIndexBuffer;
  76004. private _fillIndexData;
  76005. /**
  76006. * Instantiates a new bounding box renderer in a scene.
  76007. * @param scene the scene the renderer renders in
  76008. */
  76009. constructor(scene: Scene);
  76010. /**
  76011. * Registers the component in a given scene
  76012. */
  76013. register(): void;
  76014. private _evaluateSubMesh;
  76015. private _activeMesh;
  76016. private _prepareRessources;
  76017. private _createIndexBuffer;
  76018. /**
  76019. * Rebuilds the elements related to this component in case of
  76020. * context lost for instance.
  76021. */
  76022. rebuild(): void;
  76023. /**
  76024. * @hidden
  76025. */
  76026. reset(): void;
  76027. /**
  76028. * Render the bounding boxes of a specific rendering group
  76029. * @param renderingGroupId defines the rendering group to render
  76030. */
  76031. render(renderingGroupId: number): void;
  76032. /**
  76033. * In case of occlusion queries, we can render the occlusion bounding box through this method
  76034. * @param mesh Define the mesh to render the occlusion bounding box for
  76035. */
  76036. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  76037. /**
  76038. * Dispose and release the resources attached to this renderer.
  76039. */
  76040. dispose(): void;
  76041. }
  76042. }
  76043. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  76044. import { Nullable } from "babylonjs/types";
  76045. import { Scene } from "babylonjs/scene";
  76046. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  76047. import { Camera } from "babylonjs/Cameras/camera";
  76048. import { ISceneComponent } from "babylonjs/sceneComponent";
  76049. module "babylonjs/scene" {
  76050. interface Scene {
  76051. /** @hidden (Backing field) */
  76052. _depthRenderer: {
  76053. [id: string]: DepthRenderer;
  76054. };
  76055. /**
  76056. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  76057. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  76058. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  76059. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  76060. * @returns the created depth renderer
  76061. */
  76062. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  76063. /**
  76064. * Disables a depth renderer for a given camera
  76065. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  76066. */
  76067. disableDepthRenderer(camera?: Nullable<Camera>): void;
  76068. }
  76069. }
  76070. /**
  76071. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  76072. * in several rendering techniques.
  76073. */
  76074. export class DepthRendererSceneComponent implements ISceneComponent {
  76075. /**
  76076. * The component name helpfull to identify the component in the list of scene components.
  76077. */
  76078. readonly name: string;
  76079. /**
  76080. * The scene the component belongs to.
  76081. */
  76082. scene: Scene;
  76083. /**
  76084. * Creates a new instance of the component for the given scene
  76085. * @param scene Defines the scene to register the component in
  76086. */
  76087. constructor(scene: Scene);
  76088. /**
  76089. * Registers the component in a given scene
  76090. */
  76091. register(): void;
  76092. /**
  76093. * Rebuilds the elements related to this component in case of
  76094. * context lost for instance.
  76095. */
  76096. rebuild(): void;
  76097. /**
  76098. * Disposes the component and the associated ressources
  76099. */
  76100. dispose(): void;
  76101. private _gatherRenderTargets;
  76102. private _gatherActiveCameraRenderTargets;
  76103. }
  76104. }
  76105. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  76106. import { Nullable } from "babylonjs/types";
  76107. import { Scene } from "babylonjs/scene";
  76108. import { ISceneComponent } from "babylonjs/sceneComponent";
  76109. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  76110. module "babylonjs/abstractScene" {
  76111. interface AbstractScene {
  76112. /** @hidden (Backing field) */
  76113. _prePassRenderer: Nullable<PrePassRenderer>;
  76114. /**
  76115. * Gets or Sets the current prepass renderer associated to the scene.
  76116. */
  76117. prePassRenderer: Nullable<PrePassRenderer>;
  76118. /**
  76119. * Enables the prepass and associates it with the scene
  76120. * @returns the PrePassRenderer
  76121. */
  76122. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  76123. /**
  76124. * Disables the prepass associated with the scene
  76125. */
  76126. disablePrePassRenderer(): void;
  76127. }
  76128. }
  76129. /**
  76130. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  76131. * in several rendering techniques.
  76132. */
  76133. export class PrePassRendererSceneComponent implements ISceneComponent {
  76134. /**
  76135. * The component name helpful to identify the component in the list of scene components.
  76136. */
  76137. readonly name: string;
  76138. /**
  76139. * The scene the component belongs to.
  76140. */
  76141. scene: Scene;
  76142. /**
  76143. * Creates a new instance of the component for the given scene
  76144. * @param scene Defines the scene to register the component in
  76145. */
  76146. constructor(scene: Scene);
  76147. /**
  76148. * Registers the component in a given scene
  76149. */
  76150. register(): void;
  76151. private _beforeCameraDraw;
  76152. private _afterCameraDraw;
  76153. private _beforeClearStage;
  76154. /**
  76155. * Rebuilds the elements related to this component in case of
  76156. * context lost for instance.
  76157. */
  76158. rebuild(): void;
  76159. /**
  76160. * Disposes the component and the associated ressources
  76161. */
  76162. dispose(): void;
  76163. }
  76164. }
  76165. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  76166. /** @hidden */
  76167. export var fibonacci: {
  76168. name: string;
  76169. shader: string;
  76170. };
  76171. }
  76172. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  76173. /** @hidden */
  76174. export var diffusionProfile: {
  76175. name: string;
  76176. shader: string;
  76177. };
  76178. }
  76179. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  76180. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  76181. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  76182. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  76183. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  76184. /** @hidden */
  76185. export var subSurfaceScatteringPixelShader: {
  76186. name: string;
  76187. shader: string;
  76188. };
  76189. }
  76190. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  76191. import { Nullable } from "babylonjs/types";
  76192. import { Camera } from "babylonjs/Cameras/camera";
  76193. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  76194. import { Engine } from "babylonjs/Engines/engine";
  76195. import { Scene } from "babylonjs/scene";
  76196. import "babylonjs/Shaders/imageProcessing.fragment";
  76197. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  76198. import "babylonjs/Shaders/postprocess.vertex";
  76199. /**
  76200. * Sub surface scattering post process
  76201. */
  76202. export class SubSurfaceScatteringPostProcess extends PostProcess {
  76203. /**
  76204. * Gets a string identifying the name of the class
  76205. * @returns "SubSurfaceScatteringPostProcess" string
  76206. */
  76207. getClassName(): string;
  76208. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  76209. }
  76210. }
  76211. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  76212. import { Scene } from "babylonjs/scene";
  76213. import { Color3 } from "babylonjs/Maths/math.color";
  76214. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  76215. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  76216. /**
  76217. * Contains all parameters needed for the prepass to perform
  76218. * screen space subsurface scattering
  76219. */
  76220. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  76221. /** @hidden */
  76222. static _SceneComponentInitialization: (scene: Scene) => void;
  76223. private _ssDiffusionS;
  76224. private _ssFilterRadii;
  76225. private _ssDiffusionD;
  76226. /**
  76227. * Post process to attach for screen space subsurface scattering
  76228. */
  76229. postProcess: SubSurfaceScatteringPostProcess;
  76230. /**
  76231. * Diffusion profile color for subsurface scattering
  76232. */
  76233. get ssDiffusionS(): number[];
  76234. /**
  76235. * Diffusion profile max color channel value for subsurface scattering
  76236. */
  76237. get ssDiffusionD(): number[];
  76238. /**
  76239. * Diffusion profile filter radius for subsurface scattering
  76240. */
  76241. get ssFilterRadii(): number[];
  76242. /**
  76243. * Is subsurface enabled
  76244. */
  76245. enabled: boolean;
  76246. /**
  76247. * Name of the configuration
  76248. */
  76249. name: string;
  76250. /**
  76251. * Diffusion profile colors for subsurface scattering
  76252. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  76253. * See ...
  76254. * Note that you can only store up to 5 of them
  76255. */
  76256. ssDiffusionProfileColors: Color3[];
  76257. /**
  76258. * Defines the ratio real world => scene units.
  76259. * Used for subsurface scattering
  76260. */
  76261. metersPerUnit: number;
  76262. /**
  76263. * Textures that should be present in the MRT for this effect to work
  76264. */
  76265. readonly texturesRequired: number[];
  76266. private _scene;
  76267. /**
  76268. * Builds a subsurface configuration object
  76269. * @param scene The scene
  76270. */
  76271. constructor(scene: Scene);
  76272. /**
  76273. * Adds a new diffusion profile.
  76274. * Useful for more realistic subsurface scattering on diverse materials.
  76275. * @param color The color of the diffusion profile. Should be the average color of the material.
  76276. * @return The index of the diffusion profile for the material subsurface configuration
  76277. */
  76278. addDiffusionProfile(color: Color3): number;
  76279. /**
  76280. * Creates the sss post process
  76281. * @return The created post process
  76282. */
  76283. createPostProcess(): SubSurfaceScatteringPostProcess;
  76284. /**
  76285. * Deletes all diffusion profiles.
  76286. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  76287. */
  76288. clearAllDiffusionProfiles(): void;
  76289. /**
  76290. * Disposes this object
  76291. */
  76292. dispose(): void;
  76293. /**
  76294. * @hidden
  76295. * https://zero-radiance.github.io/post/sampling-diffusion/
  76296. *
  76297. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  76298. * ------------------------------------------------------------------------------------
  76299. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  76300. * PDF[r, phi, s] = r * R[r, phi, s]
  76301. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  76302. * ------------------------------------------------------------------------------------
  76303. * We importance sample the color channel with the widest scattering distance.
  76304. */
  76305. getDiffusionProfileParameters(color: Color3): number;
  76306. /**
  76307. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  76308. * 'u' is the random number (the value of the CDF): [0, 1).
  76309. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  76310. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  76311. */
  76312. private _sampleBurleyDiffusionProfile;
  76313. }
  76314. }
  76315. declare module "babylonjs/Rendering/subSurfaceSceneComponent" {
  76316. import { Nullable } from "babylonjs/types";
  76317. import { Scene } from "babylonjs/scene";
  76318. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  76319. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  76320. import { AbstractScene } from "babylonjs/abstractScene";
  76321. module "babylonjs/abstractScene" {
  76322. interface AbstractScene {
  76323. /** @hidden (Backing field) */
  76324. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  76325. /**
  76326. * Gets or Sets the current prepass renderer associated to the scene.
  76327. */
  76328. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  76329. /**
  76330. * Enables the subsurface effect for prepass
  76331. * @returns the SubSurfaceConfiguration
  76332. */
  76333. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  76334. /**
  76335. * Disables the subsurface effect for prepass
  76336. */
  76337. disableSubSurfaceForPrePass(): void;
  76338. }
  76339. }
  76340. /**
  76341. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  76342. * in several rendering techniques.
  76343. */
  76344. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  76345. /**
  76346. * The component name helpful to identify the component in the list of scene components.
  76347. */
  76348. readonly name: string;
  76349. /**
  76350. * The scene the component belongs to.
  76351. */
  76352. scene: Scene;
  76353. /**
  76354. * Creates a new instance of the component for the given scene
  76355. * @param scene Defines the scene to register the component in
  76356. */
  76357. constructor(scene: Scene);
  76358. /**
  76359. * Registers the component in a given scene
  76360. */
  76361. register(): void;
  76362. /**
  76363. * Serializes the component data to the specified json object
  76364. * @param serializationObject The object to serialize to
  76365. */
  76366. serialize(serializationObject: any): void;
  76367. /**
  76368. * Adds all the elements from the container to the scene
  76369. * @param container the container holding the elements
  76370. */
  76371. addFromContainer(container: AbstractScene): void;
  76372. /**
  76373. * Removes all the elements in the container from the scene
  76374. * @param container contains the elements to remove
  76375. * @param dispose if the removed element should be disposed (default: false)
  76376. */
  76377. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  76378. /**
  76379. * Rebuilds the elements related to this component in case of
  76380. * context lost for instance.
  76381. */
  76382. rebuild(): void;
  76383. /**
  76384. * Disposes the component and the associated ressources
  76385. */
  76386. dispose(): void;
  76387. }
  76388. }
  76389. declare module "babylonjs/Shaders/outline.fragment" {
  76390. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76391. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  76392. /** @hidden */
  76393. export var outlinePixelShader: {
  76394. name: string;
  76395. shader: string;
  76396. };
  76397. }
  76398. declare module "babylonjs/Shaders/outline.vertex" {
  76399. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  76400. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  76401. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  76402. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  76403. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76404. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  76405. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  76406. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  76407. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  76408. /** @hidden */
  76409. export var outlineVertexShader: {
  76410. name: string;
  76411. shader: string;
  76412. };
  76413. }
  76414. declare module "babylonjs/Rendering/outlineRenderer" {
  76415. import { SubMesh } from "babylonjs/Meshes/subMesh";
  76416. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  76417. import { Scene } from "babylonjs/scene";
  76418. import { ISceneComponent } from "babylonjs/sceneComponent";
  76419. import "babylonjs/Shaders/outline.fragment";
  76420. import "babylonjs/Shaders/outline.vertex";
  76421. module "babylonjs/scene" {
  76422. interface Scene {
  76423. /** @hidden */
  76424. _outlineRenderer: OutlineRenderer;
  76425. /**
  76426. * Gets the outline renderer associated with the scene
  76427. * @returns a OutlineRenderer
  76428. */
  76429. getOutlineRenderer(): OutlineRenderer;
  76430. }
  76431. }
  76432. module "babylonjs/Meshes/abstractMesh" {
  76433. interface AbstractMesh {
  76434. /** @hidden (Backing field) */
  76435. _renderOutline: boolean;
  76436. /**
  76437. * Gets or sets a boolean indicating if the outline must be rendered as well
  76438. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  76439. */
  76440. renderOutline: boolean;
  76441. /** @hidden (Backing field) */
  76442. _renderOverlay: boolean;
  76443. /**
  76444. * Gets or sets a boolean indicating if the overlay must be rendered as well
  76445. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  76446. */
  76447. renderOverlay: boolean;
  76448. }
  76449. }
  76450. /**
  76451. * This class is responsible to draw bothe outline/overlay of meshes.
  76452. * It should not be used directly but through the available method on mesh.
  76453. */
  76454. export class OutlineRenderer implements ISceneComponent {
  76455. /**
  76456. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  76457. */
  76458. private static _StencilReference;
  76459. /**
  76460. * The name of the component. Each component must have a unique name.
  76461. */
  76462. name: string;
  76463. /**
  76464. * The scene the component belongs to.
  76465. */
  76466. scene: Scene;
  76467. /**
  76468. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  76469. */
  76470. zOffset: number;
  76471. private _engine;
  76472. private _effect;
  76473. private _cachedDefines;
  76474. private _savedDepthWrite;
  76475. /**
  76476. * Instantiates a new outline renderer. (There could be only one per scene).
  76477. * @param scene Defines the scene it belongs to
  76478. */
  76479. constructor(scene: Scene);
  76480. /**
  76481. * Register the component to one instance of a scene.
  76482. */
  76483. register(): void;
  76484. /**
  76485. * Rebuilds the elements related to this component in case of
  76486. * context lost for instance.
  76487. */
  76488. rebuild(): void;
  76489. /**
  76490. * Disposes the component and the associated ressources.
  76491. */
  76492. dispose(): void;
  76493. /**
  76494. * Renders the outline in the canvas.
  76495. * @param subMesh Defines the sumesh to render
  76496. * @param batch Defines the batch of meshes in case of instances
  76497. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76498. */
  76499. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76500. /**
  76501. * Returns whether or not the outline renderer is ready for a given submesh.
  76502. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76503. * @param subMesh Defines the submesh to check readyness for
  76504. * @param useInstances Defines wheter wee are trying to render instances or not
  76505. * @returns true if ready otherwise false
  76506. */
  76507. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76508. private _beforeRenderingMesh;
  76509. private _afterRenderingMesh;
  76510. }
  76511. }
  76512. declare module "babylonjs/Rendering/index" {
  76513. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76514. export * from "babylonjs/Rendering/depthRenderer";
  76515. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76516. export * from "babylonjs/Rendering/edgesRenderer";
  76517. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76518. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76519. export * from "babylonjs/Rendering/prePassRenderer";
  76520. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76521. export * from "babylonjs/Rendering/subSurfaceSceneComponent";
  76522. export * from "babylonjs/Rendering/outlineRenderer";
  76523. export * from "babylonjs/Rendering/renderingGroup";
  76524. export * from "babylonjs/Rendering/renderingManager";
  76525. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76526. }
  76527. declare module "babylonjs/Sprites/ISprites" {
  76528. /**
  76529. * Defines the basic options interface of a Sprite Frame Source Size.
  76530. */
  76531. export interface ISpriteJSONSpriteSourceSize {
  76532. /**
  76533. * number of the original width of the Frame
  76534. */
  76535. w: number;
  76536. /**
  76537. * number of the original height of the Frame
  76538. */
  76539. h: number;
  76540. }
  76541. /**
  76542. * Defines the basic options interface of a Sprite Frame Data.
  76543. */
  76544. export interface ISpriteJSONSpriteFrameData {
  76545. /**
  76546. * number of the x offset of the Frame
  76547. */
  76548. x: number;
  76549. /**
  76550. * number of the y offset of the Frame
  76551. */
  76552. y: number;
  76553. /**
  76554. * number of the width of the Frame
  76555. */
  76556. w: number;
  76557. /**
  76558. * number of the height of the Frame
  76559. */
  76560. h: number;
  76561. }
  76562. /**
  76563. * Defines the basic options interface of a JSON Sprite.
  76564. */
  76565. export interface ISpriteJSONSprite {
  76566. /**
  76567. * string name of the Frame
  76568. */
  76569. filename: string;
  76570. /**
  76571. * ISpriteJSONSpriteFrame basic object of the frame data
  76572. */
  76573. frame: ISpriteJSONSpriteFrameData;
  76574. /**
  76575. * boolean to flag is the frame was rotated.
  76576. */
  76577. rotated: boolean;
  76578. /**
  76579. * boolean to flag is the frame was trimmed.
  76580. */
  76581. trimmed: boolean;
  76582. /**
  76583. * ISpriteJSONSpriteFrame basic object of the source data
  76584. */
  76585. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76586. /**
  76587. * ISpriteJSONSpriteFrame basic object of the source data
  76588. */
  76589. sourceSize: ISpriteJSONSpriteSourceSize;
  76590. }
  76591. /**
  76592. * Defines the basic options interface of a JSON atlas.
  76593. */
  76594. export interface ISpriteJSONAtlas {
  76595. /**
  76596. * Array of objects that contain the frame data.
  76597. */
  76598. frames: Array<ISpriteJSONSprite>;
  76599. /**
  76600. * object basic object containing the sprite meta data.
  76601. */
  76602. meta?: object;
  76603. }
  76604. }
  76605. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76606. /** @hidden */
  76607. export var spriteMapPixelShader: {
  76608. name: string;
  76609. shader: string;
  76610. };
  76611. }
  76612. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76613. /** @hidden */
  76614. export var spriteMapVertexShader: {
  76615. name: string;
  76616. shader: string;
  76617. };
  76618. }
  76619. declare module "babylonjs/Sprites/spriteMap" {
  76620. import { IDisposable, Scene } from "babylonjs/scene";
  76621. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76622. import { Texture } from "babylonjs/Materials/Textures/texture";
  76623. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76624. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76625. import "babylonjs/Meshes/Builders/planeBuilder";
  76626. import "babylonjs/Shaders/spriteMap.fragment";
  76627. import "babylonjs/Shaders/spriteMap.vertex";
  76628. /**
  76629. * Defines the basic options interface of a SpriteMap
  76630. */
  76631. export interface ISpriteMapOptions {
  76632. /**
  76633. * Vector2 of the number of cells in the grid.
  76634. */
  76635. stageSize?: Vector2;
  76636. /**
  76637. * Vector2 of the size of the output plane in World Units.
  76638. */
  76639. outputSize?: Vector2;
  76640. /**
  76641. * Vector3 of the position of the output plane in World Units.
  76642. */
  76643. outputPosition?: Vector3;
  76644. /**
  76645. * Vector3 of the rotation of the output plane.
  76646. */
  76647. outputRotation?: Vector3;
  76648. /**
  76649. * number of layers that the system will reserve in resources.
  76650. */
  76651. layerCount?: number;
  76652. /**
  76653. * number of max animation frames a single cell will reserve in resources.
  76654. */
  76655. maxAnimationFrames?: number;
  76656. /**
  76657. * number cell index of the base tile when the system compiles.
  76658. */
  76659. baseTile?: number;
  76660. /**
  76661. * boolean flip the sprite after its been repositioned by the framing data.
  76662. */
  76663. flipU?: boolean;
  76664. /**
  76665. * Vector3 scalar of the global RGB values of the SpriteMap.
  76666. */
  76667. colorMultiply?: Vector3;
  76668. }
  76669. /**
  76670. * Defines the IDisposable interface in order to be cleanable from resources.
  76671. */
  76672. export interface ISpriteMap extends IDisposable {
  76673. /**
  76674. * String name of the SpriteMap.
  76675. */
  76676. name: string;
  76677. /**
  76678. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76679. */
  76680. atlasJSON: ISpriteJSONAtlas;
  76681. /**
  76682. * Texture of the SpriteMap.
  76683. */
  76684. spriteSheet: Texture;
  76685. /**
  76686. * The parameters to initialize the SpriteMap with.
  76687. */
  76688. options: ISpriteMapOptions;
  76689. }
  76690. /**
  76691. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76692. */
  76693. export class SpriteMap implements ISpriteMap {
  76694. /** The Name of the spriteMap */
  76695. name: string;
  76696. /** The JSON file with the frame and meta data */
  76697. atlasJSON: ISpriteJSONAtlas;
  76698. /** The systems Sprite Sheet Texture */
  76699. spriteSheet: Texture;
  76700. /** Arguments passed with the Constructor */
  76701. options: ISpriteMapOptions;
  76702. /** Public Sprite Storage array, parsed from atlasJSON */
  76703. sprites: Array<ISpriteJSONSprite>;
  76704. /** Returns the Number of Sprites in the System */
  76705. get spriteCount(): number;
  76706. /** Returns the Position of Output Plane*/
  76707. get position(): Vector3;
  76708. /** Returns the Position of Output Plane*/
  76709. set position(v: Vector3);
  76710. /** Returns the Rotation of Output Plane*/
  76711. get rotation(): Vector3;
  76712. /** Returns the Rotation of Output Plane*/
  76713. set rotation(v: Vector3);
  76714. /** Sets the AnimationMap*/
  76715. get animationMap(): RawTexture;
  76716. /** Sets the AnimationMap*/
  76717. set animationMap(v: RawTexture);
  76718. /** Scene that the SpriteMap was created in */
  76719. private _scene;
  76720. /** Texture Buffer of Float32 that holds tile frame data*/
  76721. private _frameMap;
  76722. /** Texture Buffers of Float32 that holds tileMap data*/
  76723. private _tileMaps;
  76724. /** Texture Buffer of Float32 that holds Animation Data*/
  76725. private _animationMap;
  76726. /** Custom ShaderMaterial Central to the System*/
  76727. private _material;
  76728. /** Custom ShaderMaterial Central to the System*/
  76729. private _output;
  76730. /** Systems Time Ticker*/
  76731. private _time;
  76732. /**
  76733. * Creates a new SpriteMap
  76734. * @param name defines the SpriteMaps Name
  76735. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76736. * @param spriteSheet is the Texture that the Sprites are on.
  76737. * @param options a basic deployment configuration
  76738. * @param scene The Scene that the map is deployed on
  76739. */
  76740. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76741. /**
  76742. * Returns tileID location
  76743. * @returns Vector2 the cell position ID
  76744. */
  76745. getTileID(): Vector2;
  76746. /**
  76747. * Gets the UV location of the mouse over the SpriteMap.
  76748. * @returns Vector2 the UV position of the mouse interaction
  76749. */
  76750. getMousePosition(): Vector2;
  76751. /**
  76752. * Creates the "frame" texture Buffer
  76753. * -------------------------------------
  76754. * Structure of frames
  76755. * "filename": "Falling-Water-2.png",
  76756. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76757. * "rotated": true,
  76758. * "trimmed": true,
  76759. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76760. * "sourceSize": {"w":32,"h":32}
  76761. * @returns RawTexture of the frameMap
  76762. */
  76763. private _createFrameBuffer;
  76764. /**
  76765. * Creates the tileMap texture Buffer
  76766. * @param buffer normally and array of numbers, or a false to generate from scratch
  76767. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76768. * @returns RawTexture of the tileMap
  76769. */
  76770. private _createTileBuffer;
  76771. /**
  76772. * Modifies the data of the tileMaps
  76773. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76774. * @param pos is the iVector2 Coordinates of the Tile
  76775. * @param tile The SpriteIndex of the new Tile
  76776. */
  76777. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76778. /**
  76779. * Creates the animationMap texture Buffer
  76780. * @param buffer normally and array of numbers, or a false to generate from scratch
  76781. * @returns RawTexture of the animationMap
  76782. */
  76783. private _createTileAnimationBuffer;
  76784. /**
  76785. * Modifies the data of the animationMap
  76786. * @param cellID is the Index of the Sprite
  76787. * @param _frame is the target Animation frame
  76788. * @param toCell is the Target Index of the next frame of the animation
  76789. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76790. * @param speed is a global scalar of the time variable on the map.
  76791. */
  76792. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76793. /**
  76794. * Exports the .tilemaps file
  76795. */
  76796. saveTileMaps(): void;
  76797. /**
  76798. * Imports the .tilemaps file
  76799. * @param url of the .tilemaps file
  76800. */
  76801. loadTileMaps(url: string): void;
  76802. /**
  76803. * Release associated resources
  76804. */
  76805. dispose(): void;
  76806. }
  76807. }
  76808. declare module "babylonjs/Sprites/spritePackedManager" {
  76809. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76810. import { Scene } from "babylonjs/scene";
  76811. /**
  76812. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76813. * @see https://doc.babylonjs.com/babylon101/sprites
  76814. */
  76815. export class SpritePackedManager extends SpriteManager {
  76816. /** defines the packed manager's name */
  76817. name: string;
  76818. /**
  76819. * Creates a new sprite manager from a packed sprite sheet
  76820. * @param name defines the manager's name
  76821. * @param imgUrl defines the sprite sheet url
  76822. * @param capacity defines the maximum allowed number of sprites
  76823. * @param scene defines the hosting scene
  76824. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76825. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76826. * @param samplingMode defines the smapling mode to use with spritesheet
  76827. * @param fromPacked set to true; do not alter
  76828. */
  76829. constructor(
  76830. /** defines the packed manager's name */
  76831. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76832. }
  76833. }
  76834. declare module "babylonjs/Sprites/index" {
  76835. export * from "babylonjs/Sprites/sprite";
  76836. export * from "babylonjs/Sprites/ISprites";
  76837. export * from "babylonjs/Sprites/spriteManager";
  76838. export * from "babylonjs/Sprites/spriteMap";
  76839. export * from "babylonjs/Sprites/spritePackedManager";
  76840. export * from "babylonjs/Sprites/spriteSceneComponent";
  76841. }
  76842. declare module "babylonjs/States/index" {
  76843. export * from "babylonjs/States/alphaCullingState";
  76844. export * from "babylonjs/States/depthCullingState";
  76845. export * from "babylonjs/States/stencilState";
  76846. }
  76847. declare module "babylonjs/Misc/assetsManager" {
  76848. import { Scene } from "babylonjs/scene";
  76849. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76850. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76851. import { Skeleton } from "babylonjs/Bones/skeleton";
  76852. import { Observable } from "babylonjs/Misc/observable";
  76853. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76854. import { Texture } from "babylonjs/Materials/Textures/texture";
  76855. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76856. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76857. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76858. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76859. import { AssetContainer } from "babylonjs/assetContainer";
  76860. /**
  76861. * Defines the list of states available for a task inside a AssetsManager
  76862. */
  76863. export enum AssetTaskState {
  76864. /**
  76865. * Initialization
  76866. */
  76867. INIT = 0,
  76868. /**
  76869. * Running
  76870. */
  76871. RUNNING = 1,
  76872. /**
  76873. * Done
  76874. */
  76875. DONE = 2,
  76876. /**
  76877. * Error
  76878. */
  76879. ERROR = 3
  76880. }
  76881. /**
  76882. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76883. */
  76884. export abstract class AbstractAssetTask {
  76885. /**
  76886. * Task name
  76887. */ name: string;
  76888. /**
  76889. * Callback called when the task is successful
  76890. */
  76891. onSuccess: (task: any) => void;
  76892. /**
  76893. * Callback called when the task is not successful
  76894. */
  76895. onError: (task: any, message?: string, exception?: any) => void;
  76896. /**
  76897. * Creates a new AssetsManager
  76898. * @param name defines the name of the task
  76899. */
  76900. constructor(
  76901. /**
  76902. * Task name
  76903. */ name: string);
  76904. private _isCompleted;
  76905. private _taskState;
  76906. private _errorObject;
  76907. /**
  76908. * Get if the task is completed
  76909. */
  76910. get isCompleted(): boolean;
  76911. /**
  76912. * Gets the current state of the task
  76913. */
  76914. get taskState(): AssetTaskState;
  76915. /**
  76916. * Gets the current error object (if task is in error)
  76917. */
  76918. get errorObject(): {
  76919. message?: string;
  76920. exception?: any;
  76921. };
  76922. /**
  76923. * Internal only
  76924. * @hidden
  76925. */
  76926. _setErrorObject(message?: string, exception?: any): void;
  76927. /**
  76928. * Execute the current task
  76929. * @param scene defines the scene where you want your assets to be loaded
  76930. * @param onSuccess is a callback called when the task is successfully executed
  76931. * @param onError is a callback called if an error occurs
  76932. */
  76933. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76934. /**
  76935. * Execute the current task
  76936. * @param scene defines the scene where you want your assets to be loaded
  76937. * @param onSuccess is a callback called when the task is successfully executed
  76938. * @param onError is a callback called if an error occurs
  76939. */
  76940. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76941. /**
  76942. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76943. * This can be used with failed tasks that have the reason for failure fixed.
  76944. */
  76945. reset(): void;
  76946. private onErrorCallback;
  76947. private onDoneCallback;
  76948. }
  76949. /**
  76950. * Define the interface used by progress events raised during assets loading
  76951. */
  76952. export interface IAssetsProgressEvent {
  76953. /**
  76954. * Defines the number of remaining tasks to process
  76955. */
  76956. remainingCount: number;
  76957. /**
  76958. * Defines the total number of tasks
  76959. */
  76960. totalCount: number;
  76961. /**
  76962. * Defines the task that was just processed
  76963. */
  76964. task: AbstractAssetTask;
  76965. }
  76966. /**
  76967. * Class used to share progress information about assets loading
  76968. */
  76969. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76970. /**
  76971. * Defines the number of remaining tasks to process
  76972. */
  76973. remainingCount: number;
  76974. /**
  76975. * Defines the total number of tasks
  76976. */
  76977. totalCount: number;
  76978. /**
  76979. * Defines the task that was just processed
  76980. */
  76981. task: AbstractAssetTask;
  76982. /**
  76983. * Creates a AssetsProgressEvent
  76984. * @param remainingCount defines the number of remaining tasks to process
  76985. * @param totalCount defines the total number of tasks
  76986. * @param task defines the task that was just processed
  76987. */
  76988. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76989. }
  76990. /**
  76991. * Define a task used by AssetsManager to load assets into a container
  76992. */
  76993. export class ContainerAssetTask extends AbstractAssetTask {
  76994. /**
  76995. * Defines the name of the task
  76996. */
  76997. name: string;
  76998. /**
  76999. * Defines the list of mesh's names you want to load
  77000. */
  77001. meshesNames: any;
  77002. /**
  77003. * Defines the root url to use as a base to load your meshes and associated resources
  77004. */
  77005. rootUrl: string;
  77006. /**
  77007. * Defines the filename or File of the scene to load from
  77008. */
  77009. sceneFilename: string | File;
  77010. /**
  77011. * Get the loaded asset container
  77012. */
  77013. loadedContainer: AssetContainer;
  77014. /**
  77015. * Gets the list of loaded meshes
  77016. */
  77017. loadedMeshes: Array<AbstractMesh>;
  77018. /**
  77019. * Gets the list of loaded particle systems
  77020. */
  77021. loadedParticleSystems: Array<IParticleSystem>;
  77022. /**
  77023. * Gets the list of loaded skeletons
  77024. */
  77025. loadedSkeletons: Array<Skeleton>;
  77026. /**
  77027. * Gets the list of loaded animation groups
  77028. */
  77029. loadedAnimationGroups: Array<AnimationGroup>;
  77030. /**
  77031. * Callback called when the task is successful
  77032. */
  77033. onSuccess: (task: ContainerAssetTask) => void;
  77034. /**
  77035. * Callback called when the task is successful
  77036. */
  77037. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  77038. /**
  77039. * Creates a new ContainerAssetTask
  77040. * @param name defines the name of the task
  77041. * @param meshesNames defines the list of mesh's names you want to load
  77042. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  77043. * @param sceneFilename defines the filename or File of the scene to load from
  77044. */
  77045. constructor(
  77046. /**
  77047. * Defines the name of the task
  77048. */
  77049. name: string,
  77050. /**
  77051. * Defines the list of mesh's names you want to load
  77052. */
  77053. meshesNames: any,
  77054. /**
  77055. * Defines the root url to use as a base to load your meshes and associated resources
  77056. */
  77057. rootUrl: string,
  77058. /**
  77059. * Defines the filename or File of the scene to load from
  77060. */
  77061. sceneFilename: string | File);
  77062. /**
  77063. * Execute the current task
  77064. * @param scene defines the scene where you want your assets to be loaded
  77065. * @param onSuccess is a callback called when the task is successfully executed
  77066. * @param onError is a callback called if an error occurs
  77067. */
  77068. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77069. }
  77070. /**
  77071. * Define a task used by AssetsManager to load meshes
  77072. */
  77073. export class MeshAssetTask extends AbstractAssetTask {
  77074. /**
  77075. * Defines the name of the task
  77076. */
  77077. name: string;
  77078. /**
  77079. * Defines the list of mesh's names you want to load
  77080. */
  77081. meshesNames: any;
  77082. /**
  77083. * Defines the root url to use as a base to load your meshes and associated resources
  77084. */
  77085. rootUrl: string;
  77086. /**
  77087. * Defines the filename or File of the scene to load from
  77088. */
  77089. sceneFilename: string | File;
  77090. /**
  77091. * Gets the list of loaded meshes
  77092. */
  77093. loadedMeshes: Array<AbstractMesh>;
  77094. /**
  77095. * Gets the list of loaded particle systems
  77096. */
  77097. loadedParticleSystems: Array<IParticleSystem>;
  77098. /**
  77099. * Gets the list of loaded skeletons
  77100. */
  77101. loadedSkeletons: Array<Skeleton>;
  77102. /**
  77103. * Gets the list of loaded animation groups
  77104. */
  77105. loadedAnimationGroups: Array<AnimationGroup>;
  77106. /**
  77107. * Callback called when the task is successful
  77108. */
  77109. onSuccess: (task: MeshAssetTask) => void;
  77110. /**
  77111. * Callback called when the task is successful
  77112. */
  77113. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  77114. /**
  77115. * Creates a new MeshAssetTask
  77116. * @param name defines the name of the task
  77117. * @param meshesNames defines the list of mesh's names you want to load
  77118. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  77119. * @param sceneFilename defines the filename or File of the scene to load from
  77120. */
  77121. constructor(
  77122. /**
  77123. * Defines the name of the task
  77124. */
  77125. name: string,
  77126. /**
  77127. * Defines the list of mesh's names you want to load
  77128. */
  77129. meshesNames: any,
  77130. /**
  77131. * Defines the root url to use as a base to load your meshes and associated resources
  77132. */
  77133. rootUrl: string,
  77134. /**
  77135. * Defines the filename or File of the scene to load from
  77136. */
  77137. sceneFilename: string | File);
  77138. /**
  77139. * Execute the current task
  77140. * @param scene defines the scene where you want your assets to be loaded
  77141. * @param onSuccess is a callback called when the task is successfully executed
  77142. * @param onError is a callback called if an error occurs
  77143. */
  77144. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77145. }
  77146. /**
  77147. * Define a task used by AssetsManager to load text content
  77148. */
  77149. export class TextFileAssetTask extends AbstractAssetTask {
  77150. /**
  77151. * Defines the name of the task
  77152. */
  77153. name: string;
  77154. /**
  77155. * Defines the location of the file to load
  77156. */
  77157. url: string;
  77158. /**
  77159. * Gets the loaded text string
  77160. */
  77161. text: string;
  77162. /**
  77163. * Callback called when the task is successful
  77164. */
  77165. onSuccess: (task: TextFileAssetTask) => void;
  77166. /**
  77167. * Callback called when the task is successful
  77168. */
  77169. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  77170. /**
  77171. * Creates a new TextFileAssetTask object
  77172. * @param name defines the name of the task
  77173. * @param url defines the location of the file to load
  77174. */
  77175. constructor(
  77176. /**
  77177. * Defines the name of the task
  77178. */
  77179. name: string,
  77180. /**
  77181. * Defines the location of the file to load
  77182. */
  77183. url: string);
  77184. /**
  77185. * Execute the current task
  77186. * @param scene defines the scene where you want your assets to be loaded
  77187. * @param onSuccess is a callback called when the task is successfully executed
  77188. * @param onError is a callback called if an error occurs
  77189. */
  77190. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77191. }
  77192. /**
  77193. * Define a task used by AssetsManager to load binary data
  77194. */
  77195. export class BinaryFileAssetTask extends AbstractAssetTask {
  77196. /**
  77197. * Defines the name of the task
  77198. */
  77199. name: string;
  77200. /**
  77201. * Defines the location of the file to load
  77202. */
  77203. url: string;
  77204. /**
  77205. * Gets the lodaded data (as an array buffer)
  77206. */
  77207. data: ArrayBuffer;
  77208. /**
  77209. * Callback called when the task is successful
  77210. */
  77211. onSuccess: (task: BinaryFileAssetTask) => void;
  77212. /**
  77213. * Callback called when the task is successful
  77214. */
  77215. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  77216. /**
  77217. * Creates a new BinaryFileAssetTask object
  77218. * @param name defines the name of the new task
  77219. * @param url defines the location of the file to load
  77220. */
  77221. constructor(
  77222. /**
  77223. * Defines the name of the task
  77224. */
  77225. name: string,
  77226. /**
  77227. * Defines the location of the file to load
  77228. */
  77229. url: string);
  77230. /**
  77231. * Execute the current task
  77232. * @param scene defines the scene where you want your assets to be loaded
  77233. * @param onSuccess is a callback called when the task is successfully executed
  77234. * @param onError is a callback called if an error occurs
  77235. */
  77236. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77237. }
  77238. /**
  77239. * Define a task used by AssetsManager to load images
  77240. */
  77241. export class ImageAssetTask extends AbstractAssetTask {
  77242. /**
  77243. * Defines the name of the task
  77244. */
  77245. name: string;
  77246. /**
  77247. * Defines the location of the image to load
  77248. */
  77249. url: string;
  77250. /**
  77251. * Gets the loaded images
  77252. */
  77253. image: HTMLImageElement;
  77254. /**
  77255. * Callback called when the task is successful
  77256. */
  77257. onSuccess: (task: ImageAssetTask) => void;
  77258. /**
  77259. * Callback called when the task is successful
  77260. */
  77261. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  77262. /**
  77263. * Creates a new ImageAssetTask
  77264. * @param name defines the name of the task
  77265. * @param url defines the location of the image to load
  77266. */
  77267. constructor(
  77268. /**
  77269. * Defines the name of the task
  77270. */
  77271. name: string,
  77272. /**
  77273. * Defines the location of the image to load
  77274. */
  77275. url: string);
  77276. /**
  77277. * Execute the current task
  77278. * @param scene defines the scene where you want your assets to be loaded
  77279. * @param onSuccess is a callback called when the task is successfully executed
  77280. * @param onError is a callback called if an error occurs
  77281. */
  77282. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77283. }
  77284. /**
  77285. * Defines the interface used by texture loading tasks
  77286. */
  77287. export interface ITextureAssetTask<TEX extends BaseTexture> {
  77288. /**
  77289. * Gets the loaded texture
  77290. */
  77291. texture: TEX;
  77292. }
  77293. /**
  77294. * Define a task used by AssetsManager to load 2D textures
  77295. */
  77296. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  77297. /**
  77298. * Defines the name of the task
  77299. */
  77300. name: string;
  77301. /**
  77302. * Defines the location of the file to load
  77303. */
  77304. url: string;
  77305. /**
  77306. * Defines if mipmap should not be generated (default is false)
  77307. */
  77308. noMipmap?: boolean | undefined;
  77309. /**
  77310. * Defines if texture must be inverted on Y axis (default is true)
  77311. */
  77312. invertY: boolean;
  77313. /**
  77314. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77315. */
  77316. samplingMode: number;
  77317. /**
  77318. * Gets the loaded texture
  77319. */
  77320. texture: Texture;
  77321. /**
  77322. * Callback called when the task is successful
  77323. */
  77324. onSuccess: (task: TextureAssetTask) => void;
  77325. /**
  77326. * Callback called when the task is successful
  77327. */
  77328. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  77329. /**
  77330. * Creates a new TextureAssetTask object
  77331. * @param name defines the name of the task
  77332. * @param url defines the location of the file to load
  77333. * @param noMipmap defines if mipmap should not be generated (default is false)
  77334. * @param invertY defines if texture must be inverted on Y axis (default is true)
  77335. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77336. */
  77337. constructor(
  77338. /**
  77339. * Defines the name of the task
  77340. */
  77341. name: string,
  77342. /**
  77343. * Defines the location of the file to load
  77344. */
  77345. url: string,
  77346. /**
  77347. * Defines if mipmap should not be generated (default is false)
  77348. */
  77349. noMipmap?: boolean | undefined,
  77350. /**
  77351. * Defines if texture must be inverted on Y axis (default is true)
  77352. */
  77353. invertY?: boolean,
  77354. /**
  77355. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77356. */
  77357. samplingMode?: number);
  77358. /**
  77359. * Execute the current task
  77360. * @param scene defines the scene where you want your assets to be loaded
  77361. * @param onSuccess is a callback called when the task is successfully executed
  77362. * @param onError is a callback called if an error occurs
  77363. */
  77364. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77365. }
  77366. /**
  77367. * Define a task used by AssetsManager to load cube textures
  77368. */
  77369. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  77370. /**
  77371. * Defines the name of the task
  77372. */
  77373. name: string;
  77374. /**
  77375. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77376. */
  77377. url: string;
  77378. /**
  77379. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77380. */
  77381. extensions?: string[] | undefined;
  77382. /**
  77383. * Defines if mipmaps should not be generated (default is false)
  77384. */
  77385. noMipmap?: boolean | undefined;
  77386. /**
  77387. * Defines the explicit list of files (undefined by default)
  77388. */
  77389. files?: string[] | undefined;
  77390. /**
  77391. * Gets the loaded texture
  77392. */
  77393. texture: CubeTexture;
  77394. /**
  77395. * Callback called when the task is successful
  77396. */
  77397. onSuccess: (task: CubeTextureAssetTask) => void;
  77398. /**
  77399. * Callback called when the task is successful
  77400. */
  77401. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  77402. /**
  77403. * Creates a new CubeTextureAssetTask
  77404. * @param name defines the name of the task
  77405. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77406. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77407. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77408. * @param files defines the explicit list of files (undefined by default)
  77409. */
  77410. constructor(
  77411. /**
  77412. * Defines the name of the task
  77413. */
  77414. name: string,
  77415. /**
  77416. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77417. */
  77418. url: string,
  77419. /**
  77420. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77421. */
  77422. extensions?: string[] | undefined,
  77423. /**
  77424. * Defines if mipmaps should not be generated (default is false)
  77425. */
  77426. noMipmap?: boolean | undefined,
  77427. /**
  77428. * Defines the explicit list of files (undefined by default)
  77429. */
  77430. files?: string[] | undefined);
  77431. /**
  77432. * Execute the current task
  77433. * @param scene defines the scene where you want your assets to be loaded
  77434. * @param onSuccess is a callback called when the task is successfully executed
  77435. * @param onError is a callback called if an error occurs
  77436. */
  77437. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77438. }
  77439. /**
  77440. * Define a task used by AssetsManager to load HDR cube textures
  77441. */
  77442. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  77443. /**
  77444. * Defines the name of the task
  77445. */
  77446. name: string;
  77447. /**
  77448. * Defines the location of the file to load
  77449. */
  77450. url: string;
  77451. /**
  77452. * Defines the desired size (the more it increases the longer the generation will be)
  77453. */
  77454. size: number;
  77455. /**
  77456. * Defines if mipmaps should not be generated (default is false)
  77457. */
  77458. noMipmap: boolean;
  77459. /**
  77460. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77461. */
  77462. generateHarmonics: boolean;
  77463. /**
  77464. * 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)
  77465. */
  77466. gammaSpace: boolean;
  77467. /**
  77468. * Internal Use Only
  77469. */
  77470. reserved: boolean;
  77471. /**
  77472. * Gets the loaded texture
  77473. */
  77474. texture: HDRCubeTexture;
  77475. /**
  77476. * Callback called when the task is successful
  77477. */
  77478. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  77479. /**
  77480. * Callback called when the task is successful
  77481. */
  77482. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77483. /**
  77484. * Creates a new HDRCubeTextureAssetTask object
  77485. * @param name defines the name of the task
  77486. * @param url defines the location of the file to load
  77487. * @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.
  77488. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77489. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77490. * @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)
  77491. * @param reserved Internal use only
  77492. */
  77493. constructor(
  77494. /**
  77495. * Defines the name of the task
  77496. */
  77497. name: string,
  77498. /**
  77499. * Defines the location of the file to load
  77500. */
  77501. url: string,
  77502. /**
  77503. * Defines the desired size (the more it increases the longer the generation will be)
  77504. */
  77505. size: number,
  77506. /**
  77507. * Defines if mipmaps should not be generated (default is false)
  77508. */
  77509. noMipmap?: boolean,
  77510. /**
  77511. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77512. */
  77513. generateHarmonics?: boolean,
  77514. /**
  77515. * 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)
  77516. */
  77517. gammaSpace?: boolean,
  77518. /**
  77519. * Internal Use Only
  77520. */
  77521. reserved?: boolean);
  77522. /**
  77523. * Execute the current task
  77524. * @param scene defines the scene where you want your assets to be loaded
  77525. * @param onSuccess is a callback called when the task is successfully executed
  77526. * @param onError is a callback called if an error occurs
  77527. */
  77528. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77529. }
  77530. /**
  77531. * Define a task used by AssetsManager to load Equirectangular cube textures
  77532. */
  77533. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77534. /**
  77535. * Defines the name of the task
  77536. */
  77537. name: string;
  77538. /**
  77539. * Defines the location of the file to load
  77540. */
  77541. url: string;
  77542. /**
  77543. * Defines the desired size (the more it increases the longer the generation will be)
  77544. */
  77545. size: number;
  77546. /**
  77547. * Defines if mipmaps should not be generated (default is false)
  77548. */
  77549. noMipmap: boolean;
  77550. /**
  77551. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77552. * but the standard material would require them in Gamma space) (default is true)
  77553. */
  77554. gammaSpace: boolean;
  77555. /**
  77556. * Gets the loaded texture
  77557. */
  77558. texture: EquiRectangularCubeTexture;
  77559. /**
  77560. * Callback called when the task is successful
  77561. */
  77562. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77563. /**
  77564. * Callback called when the task is successful
  77565. */
  77566. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77567. /**
  77568. * Creates a new EquiRectangularCubeTextureAssetTask object
  77569. * @param name defines the name of the task
  77570. * @param url defines the location of the file to load
  77571. * @param size defines the desired size (the more it increases the longer the generation will be)
  77572. * If the size is omitted this implies you are using a preprocessed cubemap.
  77573. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77574. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77575. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77576. * (default is true)
  77577. */
  77578. constructor(
  77579. /**
  77580. * Defines the name of the task
  77581. */
  77582. name: string,
  77583. /**
  77584. * Defines the location of the file to load
  77585. */
  77586. url: string,
  77587. /**
  77588. * Defines the desired size (the more it increases the longer the generation will be)
  77589. */
  77590. size: number,
  77591. /**
  77592. * Defines if mipmaps should not be generated (default is false)
  77593. */
  77594. noMipmap?: boolean,
  77595. /**
  77596. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77597. * but the standard material would require them in Gamma space) (default is true)
  77598. */
  77599. gammaSpace?: boolean);
  77600. /**
  77601. * Execute the current task
  77602. * @param scene defines the scene where you want your assets to be loaded
  77603. * @param onSuccess is a callback called when the task is successfully executed
  77604. * @param onError is a callback called if an error occurs
  77605. */
  77606. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77607. }
  77608. /**
  77609. * This class can be used to easily import assets into a scene
  77610. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77611. */
  77612. export class AssetsManager {
  77613. private _scene;
  77614. private _isLoading;
  77615. protected _tasks: AbstractAssetTask[];
  77616. protected _waitingTasksCount: number;
  77617. protected _totalTasksCount: number;
  77618. /**
  77619. * Callback called when all tasks are processed
  77620. */
  77621. onFinish: (tasks: AbstractAssetTask[]) => void;
  77622. /**
  77623. * Callback called when a task is successful
  77624. */
  77625. onTaskSuccess: (task: AbstractAssetTask) => void;
  77626. /**
  77627. * Callback called when a task had an error
  77628. */
  77629. onTaskError: (task: AbstractAssetTask) => void;
  77630. /**
  77631. * Callback called when a task is done (whatever the result is)
  77632. */
  77633. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77634. /**
  77635. * Observable called when all tasks are processed
  77636. */
  77637. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77638. /**
  77639. * Observable called when a task had an error
  77640. */
  77641. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77642. /**
  77643. * Observable called when all tasks were executed
  77644. */
  77645. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77646. /**
  77647. * Observable called when a task is done (whatever the result is)
  77648. */
  77649. onProgressObservable: Observable<IAssetsProgressEvent>;
  77650. /**
  77651. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77652. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77653. */
  77654. useDefaultLoadingScreen: boolean;
  77655. /**
  77656. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77657. * when all assets have been downloaded.
  77658. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77659. */
  77660. autoHideLoadingUI: boolean;
  77661. /**
  77662. * Creates a new AssetsManager
  77663. * @param scene defines the scene to work on
  77664. */
  77665. constructor(scene: Scene);
  77666. /**
  77667. * Add a ContainerAssetTask to the list of active tasks
  77668. * @param taskName defines the name of the new task
  77669. * @param meshesNames defines the name of meshes to load
  77670. * @param rootUrl defines the root url to use to locate files
  77671. * @param sceneFilename defines the filename of the scene file
  77672. * @returns a new ContainerAssetTask object
  77673. */
  77674. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77675. /**
  77676. * Add a MeshAssetTask to the list of active tasks
  77677. * @param taskName defines the name of the new task
  77678. * @param meshesNames defines the name of meshes to load
  77679. * @param rootUrl defines the root url to use to locate files
  77680. * @param sceneFilename defines the filename of the scene file
  77681. * @returns a new MeshAssetTask object
  77682. */
  77683. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77684. /**
  77685. * Add a TextFileAssetTask to the list of active tasks
  77686. * @param taskName defines the name of the new task
  77687. * @param url defines the url of the file to load
  77688. * @returns a new TextFileAssetTask object
  77689. */
  77690. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77691. /**
  77692. * Add a BinaryFileAssetTask to the list of active tasks
  77693. * @param taskName defines the name of the new task
  77694. * @param url defines the url of the file to load
  77695. * @returns a new BinaryFileAssetTask object
  77696. */
  77697. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77698. /**
  77699. * Add a ImageAssetTask to the list of active tasks
  77700. * @param taskName defines the name of the new task
  77701. * @param url defines the url of the file to load
  77702. * @returns a new ImageAssetTask object
  77703. */
  77704. addImageTask(taskName: string, url: string): ImageAssetTask;
  77705. /**
  77706. * Add a TextureAssetTask to the list of active tasks
  77707. * @param taskName defines the name of the new task
  77708. * @param url defines the url of the file to load
  77709. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77710. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77711. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77712. * @returns a new TextureAssetTask object
  77713. */
  77714. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77715. /**
  77716. * Add a CubeTextureAssetTask to the list of active tasks
  77717. * @param taskName defines the name of the new task
  77718. * @param url defines the url of the file to load
  77719. * @param extensions defines the extension to use to load the cube map (can be null)
  77720. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77721. * @param files defines the list of files to load (can be null)
  77722. * @returns a new CubeTextureAssetTask object
  77723. */
  77724. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77725. /**
  77726. *
  77727. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77728. * @param taskName defines the name of the new task
  77729. * @param url defines the url of the file to load
  77730. * @param size defines the size you want for the cubemap (can be null)
  77731. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77732. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77733. * @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)
  77734. * @param reserved Internal use only
  77735. * @returns a new HDRCubeTextureAssetTask object
  77736. */
  77737. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77738. /**
  77739. *
  77740. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77741. * @param taskName defines the name of the new task
  77742. * @param url defines the url of the file to load
  77743. * @param size defines the size you want for the cubemap (can be null)
  77744. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77745. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77746. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77747. * @returns a new EquiRectangularCubeTextureAssetTask object
  77748. */
  77749. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77750. /**
  77751. * Remove a task from the assets manager.
  77752. * @param task the task to remove
  77753. */
  77754. removeTask(task: AbstractAssetTask): void;
  77755. private _decreaseWaitingTasksCount;
  77756. private _runTask;
  77757. /**
  77758. * Reset the AssetsManager and remove all tasks
  77759. * @return the current instance of the AssetsManager
  77760. */
  77761. reset(): AssetsManager;
  77762. /**
  77763. * Start the loading process
  77764. * @return the current instance of the AssetsManager
  77765. */
  77766. load(): AssetsManager;
  77767. /**
  77768. * Start the loading process as an async operation
  77769. * @return a promise returning the list of failed tasks
  77770. */
  77771. loadAsync(): Promise<void>;
  77772. }
  77773. }
  77774. declare module "babylonjs/Misc/deferred" {
  77775. /**
  77776. * Wrapper class for promise with external resolve and reject.
  77777. */
  77778. export class Deferred<T> {
  77779. /**
  77780. * The promise associated with this deferred object.
  77781. */
  77782. readonly promise: Promise<T>;
  77783. private _resolve;
  77784. private _reject;
  77785. /**
  77786. * The resolve method of the promise associated with this deferred object.
  77787. */
  77788. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77789. /**
  77790. * The reject method of the promise associated with this deferred object.
  77791. */
  77792. get reject(): (reason?: any) => void;
  77793. /**
  77794. * Constructor for this deferred object.
  77795. */
  77796. constructor();
  77797. }
  77798. }
  77799. declare module "babylonjs/Misc/meshExploder" {
  77800. import { Mesh } from "babylonjs/Meshes/mesh";
  77801. /**
  77802. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77803. */
  77804. export class MeshExploder {
  77805. private _centerMesh;
  77806. private _meshes;
  77807. private _meshesOrigins;
  77808. private _toCenterVectors;
  77809. private _scaledDirection;
  77810. private _newPosition;
  77811. private _centerPosition;
  77812. /**
  77813. * Explodes meshes from a center mesh.
  77814. * @param meshes The meshes to explode.
  77815. * @param centerMesh The mesh to be center of explosion.
  77816. */
  77817. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77818. private _setCenterMesh;
  77819. /**
  77820. * Get class name
  77821. * @returns "MeshExploder"
  77822. */
  77823. getClassName(): string;
  77824. /**
  77825. * "Exploded meshes"
  77826. * @returns Array of meshes with the centerMesh at index 0.
  77827. */
  77828. getMeshes(): Array<Mesh>;
  77829. /**
  77830. * Explodes meshes giving a specific direction
  77831. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77832. */
  77833. explode(direction?: number): void;
  77834. }
  77835. }
  77836. declare module "babylonjs/Misc/filesInput" {
  77837. import { Engine } from "babylonjs/Engines/engine";
  77838. import { Scene } from "babylonjs/scene";
  77839. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77840. import { Nullable } from "babylonjs/types";
  77841. /**
  77842. * Class used to help managing file picking and drag'n'drop
  77843. */
  77844. export class FilesInput {
  77845. /**
  77846. * List of files ready to be loaded
  77847. */
  77848. static get FilesToLoad(): {
  77849. [key: string]: File;
  77850. };
  77851. /**
  77852. * Callback called when a file is processed
  77853. */
  77854. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77855. private _engine;
  77856. private _currentScene;
  77857. private _sceneLoadedCallback;
  77858. private _progressCallback;
  77859. private _additionalRenderLoopLogicCallback;
  77860. private _textureLoadingCallback;
  77861. private _startingProcessingFilesCallback;
  77862. private _onReloadCallback;
  77863. private _errorCallback;
  77864. private _elementToMonitor;
  77865. private _sceneFileToLoad;
  77866. private _filesToLoad;
  77867. /**
  77868. * Creates a new FilesInput
  77869. * @param engine defines the rendering engine
  77870. * @param scene defines the hosting scene
  77871. * @param sceneLoadedCallback callback called when scene is loaded
  77872. * @param progressCallback callback called to track progress
  77873. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77874. * @param textureLoadingCallback callback called when a texture is loading
  77875. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77876. * @param onReloadCallback callback called when a reload is requested
  77877. * @param errorCallback callback call if an error occurs
  77878. */
  77879. 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>);
  77880. private _dragEnterHandler;
  77881. private _dragOverHandler;
  77882. private _dropHandler;
  77883. /**
  77884. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77885. * @param elementToMonitor defines the DOM element to track
  77886. */
  77887. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77888. /** Gets the current list of files to load */
  77889. get filesToLoad(): File[];
  77890. /**
  77891. * Release all associated resources
  77892. */
  77893. dispose(): void;
  77894. private renderFunction;
  77895. private drag;
  77896. private drop;
  77897. private _traverseFolder;
  77898. private _processFiles;
  77899. /**
  77900. * Load files from a drop event
  77901. * @param event defines the drop event to use as source
  77902. */
  77903. loadFiles(event: any): void;
  77904. private _processReload;
  77905. /**
  77906. * Reload the current scene from the loaded files
  77907. */
  77908. reload(): void;
  77909. }
  77910. }
  77911. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77912. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77913. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77914. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77915. }
  77916. declare module "babylonjs/Misc/sceneOptimizer" {
  77917. import { Scene, IDisposable } from "babylonjs/scene";
  77918. import { Observable } from "babylonjs/Misc/observable";
  77919. /**
  77920. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77921. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77922. */
  77923. export class SceneOptimization {
  77924. /**
  77925. * Defines the priority of this optimization (0 by default which means first in the list)
  77926. */
  77927. priority: number;
  77928. /**
  77929. * Gets a string describing the action executed by the current optimization
  77930. * @returns description string
  77931. */
  77932. getDescription(): string;
  77933. /**
  77934. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77935. * @param scene defines the current scene where to apply this optimization
  77936. * @param optimizer defines the current optimizer
  77937. * @returns true if everything that can be done was applied
  77938. */
  77939. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77940. /**
  77941. * Creates the SceneOptimization object
  77942. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77943. * @param desc defines the description associated with the optimization
  77944. */
  77945. constructor(
  77946. /**
  77947. * Defines the priority of this optimization (0 by default which means first in the list)
  77948. */
  77949. priority?: number);
  77950. }
  77951. /**
  77952. * Defines an optimization used to reduce the size of render target textures
  77953. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77954. */
  77955. export class TextureOptimization extends SceneOptimization {
  77956. /**
  77957. * Defines the priority of this optimization (0 by default which means first in the list)
  77958. */
  77959. priority: number;
  77960. /**
  77961. * 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
  77962. */
  77963. maximumSize: number;
  77964. /**
  77965. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77966. */
  77967. step: number;
  77968. /**
  77969. * Gets a string describing the action executed by the current optimization
  77970. * @returns description string
  77971. */
  77972. getDescription(): string;
  77973. /**
  77974. * Creates the TextureOptimization object
  77975. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77976. * @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
  77977. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77978. */
  77979. constructor(
  77980. /**
  77981. * Defines the priority of this optimization (0 by default which means first in the list)
  77982. */
  77983. priority?: number,
  77984. /**
  77985. * 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
  77986. */
  77987. maximumSize?: number,
  77988. /**
  77989. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77990. */
  77991. step?: number);
  77992. /**
  77993. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77994. * @param scene defines the current scene where to apply this optimization
  77995. * @param optimizer defines the current optimizer
  77996. * @returns true if everything that can be done was applied
  77997. */
  77998. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77999. }
  78000. /**
  78001. * Defines an optimization used to increase or decrease the rendering resolution
  78002. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78003. */
  78004. export class HardwareScalingOptimization extends SceneOptimization {
  78005. /**
  78006. * Defines the priority of this optimization (0 by default which means first in the list)
  78007. */
  78008. priority: number;
  78009. /**
  78010. * Defines the maximum scale to use (2 by default)
  78011. */
  78012. maximumScale: number;
  78013. /**
  78014. * Defines the step to use between two passes (0.5 by default)
  78015. */
  78016. step: number;
  78017. private _currentScale;
  78018. private _directionOffset;
  78019. /**
  78020. * Gets a string describing the action executed by the current optimization
  78021. * @return description string
  78022. */
  78023. getDescription(): string;
  78024. /**
  78025. * Creates the HardwareScalingOptimization object
  78026. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78027. * @param maximumScale defines the maximum scale to use (2 by default)
  78028. * @param step defines the step to use between two passes (0.5 by default)
  78029. */
  78030. constructor(
  78031. /**
  78032. * Defines the priority of this optimization (0 by default which means first in the list)
  78033. */
  78034. priority?: number,
  78035. /**
  78036. * Defines the maximum scale to use (2 by default)
  78037. */
  78038. maximumScale?: number,
  78039. /**
  78040. * Defines the step to use between two passes (0.5 by default)
  78041. */
  78042. step?: number);
  78043. /**
  78044. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78045. * @param scene defines the current scene where to apply this optimization
  78046. * @param optimizer defines the current optimizer
  78047. * @returns true if everything that can be done was applied
  78048. */
  78049. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78050. }
  78051. /**
  78052. * Defines an optimization used to remove shadows
  78053. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78054. */
  78055. export class ShadowsOptimization extends SceneOptimization {
  78056. /**
  78057. * Gets a string describing the action executed by the current optimization
  78058. * @return description string
  78059. */
  78060. getDescription(): string;
  78061. /**
  78062. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78063. * @param scene defines the current scene where to apply this optimization
  78064. * @param optimizer defines the current optimizer
  78065. * @returns true if everything that can be done was applied
  78066. */
  78067. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78068. }
  78069. /**
  78070. * Defines an optimization used to turn post-processes off
  78071. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78072. */
  78073. export class PostProcessesOptimization extends SceneOptimization {
  78074. /**
  78075. * Gets a string describing the action executed by the current optimization
  78076. * @return description string
  78077. */
  78078. getDescription(): string;
  78079. /**
  78080. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78081. * @param scene defines the current scene where to apply this optimization
  78082. * @param optimizer defines the current optimizer
  78083. * @returns true if everything that can be done was applied
  78084. */
  78085. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78086. }
  78087. /**
  78088. * Defines an optimization used to turn lens flares off
  78089. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78090. */
  78091. export class LensFlaresOptimization extends SceneOptimization {
  78092. /**
  78093. * Gets a string describing the action executed by the current optimization
  78094. * @return description string
  78095. */
  78096. getDescription(): string;
  78097. /**
  78098. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78099. * @param scene defines the current scene where to apply this optimization
  78100. * @param optimizer defines the current optimizer
  78101. * @returns true if everything that can be done was applied
  78102. */
  78103. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78104. }
  78105. /**
  78106. * Defines an optimization based on user defined callback.
  78107. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78108. */
  78109. export class CustomOptimization extends SceneOptimization {
  78110. /**
  78111. * Callback called to apply the custom optimization.
  78112. */
  78113. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  78114. /**
  78115. * Callback called to get custom description
  78116. */
  78117. onGetDescription: () => string;
  78118. /**
  78119. * Gets a string describing the action executed by the current optimization
  78120. * @returns description string
  78121. */
  78122. getDescription(): string;
  78123. /**
  78124. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78125. * @param scene defines the current scene where to apply this optimization
  78126. * @param optimizer defines the current optimizer
  78127. * @returns true if everything that can be done was applied
  78128. */
  78129. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78130. }
  78131. /**
  78132. * Defines an optimization used to turn particles off
  78133. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78134. */
  78135. export class ParticlesOptimization extends SceneOptimization {
  78136. /**
  78137. * Gets a string describing the action executed by the current optimization
  78138. * @return description string
  78139. */
  78140. getDescription(): string;
  78141. /**
  78142. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78143. * @param scene defines the current scene where to apply this optimization
  78144. * @param optimizer defines the current optimizer
  78145. * @returns true if everything that can be done was applied
  78146. */
  78147. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78148. }
  78149. /**
  78150. * Defines an optimization used to turn render targets off
  78151. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78152. */
  78153. export class RenderTargetsOptimization extends SceneOptimization {
  78154. /**
  78155. * Gets a string describing the action executed by the current optimization
  78156. * @return description string
  78157. */
  78158. getDescription(): string;
  78159. /**
  78160. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78161. * @param scene defines the current scene where to apply this optimization
  78162. * @param optimizer defines the current optimizer
  78163. * @returns true if everything that can be done was applied
  78164. */
  78165. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78166. }
  78167. /**
  78168. * Defines an optimization used to merge meshes with compatible materials
  78169. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78170. */
  78171. export class MergeMeshesOptimization extends SceneOptimization {
  78172. private static _UpdateSelectionTree;
  78173. /**
  78174. * Gets or sets a boolean which defines if optimization octree has to be updated
  78175. */
  78176. static get UpdateSelectionTree(): boolean;
  78177. /**
  78178. * Gets or sets a boolean which defines if optimization octree has to be updated
  78179. */
  78180. static set UpdateSelectionTree(value: boolean);
  78181. /**
  78182. * Gets a string describing the action executed by the current optimization
  78183. * @return description string
  78184. */
  78185. getDescription(): string;
  78186. private _canBeMerged;
  78187. /**
  78188. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78189. * @param scene defines the current scene where to apply this optimization
  78190. * @param optimizer defines the current optimizer
  78191. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  78192. * @returns true if everything that can be done was applied
  78193. */
  78194. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  78195. }
  78196. /**
  78197. * Defines a list of options used by SceneOptimizer
  78198. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78199. */
  78200. export class SceneOptimizerOptions {
  78201. /**
  78202. * Defines the target frame rate to reach (60 by default)
  78203. */
  78204. targetFrameRate: number;
  78205. /**
  78206. * Defines the interval between two checkes (2000ms by default)
  78207. */
  78208. trackerDuration: number;
  78209. /**
  78210. * Gets the list of optimizations to apply
  78211. */
  78212. optimizations: SceneOptimization[];
  78213. /**
  78214. * Creates a new list of options used by SceneOptimizer
  78215. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  78216. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  78217. */
  78218. constructor(
  78219. /**
  78220. * Defines the target frame rate to reach (60 by default)
  78221. */
  78222. targetFrameRate?: number,
  78223. /**
  78224. * Defines the interval between two checkes (2000ms by default)
  78225. */
  78226. trackerDuration?: number);
  78227. /**
  78228. * Add a new optimization
  78229. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  78230. * @returns the current SceneOptimizerOptions
  78231. */
  78232. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  78233. /**
  78234. * Add a new custom optimization
  78235. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  78236. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  78237. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78238. * @returns the current SceneOptimizerOptions
  78239. */
  78240. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  78241. /**
  78242. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  78243. * @param targetFrameRate defines the target frame rate (60 by default)
  78244. * @returns a SceneOptimizerOptions object
  78245. */
  78246. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78247. /**
  78248. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  78249. * @param targetFrameRate defines the target frame rate (60 by default)
  78250. * @returns a SceneOptimizerOptions object
  78251. */
  78252. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78253. /**
  78254. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  78255. * @param targetFrameRate defines the target frame rate (60 by default)
  78256. * @returns a SceneOptimizerOptions object
  78257. */
  78258. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78259. }
  78260. /**
  78261. * Class used to run optimizations in order to reach a target frame rate
  78262. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78263. */
  78264. export class SceneOptimizer implements IDisposable {
  78265. private _isRunning;
  78266. private _options;
  78267. private _scene;
  78268. private _currentPriorityLevel;
  78269. private _targetFrameRate;
  78270. private _trackerDuration;
  78271. private _currentFrameRate;
  78272. private _sceneDisposeObserver;
  78273. private _improvementMode;
  78274. /**
  78275. * Defines an observable called when the optimizer reaches the target frame rate
  78276. */
  78277. onSuccessObservable: Observable<SceneOptimizer>;
  78278. /**
  78279. * Defines an observable called when the optimizer enables an optimization
  78280. */
  78281. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  78282. /**
  78283. * Defines an observable called when the optimizer is not able to reach the target frame rate
  78284. */
  78285. onFailureObservable: Observable<SceneOptimizer>;
  78286. /**
  78287. * Gets a boolean indicating if the optimizer is in improvement mode
  78288. */
  78289. get isInImprovementMode(): boolean;
  78290. /**
  78291. * Gets the current priority level (0 at start)
  78292. */
  78293. get currentPriorityLevel(): number;
  78294. /**
  78295. * Gets the current frame rate checked by the SceneOptimizer
  78296. */
  78297. get currentFrameRate(): number;
  78298. /**
  78299. * Gets or sets the current target frame rate (60 by default)
  78300. */
  78301. get targetFrameRate(): number;
  78302. /**
  78303. * Gets or sets the current target frame rate (60 by default)
  78304. */
  78305. set targetFrameRate(value: number);
  78306. /**
  78307. * Gets or sets the current interval between two checks (every 2000ms by default)
  78308. */
  78309. get trackerDuration(): number;
  78310. /**
  78311. * Gets or sets the current interval between two checks (every 2000ms by default)
  78312. */
  78313. set trackerDuration(value: number);
  78314. /**
  78315. * Gets the list of active optimizations
  78316. */
  78317. get optimizations(): SceneOptimization[];
  78318. /**
  78319. * Creates a new SceneOptimizer
  78320. * @param scene defines the scene to work on
  78321. * @param options defines the options to use with the SceneOptimizer
  78322. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  78323. * @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)
  78324. */
  78325. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  78326. /**
  78327. * Stops the current optimizer
  78328. */
  78329. stop(): void;
  78330. /**
  78331. * Reset the optimizer to initial step (current priority level = 0)
  78332. */
  78333. reset(): void;
  78334. /**
  78335. * Start the optimizer. By default it will try to reach a specific framerate
  78336. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  78337. */
  78338. start(): void;
  78339. private _checkCurrentState;
  78340. /**
  78341. * Release all resources
  78342. */
  78343. dispose(): void;
  78344. /**
  78345. * Helper function to create a SceneOptimizer with one single line of code
  78346. * @param scene defines the scene to work on
  78347. * @param options defines the options to use with the SceneOptimizer
  78348. * @param onSuccess defines a callback to call on success
  78349. * @param onFailure defines a callback to call on failure
  78350. * @returns the new SceneOptimizer object
  78351. */
  78352. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  78353. }
  78354. }
  78355. declare module "babylonjs/Misc/sceneSerializer" {
  78356. import { Scene } from "babylonjs/scene";
  78357. /**
  78358. * Class used to serialize a scene into a string
  78359. */
  78360. export class SceneSerializer {
  78361. /**
  78362. * Clear cache used by a previous serialization
  78363. */
  78364. static ClearCache(): void;
  78365. /**
  78366. * Serialize a scene into a JSON compatible object
  78367. * @param scene defines the scene to serialize
  78368. * @returns a JSON compatible object
  78369. */
  78370. static Serialize(scene: Scene): any;
  78371. /**
  78372. * Serialize a mesh into a JSON compatible object
  78373. * @param toSerialize defines the mesh to serialize
  78374. * @param withParents defines if parents must be serialized as well
  78375. * @param withChildren defines if children must be serialized as well
  78376. * @returns a JSON compatible object
  78377. */
  78378. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  78379. }
  78380. }
  78381. declare module "babylonjs/Misc/textureTools" {
  78382. import { Texture } from "babylonjs/Materials/Textures/texture";
  78383. /**
  78384. * Class used to host texture specific utilities
  78385. */
  78386. export class TextureTools {
  78387. /**
  78388. * Uses the GPU to create a copy texture rescaled at a given size
  78389. * @param texture Texture to copy from
  78390. * @param width defines the desired width
  78391. * @param height defines the desired height
  78392. * @param useBilinearMode defines if bilinear mode has to be used
  78393. * @return the generated texture
  78394. */
  78395. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  78396. }
  78397. }
  78398. declare module "babylonjs/Misc/videoRecorder" {
  78399. import { Nullable } from "babylonjs/types";
  78400. import { Engine } from "babylonjs/Engines/engine";
  78401. /**
  78402. * This represents the different options available for the video capture.
  78403. */
  78404. export interface VideoRecorderOptions {
  78405. /** Defines the mime type of the video. */
  78406. mimeType: string;
  78407. /** Defines the FPS the video should be recorded at. */
  78408. fps: number;
  78409. /** Defines the chunk size for the recording data. */
  78410. recordChunckSize: number;
  78411. /** The audio tracks to attach to the recording. */
  78412. audioTracks?: MediaStreamTrack[];
  78413. }
  78414. /**
  78415. * This can help with recording videos from BabylonJS.
  78416. * This is based on the available WebRTC functionalities of the browser.
  78417. *
  78418. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  78419. */
  78420. export class VideoRecorder {
  78421. private static readonly _defaultOptions;
  78422. /**
  78423. * Returns whether or not the VideoRecorder is available in your browser.
  78424. * @param engine Defines the Babylon Engine.
  78425. * @returns true if supported otherwise false.
  78426. */
  78427. static IsSupported(engine: Engine): boolean;
  78428. private readonly _options;
  78429. private _canvas;
  78430. private _mediaRecorder;
  78431. private _recordedChunks;
  78432. private _fileName;
  78433. private _resolve;
  78434. private _reject;
  78435. /**
  78436. * True when a recording is already in progress.
  78437. */
  78438. get isRecording(): boolean;
  78439. /**
  78440. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  78441. * @param engine Defines the BabylonJS Engine you wish to record.
  78442. * @param options Defines options that can be used to customize the capture.
  78443. */
  78444. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  78445. /**
  78446. * Stops the current recording before the default capture timeout passed in the startRecording function.
  78447. */
  78448. stopRecording(): void;
  78449. /**
  78450. * Starts recording the canvas for a max duration specified in parameters.
  78451. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  78452. * If null no automatic download will start and you can rely on the promise to get the data back.
  78453. * @param maxDuration Defines the maximum recording time in seconds.
  78454. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  78455. * @return A promise callback at the end of the recording with the video data in Blob.
  78456. */
  78457. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  78458. /**
  78459. * Releases internal resources used during the recording.
  78460. */
  78461. dispose(): void;
  78462. private _handleDataAvailable;
  78463. private _handleError;
  78464. private _handleStop;
  78465. }
  78466. }
  78467. declare module "babylonjs/Misc/screenshotTools" {
  78468. import { Camera } from "babylonjs/Cameras/camera";
  78469. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  78470. import { Engine } from "babylonjs/Engines/engine";
  78471. /**
  78472. * Class containing a set of static utilities functions for screenshots
  78473. */
  78474. export class ScreenshotTools {
  78475. /**
  78476. * Captures a screenshot of the current rendering
  78477. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78478. * @param engine defines the rendering engine
  78479. * @param camera defines the source camera
  78480. * @param size This parameter can be set to a single number or to an object with the
  78481. * following (optional) properties: precision, width, height. If a single number is passed,
  78482. * it will be used for both width and height. If an object is passed, the screenshot size
  78483. * will be derived from the parameters. The precision property is a multiplier allowing
  78484. * rendering at a higher or lower resolution
  78485. * @param successCallback defines the callback receives a single parameter which contains the
  78486. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78487. * src parameter of an <img> to display it
  78488. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78489. * Check your browser for supported MIME types
  78490. */
  78491. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78492. /**
  78493. * Captures a screenshot of the current rendering
  78494. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78495. * @param engine defines the rendering engine
  78496. * @param camera defines the source camera
  78497. * @param size This parameter can be set to a single number or to an object with the
  78498. * following (optional) properties: precision, width, height. If a single number is passed,
  78499. * it will be used for both width and height. If an object is passed, the screenshot size
  78500. * will be derived from the parameters. The precision property is a multiplier allowing
  78501. * rendering at a higher or lower resolution
  78502. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78503. * Check your browser for supported MIME types
  78504. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78505. * to the src parameter of an <img> to display it
  78506. */
  78507. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78508. /**
  78509. * Generates an image screenshot from the specified camera.
  78510. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78511. * @param engine The engine to use for rendering
  78512. * @param camera The camera to use for rendering
  78513. * @param size This parameter can be set to a single number or to an object with the
  78514. * following (optional) properties: precision, width, height. If a single number is passed,
  78515. * it will be used for both width and height. If an object is passed, the screenshot size
  78516. * will be derived from the parameters. The precision property is a multiplier allowing
  78517. * rendering at a higher or lower resolution
  78518. * @param successCallback The callback receives a single parameter which contains the
  78519. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78520. * src parameter of an <img> to display it
  78521. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78522. * Check your browser for supported MIME types
  78523. * @param samples Texture samples (default: 1)
  78524. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78525. * @param fileName A name for for the downloaded file.
  78526. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78527. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78528. */
  78529. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  78530. /**
  78531. * Generates an image screenshot from the specified camera.
  78532. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78533. * @param engine The engine to use for rendering
  78534. * @param camera The camera to use for rendering
  78535. * @param size This parameter can be set to a single number or to an object with the
  78536. * following (optional) properties: precision, width, height. If a single number is passed,
  78537. * it will be used for both width and height. If an object is passed, the screenshot size
  78538. * will be derived from the parameters. The precision property is a multiplier allowing
  78539. * rendering at a higher or lower resolution
  78540. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78541. * Check your browser for supported MIME types
  78542. * @param samples Texture samples (default: 1)
  78543. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78544. * @param fileName A name for for the downloaded file.
  78545. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78546. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78547. * to the src parameter of an <img> to display it
  78548. */
  78549. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78550. /**
  78551. * Gets height and width for screenshot size
  78552. * @private
  78553. */
  78554. private static _getScreenshotSize;
  78555. }
  78556. }
  78557. declare module "babylonjs/Misc/dataReader" {
  78558. /**
  78559. * Interface for a data buffer
  78560. */
  78561. export interface IDataBuffer {
  78562. /**
  78563. * Reads bytes from the data buffer.
  78564. * @param byteOffset The byte offset to read
  78565. * @param byteLength The byte length to read
  78566. * @returns A promise that resolves when the bytes are read
  78567. */
  78568. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78569. /**
  78570. * The byte length of the buffer.
  78571. */
  78572. readonly byteLength: number;
  78573. }
  78574. /**
  78575. * Utility class for reading from a data buffer
  78576. */
  78577. export class DataReader {
  78578. /**
  78579. * The data buffer associated with this data reader.
  78580. */
  78581. readonly buffer: IDataBuffer;
  78582. /**
  78583. * The current byte offset from the beginning of the data buffer.
  78584. */
  78585. byteOffset: number;
  78586. private _dataView;
  78587. private _dataByteOffset;
  78588. /**
  78589. * Constructor
  78590. * @param buffer The buffer to read
  78591. */
  78592. constructor(buffer: IDataBuffer);
  78593. /**
  78594. * Loads the given byte length.
  78595. * @param byteLength The byte length to load
  78596. * @returns A promise that resolves when the load is complete
  78597. */
  78598. loadAsync(byteLength: number): Promise<void>;
  78599. /**
  78600. * Read a unsigned 32-bit integer from the currently loaded data range.
  78601. * @returns The 32-bit integer read
  78602. */
  78603. readUint32(): number;
  78604. /**
  78605. * Read a byte array from the currently loaded data range.
  78606. * @param byteLength The byte length to read
  78607. * @returns The byte array read
  78608. */
  78609. readUint8Array(byteLength: number): Uint8Array;
  78610. /**
  78611. * Read a string from the currently loaded data range.
  78612. * @param byteLength The byte length to read
  78613. * @returns The string read
  78614. */
  78615. readString(byteLength: number): string;
  78616. /**
  78617. * Skips the given byte length the currently loaded data range.
  78618. * @param byteLength The byte length to skip
  78619. */
  78620. skipBytes(byteLength: number): void;
  78621. }
  78622. }
  78623. declare module "babylonjs/Misc/dataStorage" {
  78624. /**
  78625. * Class for storing data to local storage if available or in-memory storage otherwise
  78626. */
  78627. export class DataStorage {
  78628. private static _Storage;
  78629. private static _GetStorage;
  78630. /**
  78631. * Reads a string from the data storage
  78632. * @param key The key to read
  78633. * @param defaultValue The value if the key doesn't exist
  78634. * @returns The string value
  78635. */
  78636. static ReadString(key: string, defaultValue: string): string;
  78637. /**
  78638. * Writes a string to the data storage
  78639. * @param key The key to write
  78640. * @param value The value to write
  78641. */
  78642. static WriteString(key: string, value: string): void;
  78643. /**
  78644. * Reads a boolean from the data storage
  78645. * @param key The key to read
  78646. * @param defaultValue The value if the key doesn't exist
  78647. * @returns The boolean value
  78648. */
  78649. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78650. /**
  78651. * Writes a boolean to the data storage
  78652. * @param key The key to write
  78653. * @param value The value to write
  78654. */
  78655. static WriteBoolean(key: string, value: boolean): void;
  78656. /**
  78657. * Reads a number from the data storage
  78658. * @param key The key to read
  78659. * @param defaultValue The value if the key doesn't exist
  78660. * @returns The number value
  78661. */
  78662. static ReadNumber(key: string, defaultValue: number): number;
  78663. /**
  78664. * Writes a number to the data storage
  78665. * @param key The key to write
  78666. * @param value The value to write
  78667. */
  78668. static WriteNumber(key: string, value: number): void;
  78669. }
  78670. }
  78671. declare module "babylonjs/Misc/sceneRecorder" {
  78672. import { Scene } from "babylonjs/scene";
  78673. /**
  78674. * Class used to record delta files between 2 scene states
  78675. */
  78676. export class SceneRecorder {
  78677. private _trackedScene;
  78678. private _savedJSON;
  78679. /**
  78680. * Track a given scene. This means the current scene state will be considered the original state
  78681. * @param scene defines the scene to track
  78682. */
  78683. track(scene: Scene): void;
  78684. /**
  78685. * Get the delta between current state and original state
  78686. * @returns a string containing the delta
  78687. */
  78688. getDelta(): any;
  78689. private _compareArray;
  78690. private _compareObjects;
  78691. private _compareCollections;
  78692. private static GetShadowGeneratorById;
  78693. /**
  78694. * Apply a given delta to a given scene
  78695. * @param deltaJSON defines the JSON containing the delta
  78696. * @param scene defines the scene to apply the delta to
  78697. */
  78698. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78699. private static _ApplyPropertiesToEntity;
  78700. private static _ApplyDeltaForEntity;
  78701. }
  78702. }
  78703. declare module "babylonjs/Misc/trajectoryClassifier" {
  78704. import { DeepImmutable, Nullable } from "babylonjs/types";
  78705. import { Vector3 } from "babylonjs/Maths/math.vector";
  78706. /**
  78707. * A 3D trajectory consisting of an order list of vectors describing a
  78708. * path of motion through 3D space.
  78709. */
  78710. export class Trajectory {
  78711. private _points;
  78712. private readonly _segmentLength;
  78713. /**
  78714. * Serialize to JSON.
  78715. * @returns serialized JSON string
  78716. */
  78717. serialize(): string;
  78718. /**
  78719. * Deserialize from JSON.
  78720. * @param json serialized JSON string
  78721. * @returns deserialized Trajectory
  78722. */
  78723. static Deserialize(json: string): Trajectory;
  78724. /**
  78725. * Create a new empty Trajectory.
  78726. * @param segmentLength radius of discretization for Trajectory points
  78727. */
  78728. constructor(segmentLength?: number);
  78729. /**
  78730. * Get the length of the Trajectory.
  78731. * @returns length of the Trajectory
  78732. */
  78733. getLength(): number;
  78734. /**
  78735. * Append a new point to the Trajectory.
  78736. * NOTE: This implementation has many allocations.
  78737. * @param point point to append to the Trajectory
  78738. */
  78739. add(point: DeepImmutable<Vector3>): void;
  78740. /**
  78741. * Create a new Trajectory with a segment length chosen to make it
  78742. * probable that the new Trajectory will have a specified number of
  78743. * segments. This operation is imprecise.
  78744. * @param targetResolution number of segments desired
  78745. * @returns new Trajectory with approximately the requested number of segments
  78746. */
  78747. resampleAtTargetResolution(targetResolution: number): Trajectory;
  78748. /**
  78749. * Convert Trajectory segments into tokenized representation. This
  78750. * representation is an array of numbers where each nth number is the
  78751. * index of the token which is most similar to the nth segment of the
  78752. * Trajectory.
  78753. * @param tokens list of vectors which serve as discrete tokens
  78754. * @returns list of indices of most similar token per segment
  78755. */
  78756. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  78757. private static _forwardDir;
  78758. private static _inverseFromVec;
  78759. private static _upDir;
  78760. private static _fromToVec;
  78761. private static _lookMatrix;
  78762. /**
  78763. * Transform the rotation (i.e., direction) of a segment to isolate
  78764. * the relative transformation represented by the segment. This operation
  78765. * may or may not succeed due to singularities in the equations that define
  78766. * motion relativity in this context.
  78767. * @param priorVec the origin of the prior segment
  78768. * @param fromVec the origin of the current segment
  78769. * @param toVec the destination of the current segment
  78770. * @param result reference to output variable
  78771. * @returns whether or not transformation was successful
  78772. */
  78773. private static _transformSegmentDirToRef;
  78774. private static _bestMatch;
  78775. private static _score;
  78776. private static _bestScore;
  78777. /**
  78778. * Determine which token vector is most similar to the
  78779. * segment vector.
  78780. * @param segment segment vector
  78781. * @param tokens token vector list
  78782. * @returns index of the most similar token to the segment
  78783. */
  78784. private static _tokenizeSegment;
  78785. }
  78786. /**
  78787. * Class representing a set of known, named trajectories to which Trajectories can be
  78788. * added and using which Trajectories can be recognized.
  78789. */
  78790. export class TrajectoryClassifier {
  78791. private _maximumAllowableMatchCost;
  78792. private _vector3Alphabet;
  78793. private _levenshteinAlphabet;
  78794. private _nameToDescribedTrajectory;
  78795. /**
  78796. * Serialize to JSON.
  78797. * @returns JSON serialization
  78798. */
  78799. serialize(): string;
  78800. /**
  78801. * Deserialize from JSON.
  78802. * @param json JSON serialization
  78803. * @returns deserialized TrajectorySet
  78804. */
  78805. static Deserialize(json: string): TrajectoryClassifier;
  78806. /**
  78807. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  78808. * VERY naive, need to be generating these things from known
  78809. * sets. Better version later, probably eliminating this one.
  78810. * @returns auto-generated TrajectorySet
  78811. */
  78812. static Generate(): TrajectoryClassifier;
  78813. private constructor();
  78814. /**
  78815. * Add a new Trajectory to the set with a given name.
  78816. * @param trajectory new Trajectory to be added
  78817. * @param classification name to which to add the Trajectory
  78818. */
  78819. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  78820. /**
  78821. * Remove a known named trajectory and all Trajectories associated with it.
  78822. * @param classification name to remove
  78823. * @returns whether anything was removed
  78824. */
  78825. deleteClassification(classification: string): boolean;
  78826. /**
  78827. * Attempt to recognize a Trajectory from among all the classifications
  78828. * already known to the classifier.
  78829. * @param trajectory Trajectory to be recognized
  78830. * @returns classification of Trajectory if recognized, null otherwise
  78831. */
  78832. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  78833. }
  78834. }
  78835. declare module "babylonjs/Misc/index" {
  78836. export * from "babylonjs/Misc/andOrNotEvaluator";
  78837. export * from "babylonjs/Misc/assetsManager";
  78838. export * from "babylonjs/Misc/basis";
  78839. export * from "babylonjs/Misc/dds";
  78840. export * from "babylonjs/Misc/decorators";
  78841. export * from "babylonjs/Misc/deferred";
  78842. export * from "babylonjs/Misc/environmentTextureTools";
  78843. export * from "babylonjs/Misc/meshExploder";
  78844. export * from "babylonjs/Misc/filesInput";
  78845. export * from "babylonjs/Misc/HighDynamicRange/index";
  78846. export * from "babylonjs/Misc/khronosTextureContainer";
  78847. export * from "babylonjs/Misc/observable";
  78848. export * from "babylonjs/Misc/performanceMonitor";
  78849. export * from "babylonjs/Misc/promise";
  78850. export * from "babylonjs/Misc/sceneOptimizer";
  78851. export * from "babylonjs/Misc/sceneSerializer";
  78852. export * from "babylonjs/Misc/smartArray";
  78853. export * from "babylonjs/Misc/stringDictionary";
  78854. export * from "babylonjs/Misc/tags";
  78855. export * from "babylonjs/Misc/textureTools";
  78856. export * from "babylonjs/Misc/tga";
  78857. export * from "babylonjs/Misc/tools";
  78858. export * from "babylonjs/Misc/videoRecorder";
  78859. export * from "babylonjs/Misc/virtualJoystick";
  78860. export * from "babylonjs/Misc/workerPool";
  78861. export * from "babylonjs/Misc/logger";
  78862. export * from "babylonjs/Misc/typeStore";
  78863. export * from "babylonjs/Misc/filesInputStore";
  78864. export * from "babylonjs/Misc/deepCopier";
  78865. export * from "babylonjs/Misc/pivotTools";
  78866. export * from "babylonjs/Misc/precisionDate";
  78867. export * from "babylonjs/Misc/screenshotTools";
  78868. export * from "babylonjs/Misc/typeStore";
  78869. export * from "babylonjs/Misc/webRequest";
  78870. export * from "babylonjs/Misc/iInspectable";
  78871. export * from "babylonjs/Misc/brdfTextureTools";
  78872. export * from "babylonjs/Misc/rgbdTextureTools";
  78873. export * from "babylonjs/Misc/gradients";
  78874. export * from "babylonjs/Misc/perfCounter";
  78875. export * from "babylonjs/Misc/fileRequest";
  78876. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78877. export * from "babylonjs/Misc/retryStrategy";
  78878. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78879. export * from "babylonjs/Misc/canvasGenerator";
  78880. export * from "babylonjs/Misc/fileTools";
  78881. export * from "babylonjs/Misc/stringTools";
  78882. export * from "babylonjs/Misc/dataReader";
  78883. export * from "babylonjs/Misc/minMaxReducer";
  78884. export * from "babylonjs/Misc/depthReducer";
  78885. export * from "babylonjs/Misc/dataStorage";
  78886. export * from "babylonjs/Misc/sceneRecorder";
  78887. export * from "babylonjs/Misc/khronosTextureContainer2";
  78888. export * from "babylonjs/Misc/trajectoryClassifier";
  78889. }
  78890. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78891. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78892. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78893. import { Observable } from "babylonjs/Misc/observable";
  78894. import { Matrix } from "babylonjs/Maths/math.vector";
  78895. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78896. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78897. /**
  78898. * An interface for all Hit test features
  78899. */
  78900. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78901. /**
  78902. * Triggered when new babylon (transformed) hit test results are available
  78903. */
  78904. onHitTestResultObservable: Observable<T[]>;
  78905. }
  78906. /**
  78907. * Options used for hit testing
  78908. */
  78909. export interface IWebXRLegacyHitTestOptions {
  78910. /**
  78911. * Only test when user interacted with the scene. Default - hit test every frame
  78912. */
  78913. testOnPointerDownOnly?: boolean;
  78914. /**
  78915. * The node to use to transform the local results to world coordinates
  78916. */
  78917. worldParentNode?: TransformNode;
  78918. }
  78919. /**
  78920. * Interface defining the babylon result of raycasting/hit-test
  78921. */
  78922. export interface IWebXRLegacyHitResult {
  78923. /**
  78924. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78925. */
  78926. transformationMatrix: Matrix;
  78927. /**
  78928. * The native hit test result
  78929. */
  78930. xrHitResult: XRHitResult | XRHitTestResult;
  78931. }
  78932. /**
  78933. * The currently-working hit-test module.
  78934. * Hit test (or Ray-casting) is used to interact with the real world.
  78935. * For further information read here - https://github.com/immersive-web/hit-test
  78936. */
  78937. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78938. /**
  78939. * options to use when constructing this feature
  78940. */
  78941. readonly options: IWebXRLegacyHitTestOptions;
  78942. private _direction;
  78943. private _mat;
  78944. private _onSelectEnabled;
  78945. private _origin;
  78946. /**
  78947. * The module's name
  78948. */
  78949. static readonly Name: string;
  78950. /**
  78951. * The (Babylon) version of this module.
  78952. * This is an integer representing the implementation version.
  78953. * This number does not correspond to the WebXR specs version
  78954. */
  78955. static readonly Version: number;
  78956. /**
  78957. * Populated with the last native XR Hit Results
  78958. */
  78959. lastNativeXRHitResults: XRHitResult[];
  78960. /**
  78961. * Triggered when new babylon (transformed) hit test results are available
  78962. */
  78963. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78964. /**
  78965. * Creates a new instance of the (legacy version) hit test feature
  78966. * @param _xrSessionManager an instance of WebXRSessionManager
  78967. * @param options options to use when constructing this feature
  78968. */
  78969. constructor(_xrSessionManager: WebXRSessionManager,
  78970. /**
  78971. * options to use when constructing this feature
  78972. */
  78973. options?: IWebXRLegacyHitTestOptions);
  78974. /**
  78975. * execute a hit test with an XR Ray
  78976. *
  78977. * @param xrSession a native xrSession that will execute this hit test
  78978. * @param xrRay the ray (position and direction) to use for ray-casting
  78979. * @param referenceSpace native XR reference space to use for the hit-test
  78980. * @param filter filter function that will filter the results
  78981. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78982. */
  78983. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78984. /**
  78985. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78986. * @param event the (select) event to use to select with
  78987. * @param referenceSpace the reference space to use for this hit test
  78988. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78989. */
  78990. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78991. /**
  78992. * attach this feature
  78993. * Will usually be called by the features manager
  78994. *
  78995. * @returns true if successful.
  78996. */
  78997. attach(): boolean;
  78998. /**
  78999. * detach this feature.
  79000. * Will usually be called by the features manager
  79001. *
  79002. * @returns true if successful.
  79003. */
  79004. detach(): boolean;
  79005. /**
  79006. * Dispose this feature and all of the resources attached
  79007. */
  79008. dispose(): void;
  79009. protected _onXRFrame(frame: XRFrame): void;
  79010. private _onHitTestResults;
  79011. private _onSelect;
  79012. }
  79013. }
  79014. declare module "babylonjs/XR/features/WebXRHitTest" {
  79015. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79016. import { Observable } from "babylonjs/Misc/observable";
  79017. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  79018. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79019. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  79020. /**
  79021. * Options used for hit testing (version 2)
  79022. */
  79023. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  79024. /**
  79025. * Do not create a permanent hit test. Will usually be used when only
  79026. * transient inputs are needed.
  79027. */
  79028. disablePermanentHitTest?: boolean;
  79029. /**
  79030. * Enable transient (for example touch-based) hit test inspections
  79031. */
  79032. enableTransientHitTest?: boolean;
  79033. /**
  79034. * Offset ray for the permanent hit test
  79035. */
  79036. offsetRay?: Vector3;
  79037. /**
  79038. * Offset ray for the transient hit test
  79039. */
  79040. transientOffsetRay?: Vector3;
  79041. /**
  79042. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  79043. */
  79044. useReferenceSpace?: boolean;
  79045. /**
  79046. * Override the default entity type(s) of the hit-test result
  79047. */
  79048. entityTypes?: XRHitTestTrackableType[];
  79049. }
  79050. /**
  79051. * Interface defining the babylon result of hit-test
  79052. */
  79053. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  79054. /**
  79055. * The input source that generated this hit test (if transient)
  79056. */
  79057. inputSource?: XRInputSource;
  79058. /**
  79059. * Is this a transient hit test
  79060. */
  79061. isTransient?: boolean;
  79062. /**
  79063. * Position of the hit test result
  79064. */
  79065. position: Vector3;
  79066. /**
  79067. * Rotation of the hit test result
  79068. */
  79069. rotationQuaternion: Quaternion;
  79070. /**
  79071. * The native hit test result
  79072. */
  79073. xrHitResult: XRHitTestResult;
  79074. }
  79075. /**
  79076. * The currently-working hit-test module.
  79077. * Hit test (or Ray-casting) is used to interact with the real world.
  79078. * For further information read here - https://github.com/immersive-web/hit-test
  79079. *
  79080. * Tested on chrome (mobile) 80.
  79081. */
  79082. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  79083. /**
  79084. * options to use when constructing this feature
  79085. */
  79086. readonly options: IWebXRHitTestOptions;
  79087. private _tmpMat;
  79088. private _tmpPos;
  79089. private _tmpQuat;
  79090. private _transientXrHitTestSource;
  79091. private _xrHitTestSource;
  79092. private initHitTestSource;
  79093. /**
  79094. * The module's name
  79095. */
  79096. static readonly Name: string;
  79097. /**
  79098. * The (Babylon) version of this module.
  79099. * This is an integer representing the implementation version.
  79100. * This number does not correspond to the WebXR specs version
  79101. */
  79102. static readonly Version: number;
  79103. /**
  79104. * When set to true, each hit test will have its own position/rotation objects
  79105. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  79106. * the developers will clone them or copy them as they see fit.
  79107. */
  79108. autoCloneTransformation: boolean;
  79109. /**
  79110. * Triggered when new babylon (transformed) hit test results are available
  79111. * Note - this will be called when results come back from the device. It can be an empty array!!
  79112. */
  79113. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  79114. /**
  79115. * Use this to temporarily pause hit test checks.
  79116. */
  79117. paused: boolean;
  79118. /**
  79119. * Creates a new instance of the hit test feature
  79120. * @param _xrSessionManager an instance of WebXRSessionManager
  79121. * @param options options to use when constructing this feature
  79122. */
  79123. constructor(_xrSessionManager: WebXRSessionManager,
  79124. /**
  79125. * options to use when constructing this feature
  79126. */
  79127. options?: IWebXRHitTestOptions);
  79128. /**
  79129. * attach this feature
  79130. * Will usually be called by the features manager
  79131. *
  79132. * @returns true if successful.
  79133. */
  79134. attach(): boolean;
  79135. /**
  79136. * detach this feature.
  79137. * Will usually be called by the features manager
  79138. *
  79139. * @returns true if successful.
  79140. */
  79141. detach(): boolean;
  79142. /**
  79143. * Dispose this feature and all of the resources attached
  79144. */
  79145. dispose(): void;
  79146. protected _onXRFrame(frame: XRFrame): void;
  79147. private _processWebXRHitTestResult;
  79148. }
  79149. }
  79150. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  79151. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79152. import { Observable } from "babylonjs/Misc/observable";
  79153. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  79154. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79155. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79156. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  79157. /**
  79158. * Configuration options of the anchor system
  79159. */
  79160. export interface IWebXRAnchorSystemOptions {
  79161. /**
  79162. * a node that will be used to convert local to world coordinates
  79163. */
  79164. worldParentNode?: TransformNode;
  79165. /**
  79166. * If set to true a reference of the created anchors will be kept until the next session starts
  79167. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  79168. */
  79169. doNotRemoveAnchorsOnSessionEnded?: boolean;
  79170. }
  79171. /**
  79172. * A babylon container for an XR Anchor
  79173. */
  79174. export interface IWebXRAnchor {
  79175. /**
  79176. * A babylon-assigned ID for this anchor
  79177. */
  79178. id: number;
  79179. /**
  79180. * Transformation matrix to apply to an object attached to this anchor
  79181. */
  79182. transformationMatrix: Matrix;
  79183. /**
  79184. * The native anchor object
  79185. */
  79186. xrAnchor: XRAnchor;
  79187. /**
  79188. * if defined, this object will be constantly updated by the anchor's position and rotation
  79189. */
  79190. attachedNode?: TransformNode;
  79191. }
  79192. /**
  79193. * An implementation of the anchor system for WebXR.
  79194. * For further information see https://github.com/immersive-web/anchors/
  79195. */
  79196. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  79197. private _options;
  79198. private _lastFrameDetected;
  79199. private _trackedAnchors;
  79200. private _referenceSpaceForFrameAnchors;
  79201. private _futureAnchors;
  79202. /**
  79203. * The module's name
  79204. */
  79205. static readonly Name: string;
  79206. /**
  79207. * The (Babylon) version of this module.
  79208. * This is an integer representing the implementation version.
  79209. * This number does not correspond to the WebXR specs version
  79210. */
  79211. static readonly Version: number;
  79212. /**
  79213. * Observers registered here will be executed when a new anchor was added to the session
  79214. */
  79215. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  79216. /**
  79217. * Observers registered here will be executed when an anchor was removed from the session
  79218. */
  79219. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  79220. /**
  79221. * Observers registered here will be executed when an existing anchor updates
  79222. * This can execute N times every frame
  79223. */
  79224. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  79225. /**
  79226. * Set the reference space to use for anchor creation, when not using a hit test.
  79227. * Will default to the session's reference space if not defined
  79228. */
  79229. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  79230. /**
  79231. * constructs a new anchor system
  79232. * @param _xrSessionManager an instance of WebXRSessionManager
  79233. * @param _options configuration object for this feature
  79234. */
  79235. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  79236. private _tmpVector;
  79237. private _tmpQuaternion;
  79238. private _populateTmpTransformation;
  79239. /**
  79240. * Create a new anchor point using a hit test result at a specific point in the scene
  79241. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  79242. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  79243. *
  79244. * @param hitTestResult The hit test result to use for this anchor creation
  79245. * @param position an optional position offset for this anchor
  79246. * @param rotationQuaternion an optional rotation offset for this anchor
  79247. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  79248. */
  79249. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  79250. /**
  79251. * Add a new anchor at a specific position and rotation
  79252. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  79253. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  79254. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  79255. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  79256. *
  79257. * @param position the position in which to add an anchor
  79258. * @param rotationQuaternion an optional rotation for the anchor transformation
  79259. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  79260. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  79261. */
  79262. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  79263. /**
  79264. * detach this feature.
  79265. * Will usually be called by the features manager
  79266. *
  79267. * @returns true if successful.
  79268. */
  79269. detach(): boolean;
  79270. /**
  79271. * Dispose this feature and all of the resources attached
  79272. */
  79273. dispose(): void;
  79274. protected _onXRFrame(frame: XRFrame): void;
  79275. /**
  79276. * avoiding using Array.find for global support.
  79277. * @param xrAnchor the plane to find in the array
  79278. */
  79279. private _findIndexInAnchorArray;
  79280. private _updateAnchorWithXRFrame;
  79281. private _createAnchorAtTransformation;
  79282. }
  79283. }
  79284. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  79285. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79286. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79287. import { Observable } from "babylonjs/Misc/observable";
  79288. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  79289. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79290. /**
  79291. * Options used in the plane detector module
  79292. */
  79293. export interface IWebXRPlaneDetectorOptions {
  79294. /**
  79295. * The node to use to transform the local results to world coordinates
  79296. */
  79297. worldParentNode?: TransformNode;
  79298. /**
  79299. * If set to true a reference of the created planes will be kept until the next session starts
  79300. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  79301. */
  79302. doNotRemovePlanesOnSessionEnded?: boolean;
  79303. }
  79304. /**
  79305. * A babylon interface for a WebXR plane.
  79306. * A Plane is actually a polygon, built from N points in space
  79307. *
  79308. * Supported in chrome 79, not supported in canary 81 ATM
  79309. */
  79310. export interface IWebXRPlane {
  79311. /**
  79312. * a babylon-assigned ID for this polygon
  79313. */
  79314. id: number;
  79315. /**
  79316. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  79317. */
  79318. polygonDefinition: Array<Vector3>;
  79319. /**
  79320. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  79321. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  79322. */
  79323. transformationMatrix: Matrix;
  79324. /**
  79325. * the native xr-plane object
  79326. */
  79327. xrPlane: XRPlane;
  79328. }
  79329. /**
  79330. * The plane detector is used to detect planes in the real world when in AR
  79331. * For more information see https://github.com/immersive-web/real-world-geometry/
  79332. */
  79333. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  79334. private _options;
  79335. private _detectedPlanes;
  79336. private _enabled;
  79337. private _lastFrameDetected;
  79338. /**
  79339. * The module's name
  79340. */
  79341. static readonly Name: string;
  79342. /**
  79343. * The (Babylon) version of this module.
  79344. * This is an integer representing the implementation version.
  79345. * This number does not correspond to the WebXR specs version
  79346. */
  79347. static readonly Version: number;
  79348. /**
  79349. * Observers registered here will be executed when a new plane was added to the session
  79350. */
  79351. onPlaneAddedObservable: Observable<IWebXRPlane>;
  79352. /**
  79353. * Observers registered here will be executed when a plane is no longer detected in the session
  79354. */
  79355. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  79356. /**
  79357. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  79358. * This can execute N times every frame
  79359. */
  79360. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  79361. /**
  79362. * construct a new Plane Detector
  79363. * @param _xrSessionManager an instance of xr Session manager
  79364. * @param _options configuration to use when constructing this feature
  79365. */
  79366. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  79367. /**
  79368. * detach this feature.
  79369. * Will usually be called by the features manager
  79370. *
  79371. * @returns true if successful.
  79372. */
  79373. detach(): boolean;
  79374. /**
  79375. * Dispose this feature and all of the resources attached
  79376. */
  79377. dispose(): void;
  79378. protected _onXRFrame(frame: XRFrame): void;
  79379. private _init;
  79380. private _updatePlaneWithXRPlane;
  79381. /**
  79382. * avoiding using Array.find for global support.
  79383. * @param xrPlane the plane to find in the array
  79384. */
  79385. private findIndexInPlaneArray;
  79386. }
  79387. }
  79388. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  79389. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79390. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79391. import { Observable } from "babylonjs/Misc/observable";
  79392. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79393. /**
  79394. * Options interface for the background remover plugin
  79395. */
  79396. export interface IWebXRBackgroundRemoverOptions {
  79397. /**
  79398. * Further background meshes to disable when entering AR
  79399. */
  79400. backgroundMeshes?: AbstractMesh[];
  79401. /**
  79402. * flags to configure the removal of the environment helper.
  79403. * If not set, the entire background will be removed. If set, flags should be set as well.
  79404. */
  79405. environmentHelperRemovalFlags?: {
  79406. /**
  79407. * Should the skybox be removed (default false)
  79408. */
  79409. skyBox?: boolean;
  79410. /**
  79411. * Should the ground be removed (default false)
  79412. */
  79413. ground?: boolean;
  79414. };
  79415. /**
  79416. * don't disable the environment helper
  79417. */
  79418. ignoreEnvironmentHelper?: boolean;
  79419. }
  79420. /**
  79421. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  79422. */
  79423. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  79424. /**
  79425. * read-only options to be used in this module
  79426. */
  79427. readonly options: IWebXRBackgroundRemoverOptions;
  79428. /**
  79429. * The module's name
  79430. */
  79431. static readonly Name: string;
  79432. /**
  79433. * The (Babylon) version of this module.
  79434. * This is an integer representing the implementation version.
  79435. * This number does not correspond to the WebXR specs version
  79436. */
  79437. static readonly Version: number;
  79438. /**
  79439. * registered observers will be triggered when the background state changes
  79440. */
  79441. onBackgroundStateChangedObservable: Observable<boolean>;
  79442. /**
  79443. * constructs a new background remover module
  79444. * @param _xrSessionManager the session manager for this module
  79445. * @param options read-only options to be used in this module
  79446. */
  79447. constructor(_xrSessionManager: WebXRSessionManager,
  79448. /**
  79449. * read-only options to be used in this module
  79450. */
  79451. options?: IWebXRBackgroundRemoverOptions);
  79452. /**
  79453. * attach this feature
  79454. * Will usually be called by the features manager
  79455. *
  79456. * @returns true if successful.
  79457. */
  79458. attach(): boolean;
  79459. /**
  79460. * detach this feature.
  79461. * Will usually be called by the features manager
  79462. *
  79463. * @returns true if successful.
  79464. */
  79465. detach(): boolean;
  79466. /**
  79467. * Dispose this feature and all of the resources attached
  79468. */
  79469. dispose(): void;
  79470. protected _onXRFrame(_xrFrame: XRFrame): void;
  79471. private _setBackgroundState;
  79472. }
  79473. }
  79474. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  79475. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79476. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79477. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  79478. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79479. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79480. import { Nullable } from "babylonjs/types";
  79481. /**
  79482. * Options for the controller physics feature
  79483. */
  79484. export class IWebXRControllerPhysicsOptions {
  79485. /**
  79486. * Should the headset get its own impostor
  79487. */
  79488. enableHeadsetImpostor?: boolean;
  79489. /**
  79490. * Optional parameters for the headset impostor
  79491. */
  79492. headsetImpostorParams?: {
  79493. /**
  79494. * The type of impostor to create. Default is sphere
  79495. */
  79496. impostorType: number;
  79497. /**
  79498. * the size of the impostor. Defaults to 10cm
  79499. */
  79500. impostorSize?: number | {
  79501. width: number;
  79502. height: number;
  79503. depth: number;
  79504. };
  79505. /**
  79506. * Friction definitions
  79507. */
  79508. friction?: number;
  79509. /**
  79510. * Restitution
  79511. */
  79512. restitution?: number;
  79513. };
  79514. /**
  79515. * The physics properties of the future impostors
  79516. */
  79517. physicsProperties?: {
  79518. /**
  79519. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  79520. * Note that this requires a physics engine that supports mesh impostors!
  79521. */
  79522. useControllerMesh?: boolean;
  79523. /**
  79524. * The type of impostor to create. Default is sphere
  79525. */
  79526. impostorType?: number;
  79527. /**
  79528. * the size of the impostor. Defaults to 10cm
  79529. */
  79530. impostorSize?: number | {
  79531. width: number;
  79532. height: number;
  79533. depth: number;
  79534. };
  79535. /**
  79536. * Friction definitions
  79537. */
  79538. friction?: number;
  79539. /**
  79540. * Restitution
  79541. */
  79542. restitution?: number;
  79543. };
  79544. /**
  79545. * the xr input to use with this pointer selection
  79546. */
  79547. xrInput: WebXRInput;
  79548. }
  79549. /**
  79550. * Add physics impostor to your webxr controllers,
  79551. * including naive calculation of their linear and angular velocity
  79552. */
  79553. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  79554. private readonly _options;
  79555. private _attachController;
  79556. private _controllers;
  79557. private _debugMode;
  79558. private _delta;
  79559. private _headsetImpostor?;
  79560. private _headsetMesh?;
  79561. private _lastTimestamp;
  79562. private _tmpQuaternion;
  79563. private _tmpVector;
  79564. /**
  79565. * The module's name
  79566. */
  79567. static readonly Name: string;
  79568. /**
  79569. * The (Babylon) version of this module.
  79570. * This is an integer representing the implementation version.
  79571. * This number does not correspond to the webxr specs version
  79572. */
  79573. static readonly Version: number;
  79574. /**
  79575. * Construct a new Controller Physics Feature
  79576. * @param _xrSessionManager the corresponding xr session manager
  79577. * @param _options options to create this feature with
  79578. */
  79579. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  79580. /**
  79581. * @hidden
  79582. * enable debugging - will show console outputs and the impostor mesh
  79583. */
  79584. _enablePhysicsDebug(): void;
  79585. /**
  79586. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  79587. * @param xrController the controller to add
  79588. */
  79589. addController(xrController: WebXRInputSource): void;
  79590. /**
  79591. * attach this feature
  79592. * Will usually be called by the features manager
  79593. *
  79594. * @returns true if successful.
  79595. */
  79596. attach(): boolean;
  79597. /**
  79598. * detach this feature.
  79599. * Will usually be called by the features manager
  79600. *
  79601. * @returns true if successful.
  79602. */
  79603. detach(): boolean;
  79604. /**
  79605. * Get the headset impostor, if enabled
  79606. * @returns the impostor
  79607. */
  79608. getHeadsetImpostor(): PhysicsImpostor | undefined;
  79609. /**
  79610. * Get the physics impostor of a specific controller.
  79611. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  79612. * @param controller the controller or the controller id of which to get the impostor
  79613. * @returns the impostor or null
  79614. */
  79615. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  79616. /**
  79617. * Update the physics properties provided in the constructor
  79618. * @param newProperties the new properties object
  79619. */
  79620. setPhysicsProperties(newProperties: {
  79621. impostorType?: number;
  79622. impostorSize?: number | {
  79623. width: number;
  79624. height: number;
  79625. depth: number;
  79626. };
  79627. friction?: number;
  79628. restitution?: number;
  79629. }): void;
  79630. protected _onXRFrame(_xrFrame: any): void;
  79631. private _detachController;
  79632. }
  79633. }
  79634. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79635. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79636. import { Observable } from "babylonjs/Misc/observable";
  79637. import { Vector3 } from "babylonjs/Maths/math.vector";
  79638. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79639. /**
  79640. * A babylon interface for a "WebXR" feature point.
  79641. * Represents the position and confidence value of a given feature point.
  79642. */
  79643. export interface IWebXRFeaturePoint {
  79644. /**
  79645. * Represents the position of the feature point in world space.
  79646. */
  79647. position: Vector3;
  79648. /**
  79649. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79650. */
  79651. confidenceValue: number;
  79652. }
  79653. /**
  79654. * The feature point system is used to detect feature points from real world geometry.
  79655. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79656. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79657. */
  79658. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79659. private _enabled;
  79660. private _featurePointCloud;
  79661. /**
  79662. * The module's name
  79663. */
  79664. static readonly Name: string;
  79665. /**
  79666. * The (Babylon) version of this module.
  79667. * This is an integer representing the implementation version.
  79668. * This number does not correspond to the WebXR specs version
  79669. */
  79670. static readonly Version: number;
  79671. /**
  79672. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79673. * Will notify the observers about which feature points have been added.
  79674. */
  79675. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79676. /**
  79677. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79678. * Will notify the observers about which feature points have been updated.
  79679. */
  79680. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79681. /**
  79682. * The current feature point cloud maintained across frames.
  79683. */
  79684. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79685. /**
  79686. * construct the feature point system
  79687. * @param _xrSessionManager an instance of xr Session manager
  79688. */
  79689. constructor(_xrSessionManager: WebXRSessionManager);
  79690. /**
  79691. * Detach this feature.
  79692. * Will usually be called by the features manager
  79693. *
  79694. * @returns true if successful.
  79695. */
  79696. detach(): boolean;
  79697. /**
  79698. * Dispose this feature and all of the resources attached
  79699. */
  79700. dispose(): void;
  79701. /**
  79702. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79703. */
  79704. protected _onXRFrame(frame: XRFrame): void;
  79705. /**
  79706. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79707. */
  79708. private _init;
  79709. }
  79710. }
  79711. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79712. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79713. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79714. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79715. import { Mesh } from "babylonjs/Meshes/mesh";
  79716. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79717. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79718. import { Nullable } from "babylonjs/types";
  79719. import { IDisposable } from "babylonjs/scene";
  79720. import { Observable } from "babylonjs/Misc/observable";
  79721. /**
  79722. * Configuration interface for the hand tracking feature
  79723. */
  79724. export interface IWebXRHandTrackingOptions {
  79725. /**
  79726. * The xrInput that will be used as source for new hands
  79727. */
  79728. xrInput: WebXRInput;
  79729. /**
  79730. * Configuration object for the joint meshes
  79731. */
  79732. jointMeshes?: {
  79733. /**
  79734. * Should the meshes created be invisible (defaults to false)
  79735. */
  79736. invisible?: boolean;
  79737. /**
  79738. * A source mesh to be used to create instances. Defaults to a sphere.
  79739. * This mesh will be the source for all other (25) meshes.
  79740. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79741. */
  79742. sourceMesh?: Mesh;
  79743. /**
  79744. * Should the source mesh stay visible. Defaults to false
  79745. */
  79746. keepOriginalVisible?: boolean;
  79747. /**
  79748. * Scale factor for all instances (defaults to 2)
  79749. */
  79750. scaleFactor?: number;
  79751. /**
  79752. * Should each instance have its own physics impostor
  79753. */
  79754. enablePhysics?: boolean;
  79755. /**
  79756. * If enabled, override default physics properties
  79757. */
  79758. physicsProps?: {
  79759. friction?: number;
  79760. restitution?: number;
  79761. impostorType?: number;
  79762. };
  79763. /**
  79764. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79765. */
  79766. handMesh?: AbstractMesh;
  79767. };
  79768. }
  79769. /**
  79770. * Parts of the hands divided to writs and finger names
  79771. */
  79772. export const enum HandPart {
  79773. /**
  79774. * HandPart - Wrist
  79775. */
  79776. WRIST = "wrist",
  79777. /**
  79778. * HandPart - The THumb
  79779. */
  79780. THUMB = "thumb",
  79781. /**
  79782. * HandPart - Index finger
  79783. */
  79784. INDEX = "index",
  79785. /**
  79786. * HandPart - Middle finger
  79787. */
  79788. MIDDLE = "middle",
  79789. /**
  79790. * HandPart - Ring finger
  79791. */
  79792. RING = "ring",
  79793. /**
  79794. * HandPart - Little finger
  79795. */
  79796. LITTLE = "little"
  79797. }
  79798. /**
  79799. * Representing a single hand (with its corresponding native XRHand object)
  79800. */
  79801. export class WebXRHand implements IDisposable {
  79802. /** the controller to which the hand correlates */
  79803. readonly xrController: WebXRInputSource;
  79804. /** the meshes to be used to track the hand joints */
  79805. readonly trackedMeshes: AbstractMesh[];
  79806. /**
  79807. * Hand-parts definition (key is HandPart)
  79808. */
  79809. handPartsDefinition: {
  79810. [key: string]: number[];
  79811. };
  79812. /**
  79813. * Populate the HandPartsDefinition object.
  79814. * This is called as a side effect since certain browsers don't have XRHand defined.
  79815. */
  79816. private generateHandPartsDefinition;
  79817. /**
  79818. * Construct a new hand object
  79819. * @param xrController the controller to which the hand correlates
  79820. * @param trackedMeshes the meshes to be used to track the hand joints
  79821. */
  79822. constructor(
  79823. /** the controller to which the hand correlates */
  79824. xrController: WebXRInputSource,
  79825. /** the meshes to be used to track the hand joints */
  79826. trackedMeshes: AbstractMesh[]);
  79827. /**
  79828. * Update this hand from the latest xr frame
  79829. * @param xrFrame xrFrame to update from
  79830. * @param referenceSpace The current viewer reference space
  79831. * @param scaleFactor optional scale factor for the meshes
  79832. */
  79833. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79834. /**
  79835. * Get meshes of part of the hand
  79836. * @param part the part of hand to get
  79837. * @returns An array of meshes that correlate to the hand part requested
  79838. */
  79839. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79840. /**
  79841. * Dispose this Hand object
  79842. */
  79843. dispose(): void;
  79844. }
  79845. /**
  79846. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79847. */
  79848. export class WebXRHandTracking extends WebXRAbstractFeature {
  79849. /**
  79850. * options to use when constructing this feature
  79851. */
  79852. readonly options: IWebXRHandTrackingOptions;
  79853. private static _idCounter;
  79854. /**
  79855. * The module's name
  79856. */
  79857. static readonly Name: string;
  79858. /**
  79859. * The (Babylon) version of this module.
  79860. * This is an integer representing the implementation version.
  79861. * This number does not correspond to the WebXR specs version
  79862. */
  79863. static readonly Version: number;
  79864. /**
  79865. * This observable will notify registered observers when a new hand object was added and initialized
  79866. */
  79867. onHandAddedObservable: Observable<WebXRHand>;
  79868. /**
  79869. * This observable will notify its observers right before the hand object is disposed
  79870. */
  79871. onHandRemovedObservable: Observable<WebXRHand>;
  79872. private _hands;
  79873. /**
  79874. * Creates a new instance of the hit test feature
  79875. * @param _xrSessionManager an instance of WebXRSessionManager
  79876. * @param options options to use when constructing this feature
  79877. */
  79878. constructor(_xrSessionManager: WebXRSessionManager,
  79879. /**
  79880. * options to use when constructing this feature
  79881. */
  79882. options: IWebXRHandTrackingOptions);
  79883. /**
  79884. * Check if the needed objects are defined.
  79885. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79886. */
  79887. isCompatible(): boolean;
  79888. /**
  79889. * attach this feature
  79890. * Will usually be called by the features manager
  79891. *
  79892. * @returns true if successful.
  79893. */
  79894. attach(): boolean;
  79895. /**
  79896. * detach this feature.
  79897. * Will usually be called by the features manager
  79898. *
  79899. * @returns true if successful.
  79900. */
  79901. detach(): boolean;
  79902. /**
  79903. * Dispose this feature and all of the resources attached
  79904. */
  79905. dispose(): void;
  79906. /**
  79907. * Get the hand object according to the controller id
  79908. * @param controllerId the controller id to which we want to get the hand
  79909. * @returns null if not found or the WebXRHand object if found
  79910. */
  79911. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79912. /**
  79913. * Get a hand object according to the requested handedness
  79914. * @param handedness the handedness to request
  79915. * @returns null if not found or the WebXRHand object if found
  79916. */
  79917. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79918. protected _onXRFrame(_xrFrame: XRFrame): void;
  79919. private _attachHand;
  79920. private _detachHand;
  79921. }
  79922. }
  79923. declare module "babylonjs/XR/features/index" {
  79924. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79925. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79926. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79927. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79928. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79929. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79930. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79931. export * from "babylonjs/XR/features/WebXRHitTest";
  79932. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79933. export * from "babylonjs/XR/features/WebXRHandTracking";
  79934. }
  79935. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79936. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79937. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79938. import { Scene } from "babylonjs/scene";
  79939. /**
  79940. * The motion controller class for all microsoft mixed reality controllers
  79941. */
  79942. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79943. protected readonly _mapping: {
  79944. defaultButton: {
  79945. valueNodeName: string;
  79946. unpressedNodeName: string;
  79947. pressedNodeName: string;
  79948. };
  79949. defaultAxis: {
  79950. valueNodeName: string;
  79951. minNodeName: string;
  79952. maxNodeName: string;
  79953. };
  79954. buttons: {
  79955. "xr-standard-trigger": {
  79956. rootNodeName: string;
  79957. componentProperty: string;
  79958. states: string[];
  79959. };
  79960. "xr-standard-squeeze": {
  79961. rootNodeName: string;
  79962. componentProperty: string;
  79963. states: string[];
  79964. };
  79965. "xr-standard-touchpad": {
  79966. rootNodeName: string;
  79967. labelAnchorNodeName: string;
  79968. touchPointNodeName: string;
  79969. };
  79970. "xr-standard-thumbstick": {
  79971. rootNodeName: string;
  79972. componentProperty: string;
  79973. states: string[];
  79974. };
  79975. };
  79976. axes: {
  79977. "xr-standard-touchpad": {
  79978. "x-axis": {
  79979. rootNodeName: string;
  79980. };
  79981. "y-axis": {
  79982. rootNodeName: string;
  79983. };
  79984. };
  79985. "xr-standard-thumbstick": {
  79986. "x-axis": {
  79987. rootNodeName: string;
  79988. };
  79989. "y-axis": {
  79990. rootNodeName: string;
  79991. };
  79992. };
  79993. };
  79994. };
  79995. /**
  79996. * The base url used to load the left and right controller models
  79997. */
  79998. static MODEL_BASE_URL: string;
  79999. /**
  80000. * The name of the left controller model file
  80001. */
  80002. static MODEL_LEFT_FILENAME: string;
  80003. /**
  80004. * The name of the right controller model file
  80005. */
  80006. static MODEL_RIGHT_FILENAME: string;
  80007. profileId: string;
  80008. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  80009. protected _getFilenameAndPath(): {
  80010. filename: string;
  80011. path: string;
  80012. };
  80013. protected _getModelLoadingConstraints(): boolean;
  80014. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80015. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80016. protected _updateModel(): void;
  80017. }
  80018. }
  80019. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  80020. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80022. import { Scene } from "babylonjs/scene";
  80023. /**
  80024. * The motion controller class for oculus touch (quest, rift).
  80025. * This class supports legacy mapping as well the standard xr mapping
  80026. */
  80027. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  80028. private _forceLegacyControllers;
  80029. private _modelRootNode;
  80030. /**
  80031. * The base url used to load the left and right controller models
  80032. */
  80033. static MODEL_BASE_URL: string;
  80034. /**
  80035. * The name of the left controller model file
  80036. */
  80037. static MODEL_LEFT_FILENAME: string;
  80038. /**
  80039. * The name of the right controller model file
  80040. */
  80041. static MODEL_RIGHT_FILENAME: string;
  80042. /**
  80043. * Base Url for the Quest controller model.
  80044. */
  80045. static QUEST_MODEL_BASE_URL: string;
  80046. profileId: string;
  80047. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  80048. protected _getFilenameAndPath(): {
  80049. filename: string;
  80050. path: string;
  80051. };
  80052. protected _getModelLoadingConstraints(): boolean;
  80053. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80054. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80055. protected _updateModel(): void;
  80056. /**
  80057. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  80058. * between the touch and touch 2.
  80059. */
  80060. private _isQuest;
  80061. }
  80062. }
  80063. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  80064. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80065. import { Scene } from "babylonjs/scene";
  80066. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80067. /**
  80068. * The motion controller class for the standard HTC-Vive controllers
  80069. */
  80070. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  80071. private _modelRootNode;
  80072. /**
  80073. * The base url used to load the left and right controller models
  80074. */
  80075. static MODEL_BASE_URL: string;
  80076. /**
  80077. * File name for the controller model.
  80078. */
  80079. static MODEL_FILENAME: string;
  80080. profileId: string;
  80081. /**
  80082. * Create a new Vive motion controller object
  80083. * @param scene the scene to use to create this controller
  80084. * @param gamepadObject the corresponding gamepad object
  80085. * @param handedness the handedness of the controller
  80086. */
  80087. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  80088. protected _getFilenameAndPath(): {
  80089. filename: string;
  80090. path: string;
  80091. };
  80092. protected _getModelLoadingConstraints(): boolean;
  80093. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80094. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80095. protected _updateModel(): void;
  80096. }
  80097. }
  80098. declare module "babylonjs/XR/motionController/index" {
  80099. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80100. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  80101. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  80102. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  80103. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  80104. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  80105. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  80106. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  80107. }
  80108. declare module "babylonjs/XR/index" {
  80109. export * from "babylonjs/XR/webXRCamera";
  80110. export * from "babylonjs/XR/webXREnterExitUI";
  80111. export * from "babylonjs/XR/webXRExperienceHelper";
  80112. export * from "babylonjs/XR/webXRInput";
  80113. export * from "babylonjs/XR/webXRInputSource";
  80114. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  80115. export * from "babylonjs/XR/webXRTypes";
  80116. export * from "babylonjs/XR/webXRSessionManager";
  80117. export * from "babylonjs/XR/webXRDefaultExperience";
  80118. export * from "babylonjs/XR/webXRFeaturesManager";
  80119. export * from "babylonjs/XR/features/index";
  80120. export * from "babylonjs/XR/motionController/index";
  80121. }
  80122. declare module "babylonjs/index" {
  80123. export * from "babylonjs/abstractScene";
  80124. export * from "babylonjs/Actions/index";
  80125. export * from "babylonjs/Animations/index";
  80126. export * from "babylonjs/assetContainer";
  80127. export * from "babylonjs/Audio/index";
  80128. export * from "babylonjs/Behaviors/index";
  80129. export * from "babylonjs/Bones/index";
  80130. export * from "babylonjs/Cameras/index";
  80131. export * from "babylonjs/Collisions/index";
  80132. export * from "babylonjs/Culling/index";
  80133. export * from "babylonjs/Debug/index";
  80134. export * from "babylonjs/DeviceInput/index";
  80135. export * from "babylonjs/Engines/index";
  80136. export * from "babylonjs/Events/index";
  80137. export * from "babylonjs/Gamepads/index";
  80138. export * from "babylonjs/Gizmos/index";
  80139. export * from "babylonjs/Helpers/index";
  80140. export * from "babylonjs/Instrumentation/index";
  80141. export * from "babylonjs/Layers/index";
  80142. export * from "babylonjs/LensFlares/index";
  80143. export * from "babylonjs/Lights/index";
  80144. export * from "babylonjs/Loading/index";
  80145. export * from "babylonjs/Materials/index";
  80146. export * from "babylonjs/Maths/index";
  80147. export * from "babylonjs/Meshes/index";
  80148. export * from "babylonjs/Morph/index";
  80149. export * from "babylonjs/Navigation/index";
  80150. export * from "babylonjs/node";
  80151. export * from "babylonjs/Offline/index";
  80152. export * from "babylonjs/Particles/index";
  80153. export * from "babylonjs/Physics/index";
  80154. export * from "babylonjs/PostProcesses/index";
  80155. export * from "babylonjs/Probes/index";
  80156. export * from "babylonjs/Rendering/index";
  80157. export * from "babylonjs/scene";
  80158. export * from "babylonjs/sceneComponent";
  80159. export * from "babylonjs/Sprites/index";
  80160. export * from "babylonjs/States/index";
  80161. export * from "babylonjs/Misc/index";
  80162. export * from "babylonjs/XR/index";
  80163. export * from "babylonjs/types";
  80164. }
  80165. declare module "babylonjs/Animations/pathCursor" {
  80166. import { Vector3 } from "babylonjs/Maths/math.vector";
  80167. import { Path2 } from "babylonjs/Maths/math.path";
  80168. /**
  80169. * A cursor which tracks a point on a path
  80170. */
  80171. export class PathCursor {
  80172. private path;
  80173. /**
  80174. * Stores path cursor callbacks for when an onchange event is triggered
  80175. */
  80176. private _onchange;
  80177. /**
  80178. * The value of the path cursor
  80179. */
  80180. value: number;
  80181. /**
  80182. * The animation array of the path cursor
  80183. */
  80184. animations: Animation[];
  80185. /**
  80186. * Initializes the path cursor
  80187. * @param path The path to track
  80188. */
  80189. constructor(path: Path2);
  80190. /**
  80191. * Gets the cursor point on the path
  80192. * @returns A point on the path cursor at the cursor location
  80193. */
  80194. getPoint(): Vector3;
  80195. /**
  80196. * Moves the cursor ahead by the step amount
  80197. * @param step The amount to move the cursor forward
  80198. * @returns This path cursor
  80199. */
  80200. moveAhead(step?: number): PathCursor;
  80201. /**
  80202. * Moves the cursor behind by the step amount
  80203. * @param step The amount to move the cursor back
  80204. * @returns This path cursor
  80205. */
  80206. moveBack(step?: number): PathCursor;
  80207. /**
  80208. * Moves the cursor by the step amount
  80209. * If the step amount is greater than one, an exception is thrown
  80210. * @param step The amount to move the cursor
  80211. * @returns This path cursor
  80212. */
  80213. move(step: number): PathCursor;
  80214. /**
  80215. * Ensures that the value is limited between zero and one
  80216. * @returns This path cursor
  80217. */
  80218. private ensureLimits;
  80219. /**
  80220. * Runs onchange callbacks on change (used by the animation engine)
  80221. * @returns This path cursor
  80222. */
  80223. private raiseOnChange;
  80224. /**
  80225. * Executes a function on change
  80226. * @param f A path cursor onchange callback
  80227. * @returns This path cursor
  80228. */
  80229. onchange(f: (cursor: PathCursor) => void): PathCursor;
  80230. }
  80231. }
  80232. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  80233. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  80234. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  80235. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  80236. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  80237. }
  80238. declare module "babylonjs/Engines/Processors/Expressions/index" {
  80239. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  80240. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  80241. }
  80242. declare module "babylonjs/Engines/Processors/index" {
  80243. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  80244. export * from "babylonjs/Engines/Processors/Expressions/index";
  80245. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  80246. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  80247. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  80248. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  80249. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  80250. export * from "babylonjs/Engines/Processors/shaderProcessor";
  80251. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  80252. }
  80253. declare module "babylonjs/Legacy/legacy" {
  80254. import * as Babylon from "babylonjs/index";
  80255. export * from "babylonjs/index";
  80256. }
  80257. declare module "babylonjs/Shaders/blur.fragment" {
  80258. /** @hidden */
  80259. export var blurPixelShader: {
  80260. name: string;
  80261. shader: string;
  80262. };
  80263. }
  80264. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  80265. /** @hidden */
  80266. export var pointCloudVertexDeclaration: {
  80267. name: string;
  80268. shader: string;
  80269. };
  80270. }
  80271. declare module "babylonjs" {
  80272. export * from "babylonjs/Legacy/legacy";
  80273. }
  80274. declare module BABYLON {
  80275. /** Alias type for value that can be null */
  80276. export type Nullable<T> = T | null;
  80277. /**
  80278. * Alias type for number that are floats
  80279. * @ignorenaming
  80280. */
  80281. export type float = number;
  80282. /**
  80283. * Alias type for number that are doubles.
  80284. * @ignorenaming
  80285. */
  80286. export type double = number;
  80287. /**
  80288. * Alias type for number that are integer
  80289. * @ignorenaming
  80290. */
  80291. export type int = number;
  80292. /** Alias type for number array or Float32Array */
  80293. export type FloatArray = number[] | Float32Array;
  80294. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  80295. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  80296. /**
  80297. * Alias for types that can be used by a Buffer or VertexBuffer.
  80298. */
  80299. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  80300. /**
  80301. * Alias type for primitive types
  80302. * @ignorenaming
  80303. */
  80304. type Primitive = undefined | null | boolean | string | number | Function;
  80305. /**
  80306. * Type modifier to make all the properties of an object Readonly
  80307. */
  80308. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  80309. /**
  80310. * Type modifier to make all the properties of an object Readonly recursively
  80311. */
  80312. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  80313. /**
  80314. * Type modifier to make object properties readonly.
  80315. */
  80316. export type DeepImmutableObject<T> = {
  80317. readonly [K in keyof T]: DeepImmutable<T[K]>;
  80318. };
  80319. /** @hidden */
  80320. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  80321. }
  80322. }
  80323. declare module BABYLON {
  80324. /**
  80325. * A class serves as a medium between the observable and its observers
  80326. */
  80327. export class EventState {
  80328. /**
  80329. * Create a new EventState
  80330. * @param mask defines the mask associated with this state
  80331. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  80332. * @param target defines the original target of the state
  80333. * @param currentTarget defines the current target of the state
  80334. */
  80335. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  80336. /**
  80337. * Initialize the current event state
  80338. * @param mask defines the mask associated with this state
  80339. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  80340. * @param target defines the original target of the state
  80341. * @param currentTarget defines the current target of the state
  80342. * @returns the current event state
  80343. */
  80344. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  80345. /**
  80346. * An Observer can set this property to true to prevent subsequent observers of being notified
  80347. */
  80348. skipNextObservers: boolean;
  80349. /**
  80350. * Get the mask value that were used to trigger the event corresponding to this EventState object
  80351. */
  80352. mask: number;
  80353. /**
  80354. * The object that originally notified the event
  80355. */
  80356. target?: any;
  80357. /**
  80358. * The current object in the bubbling phase
  80359. */
  80360. currentTarget?: any;
  80361. /**
  80362. * This will be populated with the return value of the last function that was executed.
  80363. * If it is the first function in the callback chain it will be the event data.
  80364. */
  80365. lastReturnValue?: any;
  80366. }
  80367. /**
  80368. * Represent an Observer registered to a given Observable object.
  80369. */
  80370. export class Observer<T> {
  80371. /**
  80372. * Defines the callback to call when the observer is notified
  80373. */
  80374. callback: (eventData: T, eventState: EventState) => void;
  80375. /**
  80376. * Defines the mask of the observer (used to filter notifications)
  80377. */
  80378. mask: number;
  80379. /**
  80380. * Defines the current scope used to restore the JS context
  80381. */
  80382. scope: any;
  80383. /** @hidden */
  80384. _willBeUnregistered: boolean;
  80385. /**
  80386. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  80387. */
  80388. unregisterOnNextCall: boolean;
  80389. /**
  80390. * Creates a new observer
  80391. * @param callback defines the callback to call when the observer is notified
  80392. * @param mask defines the mask of the observer (used to filter notifications)
  80393. * @param scope defines the current scope used to restore the JS context
  80394. */
  80395. constructor(
  80396. /**
  80397. * Defines the callback to call when the observer is notified
  80398. */
  80399. callback: (eventData: T, eventState: EventState) => void,
  80400. /**
  80401. * Defines the mask of the observer (used to filter notifications)
  80402. */
  80403. mask: number,
  80404. /**
  80405. * Defines the current scope used to restore the JS context
  80406. */
  80407. scope?: any);
  80408. }
  80409. /**
  80410. * Represent a list of observers registered to multiple Observables object.
  80411. */
  80412. export class MultiObserver<T> {
  80413. private _observers;
  80414. private _observables;
  80415. /**
  80416. * Release associated resources
  80417. */
  80418. dispose(): void;
  80419. /**
  80420. * Raise a callback when one of the observable will notify
  80421. * @param observables defines a list of observables to watch
  80422. * @param callback defines the callback to call on notification
  80423. * @param mask defines the mask used to filter notifications
  80424. * @param scope defines the current scope used to restore the JS context
  80425. * @returns the new MultiObserver
  80426. */
  80427. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  80428. }
  80429. /**
  80430. * The Observable class is a simple implementation of the Observable pattern.
  80431. *
  80432. * 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.
  80433. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  80434. * 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).
  80435. * 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.
  80436. */
  80437. export class Observable<T> {
  80438. private _observers;
  80439. private _eventState;
  80440. private _onObserverAdded;
  80441. /**
  80442. * Gets the list of observers
  80443. */
  80444. get observers(): Array<Observer<T>>;
  80445. /**
  80446. * Creates a new observable
  80447. * @param onObserverAdded defines a callback to call when a new observer is added
  80448. */
  80449. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  80450. /**
  80451. * Create a new Observer with the specified callback
  80452. * @param callback the callback that will be executed for that Observer
  80453. * @param mask the mask used to filter observers
  80454. * @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.
  80455. * @param scope optional scope for the callback to be called from
  80456. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  80457. * @returns the new observer created for the callback
  80458. */
  80459. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  80460. /**
  80461. * Create a new Observer with the specified callback and unregisters after the next notification
  80462. * @param callback the callback that will be executed for that Observer
  80463. * @returns the new observer created for the callback
  80464. */
  80465. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  80466. /**
  80467. * Remove an Observer from the Observable object
  80468. * @param observer the instance of the Observer to remove
  80469. * @returns false if it doesn't belong to this Observable
  80470. */
  80471. remove(observer: Nullable<Observer<T>>): boolean;
  80472. /**
  80473. * Remove a callback from the Observable object
  80474. * @param callback the callback to remove
  80475. * @param scope optional scope. If used only the callbacks with this scope will be removed
  80476. * @returns false if it doesn't belong to this Observable
  80477. */
  80478. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  80479. private _deferUnregister;
  80480. private _remove;
  80481. /**
  80482. * Moves the observable to the top of the observer list making it get called first when notified
  80483. * @param observer the observer to move
  80484. */
  80485. makeObserverTopPriority(observer: Observer<T>): void;
  80486. /**
  80487. * Moves the observable to the bottom of the observer list making it get called last when notified
  80488. * @param observer the observer to move
  80489. */
  80490. makeObserverBottomPriority(observer: Observer<T>): void;
  80491. /**
  80492. * Notify all Observers by calling their respective callback with the given data
  80493. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  80494. * @param eventData defines the data to send to all observers
  80495. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  80496. * @param target defines the original target of the state
  80497. * @param currentTarget defines the current target of the state
  80498. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  80499. */
  80500. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  80501. /**
  80502. * Calling this will execute each callback, expecting it to be a promise or return a value.
  80503. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  80504. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  80505. * and it is crucial that all callbacks will be executed.
  80506. * The order of the callbacks is kept, callbacks are not executed parallel.
  80507. *
  80508. * @param eventData The data to be sent to each callback
  80509. * @param mask is used to filter observers defaults to -1
  80510. * @param target defines the callback target (see EventState)
  80511. * @param currentTarget defines he current object in the bubbling phase
  80512. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  80513. */
  80514. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  80515. /**
  80516. * Notify a specific observer
  80517. * @param observer defines the observer to notify
  80518. * @param eventData defines the data to be sent to each callback
  80519. * @param mask is used to filter observers defaults to -1
  80520. */
  80521. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  80522. /**
  80523. * Gets a boolean indicating if the observable has at least one observer
  80524. * @returns true is the Observable has at least one Observer registered
  80525. */
  80526. hasObservers(): boolean;
  80527. /**
  80528. * Clear the list of observers
  80529. */
  80530. clear(): void;
  80531. /**
  80532. * Clone the current observable
  80533. * @returns a new observable
  80534. */
  80535. clone(): Observable<T>;
  80536. /**
  80537. * Does this observable handles observer registered with a given mask
  80538. * @param mask defines the mask to be tested
  80539. * @return whether or not one observer registered with the given mask is handeled
  80540. **/
  80541. hasSpecificMask(mask?: number): boolean;
  80542. }
  80543. }
  80544. declare module BABYLON {
  80545. /**
  80546. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  80547. * Babylon.js
  80548. */
  80549. export class DomManagement {
  80550. /**
  80551. * Checks if the window object exists
  80552. * @returns true if the window object exists
  80553. */
  80554. static IsWindowObjectExist(): boolean;
  80555. /**
  80556. * Checks if the navigator object exists
  80557. * @returns true if the navigator object exists
  80558. */
  80559. static IsNavigatorAvailable(): boolean;
  80560. /**
  80561. * Check if the document object exists
  80562. * @returns true if the document object exists
  80563. */
  80564. static IsDocumentAvailable(): boolean;
  80565. /**
  80566. * Extracts text content from a DOM element hierarchy
  80567. * @param element defines the root element
  80568. * @returns a string
  80569. */
  80570. static GetDOMTextContent(element: HTMLElement): string;
  80571. }
  80572. }
  80573. declare module BABYLON {
  80574. /**
  80575. * Logger used througouht the application to allow configuration of
  80576. * the log level required for the messages.
  80577. */
  80578. export class Logger {
  80579. /**
  80580. * No log
  80581. */
  80582. static readonly NoneLogLevel: number;
  80583. /**
  80584. * Only message logs
  80585. */
  80586. static readonly MessageLogLevel: number;
  80587. /**
  80588. * Only warning logs
  80589. */
  80590. static readonly WarningLogLevel: number;
  80591. /**
  80592. * Only error logs
  80593. */
  80594. static readonly ErrorLogLevel: number;
  80595. /**
  80596. * All logs
  80597. */
  80598. static readonly AllLogLevel: number;
  80599. private static _LogCache;
  80600. /**
  80601. * Gets a value indicating the number of loading errors
  80602. * @ignorenaming
  80603. */
  80604. static errorsCount: number;
  80605. /**
  80606. * Callback called when a new log is added
  80607. */
  80608. static OnNewCacheEntry: (entry: string) => void;
  80609. private static _AddLogEntry;
  80610. private static _FormatMessage;
  80611. private static _LogDisabled;
  80612. private static _LogEnabled;
  80613. private static _WarnDisabled;
  80614. private static _WarnEnabled;
  80615. private static _ErrorDisabled;
  80616. private static _ErrorEnabled;
  80617. /**
  80618. * Log a message to the console
  80619. */
  80620. static Log: (message: string) => void;
  80621. /**
  80622. * Write a warning message to the console
  80623. */
  80624. static Warn: (message: string) => void;
  80625. /**
  80626. * Write an error message to the console
  80627. */
  80628. static Error: (message: string) => void;
  80629. /**
  80630. * Gets current log cache (list of logs)
  80631. */
  80632. static get LogCache(): string;
  80633. /**
  80634. * Clears the log cache
  80635. */
  80636. static ClearLogCache(): void;
  80637. /**
  80638. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80639. */
  80640. static set LogLevels(level: number);
  80641. }
  80642. }
  80643. declare module BABYLON {
  80644. /** @hidden */
  80645. export class _TypeStore {
  80646. /** @hidden */
  80647. static RegisteredTypes: {
  80648. [key: string]: Object;
  80649. };
  80650. /** @hidden */
  80651. static GetClass(fqdn: string): any;
  80652. }
  80653. }
  80654. declare module BABYLON {
  80655. /**
  80656. * Helper to manipulate strings
  80657. */
  80658. export class StringTools {
  80659. /**
  80660. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80661. * @param str Source string
  80662. * @param suffix Suffix to search for in the source string
  80663. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80664. */
  80665. static EndsWith(str: string, suffix: string): boolean;
  80666. /**
  80667. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80668. * @param str Source string
  80669. * @param suffix Suffix to search for in the source string
  80670. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80671. */
  80672. static StartsWith(str: string, suffix: string): boolean;
  80673. /**
  80674. * Decodes a buffer into a string
  80675. * @param buffer The buffer to decode
  80676. * @returns The decoded string
  80677. */
  80678. static Decode(buffer: Uint8Array | Uint16Array): string;
  80679. /**
  80680. * Encode a buffer to a base64 string
  80681. * @param buffer defines the buffer to encode
  80682. * @returns the encoded string
  80683. */
  80684. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80685. /**
  80686. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80687. * @param num the number to convert and pad
  80688. * @param length the expected length of the string
  80689. * @returns the padded string
  80690. */
  80691. static PadNumber(num: number, length: number): string;
  80692. }
  80693. }
  80694. declare module BABYLON {
  80695. /**
  80696. * Class containing a set of static utilities functions for deep copy.
  80697. */
  80698. export class DeepCopier {
  80699. /**
  80700. * Tries to copy an object by duplicating every property
  80701. * @param source defines the source object
  80702. * @param destination defines the target object
  80703. * @param doNotCopyList defines a list of properties to avoid
  80704. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80705. */
  80706. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80707. }
  80708. }
  80709. declare module BABYLON {
  80710. /**
  80711. * Class containing a set of static utilities functions for precision date
  80712. */
  80713. export class PrecisionDate {
  80714. /**
  80715. * Gets either window.performance.now() if supported or Date.now() else
  80716. */
  80717. static get Now(): number;
  80718. }
  80719. }
  80720. declare module BABYLON {
  80721. /** @hidden */
  80722. export class _DevTools {
  80723. static WarnImport(name: string): string;
  80724. }
  80725. }
  80726. declare module BABYLON {
  80727. /**
  80728. * Interface used to define the mechanism to get data from the network
  80729. */
  80730. export interface IWebRequest {
  80731. /**
  80732. * Returns client's response url
  80733. */
  80734. responseURL: string;
  80735. /**
  80736. * Returns client's status
  80737. */
  80738. status: number;
  80739. /**
  80740. * Returns client's status as a text
  80741. */
  80742. statusText: string;
  80743. }
  80744. }
  80745. declare module BABYLON {
  80746. /**
  80747. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80748. */
  80749. export class WebRequest implements IWebRequest {
  80750. private _xhr;
  80751. /**
  80752. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80753. * i.e. when loading files, where the server/service expects an Authorization header
  80754. */
  80755. static CustomRequestHeaders: {
  80756. [key: string]: string;
  80757. };
  80758. /**
  80759. * Add callback functions in this array to update all the requests before they get sent to the network
  80760. */
  80761. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80762. private _injectCustomRequestHeaders;
  80763. /**
  80764. * Gets or sets a function to be called when loading progress changes
  80765. */
  80766. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80767. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80768. /**
  80769. * Returns client's state
  80770. */
  80771. get readyState(): number;
  80772. /**
  80773. * Returns client's status
  80774. */
  80775. get status(): number;
  80776. /**
  80777. * Returns client's status as a text
  80778. */
  80779. get statusText(): string;
  80780. /**
  80781. * Returns client's response
  80782. */
  80783. get response(): any;
  80784. /**
  80785. * Returns client's response url
  80786. */
  80787. get responseURL(): string;
  80788. /**
  80789. * Returns client's response as text
  80790. */
  80791. get responseText(): string;
  80792. /**
  80793. * Gets or sets the expected response type
  80794. */
  80795. get responseType(): XMLHttpRequestResponseType;
  80796. set responseType(value: XMLHttpRequestResponseType);
  80797. /** @hidden */
  80798. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80799. /** @hidden */
  80800. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80801. /**
  80802. * Cancels any network activity
  80803. */
  80804. abort(): void;
  80805. /**
  80806. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80807. * @param body defines an optional request body
  80808. */
  80809. send(body?: Document | BodyInit | null): void;
  80810. /**
  80811. * Sets the request method, request URL
  80812. * @param method defines the method to use (GET, POST, etc..)
  80813. * @param url defines the url to connect with
  80814. */
  80815. open(method: string, url: string): void;
  80816. /**
  80817. * Sets the value of a request header.
  80818. * @param name The name of the header whose value is to be set
  80819. * @param value The value to set as the body of the header
  80820. */
  80821. setRequestHeader(name: string, value: string): void;
  80822. /**
  80823. * Get the string containing the text of a particular header's value.
  80824. * @param name The name of the header
  80825. * @returns The string containing the text of the given header name
  80826. */
  80827. getResponseHeader(name: string): Nullable<string>;
  80828. }
  80829. }
  80830. declare module BABYLON {
  80831. /**
  80832. * File request interface
  80833. */
  80834. export interface IFileRequest {
  80835. /**
  80836. * Raised when the request is complete (success or error).
  80837. */
  80838. onCompleteObservable: Observable<IFileRequest>;
  80839. /**
  80840. * Aborts the request for a file.
  80841. */
  80842. abort: () => void;
  80843. }
  80844. }
  80845. declare module BABYLON {
  80846. /**
  80847. * Define options used to create a render target texture
  80848. */
  80849. export class RenderTargetCreationOptions {
  80850. /**
  80851. * Specifies is mipmaps must be generated
  80852. */
  80853. generateMipMaps?: boolean;
  80854. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80855. generateDepthBuffer?: boolean;
  80856. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80857. generateStencilBuffer?: boolean;
  80858. /** Defines texture type (int by default) */
  80859. type?: number;
  80860. /** Defines sampling mode (trilinear by default) */
  80861. samplingMode?: number;
  80862. /** Defines format (RGBA by default) */
  80863. format?: number;
  80864. }
  80865. }
  80866. declare module BABYLON {
  80867. /** Defines the cross module used constants to avoid circular dependncies */
  80868. export class Constants {
  80869. /** Defines that alpha blending is disabled */
  80870. static readonly ALPHA_DISABLE: number;
  80871. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80872. static readonly ALPHA_ADD: number;
  80873. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80874. static readonly ALPHA_COMBINE: number;
  80875. /** Defines that alpha blending is DEST - SRC * DEST */
  80876. static readonly ALPHA_SUBTRACT: number;
  80877. /** Defines that alpha blending is SRC * DEST */
  80878. static readonly ALPHA_MULTIPLY: number;
  80879. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80880. static readonly ALPHA_MAXIMIZED: number;
  80881. /** Defines that alpha blending is SRC + DEST */
  80882. static readonly ALPHA_ONEONE: number;
  80883. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80884. static readonly ALPHA_PREMULTIPLIED: number;
  80885. /**
  80886. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80887. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80888. */
  80889. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80890. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80891. static readonly ALPHA_INTERPOLATE: number;
  80892. /**
  80893. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80894. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80895. */
  80896. static readonly ALPHA_SCREENMODE: number;
  80897. /**
  80898. * Defines that alpha blending is SRC + DST
  80899. * Alpha will be set to SRC ALPHA + DST ALPHA
  80900. */
  80901. static readonly ALPHA_ONEONE_ONEONE: number;
  80902. /**
  80903. * Defines that alpha blending is SRC * DST ALPHA + DST
  80904. * Alpha will be set to 0
  80905. */
  80906. static readonly ALPHA_ALPHATOCOLOR: number;
  80907. /**
  80908. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80909. */
  80910. static readonly ALPHA_REVERSEONEMINUS: number;
  80911. /**
  80912. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80913. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80914. */
  80915. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80916. /**
  80917. * Defines that alpha blending is SRC + DST
  80918. * Alpha will be set to SRC ALPHA
  80919. */
  80920. static readonly ALPHA_ONEONE_ONEZERO: number;
  80921. /**
  80922. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80923. * Alpha will be set to DST ALPHA
  80924. */
  80925. static readonly ALPHA_EXCLUSION: number;
  80926. /** Defines that alpha blending equation a SUM */
  80927. static readonly ALPHA_EQUATION_ADD: number;
  80928. /** Defines that alpha blending equation a SUBSTRACTION */
  80929. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80930. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80931. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80932. /** Defines that alpha blending equation a MAX operation */
  80933. static readonly ALPHA_EQUATION_MAX: number;
  80934. /** Defines that alpha blending equation a MIN operation */
  80935. static readonly ALPHA_EQUATION_MIN: number;
  80936. /**
  80937. * Defines that alpha blending equation a DARKEN operation:
  80938. * It takes the min of the src and sums the alpha channels.
  80939. */
  80940. static readonly ALPHA_EQUATION_DARKEN: number;
  80941. /** Defines that the ressource is not delayed*/
  80942. static readonly DELAYLOADSTATE_NONE: number;
  80943. /** Defines that the ressource was successfully delay loaded */
  80944. static readonly DELAYLOADSTATE_LOADED: number;
  80945. /** Defines that the ressource is currently delay loading */
  80946. static readonly DELAYLOADSTATE_LOADING: number;
  80947. /** Defines that the ressource is delayed and has not started loading */
  80948. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80949. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80950. static readonly NEVER: number;
  80951. /** 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 */
  80952. static readonly ALWAYS: number;
  80953. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80954. static readonly LESS: number;
  80955. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80956. static readonly EQUAL: number;
  80957. /** 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 */
  80958. static readonly LEQUAL: number;
  80959. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80960. static readonly GREATER: number;
  80961. /** 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 */
  80962. static readonly GEQUAL: number;
  80963. /** 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 */
  80964. static readonly NOTEQUAL: number;
  80965. /** Passed to stencilOperation to specify that stencil value must be kept */
  80966. static readonly KEEP: number;
  80967. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80968. static readonly REPLACE: number;
  80969. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80970. static readonly INCR: number;
  80971. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80972. static readonly DECR: number;
  80973. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80974. static readonly INVERT: number;
  80975. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80976. static readonly INCR_WRAP: number;
  80977. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80978. static readonly DECR_WRAP: number;
  80979. /** Texture is not repeating outside of 0..1 UVs */
  80980. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80981. /** Texture is repeating outside of 0..1 UVs */
  80982. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80983. /** Texture is repeating and mirrored */
  80984. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80985. /** ALPHA */
  80986. static readonly TEXTUREFORMAT_ALPHA: number;
  80987. /** LUMINANCE */
  80988. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80989. /** LUMINANCE_ALPHA */
  80990. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80991. /** RGB */
  80992. static readonly TEXTUREFORMAT_RGB: number;
  80993. /** RGBA */
  80994. static readonly TEXTUREFORMAT_RGBA: number;
  80995. /** RED */
  80996. static readonly TEXTUREFORMAT_RED: number;
  80997. /** RED (2nd reference) */
  80998. static readonly TEXTUREFORMAT_R: number;
  80999. /** RG */
  81000. static readonly TEXTUREFORMAT_RG: number;
  81001. /** RED_INTEGER */
  81002. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  81003. /** RED_INTEGER (2nd reference) */
  81004. static readonly TEXTUREFORMAT_R_INTEGER: number;
  81005. /** RG_INTEGER */
  81006. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  81007. /** RGB_INTEGER */
  81008. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  81009. /** RGBA_INTEGER */
  81010. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  81011. /** UNSIGNED_BYTE */
  81012. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  81013. /** UNSIGNED_BYTE (2nd reference) */
  81014. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  81015. /** FLOAT */
  81016. static readonly TEXTURETYPE_FLOAT: number;
  81017. /** HALF_FLOAT */
  81018. static readonly TEXTURETYPE_HALF_FLOAT: number;
  81019. /** BYTE */
  81020. static readonly TEXTURETYPE_BYTE: number;
  81021. /** SHORT */
  81022. static readonly TEXTURETYPE_SHORT: number;
  81023. /** UNSIGNED_SHORT */
  81024. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  81025. /** INT */
  81026. static readonly TEXTURETYPE_INT: number;
  81027. /** UNSIGNED_INT */
  81028. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  81029. /** UNSIGNED_SHORT_4_4_4_4 */
  81030. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  81031. /** UNSIGNED_SHORT_5_5_5_1 */
  81032. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  81033. /** UNSIGNED_SHORT_5_6_5 */
  81034. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  81035. /** UNSIGNED_INT_2_10_10_10_REV */
  81036. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  81037. /** UNSIGNED_INT_24_8 */
  81038. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  81039. /** UNSIGNED_INT_10F_11F_11F_REV */
  81040. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  81041. /** UNSIGNED_INT_5_9_9_9_REV */
  81042. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  81043. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  81044. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  81045. /** nearest is mag = nearest and min = nearest and no mip */
  81046. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  81047. /** mag = nearest and min = nearest and mip = none */
  81048. static readonly TEXTURE_NEAREST_NEAREST: number;
  81049. /** Bilinear is mag = linear and min = linear and no mip */
  81050. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  81051. /** mag = linear and min = linear and mip = none */
  81052. static readonly TEXTURE_LINEAR_LINEAR: number;
  81053. /** Trilinear is mag = linear and min = linear and mip = linear */
  81054. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  81055. /** Trilinear is mag = linear and min = linear and mip = linear */
  81056. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  81057. /** mag = nearest and min = nearest and mip = nearest */
  81058. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  81059. /** mag = nearest and min = linear and mip = nearest */
  81060. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  81061. /** mag = nearest and min = linear and mip = linear */
  81062. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  81063. /** mag = nearest and min = linear and mip = none */
  81064. static readonly TEXTURE_NEAREST_LINEAR: number;
  81065. /** nearest is mag = nearest and min = nearest and mip = linear */
  81066. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  81067. /** mag = linear and min = nearest and mip = nearest */
  81068. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  81069. /** mag = linear and min = nearest and mip = linear */
  81070. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  81071. /** Bilinear is mag = linear and min = linear and mip = nearest */
  81072. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  81073. /** mag = linear and min = nearest and mip = none */
  81074. static readonly TEXTURE_LINEAR_NEAREST: number;
  81075. /** Explicit coordinates mode */
  81076. static readonly TEXTURE_EXPLICIT_MODE: number;
  81077. /** Spherical coordinates mode */
  81078. static readonly TEXTURE_SPHERICAL_MODE: number;
  81079. /** Planar coordinates mode */
  81080. static readonly TEXTURE_PLANAR_MODE: number;
  81081. /** Cubic coordinates mode */
  81082. static readonly TEXTURE_CUBIC_MODE: number;
  81083. /** Projection coordinates mode */
  81084. static readonly TEXTURE_PROJECTION_MODE: number;
  81085. /** Skybox coordinates mode */
  81086. static readonly TEXTURE_SKYBOX_MODE: number;
  81087. /** Inverse Cubic coordinates mode */
  81088. static readonly TEXTURE_INVCUBIC_MODE: number;
  81089. /** Equirectangular coordinates mode */
  81090. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  81091. /** Equirectangular Fixed coordinates mode */
  81092. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  81093. /** Equirectangular Fixed Mirrored coordinates mode */
  81094. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  81095. /** Offline (baking) quality for texture filtering */
  81096. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  81097. /** High quality for texture filtering */
  81098. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  81099. /** Medium quality for texture filtering */
  81100. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  81101. /** Low quality for texture filtering */
  81102. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  81103. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  81104. static readonly SCALEMODE_FLOOR: number;
  81105. /** Defines that texture rescaling will look for the nearest power of 2 size */
  81106. static readonly SCALEMODE_NEAREST: number;
  81107. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  81108. static readonly SCALEMODE_CEILING: number;
  81109. /**
  81110. * The dirty texture flag value
  81111. */
  81112. static readonly MATERIAL_TextureDirtyFlag: number;
  81113. /**
  81114. * The dirty light flag value
  81115. */
  81116. static readonly MATERIAL_LightDirtyFlag: number;
  81117. /**
  81118. * The dirty fresnel flag value
  81119. */
  81120. static readonly MATERIAL_FresnelDirtyFlag: number;
  81121. /**
  81122. * The dirty attribute flag value
  81123. */
  81124. static readonly MATERIAL_AttributesDirtyFlag: number;
  81125. /**
  81126. * The dirty misc flag value
  81127. */
  81128. static readonly MATERIAL_MiscDirtyFlag: number;
  81129. /**
  81130. * The all dirty flag value
  81131. */
  81132. static readonly MATERIAL_AllDirtyFlag: number;
  81133. /**
  81134. * Returns the triangle fill mode
  81135. */
  81136. static readonly MATERIAL_TriangleFillMode: number;
  81137. /**
  81138. * Returns the wireframe mode
  81139. */
  81140. static readonly MATERIAL_WireFrameFillMode: number;
  81141. /**
  81142. * Returns the point fill mode
  81143. */
  81144. static readonly MATERIAL_PointFillMode: number;
  81145. /**
  81146. * Returns the point list draw mode
  81147. */
  81148. static readonly MATERIAL_PointListDrawMode: number;
  81149. /**
  81150. * Returns the line list draw mode
  81151. */
  81152. static readonly MATERIAL_LineListDrawMode: number;
  81153. /**
  81154. * Returns the line loop draw mode
  81155. */
  81156. static readonly MATERIAL_LineLoopDrawMode: number;
  81157. /**
  81158. * Returns the line strip draw mode
  81159. */
  81160. static readonly MATERIAL_LineStripDrawMode: number;
  81161. /**
  81162. * Returns the triangle strip draw mode
  81163. */
  81164. static readonly MATERIAL_TriangleStripDrawMode: number;
  81165. /**
  81166. * Returns the triangle fan draw mode
  81167. */
  81168. static readonly MATERIAL_TriangleFanDrawMode: number;
  81169. /**
  81170. * Stores the clock-wise side orientation
  81171. */
  81172. static readonly MATERIAL_ClockWiseSideOrientation: number;
  81173. /**
  81174. * Stores the counter clock-wise side orientation
  81175. */
  81176. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  81177. /**
  81178. * Nothing
  81179. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81180. */
  81181. static readonly ACTION_NothingTrigger: number;
  81182. /**
  81183. * On pick
  81184. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81185. */
  81186. static readonly ACTION_OnPickTrigger: number;
  81187. /**
  81188. * On left pick
  81189. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81190. */
  81191. static readonly ACTION_OnLeftPickTrigger: number;
  81192. /**
  81193. * On right pick
  81194. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81195. */
  81196. static readonly ACTION_OnRightPickTrigger: number;
  81197. /**
  81198. * On center pick
  81199. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81200. */
  81201. static readonly ACTION_OnCenterPickTrigger: number;
  81202. /**
  81203. * On pick down
  81204. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81205. */
  81206. static readonly ACTION_OnPickDownTrigger: number;
  81207. /**
  81208. * On double pick
  81209. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81210. */
  81211. static readonly ACTION_OnDoublePickTrigger: number;
  81212. /**
  81213. * On pick up
  81214. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81215. */
  81216. static readonly ACTION_OnPickUpTrigger: number;
  81217. /**
  81218. * On pick out.
  81219. * This trigger will only be raised if you also declared a OnPickDown
  81220. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81221. */
  81222. static readonly ACTION_OnPickOutTrigger: number;
  81223. /**
  81224. * On long press
  81225. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81226. */
  81227. static readonly ACTION_OnLongPressTrigger: number;
  81228. /**
  81229. * On pointer over
  81230. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81231. */
  81232. static readonly ACTION_OnPointerOverTrigger: number;
  81233. /**
  81234. * On pointer out
  81235. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81236. */
  81237. static readonly ACTION_OnPointerOutTrigger: number;
  81238. /**
  81239. * On every frame
  81240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81241. */
  81242. static readonly ACTION_OnEveryFrameTrigger: number;
  81243. /**
  81244. * On intersection enter
  81245. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81246. */
  81247. static readonly ACTION_OnIntersectionEnterTrigger: number;
  81248. /**
  81249. * On intersection exit
  81250. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81251. */
  81252. static readonly ACTION_OnIntersectionExitTrigger: number;
  81253. /**
  81254. * On key down
  81255. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81256. */
  81257. static readonly ACTION_OnKeyDownTrigger: number;
  81258. /**
  81259. * On key up
  81260. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81261. */
  81262. static readonly ACTION_OnKeyUpTrigger: number;
  81263. /**
  81264. * Billboard mode will only apply to Y axis
  81265. */
  81266. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  81267. /**
  81268. * Billboard mode will apply to all axes
  81269. */
  81270. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  81271. /**
  81272. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  81273. */
  81274. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  81275. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  81276. * Test order :
  81277. * Is the bounding sphere outside the frustum ?
  81278. * If not, are the bounding box vertices outside the frustum ?
  81279. * It not, then the cullable object is in the frustum.
  81280. */
  81281. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  81282. /** Culling strategy : Bounding Sphere Only.
  81283. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  81284. * It's also less accurate than the standard because some not visible objects can still be selected.
  81285. * Test : is the bounding sphere outside the frustum ?
  81286. * If not, then the cullable object is in the frustum.
  81287. */
  81288. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  81289. /** Culling strategy : Optimistic Inclusion.
  81290. * This in an inclusion test first, then the standard exclusion test.
  81291. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  81292. * 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.
  81293. * Anyway, it's as accurate as the standard strategy.
  81294. * Test :
  81295. * Is the cullable object bounding sphere center in the frustum ?
  81296. * If not, apply the default culling strategy.
  81297. */
  81298. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  81299. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  81300. * This in an inclusion test first, then the bounding sphere only exclusion test.
  81301. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  81302. * 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.
  81303. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  81304. * Test :
  81305. * Is the cullable object bounding sphere center in the frustum ?
  81306. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  81307. */
  81308. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  81309. /**
  81310. * No logging while loading
  81311. */
  81312. static readonly SCENELOADER_NO_LOGGING: number;
  81313. /**
  81314. * Minimal logging while loading
  81315. */
  81316. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  81317. /**
  81318. * Summary logging while loading
  81319. */
  81320. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  81321. /**
  81322. * Detailled logging while loading
  81323. */
  81324. static readonly SCENELOADER_DETAILED_LOGGING: number;
  81325. /**
  81326. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  81327. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  81328. */
  81329. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  81330. /**
  81331. * Constant used to retrieve the position texture index in the textures array in the prepass
  81332. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  81333. */
  81334. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  81335. /**
  81336. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  81337. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  81338. */
  81339. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  81340. /**
  81341. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  81342. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  81343. */
  81344. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  81345. /**
  81346. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  81347. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  81348. */
  81349. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  81350. /**
  81351. * Constant used to retrieve depth + normal index in the textures array in the prepass
  81352. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  81353. */
  81354. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  81355. /**
  81356. * Constant used to retrieve albedo index in the textures array in the prepass
  81357. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  81358. */
  81359. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  81360. }
  81361. }
  81362. declare module BABYLON {
  81363. /**
  81364. * This represents the required contract to create a new type of texture loader.
  81365. */
  81366. export interface IInternalTextureLoader {
  81367. /**
  81368. * Defines wether the loader supports cascade loading the different faces.
  81369. */
  81370. supportCascades: boolean;
  81371. /**
  81372. * This returns if the loader support the current file information.
  81373. * @param extension defines the file extension of the file being loaded
  81374. * @param mimeType defines the optional mime type of the file being loaded
  81375. * @returns true if the loader can load the specified file
  81376. */
  81377. canLoad(extension: string, mimeType?: string): boolean;
  81378. /**
  81379. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  81380. * @param data contains the texture data
  81381. * @param texture defines the BabylonJS internal texture
  81382. * @param createPolynomials will be true if polynomials have been requested
  81383. * @param onLoad defines the callback to trigger once the texture is ready
  81384. * @param onError defines the callback to trigger in case of error
  81385. */
  81386. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  81387. /**
  81388. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  81389. * @param data contains the texture data
  81390. * @param texture defines the BabylonJS internal texture
  81391. * @param callback defines the method to call once ready to upload
  81392. */
  81393. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  81394. }
  81395. }
  81396. declare module BABYLON {
  81397. /**
  81398. * Class used to store and describe the pipeline context associated with an effect
  81399. */
  81400. export interface IPipelineContext {
  81401. /**
  81402. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  81403. */
  81404. isAsync: boolean;
  81405. /**
  81406. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  81407. */
  81408. isReady: boolean;
  81409. /** @hidden */
  81410. _getVertexShaderCode(): string | null;
  81411. /** @hidden */
  81412. _getFragmentShaderCode(): string | null;
  81413. /** @hidden */
  81414. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  81415. }
  81416. }
  81417. declare module BABYLON {
  81418. /**
  81419. * Class used to store gfx data (like WebGLBuffer)
  81420. */
  81421. export class DataBuffer {
  81422. /**
  81423. * Gets or sets the number of objects referencing this buffer
  81424. */
  81425. references: number;
  81426. /** Gets or sets the size of the underlying buffer */
  81427. capacity: number;
  81428. /**
  81429. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  81430. */
  81431. is32Bits: boolean;
  81432. /**
  81433. * Gets the underlying buffer
  81434. */
  81435. get underlyingResource(): any;
  81436. }
  81437. }
  81438. declare module BABYLON {
  81439. /** @hidden */
  81440. export interface IShaderProcessor {
  81441. attributeProcessor?: (attribute: string) => string;
  81442. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  81443. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  81444. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  81445. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  81446. lineProcessor?: (line: string, isFragment: boolean) => string;
  81447. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  81448. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  81449. }
  81450. }
  81451. declare module BABYLON {
  81452. /** @hidden */
  81453. export interface ProcessingOptions {
  81454. defines: string[];
  81455. indexParameters: any;
  81456. isFragment: boolean;
  81457. shouldUseHighPrecisionShader: boolean;
  81458. supportsUniformBuffers: boolean;
  81459. shadersRepository: string;
  81460. includesShadersStore: {
  81461. [key: string]: string;
  81462. };
  81463. processor?: IShaderProcessor;
  81464. version: string;
  81465. platformName: string;
  81466. lookForClosingBracketForUniformBuffer?: boolean;
  81467. }
  81468. }
  81469. declare module BABYLON {
  81470. /** @hidden */
  81471. export class ShaderCodeNode {
  81472. line: string;
  81473. children: ShaderCodeNode[];
  81474. additionalDefineKey?: string;
  81475. additionalDefineValue?: string;
  81476. isValid(preprocessors: {
  81477. [key: string]: string;
  81478. }): boolean;
  81479. process(preprocessors: {
  81480. [key: string]: string;
  81481. }, options: ProcessingOptions): string;
  81482. }
  81483. }
  81484. declare module BABYLON {
  81485. /** @hidden */
  81486. export class ShaderCodeCursor {
  81487. private _lines;
  81488. lineIndex: number;
  81489. get currentLine(): string;
  81490. get canRead(): boolean;
  81491. set lines(value: string[]);
  81492. }
  81493. }
  81494. declare module BABYLON {
  81495. /** @hidden */
  81496. export class ShaderCodeConditionNode extends ShaderCodeNode {
  81497. process(preprocessors: {
  81498. [key: string]: string;
  81499. }, options: ProcessingOptions): string;
  81500. }
  81501. }
  81502. declare module BABYLON {
  81503. /** @hidden */
  81504. export class ShaderDefineExpression {
  81505. isTrue(preprocessors: {
  81506. [key: string]: string;
  81507. }): boolean;
  81508. private static _OperatorPriority;
  81509. private static _Stack;
  81510. static postfixToInfix(postfix: string[]): string;
  81511. static infixToPostfix(infix: string): string[];
  81512. }
  81513. }
  81514. declare module BABYLON {
  81515. /** @hidden */
  81516. export class ShaderCodeTestNode extends ShaderCodeNode {
  81517. testExpression: ShaderDefineExpression;
  81518. isValid(preprocessors: {
  81519. [key: string]: string;
  81520. }): boolean;
  81521. }
  81522. }
  81523. declare module BABYLON {
  81524. /** @hidden */
  81525. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  81526. define: string;
  81527. not: boolean;
  81528. constructor(define: string, not?: boolean);
  81529. isTrue(preprocessors: {
  81530. [key: string]: string;
  81531. }): boolean;
  81532. }
  81533. }
  81534. declare module BABYLON {
  81535. /** @hidden */
  81536. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  81537. leftOperand: ShaderDefineExpression;
  81538. rightOperand: ShaderDefineExpression;
  81539. isTrue(preprocessors: {
  81540. [key: string]: string;
  81541. }): boolean;
  81542. }
  81543. }
  81544. declare module BABYLON {
  81545. /** @hidden */
  81546. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  81547. leftOperand: ShaderDefineExpression;
  81548. rightOperand: ShaderDefineExpression;
  81549. isTrue(preprocessors: {
  81550. [key: string]: string;
  81551. }): boolean;
  81552. }
  81553. }
  81554. declare module BABYLON {
  81555. /** @hidden */
  81556. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  81557. define: string;
  81558. operand: string;
  81559. testValue: string;
  81560. constructor(define: string, operand: string, testValue: string);
  81561. isTrue(preprocessors: {
  81562. [key: string]: string;
  81563. }): boolean;
  81564. }
  81565. }
  81566. declare module BABYLON {
  81567. /**
  81568. * Class used to enable access to offline support
  81569. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  81570. */
  81571. export interface IOfflineProvider {
  81572. /**
  81573. * Gets a boolean indicating if scene must be saved in the database
  81574. */
  81575. enableSceneOffline: boolean;
  81576. /**
  81577. * Gets a boolean indicating if textures must be saved in the database
  81578. */
  81579. enableTexturesOffline: boolean;
  81580. /**
  81581. * Open the offline support and make it available
  81582. * @param successCallback defines the callback to call on success
  81583. * @param errorCallback defines the callback to call on error
  81584. */
  81585. open(successCallback: () => void, errorCallback: () => void): void;
  81586. /**
  81587. * Loads an image from the offline support
  81588. * @param url defines the url to load from
  81589. * @param image defines the target DOM image
  81590. */
  81591. loadImage(url: string, image: HTMLImageElement): void;
  81592. /**
  81593. * Loads a file from offline support
  81594. * @param url defines the URL to load from
  81595. * @param sceneLoaded defines a callback to call on success
  81596. * @param progressCallBack defines a callback to call when progress changed
  81597. * @param errorCallback defines a callback to call on error
  81598. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  81599. */
  81600. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  81601. }
  81602. }
  81603. declare module BABYLON {
  81604. /**
  81605. * Class used to help managing file picking and drag'n'drop
  81606. * File Storage
  81607. */
  81608. export class FilesInputStore {
  81609. /**
  81610. * List of files ready to be loaded
  81611. */
  81612. static FilesToLoad: {
  81613. [key: string]: File;
  81614. };
  81615. }
  81616. }
  81617. declare module BABYLON {
  81618. /**
  81619. * Class used to define a retry strategy when error happens while loading assets
  81620. */
  81621. export class RetryStrategy {
  81622. /**
  81623. * Function used to defines an exponential back off strategy
  81624. * @param maxRetries defines the maximum number of retries (3 by default)
  81625. * @param baseInterval defines the interval between retries
  81626. * @returns the strategy function to use
  81627. */
  81628. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  81629. }
  81630. }
  81631. declare module BABYLON {
  81632. /**
  81633. * @ignore
  81634. * Application error to support additional information when loading a file
  81635. */
  81636. export abstract class BaseError extends Error {
  81637. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  81638. }
  81639. }
  81640. declare module BABYLON {
  81641. /** @ignore */
  81642. export class LoadFileError extends BaseError {
  81643. request?: WebRequest;
  81644. file?: File;
  81645. /**
  81646. * Creates a new LoadFileError
  81647. * @param message defines the message of the error
  81648. * @param request defines the optional web request
  81649. * @param file defines the optional file
  81650. */
  81651. constructor(message: string, object?: WebRequest | File);
  81652. }
  81653. /** @ignore */
  81654. export class RequestFileError extends BaseError {
  81655. request: WebRequest;
  81656. /**
  81657. * Creates a new LoadFileError
  81658. * @param message defines the message of the error
  81659. * @param request defines the optional web request
  81660. */
  81661. constructor(message: string, request: WebRequest);
  81662. }
  81663. /** @ignore */
  81664. export class ReadFileError extends BaseError {
  81665. file: File;
  81666. /**
  81667. * Creates a new ReadFileError
  81668. * @param message defines the message of the error
  81669. * @param file defines the optional file
  81670. */
  81671. constructor(message: string, file: File);
  81672. }
  81673. /**
  81674. * @hidden
  81675. */
  81676. export class FileTools {
  81677. /**
  81678. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81679. */
  81680. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81681. /**
  81682. * Gets or sets the base URL to use to load assets
  81683. */
  81684. static BaseUrl: string;
  81685. /**
  81686. * Default behaviour for cors in the application.
  81687. * It can be a string if the expected behavior is identical in the entire app.
  81688. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81689. */
  81690. static CorsBehavior: string | ((url: string | string[]) => string);
  81691. /**
  81692. * Gets or sets a function used to pre-process url before using them to load assets
  81693. */
  81694. static PreprocessUrl: (url: string) => string;
  81695. /**
  81696. * Removes unwanted characters from an url
  81697. * @param url defines the url to clean
  81698. * @returns the cleaned url
  81699. */
  81700. private static _CleanUrl;
  81701. /**
  81702. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81703. * @param url define the url we are trying
  81704. * @param element define the dom element where to configure the cors policy
  81705. */
  81706. static SetCorsBehavior(url: string | string[], element: {
  81707. crossOrigin: string | null;
  81708. }): void;
  81709. /**
  81710. * Loads an image as an HTMLImageElement.
  81711. * @param input url string, ArrayBuffer, or Blob to load
  81712. * @param onLoad callback called when the image successfully loads
  81713. * @param onError callback called when the image fails to load
  81714. * @param offlineProvider offline provider for caching
  81715. * @param mimeType optional mime type
  81716. * @returns the HTMLImageElement of the loaded image
  81717. */
  81718. 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>;
  81719. /**
  81720. * Reads a file from a File object
  81721. * @param file defines the file to load
  81722. * @param onSuccess defines the callback to call when data is loaded
  81723. * @param onProgress defines the callback to call during loading process
  81724. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81725. * @param onError defines the callback to call when an error occurs
  81726. * @returns a file request object
  81727. */
  81728. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81729. /**
  81730. * Loads a file from a url
  81731. * @param url url to load
  81732. * @param onSuccess callback called when the file successfully loads
  81733. * @param onProgress callback called while file is loading (if the server supports this mode)
  81734. * @param offlineProvider defines the offline provider for caching
  81735. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81736. * @param onError callback called when the file fails to load
  81737. * @returns a file request object
  81738. */
  81739. 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;
  81740. /**
  81741. * Loads a file
  81742. * @param url url to load
  81743. * @param onSuccess callback called when the file successfully loads
  81744. * @param onProgress callback called while file is loading (if the server supports this mode)
  81745. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81746. * @param onError callback called when the file fails to load
  81747. * @param onOpened callback called when the web request is opened
  81748. * @returns a file request object
  81749. */
  81750. 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;
  81751. /**
  81752. * Checks if the loaded document was accessed via `file:`-Protocol.
  81753. * @returns boolean
  81754. */
  81755. static IsFileURL(): boolean;
  81756. }
  81757. }
  81758. declare module BABYLON {
  81759. /** @hidden */
  81760. export class ShaderProcessor {
  81761. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81762. private static _ProcessPrecision;
  81763. private static _ExtractOperation;
  81764. private static _BuildSubExpression;
  81765. private static _BuildExpression;
  81766. private static _MoveCursorWithinIf;
  81767. private static _MoveCursor;
  81768. private static _EvaluatePreProcessors;
  81769. private static _PreparePreProcessors;
  81770. private static _ProcessShaderConversion;
  81771. private static _ProcessIncludes;
  81772. /**
  81773. * Loads a file from a url
  81774. * @param url url to load
  81775. * @param onSuccess callback called when the file successfully loads
  81776. * @param onProgress callback called while file is loading (if the server supports this mode)
  81777. * @param offlineProvider defines the offline provider for caching
  81778. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81779. * @param onError callback called when the file fails to load
  81780. * @returns a file request object
  81781. * @hidden
  81782. */
  81783. 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;
  81784. }
  81785. }
  81786. declare module BABYLON {
  81787. /**
  81788. * @hidden
  81789. */
  81790. export interface IColor4Like {
  81791. r: float;
  81792. g: float;
  81793. b: float;
  81794. a: float;
  81795. }
  81796. /**
  81797. * @hidden
  81798. */
  81799. export interface IColor3Like {
  81800. r: float;
  81801. g: float;
  81802. b: float;
  81803. }
  81804. /**
  81805. * @hidden
  81806. */
  81807. export interface IVector4Like {
  81808. x: float;
  81809. y: float;
  81810. z: float;
  81811. w: float;
  81812. }
  81813. /**
  81814. * @hidden
  81815. */
  81816. export interface IVector3Like {
  81817. x: float;
  81818. y: float;
  81819. z: float;
  81820. }
  81821. /**
  81822. * @hidden
  81823. */
  81824. export interface IVector2Like {
  81825. x: float;
  81826. y: float;
  81827. }
  81828. /**
  81829. * @hidden
  81830. */
  81831. export interface IMatrixLike {
  81832. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81833. updateFlag: int;
  81834. }
  81835. /**
  81836. * @hidden
  81837. */
  81838. export interface IViewportLike {
  81839. x: float;
  81840. y: float;
  81841. width: float;
  81842. height: float;
  81843. }
  81844. /**
  81845. * @hidden
  81846. */
  81847. export interface IPlaneLike {
  81848. normal: IVector3Like;
  81849. d: float;
  81850. normalize(): void;
  81851. }
  81852. }
  81853. declare module BABYLON {
  81854. /**
  81855. * Interface used to define common properties for effect fallbacks
  81856. */
  81857. export interface IEffectFallbacks {
  81858. /**
  81859. * Removes the defines that should be removed when falling back.
  81860. * @param currentDefines defines the current define statements for the shader.
  81861. * @param effect defines the current effect we try to compile
  81862. * @returns The resulting defines with defines of the current rank removed.
  81863. */
  81864. reduce(currentDefines: string, effect: Effect): string;
  81865. /**
  81866. * Removes the fallback from the bound mesh.
  81867. */
  81868. unBindMesh(): void;
  81869. /**
  81870. * Checks to see if more fallbacks are still availible.
  81871. */
  81872. hasMoreFallbacks: boolean;
  81873. }
  81874. }
  81875. declare module BABYLON {
  81876. /**
  81877. * Class used to evalaute queries containing `and` and `or` operators
  81878. */
  81879. export class AndOrNotEvaluator {
  81880. /**
  81881. * Evaluate a query
  81882. * @param query defines the query to evaluate
  81883. * @param evaluateCallback defines the callback used to filter result
  81884. * @returns true if the query matches
  81885. */
  81886. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81887. private static _HandleParenthesisContent;
  81888. private static _SimplifyNegation;
  81889. }
  81890. }
  81891. declare module BABYLON {
  81892. /**
  81893. * Class used to store custom tags
  81894. */
  81895. export class Tags {
  81896. /**
  81897. * Adds support for tags on the given object
  81898. * @param obj defines the object to use
  81899. */
  81900. static EnableFor(obj: any): void;
  81901. /**
  81902. * Removes tags support
  81903. * @param obj defines the object to use
  81904. */
  81905. static DisableFor(obj: any): void;
  81906. /**
  81907. * Gets a boolean indicating if the given object has tags
  81908. * @param obj defines the object to use
  81909. * @returns a boolean
  81910. */
  81911. static HasTags(obj: any): boolean;
  81912. /**
  81913. * Gets the tags available on a given object
  81914. * @param obj defines the object to use
  81915. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81916. * @returns the tags
  81917. */
  81918. static GetTags(obj: any, asString?: boolean): any;
  81919. /**
  81920. * Adds tags to an object
  81921. * @param obj defines the object to use
  81922. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81923. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81924. */
  81925. static AddTagsTo(obj: any, tagsString: string): void;
  81926. /**
  81927. * @hidden
  81928. */
  81929. static _AddTagTo(obj: any, tag: string): void;
  81930. /**
  81931. * Removes specific tags from a specific object
  81932. * @param obj defines the object to use
  81933. * @param tagsString defines the tags to remove
  81934. */
  81935. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81936. /**
  81937. * @hidden
  81938. */
  81939. static _RemoveTagFrom(obj: any, tag: string): void;
  81940. /**
  81941. * Defines if tags hosted on an object match a given query
  81942. * @param obj defines the object to use
  81943. * @param tagsQuery defines the tag query
  81944. * @returns a boolean
  81945. */
  81946. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81947. }
  81948. }
  81949. declare module BABYLON {
  81950. /**
  81951. * Scalar computation library
  81952. */
  81953. export class Scalar {
  81954. /**
  81955. * Two pi constants convenient for computation.
  81956. */
  81957. static TwoPi: number;
  81958. /**
  81959. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81960. * @param a number
  81961. * @param b number
  81962. * @param epsilon (default = 1.401298E-45)
  81963. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81964. */
  81965. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81966. /**
  81967. * Returns a string : the upper case translation of the number i to hexadecimal.
  81968. * @param i number
  81969. * @returns the upper case translation of the number i to hexadecimal.
  81970. */
  81971. static ToHex(i: number): string;
  81972. /**
  81973. * Returns -1 if value is negative and +1 is value is positive.
  81974. * @param value the value
  81975. * @returns the value itself if it's equal to zero.
  81976. */
  81977. static Sign(value: number): number;
  81978. /**
  81979. * Returns the value itself if it's between min and max.
  81980. * Returns min if the value is lower than min.
  81981. * Returns max if the value is greater than max.
  81982. * @param value the value to clmap
  81983. * @param min the min value to clamp to (default: 0)
  81984. * @param max the max value to clamp to (default: 1)
  81985. * @returns the clamped value
  81986. */
  81987. static Clamp(value: number, min?: number, max?: number): number;
  81988. /**
  81989. * the log2 of value.
  81990. * @param value the value to compute log2 of
  81991. * @returns the log2 of value.
  81992. */
  81993. static Log2(value: number): number;
  81994. /**
  81995. * Loops the value, so that it is never larger than length and never smaller than 0.
  81996. *
  81997. * This is similar to the modulo operator but it works with floating point numbers.
  81998. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81999. * With t = 5 and length = 2.5, the result would be 0.0.
  82000. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  82001. * @param value the value
  82002. * @param length the length
  82003. * @returns the looped value
  82004. */
  82005. static Repeat(value: number, length: number): number;
  82006. /**
  82007. * Normalize the value between 0.0 and 1.0 using min and max values
  82008. * @param value value to normalize
  82009. * @param min max to normalize between
  82010. * @param max min to normalize between
  82011. * @returns the normalized value
  82012. */
  82013. static Normalize(value: number, min: number, max: number): number;
  82014. /**
  82015. * Denormalize the value from 0.0 and 1.0 using min and max values
  82016. * @param normalized value to denormalize
  82017. * @param min max to denormalize between
  82018. * @param max min to denormalize between
  82019. * @returns the denormalized value
  82020. */
  82021. static Denormalize(normalized: number, min: number, max: number): number;
  82022. /**
  82023. * Calculates the shortest difference between two given angles given in degrees.
  82024. * @param current current angle in degrees
  82025. * @param target target angle in degrees
  82026. * @returns the delta
  82027. */
  82028. static DeltaAngle(current: number, target: number): number;
  82029. /**
  82030. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  82031. * @param tx value
  82032. * @param length length
  82033. * @returns The returned value will move back and forth between 0 and length
  82034. */
  82035. static PingPong(tx: number, length: number): number;
  82036. /**
  82037. * Interpolates between min and max with smoothing at the limits.
  82038. *
  82039. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  82040. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  82041. * @param from from
  82042. * @param to to
  82043. * @param tx value
  82044. * @returns the smooth stepped value
  82045. */
  82046. static SmoothStep(from: number, to: number, tx: number): number;
  82047. /**
  82048. * Moves a value current towards target.
  82049. *
  82050. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  82051. * Negative values of maxDelta pushes the value away from target.
  82052. * @param current current value
  82053. * @param target target value
  82054. * @param maxDelta max distance to move
  82055. * @returns resulting value
  82056. */
  82057. static MoveTowards(current: number, target: number, maxDelta: number): number;
  82058. /**
  82059. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  82060. *
  82061. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  82062. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  82063. * @param current current value
  82064. * @param target target value
  82065. * @param maxDelta max distance to move
  82066. * @returns resulting angle
  82067. */
  82068. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  82069. /**
  82070. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  82071. * @param start start value
  82072. * @param end target value
  82073. * @param amount amount to lerp between
  82074. * @returns the lerped value
  82075. */
  82076. static Lerp(start: number, end: number, amount: number): number;
  82077. /**
  82078. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  82079. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  82080. * @param start start value
  82081. * @param end target value
  82082. * @param amount amount to lerp between
  82083. * @returns the lerped value
  82084. */
  82085. static LerpAngle(start: number, end: number, amount: number): number;
  82086. /**
  82087. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  82088. * @param a start value
  82089. * @param b target value
  82090. * @param value value between a and b
  82091. * @returns the inverseLerp value
  82092. */
  82093. static InverseLerp(a: number, b: number, value: number): number;
  82094. /**
  82095. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  82096. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  82097. * @param value1 spline value
  82098. * @param tangent1 spline value
  82099. * @param value2 spline value
  82100. * @param tangent2 spline value
  82101. * @param amount input value
  82102. * @returns hermite result
  82103. */
  82104. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  82105. /**
  82106. * Returns a random float number between and min and max values
  82107. * @param min min value of random
  82108. * @param max max value of random
  82109. * @returns random value
  82110. */
  82111. static RandomRange(min: number, max: number): number;
  82112. /**
  82113. * This function returns percentage of a number in a given range.
  82114. *
  82115. * RangeToPercent(40,20,60) will return 0.5 (50%)
  82116. * RangeToPercent(34,0,100) will return 0.34 (34%)
  82117. * @param number to convert to percentage
  82118. * @param min min range
  82119. * @param max max range
  82120. * @returns the percentage
  82121. */
  82122. static RangeToPercent(number: number, min: number, max: number): number;
  82123. /**
  82124. * This function returns number that corresponds to the percentage in a given range.
  82125. *
  82126. * PercentToRange(0.34,0,100) will return 34.
  82127. * @param percent to convert to number
  82128. * @param min min range
  82129. * @param max max range
  82130. * @returns the number
  82131. */
  82132. static PercentToRange(percent: number, min: number, max: number): number;
  82133. /**
  82134. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  82135. * @param angle The angle to normalize in radian.
  82136. * @return The converted angle.
  82137. */
  82138. static NormalizeRadians(angle: number): number;
  82139. }
  82140. }
  82141. declare module BABYLON {
  82142. /**
  82143. * Constant used to convert a value to gamma space
  82144. * @ignorenaming
  82145. */
  82146. export const ToGammaSpace: number;
  82147. /**
  82148. * Constant used to convert a value to linear space
  82149. * @ignorenaming
  82150. */
  82151. export const ToLinearSpace = 2.2;
  82152. /**
  82153. * Constant used to define the minimal number value in Babylon.js
  82154. * @ignorenaming
  82155. */
  82156. let Epsilon: number;
  82157. }
  82158. declare module BABYLON {
  82159. /**
  82160. * Class used to represent a viewport on screen
  82161. */
  82162. export class Viewport {
  82163. /** viewport left coordinate */
  82164. x: number;
  82165. /** viewport top coordinate */
  82166. y: number;
  82167. /**viewport width */
  82168. width: number;
  82169. /** viewport height */
  82170. height: number;
  82171. /**
  82172. * Creates a Viewport object located at (x, y) and sized (width, height)
  82173. * @param x defines viewport left coordinate
  82174. * @param y defines viewport top coordinate
  82175. * @param width defines the viewport width
  82176. * @param height defines the viewport height
  82177. */
  82178. constructor(
  82179. /** viewport left coordinate */
  82180. x: number,
  82181. /** viewport top coordinate */
  82182. y: number,
  82183. /**viewport width */
  82184. width: number,
  82185. /** viewport height */
  82186. height: number);
  82187. /**
  82188. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  82189. * @param renderWidth defines the rendering width
  82190. * @param renderHeight defines the rendering height
  82191. * @returns a new Viewport
  82192. */
  82193. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  82194. /**
  82195. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  82196. * @param renderWidth defines the rendering width
  82197. * @param renderHeight defines the rendering height
  82198. * @param ref defines the target viewport
  82199. * @returns the current viewport
  82200. */
  82201. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  82202. /**
  82203. * Returns a new Viewport copied from the current one
  82204. * @returns a new Viewport
  82205. */
  82206. clone(): Viewport;
  82207. }
  82208. }
  82209. declare module BABYLON {
  82210. /**
  82211. * Class containing a set of static utilities functions for arrays.
  82212. */
  82213. export class ArrayTools {
  82214. /**
  82215. * Returns an array of the given size filled with element built from the given constructor and the paramters
  82216. * @param size the number of element to construct and put in the array
  82217. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  82218. * @returns a new array filled with new objects
  82219. */
  82220. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  82221. }
  82222. }
  82223. declare module BABYLON {
  82224. /**
  82225. * Represents a plane by the equation ax + by + cz + d = 0
  82226. */
  82227. export class Plane {
  82228. private static _TmpMatrix;
  82229. /**
  82230. * Normal of the plane (a,b,c)
  82231. */
  82232. normal: Vector3;
  82233. /**
  82234. * d component of the plane
  82235. */
  82236. d: number;
  82237. /**
  82238. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  82239. * @param a a component of the plane
  82240. * @param b b component of the plane
  82241. * @param c c component of the plane
  82242. * @param d d component of the plane
  82243. */
  82244. constructor(a: number, b: number, c: number, d: number);
  82245. /**
  82246. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  82247. */
  82248. asArray(): number[];
  82249. /**
  82250. * @returns a new plane copied from the current Plane.
  82251. */
  82252. clone(): Plane;
  82253. /**
  82254. * @returns the string "Plane".
  82255. */
  82256. getClassName(): string;
  82257. /**
  82258. * @returns the Plane hash code.
  82259. */
  82260. getHashCode(): number;
  82261. /**
  82262. * Normalize the current Plane in place.
  82263. * @returns the updated Plane.
  82264. */
  82265. normalize(): Plane;
  82266. /**
  82267. * Applies a transformation the plane and returns the result
  82268. * @param transformation the transformation matrix to be applied to the plane
  82269. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  82270. */
  82271. transform(transformation: DeepImmutable<Matrix>): Plane;
  82272. /**
  82273. * Compute the dot product between the point and the plane normal
  82274. * @param point point to calculate the dot product with
  82275. * @returns the dot product (float) of the point coordinates and the plane normal.
  82276. */
  82277. dotCoordinate(point: DeepImmutable<Vector3>): number;
  82278. /**
  82279. * Updates the current Plane from the plane defined by the three given points.
  82280. * @param point1 one of the points used to contruct the plane
  82281. * @param point2 one of the points used to contruct the plane
  82282. * @param point3 one of the points used to contruct the plane
  82283. * @returns the updated Plane.
  82284. */
  82285. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  82286. /**
  82287. * Checks if the plane is facing a given direction
  82288. * @param direction the direction to check if the plane is facing
  82289. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  82290. * @returns True is the vector "direction" is the same side than the plane normal.
  82291. */
  82292. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  82293. /**
  82294. * Calculates the distance to a point
  82295. * @param point point to calculate distance to
  82296. * @returns the signed distance (float) from the given point to the Plane.
  82297. */
  82298. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  82299. /**
  82300. * Creates a plane from an array
  82301. * @param array the array to create a plane from
  82302. * @returns a new Plane from the given array.
  82303. */
  82304. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  82305. /**
  82306. * Creates a plane from three points
  82307. * @param point1 point used to create the plane
  82308. * @param point2 point used to create the plane
  82309. * @param point3 point used to create the plane
  82310. * @returns a new Plane defined by the three given points.
  82311. */
  82312. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  82313. /**
  82314. * Creates a plane from an origin point and a normal
  82315. * @param origin origin of the plane to be constructed
  82316. * @param normal normal of the plane to be constructed
  82317. * @returns a new Plane the normal vector to this plane at the given origin point.
  82318. * Note : the vector "normal" is updated because normalized.
  82319. */
  82320. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  82321. /**
  82322. * Calculates the distance from a plane and a point
  82323. * @param origin origin of the plane to be constructed
  82324. * @param normal normal of the plane to be constructed
  82325. * @param point point to calculate distance to
  82326. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  82327. */
  82328. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  82329. }
  82330. }
  82331. declare module BABYLON {
  82332. /** @hidden */
  82333. export class PerformanceConfigurator {
  82334. /** @hidden */
  82335. static MatrixUse64Bits: boolean;
  82336. /** @hidden */
  82337. static MatrixTrackPrecisionChange: boolean;
  82338. /** @hidden */
  82339. static MatrixCurrentType: any;
  82340. /** @hidden */
  82341. static MatrixTrackedMatrices: Array<any> | null;
  82342. /** @hidden */
  82343. static SetMatrixPrecision(use64bits: boolean): void;
  82344. }
  82345. }
  82346. declare module BABYLON {
  82347. /**
  82348. * Class representing a vector containing 2 coordinates
  82349. */
  82350. export class Vector2 {
  82351. /** defines the first coordinate */
  82352. x: number;
  82353. /** defines the second coordinate */
  82354. y: number;
  82355. /**
  82356. * Creates a new Vector2 from the given x and y coordinates
  82357. * @param x defines the first coordinate
  82358. * @param y defines the second coordinate
  82359. */
  82360. constructor(
  82361. /** defines the first coordinate */
  82362. x?: number,
  82363. /** defines the second coordinate */
  82364. y?: number);
  82365. /**
  82366. * Gets a string with the Vector2 coordinates
  82367. * @returns a string with the Vector2 coordinates
  82368. */
  82369. toString(): string;
  82370. /**
  82371. * Gets class name
  82372. * @returns the string "Vector2"
  82373. */
  82374. getClassName(): string;
  82375. /**
  82376. * Gets current vector hash code
  82377. * @returns the Vector2 hash code as a number
  82378. */
  82379. getHashCode(): number;
  82380. /**
  82381. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  82382. * @param array defines the source array
  82383. * @param index defines the offset in source array
  82384. * @returns the current Vector2
  82385. */
  82386. toArray(array: FloatArray, index?: number): Vector2;
  82387. /**
  82388. * Update the current vector from an array
  82389. * @param array defines the destination array
  82390. * @param index defines the offset in the destination array
  82391. * @returns the current Vector3
  82392. */
  82393. fromArray(array: FloatArray, index?: number): Vector2;
  82394. /**
  82395. * Copy the current vector to an array
  82396. * @returns a new array with 2 elements: the Vector2 coordinates.
  82397. */
  82398. asArray(): number[];
  82399. /**
  82400. * Sets the Vector2 coordinates with the given Vector2 coordinates
  82401. * @param source defines the source Vector2
  82402. * @returns the current updated Vector2
  82403. */
  82404. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  82405. /**
  82406. * Sets the Vector2 coordinates with the given floats
  82407. * @param x defines the first coordinate
  82408. * @param y defines the second coordinate
  82409. * @returns the current updated Vector2
  82410. */
  82411. copyFromFloats(x: number, y: number): Vector2;
  82412. /**
  82413. * Sets the Vector2 coordinates with the given floats
  82414. * @param x defines the first coordinate
  82415. * @param y defines the second coordinate
  82416. * @returns the current updated Vector2
  82417. */
  82418. set(x: number, y: number): Vector2;
  82419. /**
  82420. * Add another vector with the current one
  82421. * @param otherVector defines the other vector
  82422. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  82423. */
  82424. add(otherVector: DeepImmutable<Vector2>): Vector2;
  82425. /**
  82426. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  82427. * @param otherVector defines the other vector
  82428. * @param result defines the target vector
  82429. * @returns the unmodified current Vector2
  82430. */
  82431. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82432. /**
  82433. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  82434. * @param otherVector defines the other vector
  82435. * @returns the current updated Vector2
  82436. */
  82437. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82438. /**
  82439. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  82440. * @param otherVector defines the other vector
  82441. * @returns a new Vector2
  82442. */
  82443. addVector3(otherVector: Vector3): Vector2;
  82444. /**
  82445. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  82446. * @param otherVector defines the other vector
  82447. * @returns a new Vector2
  82448. */
  82449. subtract(otherVector: Vector2): Vector2;
  82450. /**
  82451. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  82452. * @param otherVector defines the other vector
  82453. * @param result defines the target vector
  82454. * @returns the unmodified current Vector2
  82455. */
  82456. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82457. /**
  82458. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  82459. * @param otherVector defines the other vector
  82460. * @returns the current updated Vector2
  82461. */
  82462. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82463. /**
  82464. * Multiplies in place the current Vector2 coordinates by the given ones
  82465. * @param otherVector defines the other vector
  82466. * @returns the current updated Vector2
  82467. */
  82468. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82469. /**
  82470. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  82471. * @param otherVector defines the other vector
  82472. * @returns a new Vector2
  82473. */
  82474. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  82475. /**
  82476. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  82477. * @param otherVector defines the other vector
  82478. * @param result defines the target vector
  82479. * @returns the unmodified current Vector2
  82480. */
  82481. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82482. /**
  82483. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  82484. * @param x defines the first coordinate
  82485. * @param y defines the second coordinate
  82486. * @returns a new Vector2
  82487. */
  82488. multiplyByFloats(x: number, y: number): Vector2;
  82489. /**
  82490. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  82491. * @param otherVector defines the other vector
  82492. * @returns a new Vector2
  82493. */
  82494. divide(otherVector: Vector2): Vector2;
  82495. /**
  82496. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  82497. * @param otherVector defines the other vector
  82498. * @param result defines the target vector
  82499. * @returns the unmodified current Vector2
  82500. */
  82501. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82502. /**
  82503. * Divides the current Vector2 coordinates by the given ones
  82504. * @param otherVector defines the other vector
  82505. * @returns the current updated Vector2
  82506. */
  82507. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82508. /**
  82509. * Gets a new Vector2 with current Vector2 negated coordinates
  82510. * @returns a new Vector2
  82511. */
  82512. negate(): Vector2;
  82513. /**
  82514. * Negate this vector in place
  82515. * @returns this
  82516. */
  82517. negateInPlace(): Vector2;
  82518. /**
  82519. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  82520. * @param result defines the Vector3 object where to store the result
  82521. * @returns the current Vector2
  82522. */
  82523. negateToRef(result: Vector2): Vector2;
  82524. /**
  82525. * Multiply the Vector2 coordinates by scale
  82526. * @param scale defines the scaling factor
  82527. * @returns the current updated Vector2
  82528. */
  82529. scaleInPlace(scale: number): Vector2;
  82530. /**
  82531. * Returns a new Vector2 scaled by "scale" from the current Vector2
  82532. * @param scale defines the scaling factor
  82533. * @returns a new Vector2
  82534. */
  82535. scale(scale: number): Vector2;
  82536. /**
  82537. * Scale the current Vector2 values by a factor to a given Vector2
  82538. * @param scale defines the scale factor
  82539. * @param result defines the Vector2 object where to store the result
  82540. * @returns the unmodified current Vector2
  82541. */
  82542. scaleToRef(scale: number, result: Vector2): Vector2;
  82543. /**
  82544. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  82545. * @param scale defines the scale factor
  82546. * @param result defines the Vector2 object where to store the result
  82547. * @returns the unmodified current Vector2
  82548. */
  82549. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  82550. /**
  82551. * Gets a boolean if two vectors are equals
  82552. * @param otherVector defines the other vector
  82553. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  82554. */
  82555. equals(otherVector: DeepImmutable<Vector2>): boolean;
  82556. /**
  82557. * Gets a boolean if two vectors are equals (using an epsilon value)
  82558. * @param otherVector defines the other vector
  82559. * @param epsilon defines the minimal distance to consider equality
  82560. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  82561. */
  82562. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  82563. /**
  82564. * Gets a new Vector2 from current Vector2 floored values
  82565. * @returns a new Vector2
  82566. */
  82567. floor(): Vector2;
  82568. /**
  82569. * Gets a new Vector2 from current Vector2 floored values
  82570. * @returns a new Vector2
  82571. */
  82572. fract(): Vector2;
  82573. /**
  82574. * Gets the length of the vector
  82575. * @returns the vector length (float)
  82576. */
  82577. length(): number;
  82578. /**
  82579. * Gets the vector squared length
  82580. * @returns the vector squared length (float)
  82581. */
  82582. lengthSquared(): number;
  82583. /**
  82584. * Normalize the vector
  82585. * @returns the current updated Vector2
  82586. */
  82587. normalize(): Vector2;
  82588. /**
  82589. * Gets a new Vector2 copied from the Vector2
  82590. * @returns a new Vector2
  82591. */
  82592. clone(): Vector2;
  82593. /**
  82594. * Gets a new Vector2(0, 0)
  82595. * @returns a new Vector2
  82596. */
  82597. static Zero(): Vector2;
  82598. /**
  82599. * Gets a new Vector2(1, 1)
  82600. * @returns a new Vector2
  82601. */
  82602. static One(): Vector2;
  82603. /**
  82604. * Gets a new Vector2 set from the given index element of the given array
  82605. * @param array defines the data source
  82606. * @param offset defines the offset in the data source
  82607. * @returns a new Vector2
  82608. */
  82609. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  82610. /**
  82611. * Sets "result" from the given index element of the given array
  82612. * @param array defines the data source
  82613. * @param offset defines the offset in the data source
  82614. * @param result defines the target vector
  82615. */
  82616. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  82617. /**
  82618. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  82619. * @param value1 defines 1st point of control
  82620. * @param value2 defines 2nd point of control
  82621. * @param value3 defines 3rd point of control
  82622. * @param value4 defines 4th point of control
  82623. * @param amount defines the interpolation factor
  82624. * @returns a new Vector2
  82625. */
  82626. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  82627. /**
  82628. * 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".
  82629. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  82630. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  82631. * @param value defines the value to clamp
  82632. * @param min defines the lower limit
  82633. * @param max defines the upper limit
  82634. * @returns a new Vector2
  82635. */
  82636. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  82637. /**
  82638. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  82639. * @param value1 defines the 1st control point
  82640. * @param tangent1 defines the outgoing tangent
  82641. * @param value2 defines the 2nd control point
  82642. * @param tangent2 defines the incoming tangent
  82643. * @param amount defines the interpolation factor
  82644. * @returns a new Vector2
  82645. */
  82646. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82647. /**
  82648. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82649. * @param start defines the start vector
  82650. * @param end defines the end vector
  82651. * @param amount defines the interpolation factor
  82652. * @returns a new Vector2
  82653. */
  82654. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82655. /**
  82656. * Gets the dot product of the vector "left" and the vector "right"
  82657. * @param left defines first vector
  82658. * @param right defines second vector
  82659. * @returns the dot product (float)
  82660. */
  82661. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82662. /**
  82663. * Returns a new Vector2 equal to the normalized given vector
  82664. * @param vector defines the vector to normalize
  82665. * @returns a new Vector2
  82666. */
  82667. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82668. /**
  82669. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82670. * @param left defines 1st vector
  82671. * @param right defines 2nd vector
  82672. * @returns a new Vector2
  82673. */
  82674. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82675. /**
  82676. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82677. * @param left defines 1st vector
  82678. * @param right defines 2nd vector
  82679. * @returns a new Vector2
  82680. */
  82681. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82682. /**
  82683. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82684. * @param vector defines the vector to transform
  82685. * @param transformation defines the matrix to apply
  82686. * @returns a new Vector2
  82687. */
  82688. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82689. /**
  82690. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82691. * @param vector defines the vector to transform
  82692. * @param transformation defines the matrix to apply
  82693. * @param result defines the target vector
  82694. */
  82695. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82696. /**
  82697. * Determines if a given vector is included in a triangle
  82698. * @param p defines the vector to test
  82699. * @param p0 defines 1st triangle point
  82700. * @param p1 defines 2nd triangle point
  82701. * @param p2 defines 3rd triangle point
  82702. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82703. */
  82704. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82705. /**
  82706. * Gets the distance between the vectors "value1" and "value2"
  82707. * @param value1 defines first vector
  82708. * @param value2 defines second vector
  82709. * @returns the distance between vectors
  82710. */
  82711. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82712. /**
  82713. * Returns the squared distance between the vectors "value1" and "value2"
  82714. * @param value1 defines first vector
  82715. * @param value2 defines second vector
  82716. * @returns the squared distance between vectors
  82717. */
  82718. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82719. /**
  82720. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82721. * @param value1 defines first vector
  82722. * @param value2 defines second vector
  82723. * @returns a new Vector2
  82724. */
  82725. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82726. /**
  82727. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82728. * @param p defines the middle point
  82729. * @param segA defines one point of the segment
  82730. * @param segB defines the other point of the segment
  82731. * @returns the shortest distance
  82732. */
  82733. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82734. }
  82735. /**
  82736. * Class used to store (x,y,z) vector representation
  82737. * A Vector3 is the main object used in 3D geometry
  82738. * It can represent etiher the coordinates of a point the space, either a direction
  82739. * Reminder: js uses a left handed forward facing system
  82740. */
  82741. export class Vector3 {
  82742. private static _UpReadOnly;
  82743. private static _ZeroReadOnly;
  82744. /** @hidden */
  82745. _x: number;
  82746. /** @hidden */
  82747. _y: number;
  82748. /** @hidden */
  82749. _z: number;
  82750. /** @hidden */
  82751. _isDirty: boolean;
  82752. /** Gets or sets the x coordinate */
  82753. get x(): number;
  82754. set x(value: number);
  82755. /** Gets or sets the y coordinate */
  82756. get y(): number;
  82757. set y(value: number);
  82758. /** Gets or sets the z coordinate */
  82759. get z(): number;
  82760. set z(value: number);
  82761. /**
  82762. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82763. * @param x defines the first coordinates (on X axis)
  82764. * @param y defines the second coordinates (on Y axis)
  82765. * @param z defines the third coordinates (on Z axis)
  82766. */
  82767. constructor(x?: number, y?: number, z?: number);
  82768. /**
  82769. * Creates a string representation of the Vector3
  82770. * @returns a string with the Vector3 coordinates.
  82771. */
  82772. toString(): string;
  82773. /**
  82774. * Gets the class name
  82775. * @returns the string "Vector3"
  82776. */
  82777. getClassName(): string;
  82778. /**
  82779. * Creates the Vector3 hash code
  82780. * @returns a number which tends to be unique between Vector3 instances
  82781. */
  82782. getHashCode(): number;
  82783. /**
  82784. * Creates an array containing three elements : the coordinates of the Vector3
  82785. * @returns a new array of numbers
  82786. */
  82787. asArray(): number[];
  82788. /**
  82789. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82790. * @param array defines the destination array
  82791. * @param index defines the offset in the destination array
  82792. * @returns the current Vector3
  82793. */
  82794. toArray(array: FloatArray, index?: number): Vector3;
  82795. /**
  82796. * Update the current vector from an array
  82797. * @param array defines the destination array
  82798. * @param index defines the offset in the destination array
  82799. * @returns the current Vector3
  82800. */
  82801. fromArray(array: FloatArray, index?: number): Vector3;
  82802. /**
  82803. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82804. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82805. */
  82806. toQuaternion(): Quaternion;
  82807. /**
  82808. * Adds the given vector to the current Vector3
  82809. * @param otherVector defines the second operand
  82810. * @returns the current updated Vector3
  82811. */
  82812. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82813. /**
  82814. * Adds the given coordinates to the current Vector3
  82815. * @param x defines the x coordinate of the operand
  82816. * @param y defines the y coordinate of the operand
  82817. * @param z defines the z coordinate of the operand
  82818. * @returns the current updated Vector3
  82819. */
  82820. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82821. /**
  82822. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82823. * @param otherVector defines the second operand
  82824. * @returns the resulting Vector3
  82825. */
  82826. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82827. /**
  82828. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82829. * @param otherVector defines the second operand
  82830. * @param result defines the Vector3 object where to store the result
  82831. * @returns the current Vector3
  82832. */
  82833. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82834. /**
  82835. * Subtract the given vector from the current Vector3
  82836. * @param otherVector defines the second operand
  82837. * @returns the current updated Vector3
  82838. */
  82839. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82840. /**
  82841. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82842. * @param otherVector defines the second operand
  82843. * @returns the resulting Vector3
  82844. */
  82845. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82846. /**
  82847. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82848. * @param otherVector defines the second operand
  82849. * @param result defines the Vector3 object where to store the result
  82850. * @returns the current Vector3
  82851. */
  82852. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82853. /**
  82854. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82855. * @param x defines the x coordinate of the operand
  82856. * @param y defines the y coordinate of the operand
  82857. * @param z defines the z coordinate of the operand
  82858. * @returns the resulting Vector3
  82859. */
  82860. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82861. /**
  82862. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82863. * @param x defines the x coordinate of the operand
  82864. * @param y defines the y coordinate of the operand
  82865. * @param z defines the z coordinate of the operand
  82866. * @param result defines the Vector3 object where to store the result
  82867. * @returns the current Vector3
  82868. */
  82869. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82870. /**
  82871. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82872. * @returns a new Vector3
  82873. */
  82874. negate(): Vector3;
  82875. /**
  82876. * Negate this vector in place
  82877. * @returns this
  82878. */
  82879. negateInPlace(): Vector3;
  82880. /**
  82881. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82882. * @param result defines the Vector3 object where to store the result
  82883. * @returns the current Vector3
  82884. */
  82885. negateToRef(result: Vector3): Vector3;
  82886. /**
  82887. * Multiplies the Vector3 coordinates by the float "scale"
  82888. * @param scale defines the multiplier factor
  82889. * @returns the current updated Vector3
  82890. */
  82891. scaleInPlace(scale: number): Vector3;
  82892. /**
  82893. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82894. * @param scale defines the multiplier factor
  82895. * @returns a new Vector3
  82896. */
  82897. scale(scale: number): Vector3;
  82898. /**
  82899. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82900. * @param scale defines the multiplier factor
  82901. * @param result defines the Vector3 object where to store the result
  82902. * @returns the current Vector3
  82903. */
  82904. scaleToRef(scale: number, result: Vector3): Vector3;
  82905. /**
  82906. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82907. * @param scale defines the scale factor
  82908. * @param result defines the Vector3 object where to store the result
  82909. * @returns the unmodified current Vector3
  82910. */
  82911. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82912. /**
  82913. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82914. * @param origin defines the origin of the projection ray
  82915. * @param plane defines the plane to project to
  82916. * @returns the projected vector3
  82917. */
  82918. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82919. /**
  82920. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82921. * @param origin defines the origin of the projection ray
  82922. * @param plane defines the plane to project to
  82923. * @param result defines the Vector3 where to store the result
  82924. */
  82925. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82926. /**
  82927. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82928. * @param otherVector defines the second operand
  82929. * @returns true if both vectors are equals
  82930. */
  82931. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82932. /**
  82933. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82934. * @param otherVector defines the second operand
  82935. * @param epsilon defines the minimal distance to define values as equals
  82936. * @returns true if both vectors are distant less than epsilon
  82937. */
  82938. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82939. /**
  82940. * Returns true if the current Vector3 coordinates equals the given floats
  82941. * @param x defines the x coordinate of the operand
  82942. * @param y defines the y coordinate of the operand
  82943. * @param z defines the z coordinate of the operand
  82944. * @returns true if both vectors are equals
  82945. */
  82946. equalsToFloats(x: number, y: number, z: number): boolean;
  82947. /**
  82948. * Multiplies the current Vector3 coordinates by the given ones
  82949. * @param otherVector defines the second operand
  82950. * @returns the current updated Vector3
  82951. */
  82952. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82953. /**
  82954. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82955. * @param otherVector defines the second operand
  82956. * @returns the new Vector3
  82957. */
  82958. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82959. /**
  82960. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82961. * @param otherVector defines the second operand
  82962. * @param result defines the Vector3 object where to store the result
  82963. * @returns the current Vector3
  82964. */
  82965. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82966. /**
  82967. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82968. * @param x defines the x coordinate of the operand
  82969. * @param y defines the y coordinate of the operand
  82970. * @param z defines the z coordinate of the operand
  82971. * @returns the new Vector3
  82972. */
  82973. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82974. /**
  82975. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82976. * @param otherVector defines the second operand
  82977. * @returns the new Vector3
  82978. */
  82979. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82980. /**
  82981. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82982. * @param otherVector defines the second operand
  82983. * @param result defines the Vector3 object where to store the result
  82984. * @returns the current Vector3
  82985. */
  82986. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82987. /**
  82988. * Divides the current Vector3 coordinates by the given ones.
  82989. * @param otherVector defines the second operand
  82990. * @returns the current updated Vector3
  82991. */
  82992. divideInPlace(otherVector: Vector3): Vector3;
  82993. /**
  82994. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82995. * @param other defines the second operand
  82996. * @returns the current updated Vector3
  82997. */
  82998. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82999. /**
  83000. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  83001. * @param other defines the second operand
  83002. * @returns the current updated Vector3
  83003. */
  83004. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  83005. /**
  83006. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  83007. * @param x defines the x coordinate of the operand
  83008. * @param y defines the y coordinate of the operand
  83009. * @param z defines the z coordinate of the operand
  83010. * @returns the current updated Vector3
  83011. */
  83012. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83013. /**
  83014. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  83015. * @param x defines the x coordinate of the operand
  83016. * @param y defines the y coordinate of the operand
  83017. * @param z defines the z coordinate of the operand
  83018. * @returns the current updated Vector3
  83019. */
  83020. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83021. /**
  83022. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  83023. * Check if is non uniform within a certain amount of decimal places to account for this
  83024. * @param epsilon the amount the values can differ
  83025. * @returns if the the vector is non uniform to a certain number of decimal places
  83026. */
  83027. isNonUniformWithinEpsilon(epsilon: number): boolean;
  83028. /**
  83029. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  83030. */
  83031. get isNonUniform(): boolean;
  83032. /**
  83033. * Gets a new Vector3 from current Vector3 floored values
  83034. * @returns a new Vector3
  83035. */
  83036. floor(): Vector3;
  83037. /**
  83038. * Gets a new Vector3 from current Vector3 floored values
  83039. * @returns a new Vector3
  83040. */
  83041. fract(): Vector3;
  83042. /**
  83043. * Gets the length of the Vector3
  83044. * @returns the length of the Vector3
  83045. */
  83046. length(): number;
  83047. /**
  83048. * Gets the squared length of the Vector3
  83049. * @returns squared length of the Vector3
  83050. */
  83051. lengthSquared(): number;
  83052. /**
  83053. * Normalize the current Vector3.
  83054. * Please note that this is an in place operation.
  83055. * @returns the current updated Vector3
  83056. */
  83057. normalize(): Vector3;
  83058. /**
  83059. * Reorders the x y z properties of the vector in place
  83060. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  83061. * @returns the current updated vector
  83062. */
  83063. reorderInPlace(order: string): this;
  83064. /**
  83065. * Rotates the vector around 0,0,0 by a quaternion
  83066. * @param quaternion the rotation quaternion
  83067. * @param result vector to store the result
  83068. * @returns the resulting vector
  83069. */
  83070. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  83071. /**
  83072. * Rotates a vector around a given point
  83073. * @param quaternion the rotation quaternion
  83074. * @param point the point to rotate around
  83075. * @param result vector to store the result
  83076. * @returns the resulting vector
  83077. */
  83078. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  83079. /**
  83080. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  83081. * The cross product is then orthogonal to both current and "other"
  83082. * @param other defines the right operand
  83083. * @returns the cross product
  83084. */
  83085. cross(other: Vector3): Vector3;
  83086. /**
  83087. * Normalize the current Vector3 with the given input length.
  83088. * Please note that this is an in place operation.
  83089. * @param len the length of the vector
  83090. * @returns the current updated Vector3
  83091. */
  83092. normalizeFromLength(len: number): Vector3;
  83093. /**
  83094. * Normalize the current Vector3 to a new vector
  83095. * @returns the new Vector3
  83096. */
  83097. normalizeToNew(): Vector3;
  83098. /**
  83099. * Normalize the current Vector3 to the reference
  83100. * @param reference define the Vector3 to update
  83101. * @returns the updated Vector3
  83102. */
  83103. normalizeToRef(reference: Vector3): Vector3;
  83104. /**
  83105. * Creates a new Vector3 copied from the current Vector3
  83106. * @returns the new Vector3
  83107. */
  83108. clone(): Vector3;
  83109. /**
  83110. * Copies the given vector coordinates to the current Vector3 ones
  83111. * @param source defines the source Vector3
  83112. * @returns the current updated Vector3
  83113. */
  83114. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  83115. /**
  83116. * Copies the given floats to the current Vector3 coordinates
  83117. * @param x defines the x coordinate of the operand
  83118. * @param y defines the y coordinate of the operand
  83119. * @param z defines the z coordinate of the operand
  83120. * @returns the current updated Vector3
  83121. */
  83122. copyFromFloats(x: number, y: number, z: number): Vector3;
  83123. /**
  83124. * Copies the given floats to the current Vector3 coordinates
  83125. * @param x defines the x coordinate of the operand
  83126. * @param y defines the y coordinate of the operand
  83127. * @param z defines the z coordinate of the operand
  83128. * @returns the current updated Vector3
  83129. */
  83130. set(x: number, y: number, z: number): Vector3;
  83131. /**
  83132. * Copies the given float to the current Vector3 coordinates
  83133. * @param v defines the x, y and z coordinates of the operand
  83134. * @returns the current updated Vector3
  83135. */
  83136. setAll(v: number): Vector3;
  83137. /**
  83138. * Get the clip factor between two vectors
  83139. * @param vector0 defines the first operand
  83140. * @param vector1 defines the second operand
  83141. * @param axis defines the axis to use
  83142. * @param size defines the size along the axis
  83143. * @returns the clip factor
  83144. */
  83145. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  83146. /**
  83147. * Get angle between two vectors
  83148. * @param vector0 angle between vector0 and vector1
  83149. * @param vector1 angle between vector0 and vector1
  83150. * @param normal direction of the normal
  83151. * @return the angle between vector0 and vector1
  83152. */
  83153. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  83154. /**
  83155. * Returns a new Vector3 set from the index "offset" of the given array
  83156. * @param array defines the source array
  83157. * @param offset defines the offset in the source array
  83158. * @returns the new Vector3
  83159. */
  83160. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  83161. /**
  83162. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  83163. * @param array defines the source array
  83164. * @param offset defines the offset in the source array
  83165. * @returns the new Vector3
  83166. * @deprecated Please use FromArray instead.
  83167. */
  83168. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  83169. /**
  83170. * Sets the given vector "result" with the element values from the index "offset" of the given array
  83171. * @param array defines the source array
  83172. * @param offset defines the offset in the source array
  83173. * @param result defines the Vector3 where to store the result
  83174. */
  83175. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  83176. /**
  83177. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  83178. * @param array defines the source array
  83179. * @param offset defines the offset in the source array
  83180. * @param result defines the Vector3 where to store the result
  83181. * @deprecated Please use FromArrayToRef instead.
  83182. */
  83183. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  83184. /**
  83185. * Sets the given vector "result" with the given floats.
  83186. * @param x defines the x coordinate of the source
  83187. * @param y defines the y coordinate of the source
  83188. * @param z defines the z coordinate of the source
  83189. * @param result defines the Vector3 where to store the result
  83190. */
  83191. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  83192. /**
  83193. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  83194. * @returns a new empty Vector3
  83195. */
  83196. static Zero(): Vector3;
  83197. /**
  83198. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  83199. * @returns a new unit Vector3
  83200. */
  83201. static One(): Vector3;
  83202. /**
  83203. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  83204. * @returns a new up Vector3
  83205. */
  83206. static Up(): Vector3;
  83207. /**
  83208. * Gets a up Vector3 that must not be updated
  83209. */
  83210. static get UpReadOnly(): DeepImmutable<Vector3>;
  83211. /**
  83212. * Gets a zero Vector3 that must not be updated
  83213. */
  83214. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  83215. /**
  83216. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  83217. * @returns a new down Vector3
  83218. */
  83219. static Down(): Vector3;
  83220. /**
  83221. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  83222. * @param rightHandedSystem is the scene right-handed (negative z)
  83223. * @returns a new forward Vector3
  83224. */
  83225. static Forward(rightHandedSystem?: boolean): Vector3;
  83226. /**
  83227. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  83228. * @param rightHandedSystem is the scene right-handed (negative-z)
  83229. * @returns a new forward Vector3
  83230. */
  83231. static Backward(rightHandedSystem?: boolean): Vector3;
  83232. /**
  83233. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  83234. * @returns a new right Vector3
  83235. */
  83236. static Right(): Vector3;
  83237. /**
  83238. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  83239. * @returns a new left Vector3
  83240. */
  83241. static Left(): Vector3;
  83242. /**
  83243. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  83244. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  83245. * @param vector defines the Vector3 to transform
  83246. * @param transformation defines the transformation matrix
  83247. * @returns the transformed Vector3
  83248. */
  83249. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  83250. /**
  83251. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  83252. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  83253. * @param vector defines the Vector3 to transform
  83254. * @param transformation defines the transformation matrix
  83255. * @param result defines the Vector3 where to store the result
  83256. */
  83257. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83258. /**
  83259. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  83260. * This method computes tranformed coordinates only, not transformed direction vectors
  83261. * @param x define the x coordinate of the source vector
  83262. * @param y define the y coordinate of the source vector
  83263. * @param z define the z coordinate of the source vector
  83264. * @param transformation defines the transformation matrix
  83265. * @param result defines the Vector3 where to store the result
  83266. */
  83267. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83268. /**
  83269. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  83270. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83271. * @param vector defines the Vector3 to transform
  83272. * @param transformation defines the transformation matrix
  83273. * @returns the new Vector3
  83274. */
  83275. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  83276. /**
  83277. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  83278. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83279. * @param vector defines the Vector3 to transform
  83280. * @param transformation defines the transformation matrix
  83281. * @param result defines the Vector3 where to store the result
  83282. */
  83283. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83284. /**
  83285. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  83286. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83287. * @param x define the x coordinate of the source vector
  83288. * @param y define the y coordinate of the source vector
  83289. * @param z define the z coordinate of the source vector
  83290. * @param transformation defines the transformation matrix
  83291. * @param result defines the Vector3 where to store the result
  83292. */
  83293. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83294. /**
  83295. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  83296. * @param value1 defines the first control point
  83297. * @param value2 defines the second control point
  83298. * @param value3 defines the third control point
  83299. * @param value4 defines the fourth control point
  83300. * @param amount defines the amount on the spline to use
  83301. * @returns the new Vector3
  83302. */
  83303. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  83304. /**
  83305. * 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"
  83306. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  83307. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  83308. * @param value defines the current value
  83309. * @param min defines the lower range value
  83310. * @param max defines the upper range value
  83311. * @returns the new Vector3
  83312. */
  83313. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  83314. /**
  83315. * 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"
  83316. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  83317. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  83318. * @param value defines the current value
  83319. * @param min defines the lower range value
  83320. * @param max defines the upper range value
  83321. * @param result defines the Vector3 where to store the result
  83322. */
  83323. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  83324. /**
  83325. * Checks if a given vector is inside a specific range
  83326. * @param v defines the vector to test
  83327. * @param min defines the minimum range
  83328. * @param max defines the maximum range
  83329. */
  83330. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  83331. /**
  83332. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  83333. * @param value1 defines the first control point
  83334. * @param tangent1 defines the first tangent vector
  83335. * @param value2 defines the second control point
  83336. * @param tangent2 defines the second tangent vector
  83337. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  83338. * @returns the new Vector3
  83339. */
  83340. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  83341. /**
  83342. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  83343. * @param start defines the start value
  83344. * @param end defines the end value
  83345. * @param amount max defines amount between both (between 0 and 1)
  83346. * @returns the new Vector3
  83347. */
  83348. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  83349. /**
  83350. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  83351. * @param start defines the start value
  83352. * @param end defines the end value
  83353. * @param amount max defines amount between both (between 0 and 1)
  83354. * @param result defines the Vector3 where to store the result
  83355. */
  83356. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  83357. /**
  83358. * Returns the dot product (float) between the vectors "left" and "right"
  83359. * @param left defines the left operand
  83360. * @param right defines the right operand
  83361. * @returns the dot product
  83362. */
  83363. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  83364. /**
  83365. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  83366. * The cross product is then orthogonal to both "left" and "right"
  83367. * @param left defines the left operand
  83368. * @param right defines the right operand
  83369. * @returns the cross product
  83370. */
  83371. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83372. /**
  83373. * Sets the given vector "result" with the cross product of "left" and "right"
  83374. * The cross product is then orthogonal to both "left" and "right"
  83375. * @param left defines the left operand
  83376. * @param right defines the right operand
  83377. * @param result defines the Vector3 where to store the result
  83378. */
  83379. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  83380. /**
  83381. * Returns a new Vector3 as the normalization of the given vector
  83382. * @param vector defines the Vector3 to normalize
  83383. * @returns the new Vector3
  83384. */
  83385. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  83386. /**
  83387. * Sets the given vector "result" with the normalization of the given first vector
  83388. * @param vector defines the Vector3 to normalize
  83389. * @param result defines the Vector3 where to store the result
  83390. */
  83391. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  83392. /**
  83393. * Project a Vector3 onto screen space
  83394. * @param vector defines the Vector3 to project
  83395. * @param world defines the world matrix to use
  83396. * @param transform defines the transform (view x projection) matrix to use
  83397. * @param viewport defines the screen viewport to use
  83398. * @returns the new Vector3
  83399. */
  83400. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  83401. /** @hidden */
  83402. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  83403. /**
  83404. * Unproject from screen space to object space
  83405. * @param source defines the screen space Vector3 to use
  83406. * @param viewportWidth defines the current width of the viewport
  83407. * @param viewportHeight defines the current height of the viewport
  83408. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83409. * @param transform defines the transform (view x projection) matrix to use
  83410. * @returns the new Vector3
  83411. */
  83412. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  83413. /**
  83414. * Unproject from screen space to object space
  83415. * @param source defines the screen space Vector3 to use
  83416. * @param viewportWidth defines the current width of the viewport
  83417. * @param viewportHeight defines the current height of the viewport
  83418. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83419. * @param view defines the view matrix to use
  83420. * @param projection defines the projection matrix to use
  83421. * @returns the new Vector3
  83422. */
  83423. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  83424. /**
  83425. * Unproject from screen space to object space
  83426. * @param source defines the screen space Vector3 to use
  83427. * @param viewportWidth defines the current width of the viewport
  83428. * @param viewportHeight defines the current height of the viewport
  83429. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83430. * @param view defines the view matrix to use
  83431. * @param projection defines the projection matrix to use
  83432. * @param result defines the Vector3 where to store the result
  83433. */
  83434. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  83435. /**
  83436. * Unproject from screen space to object space
  83437. * @param sourceX defines the screen space x coordinate to use
  83438. * @param sourceY defines the screen space y coordinate to use
  83439. * @param sourceZ defines the screen space z coordinate to use
  83440. * @param viewportWidth defines the current width of the viewport
  83441. * @param viewportHeight defines the current height of the viewport
  83442. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83443. * @param view defines the view matrix to use
  83444. * @param projection defines the projection matrix to use
  83445. * @param result defines the Vector3 where to store the result
  83446. */
  83447. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  83448. /**
  83449. * Gets the minimal coordinate values between two Vector3
  83450. * @param left defines the first operand
  83451. * @param right defines the second operand
  83452. * @returns the new Vector3
  83453. */
  83454. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83455. /**
  83456. * Gets the maximal coordinate values between two Vector3
  83457. * @param left defines the first operand
  83458. * @param right defines the second operand
  83459. * @returns the new Vector3
  83460. */
  83461. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83462. /**
  83463. * Returns the distance between the vectors "value1" and "value2"
  83464. * @param value1 defines the first operand
  83465. * @param value2 defines the second operand
  83466. * @returns the distance
  83467. */
  83468. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  83469. /**
  83470. * Returns the squared distance between the vectors "value1" and "value2"
  83471. * @param value1 defines the first operand
  83472. * @param value2 defines the second operand
  83473. * @returns the squared distance
  83474. */
  83475. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  83476. /**
  83477. * Returns a new Vector3 located at the center between "value1" and "value2"
  83478. * @param value1 defines the first operand
  83479. * @param value2 defines the second operand
  83480. * @returns the new Vector3
  83481. */
  83482. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  83483. /**
  83484. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  83485. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  83486. * to something in order to rotate it from its local system to the given target system
  83487. * Note: axis1, axis2 and axis3 are normalized during this operation
  83488. * @param axis1 defines the first axis
  83489. * @param axis2 defines the second axis
  83490. * @param axis3 defines the third axis
  83491. * @returns a new Vector3
  83492. */
  83493. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  83494. /**
  83495. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  83496. * @param axis1 defines the first axis
  83497. * @param axis2 defines the second axis
  83498. * @param axis3 defines the third axis
  83499. * @param ref defines the Vector3 where to store the result
  83500. */
  83501. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  83502. }
  83503. /**
  83504. * Vector4 class created for EulerAngle class conversion to Quaternion
  83505. */
  83506. export class Vector4 {
  83507. /** x value of the vector */
  83508. x: number;
  83509. /** y value of the vector */
  83510. y: number;
  83511. /** z value of the vector */
  83512. z: number;
  83513. /** w value of the vector */
  83514. w: number;
  83515. /**
  83516. * Creates a Vector4 object from the given floats.
  83517. * @param x x value of the vector
  83518. * @param y y value of the vector
  83519. * @param z z value of the vector
  83520. * @param w w value of the vector
  83521. */
  83522. constructor(
  83523. /** x value of the vector */
  83524. x: number,
  83525. /** y value of the vector */
  83526. y: number,
  83527. /** z value of the vector */
  83528. z: number,
  83529. /** w value of the vector */
  83530. w: number);
  83531. /**
  83532. * Returns the string with the Vector4 coordinates.
  83533. * @returns a string containing all the vector values
  83534. */
  83535. toString(): string;
  83536. /**
  83537. * Returns the string "Vector4".
  83538. * @returns "Vector4"
  83539. */
  83540. getClassName(): string;
  83541. /**
  83542. * Returns the Vector4 hash code.
  83543. * @returns a unique hash code
  83544. */
  83545. getHashCode(): number;
  83546. /**
  83547. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  83548. * @returns the resulting array
  83549. */
  83550. asArray(): number[];
  83551. /**
  83552. * Populates the given array from the given index with the Vector4 coordinates.
  83553. * @param array array to populate
  83554. * @param index index of the array to start at (default: 0)
  83555. * @returns the Vector4.
  83556. */
  83557. toArray(array: FloatArray, index?: number): Vector4;
  83558. /**
  83559. * Update the current vector from an array
  83560. * @param array defines the destination array
  83561. * @param index defines the offset in the destination array
  83562. * @returns the current Vector3
  83563. */
  83564. fromArray(array: FloatArray, index?: number): Vector4;
  83565. /**
  83566. * Adds the given vector to the current Vector4.
  83567. * @param otherVector the vector to add
  83568. * @returns the updated Vector4.
  83569. */
  83570. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83571. /**
  83572. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  83573. * @param otherVector the vector to add
  83574. * @returns the resulting vector
  83575. */
  83576. add(otherVector: DeepImmutable<Vector4>): Vector4;
  83577. /**
  83578. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  83579. * @param otherVector the vector to add
  83580. * @param result the vector to store the result
  83581. * @returns the current Vector4.
  83582. */
  83583. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83584. /**
  83585. * Subtract in place the given vector from the current Vector4.
  83586. * @param otherVector the vector to subtract
  83587. * @returns the updated Vector4.
  83588. */
  83589. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83590. /**
  83591. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  83592. * @param otherVector the vector to add
  83593. * @returns the new vector with the result
  83594. */
  83595. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  83596. /**
  83597. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  83598. * @param otherVector the vector to subtract
  83599. * @param result the vector to store the result
  83600. * @returns the current Vector4.
  83601. */
  83602. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83603. /**
  83604. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83605. */
  83606. /**
  83607. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83608. * @param x value to subtract
  83609. * @param y value to subtract
  83610. * @param z value to subtract
  83611. * @param w value to subtract
  83612. * @returns new vector containing the result
  83613. */
  83614. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83615. /**
  83616. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83617. * @param x value to subtract
  83618. * @param y value to subtract
  83619. * @param z value to subtract
  83620. * @param w value to subtract
  83621. * @param result the vector to store the result in
  83622. * @returns the current Vector4.
  83623. */
  83624. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  83625. /**
  83626. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  83627. * @returns a new vector with the negated values
  83628. */
  83629. negate(): Vector4;
  83630. /**
  83631. * Negate this vector in place
  83632. * @returns this
  83633. */
  83634. negateInPlace(): Vector4;
  83635. /**
  83636. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  83637. * @param result defines the Vector3 object where to store the result
  83638. * @returns the current Vector4
  83639. */
  83640. negateToRef(result: Vector4): Vector4;
  83641. /**
  83642. * Multiplies the current Vector4 coordinates by scale (float).
  83643. * @param scale the number to scale with
  83644. * @returns the updated Vector4.
  83645. */
  83646. scaleInPlace(scale: number): Vector4;
  83647. /**
  83648. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83649. * @param scale the number to scale with
  83650. * @returns a new vector with the result
  83651. */
  83652. scale(scale: number): Vector4;
  83653. /**
  83654. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83655. * @param scale the number to scale with
  83656. * @param result a vector to store the result in
  83657. * @returns the current Vector4.
  83658. */
  83659. scaleToRef(scale: number, result: Vector4): Vector4;
  83660. /**
  83661. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83662. * @param scale defines the scale factor
  83663. * @param result defines the Vector4 object where to store the result
  83664. * @returns the unmodified current Vector4
  83665. */
  83666. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83667. /**
  83668. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83669. * @param otherVector the vector to compare against
  83670. * @returns true if they are equal
  83671. */
  83672. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83673. /**
  83674. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83675. * @param otherVector vector to compare against
  83676. * @param epsilon (Default: very small number)
  83677. * @returns true if they are equal
  83678. */
  83679. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83680. /**
  83681. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83682. * @param x x value to compare against
  83683. * @param y y value to compare against
  83684. * @param z z value to compare against
  83685. * @param w w value to compare against
  83686. * @returns true if equal
  83687. */
  83688. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83689. /**
  83690. * Multiplies in place the current Vector4 by the given one.
  83691. * @param otherVector vector to multiple with
  83692. * @returns the updated Vector4.
  83693. */
  83694. multiplyInPlace(otherVector: Vector4): Vector4;
  83695. /**
  83696. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83697. * @param otherVector vector to multiple with
  83698. * @returns resulting new vector
  83699. */
  83700. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83701. /**
  83702. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83703. * @param otherVector vector to multiple with
  83704. * @param result vector to store the result
  83705. * @returns the current Vector4.
  83706. */
  83707. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83708. /**
  83709. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83710. * @param x x value multiply with
  83711. * @param y y value multiply with
  83712. * @param z z value multiply with
  83713. * @param w w value multiply with
  83714. * @returns resulting new vector
  83715. */
  83716. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83717. /**
  83718. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83719. * @param otherVector vector to devide with
  83720. * @returns resulting new vector
  83721. */
  83722. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83723. /**
  83724. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83725. * @param otherVector vector to devide with
  83726. * @param result vector to store the result
  83727. * @returns the current Vector4.
  83728. */
  83729. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83730. /**
  83731. * Divides the current Vector3 coordinates by the given ones.
  83732. * @param otherVector vector to devide with
  83733. * @returns the updated Vector3.
  83734. */
  83735. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83736. /**
  83737. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83738. * @param other defines the second operand
  83739. * @returns the current updated Vector4
  83740. */
  83741. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83742. /**
  83743. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83744. * @param other defines the second operand
  83745. * @returns the current updated Vector4
  83746. */
  83747. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83748. /**
  83749. * Gets a new Vector4 from current Vector4 floored values
  83750. * @returns a new Vector4
  83751. */
  83752. floor(): Vector4;
  83753. /**
  83754. * Gets a new Vector4 from current Vector3 floored values
  83755. * @returns a new Vector4
  83756. */
  83757. fract(): Vector4;
  83758. /**
  83759. * Returns the Vector4 length (float).
  83760. * @returns the length
  83761. */
  83762. length(): number;
  83763. /**
  83764. * Returns the Vector4 squared length (float).
  83765. * @returns the length squared
  83766. */
  83767. lengthSquared(): number;
  83768. /**
  83769. * Normalizes in place the Vector4.
  83770. * @returns the updated Vector4.
  83771. */
  83772. normalize(): Vector4;
  83773. /**
  83774. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83775. * @returns this converted to a new vector3
  83776. */
  83777. toVector3(): Vector3;
  83778. /**
  83779. * Returns a new Vector4 copied from the current one.
  83780. * @returns the new cloned vector
  83781. */
  83782. clone(): Vector4;
  83783. /**
  83784. * Updates the current Vector4 with the given one coordinates.
  83785. * @param source the source vector to copy from
  83786. * @returns the updated Vector4.
  83787. */
  83788. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83789. /**
  83790. * Updates the current Vector4 coordinates with the given floats.
  83791. * @param x float to copy from
  83792. * @param y float to copy from
  83793. * @param z float to copy from
  83794. * @param w float to copy from
  83795. * @returns the updated Vector4.
  83796. */
  83797. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83798. /**
  83799. * Updates the current Vector4 coordinates with the given floats.
  83800. * @param x float to set from
  83801. * @param y float to set from
  83802. * @param z float to set from
  83803. * @param w float to set from
  83804. * @returns the updated Vector4.
  83805. */
  83806. set(x: number, y: number, z: number, w: number): Vector4;
  83807. /**
  83808. * Copies the given float to the current Vector3 coordinates
  83809. * @param v defines the x, y, z and w coordinates of the operand
  83810. * @returns the current updated Vector3
  83811. */
  83812. setAll(v: number): Vector4;
  83813. /**
  83814. * Returns a new Vector4 set from the starting index of the given array.
  83815. * @param array the array to pull values from
  83816. * @param offset the offset into the array to start at
  83817. * @returns the new vector
  83818. */
  83819. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83820. /**
  83821. * Updates the given vector "result" from the starting index of the given array.
  83822. * @param array the array to pull values from
  83823. * @param offset the offset into the array to start at
  83824. * @param result the vector to store the result in
  83825. */
  83826. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83827. /**
  83828. * Updates the given vector "result" from the starting index of the given Float32Array.
  83829. * @param array the array to pull values from
  83830. * @param offset the offset into the array to start at
  83831. * @param result the vector to store the result in
  83832. */
  83833. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83834. /**
  83835. * Updates the given vector "result" coordinates from the given floats.
  83836. * @param x float to set from
  83837. * @param y float to set from
  83838. * @param z float to set from
  83839. * @param w float to set from
  83840. * @param result the vector to the floats in
  83841. */
  83842. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83843. /**
  83844. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83845. * @returns the new vector
  83846. */
  83847. static Zero(): Vector4;
  83848. /**
  83849. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83850. * @returns the new vector
  83851. */
  83852. static One(): Vector4;
  83853. /**
  83854. * Returns a new normalized Vector4 from the given one.
  83855. * @param vector the vector to normalize
  83856. * @returns the vector
  83857. */
  83858. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83859. /**
  83860. * Updates the given vector "result" from the normalization of the given one.
  83861. * @param vector the vector to normalize
  83862. * @param result the vector to store the result in
  83863. */
  83864. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83865. /**
  83866. * Returns a vector with the minimum values from the left and right vectors
  83867. * @param left left vector to minimize
  83868. * @param right right vector to minimize
  83869. * @returns a new vector with the minimum of the left and right vector values
  83870. */
  83871. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83872. /**
  83873. * Returns a vector with the maximum values from the left and right vectors
  83874. * @param left left vector to maximize
  83875. * @param right right vector to maximize
  83876. * @returns a new vector with the maximum of the left and right vector values
  83877. */
  83878. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83879. /**
  83880. * Returns the distance (float) between the vectors "value1" and "value2".
  83881. * @param value1 value to calulate the distance between
  83882. * @param value2 value to calulate the distance between
  83883. * @return the distance between the two vectors
  83884. */
  83885. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83886. /**
  83887. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83888. * @param value1 value to calulate the distance between
  83889. * @param value2 value to calulate the distance between
  83890. * @return the distance between the two vectors squared
  83891. */
  83892. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83893. /**
  83894. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83895. * @param value1 value to calulate the center between
  83896. * @param value2 value to calulate the center between
  83897. * @return the center between the two vectors
  83898. */
  83899. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83900. /**
  83901. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83902. * This methods computes transformed normalized direction vectors only.
  83903. * @param vector the vector to transform
  83904. * @param transformation the transformation matrix to apply
  83905. * @returns the new vector
  83906. */
  83907. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83908. /**
  83909. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83910. * This methods computes transformed normalized direction vectors only.
  83911. * @param vector the vector to transform
  83912. * @param transformation the transformation matrix to apply
  83913. * @param result the vector to store the result in
  83914. */
  83915. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83916. /**
  83917. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83918. * This methods computes transformed normalized direction vectors only.
  83919. * @param x value to transform
  83920. * @param y value to transform
  83921. * @param z value to transform
  83922. * @param w value to transform
  83923. * @param transformation the transformation matrix to apply
  83924. * @param result the vector to store the results in
  83925. */
  83926. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83927. /**
  83928. * Creates a new Vector4 from a Vector3
  83929. * @param source defines the source data
  83930. * @param w defines the 4th component (default is 0)
  83931. * @returns a new Vector4
  83932. */
  83933. static FromVector3(source: Vector3, w?: number): Vector4;
  83934. }
  83935. /**
  83936. * Class used to store quaternion data
  83937. * @see https://en.wikipedia.org/wiki/Quaternion
  83938. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83939. */
  83940. export class Quaternion {
  83941. /** @hidden */
  83942. _x: number;
  83943. /** @hidden */
  83944. _y: number;
  83945. /** @hidden */
  83946. _z: number;
  83947. /** @hidden */
  83948. _w: number;
  83949. /** @hidden */
  83950. _isDirty: boolean;
  83951. /** Gets or sets the x coordinate */
  83952. get x(): number;
  83953. set x(value: number);
  83954. /** Gets or sets the y coordinate */
  83955. get y(): number;
  83956. set y(value: number);
  83957. /** Gets or sets the z coordinate */
  83958. get z(): number;
  83959. set z(value: number);
  83960. /** Gets or sets the w coordinate */
  83961. get w(): number;
  83962. set w(value: number);
  83963. /**
  83964. * Creates a new Quaternion from the given floats
  83965. * @param x defines the first component (0 by default)
  83966. * @param y defines the second component (0 by default)
  83967. * @param z defines the third component (0 by default)
  83968. * @param w defines the fourth component (1.0 by default)
  83969. */
  83970. constructor(x?: number, y?: number, z?: number, w?: number);
  83971. /**
  83972. * Gets a string representation for the current quaternion
  83973. * @returns a string with the Quaternion coordinates
  83974. */
  83975. toString(): string;
  83976. /**
  83977. * Gets the class name of the quaternion
  83978. * @returns the string "Quaternion"
  83979. */
  83980. getClassName(): string;
  83981. /**
  83982. * Gets a hash code for this quaternion
  83983. * @returns the quaternion hash code
  83984. */
  83985. getHashCode(): number;
  83986. /**
  83987. * Copy the quaternion to an array
  83988. * @returns a new array populated with 4 elements from the quaternion coordinates
  83989. */
  83990. asArray(): number[];
  83991. /**
  83992. * Check if two quaternions are equals
  83993. * @param otherQuaternion defines the second operand
  83994. * @return true if the current quaternion and the given one coordinates are strictly equals
  83995. */
  83996. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83997. /**
  83998. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83999. * @param otherQuaternion defines the other quaternion
  84000. * @param epsilon defines the minimal distance to consider equality
  84001. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  84002. */
  84003. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  84004. /**
  84005. * Clone the current quaternion
  84006. * @returns a new quaternion copied from the current one
  84007. */
  84008. clone(): Quaternion;
  84009. /**
  84010. * Copy a quaternion to the current one
  84011. * @param other defines the other quaternion
  84012. * @returns the updated current quaternion
  84013. */
  84014. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  84015. /**
  84016. * Updates the current quaternion with the given float coordinates
  84017. * @param x defines the x coordinate
  84018. * @param y defines the y coordinate
  84019. * @param z defines the z coordinate
  84020. * @param w defines the w coordinate
  84021. * @returns the updated current quaternion
  84022. */
  84023. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  84024. /**
  84025. * Updates the current quaternion from the given float coordinates
  84026. * @param x defines the x coordinate
  84027. * @param y defines the y coordinate
  84028. * @param z defines the z coordinate
  84029. * @param w defines the w coordinate
  84030. * @returns the updated current quaternion
  84031. */
  84032. set(x: number, y: number, z: number, w: number): Quaternion;
  84033. /**
  84034. * Adds two quaternions
  84035. * @param other defines the second operand
  84036. * @returns a new quaternion as the addition result of the given one and the current quaternion
  84037. */
  84038. add(other: DeepImmutable<Quaternion>): Quaternion;
  84039. /**
  84040. * Add a quaternion to the current one
  84041. * @param other defines the quaternion to add
  84042. * @returns the current quaternion
  84043. */
  84044. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  84045. /**
  84046. * Subtract two quaternions
  84047. * @param other defines the second operand
  84048. * @returns a new quaternion as the subtraction result of the given one from the current one
  84049. */
  84050. subtract(other: Quaternion): Quaternion;
  84051. /**
  84052. * Multiplies the current quaternion by a scale factor
  84053. * @param value defines the scale factor
  84054. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  84055. */
  84056. scale(value: number): Quaternion;
  84057. /**
  84058. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  84059. * @param scale defines the scale factor
  84060. * @param result defines the Quaternion object where to store the result
  84061. * @returns the unmodified current quaternion
  84062. */
  84063. scaleToRef(scale: number, result: Quaternion): Quaternion;
  84064. /**
  84065. * Multiplies in place the current quaternion by a scale factor
  84066. * @param value defines the scale factor
  84067. * @returns the current modified quaternion
  84068. */
  84069. scaleInPlace(value: number): Quaternion;
  84070. /**
  84071. * Scale the current quaternion values by a factor and add the result to a given quaternion
  84072. * @param scale defines the scale factor
  84073. * @param result defines the Quaternion object where to store the result
  84074. * @returns the unmodified current quaternion
  84075. */
  84076. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  84077. /**
  84078. * Multiplies two quaternions
  84079. * @param q1 defines the second operand
  84080. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  84081. */
  84082. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  84083. /**
  84084. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  84085. * @param q1 defines the second operand
  84086. * @param result defines the target quaternion
  84087. * @returns the current quaternion
  84088. */
  84089. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  84090. /**
  84091. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  84092. * @param q1 defines the second operand
  84093. * @returns the currentupdated quaternion
  84094. */
  84095. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  84096. /**
  84097. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  84098. * @param ref defines the target quaternion
  84099. * @returns the current quaternion
  84100. */
  84101. conjugateToRef(ref: Quaternion): Quaternion;
  84102. /**
  84103. * Conjugates in place (1-q) the current quaternion
  84104. * @returns the current updated quaternion
  84105. */
  84106. conjugateInPlace(): Quaternion;
  84107. /**
  84108. * Conjugates in place (1-q) the current quaternion
  84109. * @returns a new quaternion
  84110. */
  84111. conjugate(): Quaternion;
  84112. /**
  84113. * Gets length of current quaternion
  84114. * @returns the quaternion length (float)
  84115. */
  84116. length(): number;
  84117. /**
  84118. * Normalize in place the current quaternion
  84119. * @returns the current updated quaternion
  84120. */
  84121. normalize(): Quaternion;
  84122. /**
  84123. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  84124. * @param order is a reserved parameter and is ignored for now
  84125. * @returns a new Vector3 containing the Euler angles
  84126. */
  84127. toEulerAngles(order?: string): Vector3;
  84128. /**
  84129. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  84130. * @param result defines the vector which will be filled with the Euler angles
  84131. * @returns the current unchanged quaternion
  84132. */
  84133. toEulerAnglesToRef(result: Vector3): Quaternion;
  84134. /**
  84135. * Updates the given rotation matrix with the current quaternion values
  84136. * @param result defines the target matrix
  84137. * @returns the current unchanged quaternion
  84138. */
  84139. toRotationMatrix(result: Matrix): Quaternion;
  84140. /**
  84141. * Updates the current quaternion from the given rotation matrix values
  84142. * @param matrix defines the source matrix
  84143. * @returns the current updated quaternion
  84144. */
  84145. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  84146. /**
  84147. * Creates a new quaternion from a rotation matrix
  84148. * @param matrix defines the source matrix
  84149. * @returns a new quaternion created from the given rotation matrix values
  84150. */
  84151. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  84152. /**
  84153. * Updates the given quaternion with the given rotation matrix values
  84154. * @param matrix defines the source matrix
  84155. * @param result defines the target quaternion
  84156. */
  84157. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  84158. /**
  84159. * Returns the dot product (float) between the quaternions "left" and "right"
  84160. * @param left defines the left operand
  84161. * @param right defines the right operand
  84162. * @returns the dot product
  84163. */
  84164. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  84165. /**
  84166. * Checks if the two quaternions are close to each other
  84167. * @param quat0 defines the first quaternion to check
  84168. * @param quat1 defines the second quaternion to check
  84169. * @returns true if the two quaternions are close to each other
  84170. */
  84171. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  84172. /**
  84173. * Creates an empty quaternion
  84174. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  84175. */
  84176. static Zero(): Quaternion;
  84177. /**
  84178. * Inverse a given quaternion
  84179. * @param q defines the source quaternion
  84180. * @returns a new quaternion as the inverted current quaternion
  84181. */
  84182. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  84183. /**
  84184. * Inverse a given quaternion
  84185. * @param q defines the source quaternion
  84186. * @param result the quaternion the result will be stored in
  84187. * @returns the result quaternion
  84188. */
  84189. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  84190. /**
  84191. * Creates an identity quaternion
  84192. * @returns the identity quaternion
  84193. */
  84194. static Identity(): Quaternion;
  84195. /**
  84196. * Gets a boolean indicating if the given quaternion is identity
  84197. * @param quaternion defines the quaternion to check
  84198. * @returns true if the quaternion is identity
  84199. */
  84200. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  84201. /**
  84202. * Creates a quaternion from a rotation around an axis
  84203. * @param axis defines the axis to use
  84204. * @param angle defines the angle to use
  84205. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  84206. */
  84207. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  84208. /**
  84209. * Creates a rotation around an axis and stores it into the given quaternion
  84210. * @param axis defines the axis to use
  84211. * @param angle defines the angle to use
  84212. * @param result defines the target quaternion
  84213. * @returns the target quaternion
  84214. */
  84215. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  84216. /**
  84217. * Creates a new quaternion from data stored into an array
  84218. * @param array defines the data source
  84219. * @param offset defines the offset in the source array where the data starts
  84220. * @returns a new quaternion
  84221. */
  84222. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  84223. /**
  84224. * Updates the given quaternion "result" from the starting index of the given array.
  84225. * @param array the array to pull values from
  84226. * @param offset the offset into the array to start at
  84227. * @param result the quaternion to store the result in
  84228. */
  84229. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  84230. /**
  84231. * Create a quaternion from Euler rotation angles
  84232. * @param x Pitch
  84233. * @param y Yaw
  84234. * @param z Roll
  84235. * @returns the new Quaternion
  84236. */
  84237. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  84238. /**
  84239. * Updates a quaternion from Euler rotation angles
  84240. * @param x Pitch
  84241. * @param y Yaw
  84242. * @param z Roll
  84243. * @param result the quaternion to store the result
  84244. * @returns the updated quaternion
  84245. */
  84246. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  84247. /**
  84248. * Create a quaternion from Euler rotation vector
  84249. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  84250. * @returns the new Quaternion
  84251. */
  84252. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  84253. /**
  84254. * Updates a quaternion from Euler rotation vector
  84255. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  84256. * @param result the quaternion to store the result
  84257. * @returns the updated quaternion
  84258. */
  84259. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  84260. /**
  84261. * Creates a new quaternion from the given Euler float angles (y, x, z)
  84262. * @param yaw defines the rotation around Y axis
  84263. * @param pitch defines the rotation around X axis
  84264. * @param roll defines the rotation around Z axis
  84265. * @returns the new quaternion
  84266. */
  84267. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  84268. /**
  84269. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  84270. * @param yaw defines the rotation around Y axis
  84271. * @param pitch defines the rotation around X axis
  84272. * @param roll defines the rotation around Z axis
  84273. * @param result defines the target quaternion
  84274. */
  84275. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  84276. /**
  84277. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  84278. * @param alpha defines the rotation around first axis
  84279. * @param beta defines the rotation around second axis
  84280. * @param gamma defines the rotation around third axis
  84281. * @returns the new quaternion
  84282. */
  84283. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  84284. /**
  84285. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  84286. * @param alpha defines the rotation around first axis
  84287. * @param beta defines the rotation around second axis
  84288. * @param gamma defines the rotation around third axis
  84289. * @param result defines the target quaternion
  84290. */
  84291. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  84292. /**
  84293. * 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)
  84294. * @param axis1 defines the first axis
  84295. * @param axis2 defines the second axis
  84296. * @param axis3 defines the third axis
  84297. * @returns the new quaternion
  84298. */
  84299. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  84300. /**
  84301. * 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
  84302. * @param axis1 defines the first axis
  84303. * @param axis2 defines the second axis
  84304. * @param axis3 defines the third axis
  84305. * @param ref defines the target quaternion
  84306. */
  84307. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  84308. /**
  84309. * Interpolates between two quaternions
  84310. * @param left defines first quaternion
  84311. * @param right defines second quaternion
  84312. * @param amount defines the gradient to use
  84313. * @returns the new interpolated quaternion
  84314. */
  84315. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  84316. /**
  84317. * Interpolates between two quaternions and stores it into a target quaternion
  84318. * @param left defines first quaternion
  84319. * @param right defines second quaternion
  84320. * @param amount defines the gradient to use
  84321. * @param result defines the target quaternion
  84322. */
  84323. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  84324. /**
  84325. * Interpolate between two quaternions using Hermite interpolation
  84326. * @param value1 defines first quaternion
  84327. * @param tangent1 defines the incoming tangent
  84328. * @param value2 defines second quaternion
  84329. * @param tangent2 defines the outgoing tangent
  84330. * @param amount defines the target quaternion
  84331. * @returns the new interpolated quaternion
  84332. */
  84333. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  84334. }
  84335. /**
  84336. * Class used to store matrix data (4x4)
  84337. */
  84338. export class Matrix {
  84339. /**
  84340. * Gets the precision of matrix computations
  84341. */
  84342. static get Use64Bits(): boolean;
  84343. private static _updateFlagSeed;
  84344. private static _identityReadOnly;
  84345. private _isIdentity;
  84346. private _isIdentityDirty;
  84347. private _isIdentity3x2;
  84348. private _isIdentity3x2Dirty;
  84349. /**
  84350. * Gets the update flag of the matrix which is an unique number for the matrix.
  84351. * It will be incremented every time the matrix data change.
  84352. * You can use it to speed the comparison between two versions of the same matrix.
  84353. */
  84354. updateFlag: number;
  84355. private readonly _m;
  84356. /**
  84357. * Gets the internal data of the matrix
  84358. */
  84359. get m(): DeepImmutable<Float32Array | Array<number>>;
  84360. /** @hidden */
  84361. _markAsUpdated(): void;
  84362. /** @hidden */
  84363. private _updateIdentityStatus;
  84364. /**
  84365. * Creates an empty matrix (filled with zeros)
  84366. */
  84367. constructor();
  84368. /**
  84369. * Check if the current matrix is identity
  84370. * @returns true is the matrix is the identity matrix
  84371. */
  84372. isIdentity(): boolean;
  84373. /**
  84374. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  84375. * @returns true is the matrix is the identity matrix
  84376. */
  84377. isIdentityAs3x2(): boolean;
  84378. /**
  84379. * Gets the determinant of the matrix
  84380. * @returns the matrix determinant
  84381. */
  84382. determinant(): number;
  84383. /**
  84384. * Returns the matrix as a Float32Array or Array<number>
  84385. * @returns the matrix underlying array
  84386. */
  84387. toArray(): DeepImmutable<Float32Array | Array<number>>;
  84388. /**
  84389. * Returns the matrix as a Float32Array or Array<number>
  84390. * @returns the matrix underlying array.
  84391. */
  84392. asArray(): DeepImmutable<Float32Array | Array<number>>;
  84393. /**
  84394. * Inverts the current matrix in place
  84395. * @returns the current inverted matrix
  84396. */
  84397. invert(): Matrix;
  84398. /**
  84399. * Sets all the matrix elements to zero
  84400. * @returns the current matrix
  84401. */
  84402. reset(): Matrix;
  84403. /**
  84404. * Adds the current matrix with a second one
  84405. * @param other defines the matrix to add
  84406. * @returns a new matrix as the addition of the current matrix and the given one
  84407. */
  84408. add(other: DeepImmutable<Matrix>): Matrix;
  84409. /**
  84410. * Sets the given matrix "result" to the addition of the current matrix and the given one
  84411. * @param other defines the matrix to add
  84412. * @param result defines the target matrix
  84413. * @returns the current matrix
  84414. */
  84415. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  84416. /**
  84417. * Adds in place the given matrix to the current matrix
  84418. * @param other defines the second operand
  84419. * @returns the current updated matrix
  84420. */
  84421. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  84422. /**
  84423. * Sets the given matrix to the current inverted Matrix
  84424. * @param other defines the target matrix
  84425. * @returns the unmodified current matrix
  84426. */
  84427. invertToRef(other: Matrix): Matrix;
  84428. /**
  84429. * add a value at the specified position in the current Matrix
  84430. * @param index the index of the value within the matrix. between 0 and 15.
  84431. * @param value the value to be added
  84432. * @returns the current updated matrix
  84433. */
  84434. addAtIndex(index: number, value: number): Matrix;
  84435. /**
  84436. * mutiply the specified position in the current Matrix by a value
  84437. * @param index the index of the value within the matrix. between 0 and 15.
  84438. * @param value the value to be added
  84439. * @returns the current updated matrix
  84440. */
  84441. multiplyAtIndex(index: number, value: number): Matrix;
  84442. /**
  84443. * Inserts the translation vector (using 3 floats) in the current matrix
  84444. * @param x defines the 1st component of the translation
  84445. * @param y defines the 2nd component of the translation
  84446. * @param z defines the 3rd component of the translation
  84447. * @returns the current updated matrix
  84448. */
  84449. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  84450. /**
  84451. * Adds the translation vector (using 3 floats) in the current matrix
  84452. * @param x defines the 1st component of the translation
  84453. * @param y defines the 2nd component of the translation
  84454. * @param z defines the 3rd component of the translation
  84455. * @returns the current updated matrix
  84456. */
  84457. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  84458. /**
  84459. * Inserts the translation vector in the current matrix
  84460. * @param vector3 defines the translation to insert
  84461. * @returns the current updated matrix
  84462. */
  84463. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  84464. /**
  84465. * Gets the translation value of the current matrix
  84466. * @returns a new Vector3 as the extracted translation from the matrix
  84467. */
  84468. getTranslation(): Vector3;
  84469. /**
  84470. * Fill a Vector3 with the extracted translation from the matrix
  84471. * @param result defines the Vector3 where to store the translation
  84472. * @returns the current matrix
  84473. */
  84474. getTranslationToRef(result: Vector3): Matrix;
  84475. /**
  84476. * Remove rotation and scaling part from the matrix
  84477. * @returns the updated matrix
  84478. */
  84479. removeRotationAndScaling(): Matrix;
  84480. /**
  84481. * Multiply two matrices
  84482. * @param other defines the second operand
  84483. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  84484. */
  84485. multiply(other: DeepImmutable<Matrix>): Matrix;
  84486. /**
  84487. * Copy the current matrix from the given one
  84488. * @param other defines the source matrix
  84489. * @returns the current updated matrix
  84490. */
  84491. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  84492. /**
  84493. * Populates the given array from the starting index with the current matrix values
  84494. * @param array defines the target array
  84495. * @param offset defines the offset in the target array where to start storing values
  84496. * @returns the current matrix
  84497. */
  84498. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  84499. /**
  84500. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  84501. * @param other defines the second operand
  84502. * @param result defines the matrix where to store the multiplication
  84503. * @returns the current matrix
  84504. */
  84505. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  84506. /**
  84507. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  84508. * @param other defines the second operand
  84509. * @param result defines the array where to store the multiplication
  84510. * @param offset defines the offset in the target array where to start storing values
  84511. * @returns the current matrix
  84512. */
  84513. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  84514. /**
  84515. * Check equality between this matrix and a second one
  84516. * @param value defines the second matrix to compare
  84517. * @returns true is the current matrix and the given one values are strictly equal
  84518. */
  84519. equals(value: DeepImmutable<Matrix>): boolean;
  84520. /**
  84521. * Clone the current matrix
  84522. * @returns a new matrix from the current matrix
  84523. */
  84524. clone(): Matrix;
  84525. /**
  84526. * Returns the name of the current matrix class
  84527. * @returns the string "Matrix"
  84528. */
  84529. getClassName(): string;
  84530. /**
  84531. * Gets the hash code of the current matrix
  84532. * @returns the hash code
  84533. */
  84534. getHashCode(): number;
  84535. /**
  84536. * Decomposes the current Matrix into a translation, rotation and scaling components
  84537. * @param scale defines the scale vector3 given as a reference to update
  84538. * @param rotation defines the rotation quaternion given as a reference to update
  84539. * @param translation defines the translation vector3 given as a reference to update
  84540. * @returns true if operation was successful
  84541. */
  84542. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  84543. /**
  84544. * Gets specific row of the matrix
  84545. * @param index defines the number of the row to get
  84546. * @returns the index-th row of the current matrix as a new Vector4
  84547. */
  84548. getRow(index: number): Nullable<Vector4>;
  84549. /**
  84550. * Sets the index-th row of the current matrix to the vector4 values
  84551. * @param index defines the number of the row to set
  84552. * @param row defines the target vector4
  84553. * @returns the updated current matrix
  84554. */
  84555. setRow(index: number, row: Vector4): Matrix;
  84556. /**
  84557. * Compute the transpose of the matrix
  84558. * @returns the new transposed matrix
  84559. */
  84560. transpose(): Matrix;
  84561. /**
  84562. * Compute the transpose of the matrix and store it in a given matrix
  84563. * @param result defines the target matrix
  84564. * @returns the current matrix
  84565. */
  84566. transposeToRef(result: Matrix): Matrix;
  84567. /**
  84568. * Sets the index-th row of the current matrix with the given 4 x float values
  84569. * @param index defines the row index
  84570. * @param x defines the x component to set
  84571. * @param y defines the y component to set
  84572. * @param z defines the z component to set
  84573. * @param w defines the w component to set
  84574. * @returns the updated current matrix
  84575. */
  84576. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  84577. /**
  84578. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  84579. * @param scale defines the scale factor
  84580. * @returns a new matrix
  84581. */
  84582. scale(scale: number): Matrix;
  84583. /**
  84584. * Scale the current matrix values by a factor to a given result matrix
  84585. * @param scale defines the scale factor
  84586. * @param result defines the matrix to store the result
  84587. * @returns the current matrix
  84588. */
  84589. scaleToRef(scale: number, result: Matrix): Matrix;
  84590. /**
  84591. * Scale the current matrix values by a factor and add the result to a given matrix
  84592. * @param scale defines the scale factor
  84593. * @param result defines the Matrix to store the result
  84594. * @returns the current matrix
  84595. */
  84596. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  84597. /**
  84598. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  84599. * @param ref matrix to store the result
  84600. */
  84601. toNormalMatrix(ref: Matrix): void;
  84602. /**
  84603. * Gets only rotation part of the current matrix
  84604. * @returns a new matrix sets to the extracted rotation matrix from the current one
  84605. */
  84606. getRotationMatrix(): Matrix;
  84607. /**
  84608. * Extracts the rotation matrix from the current one and sets it as the given "result"
  84609. * @param result defines the target matrix to store data to
  84610. * @returns the current matrix
  84611. */
  84612. getRotationMatrixToRef(result: Matrix): Matrix;
  84613. /**
  84614. * Toggles model matrix from being right handed to left handed in place and vice versa
  84615. */
  84616. toggleModelMatrixHandInPlace(): void;
  84617. /**
  84618. * Toggles projection matrix from being right handed to left handed in place and vice versa
  84619. */
  84620. toggleProjectionMatrixHandInPlace(): void;
  84621. /**
  84622. * Creates a matrix from an array
  84623. * @param array defines the source array
  84624. * @param offset defines an offset in the source array
  84625. * @returns a new Matrix set from the starting index of the given array
  84626. */
  84627. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  84628. /**
  84629. * Copy the content of an array into a given matrix
  84630. * @param array defines the source array
  84631. * @param offset defines an offset in the source array
  84632. * @param result defines the target matrix
  84633. */
  84634. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  84635. /**
  84636. * Stores an array into a matrix after having multiplied each component by a given factor
  84637. * @param array defines the source array
  84638. * @param offset defines the offset in the source array
  84639. * @param scale defines the scaling factor
  84640. * @param result defines the target matrix
  84641. */
  84642. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84643. /**
  84644. * Gets an identity matrix that must not be updated
  84645. */
  84646. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84647. /**
  84648. * Stores a list of values (16) inside a given matrix
  84649. * @param initialM11 defines 1st value of 1st row
  84650. * @param initialM12 defines 2nd value of 1st row
  84651. * @param initialM13 defines 3rd value of 1st row
  84652. * @param initialM14 defines 4th value of 1st row
  84653. * @param initialM21 defines 1st value of 2nd row
  84654. * @param initialM22 defines 2nd value of 2nd row
  84655. * @param initialM23 defines 3rd value of 2nd row
  84656. * @param initialM24 defines 4th value of 2nd row
  84657. * @param initialM31 defines 1st value of 3rd row
  84658. * @param initialM32 defines 2nd value of 3rd row
  84659. * @param initialM33 defines 3rd value of 3rd row
  84660. * @param initialM34 defines 4th value of 3rd row
  84661. * @param initialM41 defines 1st value of 4th row
  84662. * @param initialM42 defines 2nd value of 4th row
  84663. * @param initialM43 defines 3rd value of 4th row
  84664. * @param initialM44 defines 4th value of 4th row
  84665. * @param result defines the target matrix
  84666. */
  84667. 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;
  84668. /**
  84669. * Creates new matrix from a list of values (16)
  84670. * @param initialM11 defines 1st value of 1st row
  84671. * @param initialM12 defines 2nd value of 1st row
  84672. * @param initialM13 defines 3rd value of 1st row
  84673. * @param initialM14 defines 4th value of 1st row
  84674. * @param initialM21 defines 1st value of 2nd row
  84675. * @param initialM22 defines 2nd value of 2nd row
  84676. * @param initialM23 defines 3rd value of 2nd row
  84677. * @param initialM24 defines 4th value of 2nd row
  84678. * @param initialM31 defines 1st value of 3rd row
  84679. * @param initialM32 defines 2nd value of 3rd row
  84680. * @param initialM33 defines 3rd value of 3rd row
  84681. * @param initialM34 defines 4th value of 3rd row
  84682. * @param initialM41 defines 1st value of 4th row
  84683. * @param initialM42 defines 2nd value of 4th row
  84684. * @param initialM43 defines 3rd value of 4th row
  84685. * @param initialM44 defines 4th value of 4th row
  84686. * @returns the new matrix
  84687. */
  84688. 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;
  84689. /**
  84690. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84691. * @param scale defines the scale vector3
  84692. * @param rotation defines the rotation quaternion
  84693. * @param translation defines the translation vector3
  84694. * @returns a new matrix
  84695. */
  84696. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84697. /**
  84698. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84699. * @param scale defines the scale vector3
  84700. * @param rotation defines the rotation quaternion
  84701. * @param translation defines the translation vector3
  84702. * @param result defines the target matrix
  84703. */
  84704. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84705. /**
  84706. * Creates a new identity matrix
  84707. * @returns a new identity matrix
  84708. */
  84709. static Identity(): Matrix;
  84710. /**
  84711. * Creates a new identity matrix and stores the result in a given matrix
  84712. * @param result defines the target matrix
  84713. */
  84714. static IdentityToRef(result: Matrix): void;
  84715. /**
  84716. * Creates a new zero matrix
  84717. * @returns a new zero matrix
  84718. */
  84719. static Zero(): Matrix;
  84720. /**
  84721. * Creates a new rotation matrix for "angle" radians around the X axis
  84722. * @param angle defines the angle (in radians) to use
  84723. * @return the new matrix
  84724. */
  84725. static RotationX(angle: number): Matrix;
  84726. /**
  84727. * Creates a new matrix as the invert of a given matrix
  84728. * @param source defines the source matrix
  84729. * @returns the new matrix
  84730. */
  84731. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84732. /**
  84733. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84734. * @param angle defines the angle (in radians) to use
  84735. * @param result defines the target matrix
  84736. */
  84737. static RotationXToRef(angle: number, result: Matrix): void;
  84738. /**
  84739. * Creates a new rotation matrix for "angle" radians around the Y axis
  84740. * @param angle defines the angle (in radians) to use
  84741. * @return the new matrix
  84742. */
  84743. static RotationY(angle: number): Matrix;
  84744. /**
  84745. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84746. * @param angle defines the angle (in radians) to use
  84747. * @param result defines the target matrix
  84748. */
  84749. static RotationYToRef(angle: number, result: Matrix): void;
  84750. /**
  84751. * Creates a new rotation matrix for "angle" radians around the Z axis
  84752. * @param angle defines the angle (in radians) to use
  84753. * @return the new matrix
  84754. */
  84755. static RotationZ(angle: number): Matrix;
  84756. /**
  84757. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84758. * @param angle defines the angle (in radians) to use
  84759. * @param result defines the target matrix
  84760. */
  84761. static RotationZToRef(angle: number, result: Matrix): void;
  84762. /**
  84763. * Creates a new rotation matrix for "angle" radians around the given axis
  84764. * @param axis defines the axis to use
  84765. * @param angle defines the angle (in radians) to use
  84766. * @return the new matrix
  84767. */
  84768. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84769. /**
  84770. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84771. * @param axis defines the axis to use
  84772. * @param angle defines the angle (in radians) to use
  84773. * @param result defines the target matrix
  84774. */
  84775. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84776. /**
  84777. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84778. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84779. * @param from defines the vector to align
  84780. * @param to defines the vector to align to
  84781. * @param result defines the target matrix
  84782. */
  84783. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84784. /**
  84785. * Creates a rotation matrix
  84786. * @param yaw defines the yaw angle in radians (Y axis)
  84787. * @param pitch defines the pitch angle in radians (X axis)
  84788. * @param roll defines the roll angle in radians (Z axis)
  84789. * @returns the new rotation matrix
  84790. */
  84791. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84792. /**
  84793. * Creates a rotation matrix and stores it in a given matrix
  84794. * @param yaw defines the yaw angle in radians (Y axis)
  84795. * @param pitch defines the pitch angle in radians (X axis)
  84796. * @param roll defines the roll angle in radians (Z axis)
  84797. * @param result defines the target matrix
  84798. */
  84799. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84800. /**
  84801. * Creates a scaling matrix
  84802. * @param x defines the scale factor on X axis
  84803. * @param y defines the scale factor on Y axis
  84804. * @param z defines the scale factor on Z axis
  84805. * @returns the new matrix
  84806. */
  84807. static Scaling(x: number, y: number, z: number): Matrix;
  84808. /**
  84809. * Creates a scaling matrix and stores it in a given matrix
  84810. * @param x defines the scale factor on X axis
  84811. * @param y defines the scale factor on Y axis
  84812. * @param z defines the scale factor on Z axis
  84813. * @param result defines the target matrix
  84814. */
  84815. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84816. /**
  84817. * Creates a translation matrix
  84818. * @param x defines the translation on X axis
  84819. * @param y defines the translation on Y axis
  84820. * @param z defines the translationon Z axis
  84821. * @returns the new matrix
  84822. */
  84823. static Translation(x: number, y: number, z: number): Matrix;
  84824. /**
  84825. * Creates a translation matrix and stores it in a given matrix
  84826. * @param x defines the translation on X axis
  84827. * @param y defines the translation on Y axis
  84828. * @param z defines the translationon Z axis
  84829. * @param result defines the target matrix
  84830. */
  84831. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84832. /**
  84833. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84834. * @param startValue defines the start value
  84835. * @param endValue defines the end value
  84836. * @param gradient defines the gradient factor
  84837. * @returns the new matrix
  84838. */
  84839. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84840. /**
  84841. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84842. * @param startValue defines the start value
  84843. * @param endValue defines the end value
  84844. * @param gradient defines the gradient factor
  84845. * @param result defines the Matrix object where to store data
  84846. */
  84847. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84848. /**
  84849. * Builds a new matrix whose values are computed by:
  84850. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84851. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84852. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84853. * @param startValue defines the first matrix
  84854. * @param endValue defines the second matrix
  84855. * @param gradient defines the gradient between the two matrices
  84856. * @returns the new matrix
  84857. */
  84858. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84859. /**
  84860. * Update a matrix to values which are computed by:
  84861. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84862. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84863. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84864. * @param startValue defines the first matrix
  84865. * @param endValue defines the second matrix
  84866. * @param gradient defines the gradient between the two matrices
  84867. * @param result defines the target matrix
  84868. */
  84869. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84870. /**
  84871. * 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"
  84872. * This function works in left handed mode
  84873. * @param eye defines the final position of the entity
  84874. * @param target defines where the entity should look at
  84875. * @param up defines the up vector for the entity
  84876. * @returns the new matrix
  84877. */
  84878. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84879. /**
  84880. * 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".
  84881. * This function works in left handed mode
  84882. * @param eye defines the final position of the entity
  84883. * @param target defines where the entity should look at
  84884. * @param up defines the up vector for the entity
  84885. * @param result defines the target matrix
  84886. */
  84887. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84888. /**
  84889. * 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"
  84890. * This function works in right handed mode
  84891. * @param eye defines the final position of the entity
  84892. * @param target defines where the entity should look at
  84893. * @param up defines the up vector for the entity
  84894. * @returns the new matrix
  84895. */
  84896. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84897. /**
  84898. * 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".
  84899. * This function works in right handed mode
  84900. * @param eye defines the final position of the entity
  84901. * @param target defines where the entity should look at
  84902. * @param up defines the up vector for the entity
  84903. * @param result defines the target matrix
  84904. */
  84905. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84906. /**
  84907. * Create a left-handed orthographic projection matrix
  84908. * @param width defines the viewport width
  84909. * @param height defines the viewport height
  84910. * @param znear defines the near clip plane
  84911. * @param zfar defines the far clip plane
  84912. * @returns a new matrix as a left-handed orthographic projection matrix
  84913. */
  84914. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84915. /**
  84916. * Store a left-handed orthographic projection to a given matrix
  84917. * @param width defines the viewport width
  84918. * @param height defines the viewport height
  84919. * @param znear defines the near clip plane
  84920. * @param zfar defines the far clip plane
  84921. * @param result defines the target matrix
  84922. */
  84923. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84924. /**
  84925. * Create a left-handed orthographic projection matrix
  84926. * @param left defines the viewport left coordinate
  84927. * @param right defines the viewport right coordinate
  84928. * @param bottom defines the viewport bottom coordinate
  84929. * @param top defines the viewport top coordinate
  84930. * @param znear defines the near clip plane
  84931. * @param zfar defines the far clip plane
  84932. * @returns a new matrix as a left-handed orthographic projection matrix
  84933. */
  84934. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84935. /**
  84936. * Stores a left-handed orthographic projection into a given matrix
  84937. * @param left defines the viewport left coordinate
  84938. * @param right defines the viewport right coordinate
  84939. * @param bottom defines the viewport bottom coordinate
  84940. * @param top defines the viewport top coordinate
  84941. * @param znear defines the near clip plane
  84942. * @param zfar defines the far clip plane
  84943. * @param result defines the target matrix
  84944. */
  84945. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84946. /**
  84947. * Creates a right-handed orthographic projection matrix
  84948. * @param left defines the viewport left coordinate
  84949. * @param right defines the viewport right coordinate
  84950. * @param bottom defines the viewport bottom coordinate
  84951. * @param top defines the viewport top coordinate
  84952. * @param znear defines the near clip plane
  84953. * @param zfar defines the far clip plane
  84954. * @returns a new matrix as a right-handed orthographic projection matrix
  84955. */
  84956. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84957. /**
  84958. * Stores a right-handed orthographic projection into a given matrix
  84959. * @param left defines the viewport left coordinate
  84960. * @param right defines the viewport right coordinate
  84961. * @param bottom defines the viewport bottom coordinate
  84962. * @param top defines the viewport top coordinate
  84963. * @param znear defines the near clip plane
  84964. * @param zfar defines the far clip plane
  84965. * @param result defines the target matrix
  84966. */
  84967. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84968. /**
  84969. * Creates a left-handed perspective projection matrix
  84970. * @param width defines the viewport width
  84971. * @param height defines the viewport height
  84972. * @param znear defines the near clip plane
  84973. * @param zfar defines the far clip plane
  84974. * @returns a new matrix as a left-handed perspective projection matrix
  84975. */
  84976. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84977. /**
  84978. * Creates a left-handed perspective projection matrix
  84979. * @param fov defines the horizontal field of view
  84980. * @param aspect defines the aspect ratio
  84981. * @param znear defines the near clip plane
  84982. * @param zfar defines the far clip plane
  84983. * @returns a new matrix as a left-handed perspective projection matrix
  84984. */
  84985. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84986. /**
  84987. * Stores a left-handed perspective projection into a given matrix
  84988. * @param fov defines the horizontal field of view
  84989. * @param aspect defines the aspect ratio
  84990. * @param znear defines the near clip plane
  84991. * @param zfar defines the far clip plane
  84992. * @param result defines the target matrix
  84993. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84994. */
  84995. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84996. /**
  84997. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84998. * @param fov defines the horizontal field of view
  84999. * @param aspect defines the aspect ratio
  85000. * @param znear defines the near clip plane
  85001. * @param zfar not used as infinity is used as far clip
  85002. * @param result defines the target matrix
  85003. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85004. */
  85005. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85006. /**
  85007. * Creates a right-handed perspective projection matrix
  85008. * @param fov defines the horizontal field of view
  85009. * @param aspect defines the aspect ratio
  85010. * @param znear defines the near clip plane
  85011. * @param zfar defines the far clip plane
  85012. * @returns a new matrix as a right-handed perspective projection matrix
  85013. */
  85014. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  85015. /**
  85016. * Stores a right-handed perspective projection into a given matrix
  85017. * @param fov defines the horizontal field of view
  85018. * @param aspect defines the aspect ratio
  85019. * @param znear defines the near clip plane
  85020. * @param zfar defines the far clip plane
  85021. * @param result defines the target matrix
  85022. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85023. */
  85024. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85025. /**
  85026. * Stores a right-handed perspective projection into a given matrix
  85027. * @param fov defines the horizontal field of view
  85028. * @param aspect defines the aspect ratio
  85029. * @param znear defines the near clip plane
  85030. * @param zfar not used as infinity is used as far clip
  85031. * @param result defines the target matrix
  85032. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85033. */
  85034. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85035. /**
  85036. * Stores a perspective projection for WebVR info a given matrix
  85037. * @param fov defines the field of view
  85038. * @param znear defines the near clip plane
  85039. * @param zfar defines the far clip plane
  85040. * @param result defines the target matrix
  85041. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  85042. */
  85043. static PerspectiveFovWebVRToRef(fov: {
  85044. upDegrees: number;
  85045. downDegrees: number;
  85046. leftDegrees: number;
  85047. rightDegrees: number;
  85048. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  85049. /**
  85050. * Computes a complete transformation matrix
  85051. * @param viewport defines the viewport to use
  85052. * @param world defines the world matrix
  85053. * @param view defines the view matrix
  85054. * @param projection defines the projection matrix
  85055. * @param zmin defines the near clip plane
  85056. * @param zmax defines the far clip plane
  85057. * @returns the transformation matrix
  85058. */
  85059. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  85060. /**
  85061. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  85062. * @param matrix defines the matrix to use
  85063. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  85064. */
  85065. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  85066. /**
  85067. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  85068. * @param matrix defines the matrix to use
  85069. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  85070. */
  85071. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  85072. /**
  85073. * Compute the transpose of a given matrix
  85074. * @param matrix defines the matrix to transpose
  85075. * @returns the new matrix
  85076. */
  85077. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  85078. /**
  85079. * Compute the transpose of a matrix and store it in a target matrix
  85080. * @param matrix defines the matrix to transpose
  85081. * @param result defines the target matrix
  85082. */
  85083. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  85084. /**
  85085. * Computes a reflection matrix from a plane
  85086. * @param plane defines the reflection plane
  85087. * @returns a new matrix
  85088. */
  85089. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  85090. /**
  85091. * Computes a reflection matrix from a plane
  85092. * @param plane defines the reflection plane
  85093. * @param result defines the target matrix
  85094. */
  85095. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  85096. /**
  85097. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  85098. * @param xaxis defines the value of the 1st axis
  85099. * @param yaxis defines the value of the 2nd axis
  85100. * @param zaxis defines the value of the 3rd axis
  85101. * @param result defines the target matrix
  85102. */
  85103. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  85104. /**
  85105. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  85106. * @param quat defines the quaternion to use
  85107. * @param result defines the target matrix
  85108. */
  85109. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  85110. }
  85111. /**
  85112. * @hidden
  85113. */
  85114. export class TmpVectors {
  85115. static Vector2: Vector2[];
  85116. static Vector3: Vector3[];
  85117. static Vector4: Vector4[];
  85118. static Quaternion: Quaternion[];
  85119. static Matrix: Matrix[];
  85120. }
  85121. }
  85122. declare module BABYLON {
  85123. /**
  85124. * Defines potential orientation for back face culling
  85125. */
  85126. export enum Orientation {
  85127. /**
  85128. * Clockwise
  85129. */
  85130. CW = 0,
  85131. /** Counter clockwise */
  85132. CCW = 1
  85133. }
  85134. /** Class used to represent a Bezier curve */
  85135. export class BezierCurve {
  85136. /**
  85137. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  85138. * @param t defines the time
  85139. * @param x1 defines the left coordinate on X axis
  85140. * @param y1 defines the left coordinate on Y axis
  85141. * @param x2 defines the right coordinate on X axis
  85142. * @param y2 defines the right coordinate on Y axis
  85143. * @returns the interpolated value
  85144. */
  85145. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  85146. }
  85147. /**
  85148. * Defines angle representation
  85149. */
  85150. export class Angle {
  85151. private _radians;
  85152. /**
  85153. * Creates an Angle object of "radians" radians (float).
  85154. * @param radians the angle in radians
  85155. */
  85156. constructor(radians: number);
  85157. /**
  85158. * Get value in degrees
  85159. * @returns the Angle value in degrees (float)
  85160. */
  85161. degrees(): number;
  85162. /**
  85163. * Get value in radians
  85164. * @returns the Angle value in radians (float)
  85165. */
  85166. radians(): number;
  85167. /**
  85168. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  85169. * @param a defines first point as the origin
  85170. * @param b defines point
  85171. * @returns a new Angle
  85172. */
  85173. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  85174. /**
  85175. * Gets a new Angle object from the given float in radians
  85176. * @param radians defines the angle value in radians
  85177. * @returns a new Angle
  85178. */
  85179. static FromRadians(radians: number): Angle;
  85180. /**
  85181. * Gets a new Angle object from the given float in degrees
  85182. * @param degrees defines the angle value in degrees
  85183. * @returns a new Angle
  85184. */
  85185. static FromDegrees(degrees: number): Angle;
  85186. }
  85187. /**
  85188. * This represents an arc in a 2d space.
  85189. */
  85190. export class Arc2 {
  85191. /** Defines the start point of the arc */
  85192. startPoint: Vector2;
  85193. /** Defines the mid point of the arc */
  85194. midPoint: Vector2;
  85195. /** Defines the end point of the arc */
  85196. endPoint: Vector2;
  85197. /**
  85198. * Defines the center point of the arc.
  85199. */
  85200. centerPoint: Vector2;
  85201. /**
  85202. * Defines the radius of the arc.
  85203. */
  85204. radius: number;
  85205. /**
  85206. * Defines the angle of the arc (from mid point to end point).
  85207. */
  85208. angle: Angle;
  85209. /**
  85210. * Defines the start angle of the arc (from start point to middle point).
  85211. */
  85212. startAngle: Angle;
  85213. /**
  85214. * Defines the orientation of the arc (clock wise/counter clock wise).
  85215. */
  85216. orientation: Orientation;
  85217. /**
  85218. * Creates an Arc object from the three given points : start, middle and end.
  85219. * @param startPoint Defines the start point of the arc
  85220. * @param midPoint Defines the midlle point of the arc
  85221. * @param endPoint Defines the end point of the arc
  85222. */
  85223. constructor(
  85224. /** Defines the start point of the arc */
  85225. startPoint: Vector2,
  85226. /** Defines the mid point of the arc */
  85227. midPoint: Vector2,
  85228. /** Defines the end point of the arc */
  85229. endPoint: Vector2);
  85230. }
  85231. /**
  85232. * Represents a 2D path made up of multiple 2D points
  85233. */
  85234. export class Path2 {
  85235. private _points;
  85236. private _length;
  85237. /**
  85238. * If the path start and end point are the same
  85239. */
  85240. closed: boolean;
  85241. /**
  85242. * Creates a Path2 object from the starting 2D coordinates x and y.
  85243. * @param x the starting points x value
  85244. * @param y the starting points y value
  85245. */
  85246. constructor(x: number, y: number);
  85247. /**
  85248. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  85249. * @param x the added points x value
  85250. * @param y the added points y value
  85251. * @returns the updated Path2.
  85252. */
  85253. addLineTo(x: number, y: number): Path2;
  85254. /**
  85255. * 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.
  85256. * @param midX middle point x value
  85257. * @param midY middle point y value
  85258. * @param endX end point x value
  85259. * @param endY end point y value
  85260. * @param numberOfSegments (default: 36)
  85261. * @returns the updated Path2.
  85262. */
  85263. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  85264. /**
  85265. * Closes the Path2.
  85266. * @returns the Path2.
  85267. */
  85268. close(): Path2;
  85269. /**
  85270. * Gets the sum of the distance between each sequential point in the path
  85271. * @returns the Path2 total length (float).
  85272. */
  85273. length(): number;
  85274. /**
  85275. * Gets the points which construct the path
  85276. * @returns the Path2 internal array of points.
  85277. */
  85278. getPoints(): Vector2[];
  85279. /**
  85280. * Retreives the point at the distance aways from the starting point
  85281. * @param normalizedLengthPosition the length along the path to retreive the point from
  85282. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  85283. */
  85284. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  85285. /**
  85286. * Creates a new path starting from an x and y position
  85287. * @param x starting x value
  85288. * @param y starting y value
  85289. * @returns a new Path2 starting at the coordinates (x, y).
  85290. */
  85291. static StartingAt(x: number, y: number): Path2;
  85292. }
  85293. /**
  85294. * Represents a 3D path made up of multiple 3D points
  85295. */
  85296. export class Path3D {
  85297. /**
  85298. * an array of Vector3, the curve axis of the Path3D
  85299. */
  85300. path: Vector3[];
  85301. private _curve;
  85302. private _distances;
  85303. private _tangents;
  85304. private _normals;
  85305. private _binormals;
  85306. private _raw;
  85307. private _alignTangentsWithPath;
  85308. private readonly _pointAtData;
  85309. /**
  85310. * new Path3D(path, normal, raw)
  85311. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  85312. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  85313. * @param path an array of Vector3, the curve axis of the Path3D
  85314. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  85315. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  85316. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  85317. */
  85318. constructor(
  85319. /**
  85320. * an array of Vector3, the curve axis of the Path3D
  85321. */
  85322. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  85323. /**
  85324. * Returns the Path3D array of successive Vector3 designing its curve.
  85325. * @returns the Path3D array of successive Vector3 designing its curve.
  85326. */
  85327. getCurve(): Vector3[];
  85328. /**
  85329. * Returns the Path3D array of successive Vector3 designing its curve.
  85330. * @returns the Path3D array of successive Vector3 designing its curve.
  85331. */
  85332. getPoints(): Vector3[];
  85333. /**
  85334. * @returns the computed length (float) of the path.
  85335. */
  85336. length(): number;
  85337. /**
  85338. * Returns an array populated with tangent vectors on each Path3D curve point.
  85339. * @returns an array populated with tangent vectors on each Path3D curve point.
  85340. */
  85341. getTangents(): Vector3[];
  85342. /**
  85343. * Returns an array populated with normal vectors on each Path3D curve point.
  85344. * @returns an array populated with normal vectors on each Path3D curve point.
  85345. */
  85346. getNormals(): Vector3[];
  85347. /**
  85348. * Returns an array populated with binormal vectors on each Path3D curve point.
  85349. * @returns an array populated with binormal vectors on each Path3D curve point.
  85350. */
  85351. getBinormals(): Vector3[];
  85352. /**
  85353. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  85354. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  85355. */
  85356. getDistances(): number[];
  85357. /**
  85358. * Returns an interpolated point along this path
  85359. * @param position the position of the point along this path, from 0.0 to 1.0
  85360. * @returns a new Vector3 as the point
  85361. */
  85362. getPointAt(position: number): Vector3;
  85363. /**
  85364. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  85365. * @param position the position of the point along this path, from 0.0 to 1.0
  85366. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  85367. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  85368. */
  85369. getTangentAt(position: number, interpolated?: boolean): Vector3;
  85370. /**
  85371. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  85372. * @param position the position of the point along this path, from 0.0 to 1.0
  85373. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  85374. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  85375. */
  85376. getNormalAt(position: number, interpolated?: boolean): Vector3;
  85377. /**
  85378. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  85379. * @param position the position of the point along this path, from 0.0 to 1.0
  85380. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  85381. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  85382. */
  85383. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  85384. /**
  85385. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  85386. * @param position the position of the point along this path, from 0.0 to 1.0
  85387. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  85388. */
  85389. getDistanceAt(position: number): number;
  85390. /**
  85391. * Returns the array index of the previous point of an interpolated point along this path
  85392. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  85393. * @returns the array index
  85394. */
  85395. getPreviousPointIndexAt(position: number): number;
  85396. /**
  85397. * 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)
  85398. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  85399. * @returns the sub position
  85400. */
  85401. getSubPositionAt(position: number): number;
  85402. /**
  85403. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  85404. * @param target the vector of which to get the closest position to
  85405. * @returns the position of the closest virtual point on this path to the target vector
  85406. */
  85407. getClosestPositionTo(target: Vector3): number;
  85408. /**
  85409. * Returns a sub path (slice) of this path
  85410. * @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
  85411. * @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
  85412. * @returns a sub path (slice) of this path
  85413. */
  85414. slice(start?: number, end?: number): Path3D;
  85415. /**
  85416. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  85417. * @param path path which all values are copied into the curves points
  85418. * @param firstNormal which should be projected onto the curve
  85419. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  85420. * @returns the same object updated.
  85421. */
  85422. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  85423. private _compute;
  85424. private _getFirstNonNullVector;
  85425. private _getLastNonNullVector;
  85426. private _normalVector;
  85427. /**
  85428. * Updates the point at data for an interpolated point along this curve
  85429. * @param position the position of the point along this curve, from 0.0 to 1.0
  85430. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  85431. * @returns the (updated) point at data
  85432. */
  85433. private _updatePointAtData;
  85434. /**
  85435. * Updates the point at data from the specified parameters
  85436. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  85437. * @param point the interpolated point
  85438. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  85439. */
  85440. private _setPointAtData;
  85441. /**
  85442. * Updates the point at interpolation matrix for the tangents, normals and binormals
  85443. */
  85444. private _updateInterpolationMatrix;
  85445. }
  85446. /**
  85447. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  85448. * A Curve3 is designed from a series of successive Vector3.
  85449. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  85450. */
  85451. export class Curve3 {
  85452. private _points;
  85453. private _length;
  85454. /**
  85455. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  85456. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  85457. * @param v1 (Vector3) the control point
  85458. * @param v2 (Vector3) the end point of the Quadratic Bezier
  85459. * @param nbPoints (integer) the wanted number of points in the curve
  85460. * @returns the created Curve3
  85461. */
  85462. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85463. /**
  85464. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  85465. * @param v0 (Vector3) the origin point of the Cubic Bezier
  85466. * @param v1 (Vector3) the first control point
  85467. * @param v2 (Vector3) the second control point
  85468. * @param v3 (Vector3) the end point of the Cubic Bezier
  85469. * @param nbPoints (integer) the wanted number of points in the curve
  85470. * @returns the created Curve3
  85471. */
  85472. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85473. /**
  85474. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  85475. * @param p1 (Vector3) the origin point of the Hermite Spline
  85476. * @param t1 (Vector3) the tangent vector at the origin point
  85477. * @param p2 (Vector3) the end point of the Hermite Spline
  85478. * @param t2 (Vector3) the tangent vector at the end point
  85479. * @param nbPoints (integer) the wanted number of points in the curve
  85480. * @returns the created Curve3
  85481. */
  85482. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85483. /**
  85484. * Returns a Curve3 object along a CatmullRom Spline curve :
  85485. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  85486. * @param nbPoints (integer) the wanted number of points between each curve control points
  85487. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  85488. * @returns the created Curve3
  85489. */
  85490. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  85491. /**
  85492. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  85493. * A Curve3 is designed from a series of successive Vector3.
  85494. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  85495. * @param points points which make up the curve
  85496. */
  85497. constructor(points: Vector3[]);
  85498. /**
  85499. * @returns the Curve3 stored array of successive Vector3
  85500. */
  85501. getPoints(): Vector3[];
  85502. /**
  85503. * @returns the computed length (float) of the curve.
  85504. */
  85505. length(): number;
  85506. /**
  85507. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  85508. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  85509. * curveA and curveB keep unchanged.
  85510. * @param curve the curve to continue from this curve
  85511. * @returns the newly constructed curve
  85512. */
  85513. continue(curve: DeepImmutable<Curve3>): Curve3;
  85514. private _computeLength;
  85515. }
  85516. }
  85517. declare module BABYLON {
  85518. /**
  85519. * This represents the main contract an easing function should follow.
  85520. * Easing functions are used throughout the animation system.
  85521. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85522. */
  85523. export interface IEasingFunction {
  85524. /**
  85525. * Given an input gradient between 0 and 1, this returns the corrseponding value
  85526. * of the easing function.
  85527. * The link below provides some of the most common examples of easing functions.
  85528. * @see https://easings.net/
  85529. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85530. * @returns the corresponding value on the curve defined by the easing function
  85531. */
  85532. ease(gradient: number): number;
  85533. }
  85534. /**
  85535. * Base class used for every default easing function.
  85536. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85537. */
  85538. export class EasingFunction implements IEasingFunction {
  85539. /**
  85540. * Interpolation follows the mathematical formula associated with the easing function.
  85541. */
  85542. static readonly EASINGMODE_EASEIN: number;
  85543. /**
  85544. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  85545. */
  85546. static readonly EASINGMODE_EASEOUT: number;
  85547. /**
  85548. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  85549. */
  85550. static readonly EASINGMODE_EASEINOUT: number;
  85551. private _easingMode;
  85552. /**
  85553. * Sets the easing mode of the current function.
  85554. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  85555. */
  85556. setEasingMode(easingMode: number): void;
  85557. /**
  85558. * Gets the current easing mode.
  85559. * @returns the easing mode
  85560. */
  85561. getEasingMode(): number;
  85562. /**
  85563. * @hidden
  85564. */
  85565. easeInCore(gradient: number): number;
  85566. /**
  85567. * Given an input gradient between 0 and 1, this returns the corresponding value
  85568. * of the easing function.
  85569. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85570. * @returns the corresponding value on the curve defined by the easing function
  85571. */
  85572. ease(gradient: number): number;
  85573. }
  85574. /**
  85575. * Easing function with a circle shape (see link below).
  85576. * @see https://easings.net/#easeInCirc
  85577. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85578. */
  85579. export class CircleEase extends EasingFunction implements IEasingFunction {
  85580. /** @hidden */
  85581. easeInCore(gradient: number): number;
  85582. }
  85583. /**
  85584. * Easing function with a ease back shape (see link below).
  85585. * @see https://easings.net/#easeInBack
  85586. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85587. */
  85588. export class BackEase extends EasingFunction implements IEasingFunction {
  85589. /** Defines the amplitude of the function */
  85590. amplitude: number;
  85591. /**
  85592. * Instantiates a back ease easing
  85593. * @see https://easings.net/#easeInBack
  85594. * @param amplitude Defines the amplitude of the function
  85595. */
  85596. constructor(
  85597. /** Defines the amplitude of the function */
  85598. amplitude?: number);
  85599. /** @hidden */
  85600. easeInCore(gradient: number): number;
  85601. }
  85602. /**
  85603. * Easing function with a bouncing shape (see link below).
  85604. * @see https://easings.net/#easeInBounce
  85605. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85606. */
  85607. export class BounceEase extends EasingFunction implements IEasingFunction {
  85608. /** Defines the number of bounces */
  85609. bounces: number;
  85610. /** Defines the amplitude of the bounce */
  85611. bounciness: number;
  85612. /**
  85613. * Instantiates a bounce easing
  85614. * @see https://easings.net/#easeInBounce
  85615. * @param bounces Defines the number of bounces
  85616. * @param bounciness Defines the amplitude of the bounce
  85617. */
  85618. constructor(
  85619. /** Defines the number of bounces */
  85620. bounces?: number,
  85621. /** Defines the amplitude of the bounce */
  85622. bounciness?: number);
  85623. /** @hidden */
  85624. easeInCore(gradient: number): number;
  85625. }
  85626. /**
  85627. * Easing function with a power of 3 shape (see link below).
  85628. * @see https://easings.net/#easeInCubic
  85629. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85630. */
  85631. export class CubicEase extends EasingFunction implements IEasingFunction {
  85632. /** @hidden */
  85633. easeInCore(gradient: number): number;
  85634. }
  85635. /**
  85636. * Easing function with an elastic shape (see link below).
  85637. * @see https://easings.net/#easeInElastic
  85638. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85639. */
  85640. export class ElasticEase extends EasingFunction implements IEasingFunction {
  85641. /** Defines the number of oscillations*/
  85642. oscillations: number;
  85643. /** Defines the amplitude of the oscillations*/
  85644. springiness: number;
  85645. /**
  85646. * Instantiates an elastic easing function
  85647. * @see https://easings.net/#easeInElastic
  85648. * @param oscillations Defines the number of oscillations
  85649. * @param springiness Defines the amplitude of the oscillations
  85650. */
  85651. constructor(
  85652. /** Defines the number of oscillations*/
  85653. oscillations?: number,
  85654. /** Defines the amplitude of the oscillations*/
  85655. springiness?: number);
  85656. /** @hidden */
  85657. easeInCore(gradient: number): number;
  85658. }
  85659. /**
  85660. * Easing function with an exponential shape (see link below).
  85661. * @see https://easings.net/#easeInExpo
  85662. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85663. */
  85664. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85665. /** Defines the exponent of the function */
  85666. exponent: number;
  85667. /**
  85668. * Instantiates an exponential easing function
  85669. * @see https://easings.net/#easeInExpo
  85670. * @param exponent Defines the exponent of the function
  85671. */
  85672. constructor(
  85673. /** Defines the exponent of the function */
  85674. exponent?: number);
  85675. /** @hidden */
  85676. easeInCore(gradient: number): number;
  85677. }
  85678. /**
  85679. * Easing function with a power shape (see link below).
  85680. * @see https://easings.net/#easeInQuad
  85681. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85682. */
  85683. export class PowerEase extends EasingFunction implements IEasingFunction {
  85684. /** Defines the power of the function */
  85685. power: number;
  85686. /**
  85687. * Instantiates an power base easing function
  85688. * @see https://easings.net/#easeInQuad
  85689. * @param power Defines the power of the function
  85690. */
  85691. constructor(
  85692. /** Defines the power of the function */
  85693. power?: number);
  85694. /** @hidden */
  85695. easeInCore(gradient: number): number;
  85696. }
  85697. /**
  85698. * Easing function with a power of 2 shape (see link below).
  85699. * @see https://easings.net/#easeInQuad
  85700. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85701. */
  85702. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85703. /** @hidden */
  85704. easeInCore(gradient: number): number;
  85705. }
  85706. /**
  85707. * Easing function with a power of 4 shape (see link below).
  85708. * @see https://easings.net/#easeInQuart
  85709. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85710. */
  85711. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85712. /** @hidden */
  85713. easeInCore(gradient: number): number;
  85714. }
  85715. /**
  85716. * Easing function with a power of 5 shape (see link below).
  85717. * @see https://easings.net/#easeInQuint
  85718. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85719. */
  85720. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85721. /** @hidden */
  85722. easeInCore(gradient: number): number;
  85723. }
  85724. /**
  85725. * Easing function with a sin shape (see link below).
  85726. * @see https://easings.net/#easeInSine
  85727. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85728. */
  85729. export class SineEase extends EasingFunction implements IEasingFunction {
  85730. /** @hidden */
  85731. easeInCore(gradient: number): number;
  85732. }
  85733. /**
  85734. * Easing function with a bezier shape (see link below).
  85735. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85736. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85737. */
  85738. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85739. /** Defines the x component of the start tangent in the bezier curve */
  85740. x1: number;
  85741. /** Defines the y component of the start tangent in the bezier curve */
  85742. y1: number;
  85743. /** Defines the x component of the end tangent in the bezier curve */
  85744. x2: number;
  85745. /** Defines the y component of the end tangent in the bezier curve */
  85746. y2: number;
  85747. /**
  85748. * Instantiates a bezier function
  85749. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85750. * @param x1 Defines the x component of the start tangent in the bezier curve
  85751. * @param y1 Defines the y component of the start tangent in the bezier curve
  85752. * @param x2 Defines the x component of the end tangent in the bezier curve
  85753. * @param y2 Defines the y component of the end tangent in the bezier curve
  85754. */
  85755. constructor(
  85756. /** Defines the x component of the start tangent in the bezier curve */
  85757. x1?: number,
  85758. /** Defines the y component of the start tangent in the bezier curve */
  85759. y1?: number,
  85760. /** Defines the x component of the end tangent in the bezier curve */
  85761. x2?: number,
  85762. /** Defines the y component of the end tangent in the bezier curve */
  85763. y2?: number);
  85764. /** @hidden */
  85765. easeInCore(gradient: number): number;
  85766. }
  85767. }
  85768. declare module BABYLON {
  85769. /**
  85770. * Class used to hold a RBG color
  85771. */
  85772. export class Color3 {
  85773. /**
  85774. * Defines the red component (between 0 and 1, default is 0)
  85775. */
  85776. r: number;
  85777. /**
  85778. * Defines the green component (between 0 and 1, default is 0)
  85779. */
  85780. g: number;
  85781. /**
  85782. * Defines the blue component (between 0 and 1, default is 0)
  85783. */
  85784. b: number;
  85785. /**
  85786. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85787. * @param r defines the red component (between 0 and 1, default is 0)
  85788. * @param g defines the green component (between 0 and 1, default is 0)
  85789. * @param b defines the blue component (between 0 and 1, default is 0)
  85790. */
  85791. constructor(
  85792. /**
  85793. * Defines the red component (between 0 and 1, default is 0)
  85794. */
  85795. r?: number,
  85796. /**
  85797. * Defines the green component (between 0 and 1, default is 0)
  85798. */
  85799. g?: number,
  85800. /**
  85801. * Defines the blue component (between 0 and 1, default is 0)
  85802. */
  85803. b?: number);
  85804. /**
  85805. * Creates a string with the Color3 current values
  85806. * @returns the string representation of the Color3 object
  85807. */
  85808. toString(): string;
  85809. /**
  85810. * Returns the string "Color3"
  85811. * @returns "Color3"
  85812. */
  85813. getClassName(): string;
  85814. /**
  85815. * Compute the Color3 hash code
  85816. * @returns an unique number that can be used to hash Color3 objects
  85817. */
  85818. getHashCode(): number;
  85819. /**
  85820. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85821. * @param array defines the array where to store the r,g,b components
  85822. * @param index defines an optional index in the target array to define where to start storing values
  85823. * @returns the current Color3 object
  85824. */
  85825. toArray(array: FloatArray, index?: number): Color3;
  85826. /**
  85827. * Update the current color with values stored in an array from the starting index of the given array
  85828. * @param array defines the source array
  85829. * @param offset defines an offset in the source array
  85830. * @returns the current Color3 object
  85831. */
  85832. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85833. /**
  85834. * Returns a new Color4 object from the current Color3 and the given alpha
  85835. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85836. * @returns a new Color4 object
  85837. */
  85838. toColor4(alpha?: number): Color4;
  85839. /**
  85840. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85841. * @returns the new array
  85842. */
  85843. asArray(): number[];
  85844. /**
  85845. * Returns the luminance value
  85846. * @returns a float value
  85847. */
  85848. toLuminance(): number;
  85849. /**
  85850. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85851. * @param otherColor defines the second operand
  85852. * @returns the new Color3 object
  85853. */
  85854. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85855. /**
  85856. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85857. * @param otherColor defines the second operand
  85858. * @param result defines the Color3 object where to store the result
  85859. * @returns the current Color3
  85860. */
  85861. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85862. /**
  85863. * Determines equality between Color3 objects
  85864. * @param otherColor defines the second operand
  85865. * @returns true if the rgb values are equal to the given ones
  85866. */
  85867. equals(otherColor: DeepImmutable<Color3>): boolean;
  85868. /**
  85869. * Determines equality between the current Color3 object and a set of r,b,g values
  85870. * @param r defines the red component to check
  85871. * @param g defines the green component to check
  85872. * @param b defines the blue component to check
  85873. * @returns true if the rgb values are equal to the given ones
  85874. */
  85875. equalsFloats(r: number, g: number, b: number): boolean;
  85876. /**
  85877. * Multiplies in place each rgb value by scale
  85878. * @param scale defines the scaling factor
  85879. * @returns the updated Color3
  85880. */
  85881. scale(scale: number): Color3;
  85882. /**
  85883. * Multiplies the rgb values by scale and stores the result into "result"
  85884. * @param scale defines the scaling factor
  85885. * @param result defines the Color3 object where to store the result
  85886. * @returns the unmodified current Color3
  85887. */
  85888. scaleToRef(scale: number, result: Color3): Color3;
  85889. /**
  85890. * Scale the current Color3 values by a factor and add the result to a given Color3
  85891. * @param scale defines the scale factor
  85892. * @param result defines color to store the result into
  85893. * @returns the unmodified current Color3
  85894. */
  85895. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85896. /**
  85897. * Clamps the rgb values by the min and max values and stores the result into "result"
  85898. * @param min defines minimum clamping value (default is 0)
  85899. * @param max defines maximum clamping value (default is 1)
  85900. * @param result defines color to store the result into
  85901. * @returns the original Color3
  85902. */
  85903. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85904. /**
  85905. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85906. * @param otherColor defines the second operand
  85907. * @returns the new Color3
  85908. */
  85909. add(otherColor: DeepImmutable<Color3>): Color3;
  85910. /**
  85911. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85912. * @param otherColor defines the second operand
  85913. * @param result defines Color3 object to store the result into
  85914. * @returns the unmodified current Color3
  85915. */
  85916. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85917. /**
  85918. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85919. * @param otherColor defines the second operand
  85920. * @returns the new Color3
  85921. */
  85922. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85923. /**
  85924. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85925. * @param otherColor defines the second operand
  85926. * @param result defines Color3 object to store the result into
  85927. * @returns the unmodified current Color3
  85928. */
  85929. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85930. /**
  85931. * Copy the current object
  85932. * @returns a new Color3 copied the current one
  85933. */
  85934. clone(): Color3;
  85935. /**
  85936. * Copies the rgb values from the source in the current Color3
  85937. * @param source defines the source Color3 object
  85938. * @returns the updated Color3 object
  85939. */
  85940. copyFrom(source: DeepImmutable<Color3>): Color3;
  85941. /**
  85942. * Updates the Color3 rgb values from the given floats
  85943. * @param r defines the red component to read from
  85944. * @param g defines the green component to read from
  85945. * @param b defines the blue component to read from
  85946. * @returns the current Color3 object
  85947. */
  85948. copyFromFloats(r: number, g: number, b: number): Color3;
  85949. /**
  85950. * Updates the Color3 rgb values from the given floats
  85951. * @param r defines the red component to read from
  85952. * @param g defines the green component to read from
  85953. * @param b defines the blue component to read from
  85954. * @returns the current Color3 object
  85955. */
  85956. set(r: number, g: number, b: number): Color3;
  85957. /**
  85958. * Compute the Color3 hexadecimal code as a string
  85959. * @returns a string containing the hexadecimal representation of the Color3 object
  85960. */
  85961. toHexString(): string;
  85962. /**
  85963. * Computes a new Color3 converted from the current one to linear space
  85964. * @returns a new Color3 object
  85965. */
  85966. toLinearSpace(): Color3;
  85967. /**
  85968. * Converts current color in rgb space to HSV values
  85969. * @returns a new color3 representing the HSV values
  85970. */
  85971. toHSV(): Color3;
  85972. /**
  85973. * Converts current color in rgb space to HSV values
  85974. * @param result defines the Color3 where to store the HSV values
  85975. */
  85976. toHSVToRef(result: Color3): void;
  85977. /**
  85978. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85979. * @param convertedColor defines the Color3 object where to store the linear space version
  85980. * @returns the unmodified Color3
  85981. */
  85982. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85983. /**
  85984. * Computes a new Color3 converted from the current one to gamma space
  85985. * @returns a new Color3 object
  85986. */
  85987. toGammaSpace(): Color3;
  85988. /**
  85989. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85990. * @param convertedColor defines the Color3 object where to store the gamma space version
  85991. * @returns the unmodified Color3
  85992. */
  85993. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85994. private static _BlackReadOnly;
  85995. /**
  85996. * Convert Hue, saturation and value to a Color3 (RGB)
  85997. * @param hue defines the hue
  85998. * @param saturation defines the saturation
  85999. * @param value defines the value
  86000. * @param result defines the Color3 where to store the RGB values
  86001. */
  86002. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  86003. /**
  86004. * Creates a new Color3 from the string containing valid hexadecimal values
  86005. * @param hex defines a string containing valid hexadecimal values
  86006. * @returns a new Color3 object
  86007. */
  86008. static FromHexString(hex: string): Color3;
  86009. /**
  86010. * Creates a new Color3 from the starting index of the given array
  86011. * @param array defines the source array
  86012. * @param offset defines an offset in the source array
  86013. * @returns a new Color3 object
  86014. */
  86015. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  86016. /**
  86017. * Creates a new Color3 from the starting index element of the given array
  86018. * @param array defines the source array to read from
  86019. * @param offset defines the offset in the source array
  86020. * @param result defines the target Color3 object
  86021. */
  86022. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  86023. /**
  86024. * Creates a new Color3 from integer values (< 256)
  86025. * @param r defines the red component to read from (value between 0 and 255)
  86026. * @param g defines the green component to read from (value between 0 and 255)
  86027. * @param b defines the blue component to read from (value between 0 and 255)
  86028. * @returns a new Color3 object
  86029. */
  86030. static FromInts(r: number, g: number, b: number): Color3;
  86031. /**
  86032. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  86033. * @param start defines the start Color3 value
  86034. * @param end defines the end Color3 value
  86035. * @param amount defines the gradient value between start and end
  86036. * @returns a new Color3 object
  86037. */
  86038. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  86039. /**
  86040. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  86041. * @param left defines the start value
  86042. * @param right defines the end value
  86043. * @param amount defines the gradient factor
  86044. * @param result defines the Color3 object where to store the result
  86045. */
  86046. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  86047. /**
  86048. * Returns a Color3 value containing a red color
  86049. * @returns a new Color3 object
  86050. */
  86051. static Red(): Color3;
  86052. /**
  86053. * Returns a Color3 value containing a green color
  86054. * @returns a new Color3 object
  86055. */
  86056. static Green(): Color3;
  86057. /**
  86058. * Returns a Color3 value containing a blue color
  86059. * @returns a new Color3 object
  86060. */
  86061. static Blue(): Color3;
  86062. /**
  86063. * Returns a Color3 value containing a black color
  86064. * @returns a new Color3 object
  86065. */
  86066. static Black(): Color3;
  86067. /**
  86068. * Gets a Color3 value containing a black color that must not be updated
  86069. */
  86070. static get BlackReadOnly(): DeepImmutable<Color3>;
  86071. /**
  86072. * Returns a Color3 value containing a white color
  86073. * @returns a new Color3 object
  86074. */
  86075. static White(): Color3;
  86076. /**
  86077. * Returns a Color3 value containing a purple color
  86078. * @returns a new Color3 object
  86079. */
  86080. static Purple(): Color3;
  86081. /**
  86082. * Returns a Color3 value containing a magenta color
  86083. * @returns a new Color3 object
  86084. */
  86085. static Magenta(): Color3;
  86086. /**
  86087. * Returns a Color3 value containing a yellow color
  86088. * @returns a new Color3 object
  86089. */
  86090. static Yellow(): Color3;
  86091. /**
  86092. * Returns a Color3 value containing a gray color
  86093. * @returns a new Color3 object
  86094. */
  86095. static Gray(): Color3;
  86096. /**
  86097. * Returns a Color3 value containing a teal color
  86098. * @returns a new Color3 object
  86099. */
  86100. static Teal(): Color3;
  86101. /**
  86102. * Returns a Color3 value containing a random color
  86103. * @returns a new Color3 object
  86104. */
  86105. static Random(): Color3;
  86106. }
  86107. /**
  86108. * Class used to hold a RBGA color
  86109. */
  86110. export class Color4 {
  86111. /**
  86112. * Defines the red component (between 0 and 1, default is 0)
  86113. */
  86114. r: number;
  86115. /**
  86116. * Defines the green component (between 0 and 1, default is 0)
  86117. */
  86118. g: number;
  86119. /**
  86120. * Defines the blue component (between 0 and 1, default is 0)
  86121. */
  86122. b: number;
  86123. /**
  86124. * Defines the alpha component (between 0 and 1, default is 1)
  86125. */
  86126. a: number;
  86127. /**
  86128. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  86129. * @param r defines the red component (between 0 and 1, default is 0)
  86130. * @param g defines the green component (between 0 and 1, default is 0)
  86131. * @param b defines the blue component (between 0 and 1, default is 0)
  86132. * @param a defines the alpha component (between 0 and 1, default is 1)
  86133. */
  86134. constructor(
  86135. /**
  86136. * Defines the red component (between 0 and 1, default is 0)
  86137. */
  86138. r?: number,
  86139. /**
  86140. * Defines the green component (between 0 and 1, default is 0)
  86141. */
  86142. g?: number,
  86143. /**
  86144. * Defines the blue component (between 0 and 1, default is 0)
  86145. */
  86146. b?: number,
  86147. /**
  86148. * Defines the alpha component (between 0 and 1, default is 1)
  86149. */
  86150. a?: number);
  86151. /**
  86152. * Adds in place the given Color4 values to the current Color4 object
  86153. * @param right defines the second operand
  86154. * @returns the current updated Color4 object
  86155. */
  86156. addInPlace(right: DeepImmutable<Color4>): Color4;
  86157. /**
  86158. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  86159. * @returns the new array
  86160. */
  86161. asArray(): number[];
  86162. /**
  86163. * Stores from the starting index in the given array the Color4 successive values
  86164. * @param array defines the array where to store the r,g,b components
  86165. * @param index defines an optional index in the target array to define where to start storing values
  86166. * @returns the current Color4 object
  86167. */
  86168. toArray(array: number[], index?: number): Color4;
  86169. /**
  86170. * Update the current color with values stored in an array from the starting index of the given array
  86171. * @param array defines the source array
  86172. * @param offset defines an offset in the source array
  86173. * @returns the current Color4 object
  86174. */
  86175. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  86176. /**
  86177. * Determines equality between Color4 objects
  86178. * @param otherColor defines the second operand
  86179. * @returns true if the rgba values are equal to the given ones
  86180. */
  86181. equals(otherColor: DeepImmutable<Color4>): boolean;
  86182. /**
  86183. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  86184. * @param right defines the second operand
  86185. * @returns a new Color4 object
  86186. */
  86187. add(right: DeepImmutable<Color4>): Color4;
  86188. /**
  86189. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  86190. * @param right defines the second operand
  86191. * @returns a new Color4 object
  86192. */
  86193. subtract(right: DeepImmutable<Color4>): Color4;
  86194. /**
  86195. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  86196. * @param right defines the second operand
  86197. * @param result defines the Color4 object where to store the result
  86198. * @returns the current Color4 object
  86199. */
  86200. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  86201. /**
  86202. * Creates a new Color4 with the current Color4 values multiplied by scale
  86203. * @param scale defines the scaling factor to apply
  86204. * @returns a new Color4 object
  86205. */
  86206. scale(scale: number): Color4;
  86207. /**
  86208. * Multiplies the current Color4 values by scale and stores the result in "result"
  86209. * @param scale defines the scaling factor to apply
  86210. * @param result defines the Color4 object where to store the result
  86211. * @returns the current unmodified Color4
  86212. */
  86213. scaleToRef(scale: number, result: Color4): Color4;
  86214. /**
  86215. * Scale the current Color4 values by a factor and add the result to a given Color4
  86216. * @param scale defines the scale factor
  86217. * @param result defines the Color4 object where to store the result
  86218. * @returns the unmodified current Color4
  86219. */
  86220. scaleAndAddToRef(scale: number, result: Color4): Color4;
  86221. /**
  86222. * Clamps the rgb values by the min and max values and stores the result into "result"
  86223. * @param min defines minimum clamping value (default is 0)
  86224. * @param max defines maximum clamping value (default is 1)
  86225. * @param result defines color to store the result into.
  86226. * @returns the cuurent Color4
  86227. */
  86228. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  86229. /**
  86230. * Multipy an Color4 value by another and return a new Color4 object
  86231. * @param color defines the Color4 value to multiply by
  86232. * @returns a new Color4 object
  86233. */
  86234. multiply(color: Color4): Color4;
  86235. /**
  86236. * Multipy a Color4 value by another and push the result in a reference value
  86237. * @param color defines the Color4 value to multiply by
  86238. * @param result defines the Color4 to fill the result in
  86239. * @returns the result Color4
  86240. */
  86241. multiplyToRef(color: Color4, result: Color4): Color4;
  86242. /**
  86243. * Creates a string with the Color4 current values
  86244. * @returns the string representation of the Color4 object
  86245. */
  86246. toString(): string;
  86247. /**
  86248. * Returns the string "Color4"
  86249. * @returns "Color4"
  86250. */
  86251. getClassName(): string;
  86252. /**
  86253. * Compute the Color4 hash code
  86254. * @returns an unique number that can be used to hash Color4 objects
  86255. */
  86256. getHashCode(): number;
  86257. /**
  86258. * Creates a new Color4 copied from the current one
  86259. * @returns a new Color4 object
  86260. */
  86261. clone(): Color4;
  86262. /**
  86263. * Copies the given Color4 values into the current one
  86264. * @param source defines the source Color4 object
  86265. * @returns the current updated Color4 object
  86266. */
  86267. copyFrom(source: Color4): Color4;
  86268. /**
  86269. * Copies the given float values into the current one
  86270. * @param r defines the red component to read from
  86271. * @param g defines the green component to read from
  86272. * @param b defines the blue component to read from
  86273. * @param a defines the alpha component to read from
  86274. * @returns the current updated Color4 object
  86275. */
  86276. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  86277. /**
  86278. * Copies the given float values into the current one
  86279. * @param r defines the red component to read from
  86280. * @param g defines the green component to read from
  86281. * @param b defines the blue component to read from
  86282. * @param a defines the alpha component to read from
  86283. * @returns the current updated Color4 object
  86284. */
  86285. set(r: number, g: number, b: number, a: number): Color4;
  86286. /**
  86287. * Compute the Color4 hexadecimal code as a string
  86288. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  86289. * @returns a string containing the hexadecimal representation of the Color4 object
  86290. */
  86291. toHexString(returnAsColor3?: boolean): string;
  86292. /**
  86293. * Computes a new Color4 converted from the current one to linear space
  86294. * @returns a new Color4 object
  86295. */
  86296. toLinearSpace(): Color4;
  86297. /**
  86298. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  86299. * @param convertedColor defines the Color4 object where to store the linear space version
  86300. * @returns the unmodified Color4
  86301. */
  86302. toLinearSpaceToRef(convertedColor: Color4): Color4;
  86303. /**
  86304. * Computes a new Color4 converted from the current one to gamma space
  86305. * @returns a new Color4 object
  86306. */
  86307. toGammaSpace(): Color4;
  86308. /**
  86309. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  86310. * @param convertedColor defines the Color4 object where to store the gamma space version
  86311. * @returns the unmodified Color4
  86312. */
  86313. toGammaSpaceToRef(convertedColor: Color4): Color4;
  86314. /**
  86315. * Creates a new Color4 from the string containing valid hexadecimal values
  86316. * @param hex defines a string containing valid hexadecimal values
  86317. * @returns a new Color4 object
  86318. */
  86319. static FromHexString(hex: string): Color4;
  86320. /**
  86321. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  86322. * @param left defines the start value
  86323. * @param right defines the end value
  86324. * @param amount defines the gradient factor
  86325. * @returns a new Color4 object
  86326. */
  86327. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  86328. /**
  86329. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  86330. * @param left defines the start value
  86331. * @param right defines the end value
  86332. * @param amount defines the gradient factor
  86333. * @param result defines the Color4 object where to store data
  86334. */
  86335. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  86336. /**
  86337. * Creates a new Color4 from a Color3 and an alpha value
  86338. * @param color3 defines the source Color3 to read from
  86339. * @param alpha defines the alpha component (1.0 by default)
  86340. * @returns a new Color4 object
  86341. */
  86342. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  86343. /**
  86344. * Creates a new Color4 from the starting index element of the given array
  86345. * @param array defines the source array to read from
  86346. * @param offset defines the offset in the source array
  86347. * @returns a new Color4 object
  86348. */
  86349. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  86350. /**
  86351. * Creates a new Color4 from the starting index element of the given array
  86352. * @param array defines the source array to read from
  86353. * @param offset defines the offset in the source array
  86354. * @param result defines the target Color4 object
  86355. */
  86356. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  86357. /**
  86358. * Creates a new Color3 from integer values (< 256)
  86359. * @param r defines the red component to read from (value between 0 and 255)
  86360. * @param g defines the green component to read from (value between 0 and 255)
  86361. * @param b defines the blue component to read from (value between 0 and 255)
  86362. * @param a defines the alpha component to read from (value between 0 and 255)
  86363. * @returns a new Color3 object
  86364. */
  86365. static FromInts(r: number, g: number, b: number, a: number): Color4;
  86366. /**
  86367. * Check the content of a given array and convert it to an array containing RGBA data
  86368. * If the original array was already containing count * 4 values then it is returned directly
  86369. * @param colors defines the array to check
  86370. * @param count defines the number of RGBA data to expect
  86371. * @returns an array containing count * 4 values (RGBA)
  86372. */
  86373. static CheckColors4(colors: number[], count: number): number[];
  86374. }
  86375. /**
  86376. * @hidden
  86377. */
  86378. export class TmpColors {
  86379. static Color3: Color3[];
  86380. static Color4: Color4[];
  86381. }
  86382. }
  86383. declare module BABYLON {
  86384. /**
  86385. * Defines an interface which represents an animation key frame
  86386. */
  86387. export interface IAnimationKey {
  86388. /**
  86389. * Frame of the key frame
  86390. */
  86391. frame: number;
  86392. /**
  86393. * Value at the specifies key frame
  86394. */
  86395. value: any;
  86396. /**
  86397. * The input tangent for the cubic hermite spline
  86398. */
  86399. inTangent?: any;
  86400. /**
  86401. * The output tangent for the cubic hermite spline
  86402. */
  86403. outTangent?: any;
  86404. /**
  86405. * The animation interpolation type
  86406. */
  86407. interpolation?: AnimationKeyInterpolation;
  86408. }
  86409. /**
  86410. * Enum for the animation key frame interpolation type
  86411. */
  86412. export enum AnimationKeyInterpolation {
  86413. /**
  86414. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  86415. */
  86416. STEP = 1
  86417. }
  86418. }
  86419. declare module BABYLON {
  86420. /**
  86421. * Represents the range of an animation
  86422. */
  86423. export class AnimationRange {
  86424. /**The name of the animation range**/
  86425. name: string;
  86426. /**The starting frame of the animation */
  86427. from: number;
  86428. /**The ending frame of the animation*/
  86429. to: number;
  86430. /**
  86431. * Initializes the range of an animation
  86432. * @param name The name of the animation range
  86433. * @param from The starting frame of the animation
  86434. * @param to The ending frame of the animation
  86435. */
  86436. constructor(
  86437. /**The name of the animation range**/
  86438. name: string,
  86439. /**The starting frame of the animation */
  86440. from: number,
  86441. /**The ending frame of the animation*/
  86442. to: number);
  86443. /**
  86444. * Makes a copy of the animation range
  86445. * @returns A copy of the animation range
  86446. */
  86447. clone(): AnimationRange;
  86448. }
  86449. }
  86450. declare module BABYLON {
  86451. /**
  86452. * Composed of a frame, and an action function
  86453. */
  86454. export class AnimationEvent {
  86455. /** The frame for which the event is triggered **/
  86456. frame: number;
  86457. /** The event to perform when triggered **/
  86458. action: (currentFrame: number) => void;
  86459. /** Specifies if the event should be triggered only once**/
  86460. onlyOnce?: boolean | undefined;
  86461. /**
  86462. * Specifies if the animation event is done
  86463. */
  86464. isDone: boolean;
  86465. /**
  86466. * Initializes the animation event
  86467. * @param frame The frame for which the event is triggered
  86468. * @param action The event to perform when triggered
  86469. * @param onlyOnce Specifies if the event should be triggered only once
  86470. */
  86471. constructor(
  86472. /** The frame for which the event is triggered **/
  86473. frame: number,
  86474. /** The event to perform when triggered **/
  86475. action: (currentFrame: number) => void,
  86476. /** Specifies if the event should be triggered only once**/
  86477. onlyOnce?: boolean | undefined);
  86478. /** @hidden */
  86479. _clone(): AnimationEvent;
  86480. }
  86481. }
  86482. declare module BABYLON {
  86483. /**
  86484. * Interface used to define a behavior
  86485. */
  86486. export interface Behavior<T> {
  86487. /** gets or sets behavior's name */
  86488. name: string;
  86489. /**
  86490. * Function called when the behavior needs to be initialized (after attaching it to a target)
  86491. */
  86492. init(): void;
  86493. /**
  86494. * Called when the behavior is attached to a target
  86495. * @param target defines the target where the behavior is attached to
  86496. */
  86497. attach(target: T): void;
  86498. /**
  86499. * Called when the behavior is detached from its target
  86500. */
  86501. detach(): void;
  86502. }
  86503. /**
  86504. * Interface implemented by classes supporting behaviors
  86505. */
  86506. export interface IBehaviorAware<T> {
  86507. /**
  86508. * Attach a behavior
  86509. * @param behavior defines the behavior to attach
  86510. * @returns the current host
  86511. */
  86512. addBehavior(behavior: Behavior<T>): T;
  86513. /**
  86514. * Remove a behavior from the current object
  86515. * @param behavior defines the behavior to detach
  86516. * @returns the current host
  86517. */
  86518. removeBehavior(behavior: Behavior<T>): T;
  86519. /**
  86520. * Gets a behavior using its name to search
  86521. * @param name defines the name to search
  86522. * @returns the behavior or null if not found
  86523. */
  86524. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  86525. }
  86526. }
  86527. declare module BABYLON {
  86528. /**
  86529. * Defines an array and its length.
  86530. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  86531. */
  86532. export interface ISmartArrayLike<T> {
  86533. /**
  86534. * The data of the array.
  86535. */
  86536. data: Array<T>;
  86537. /**
  86538. * The active length of the array.
  86539. */
  86540. length: number;
  86541. }
  86542. /**
  86543. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86544. */
  86545. export class SmartArray<T> implements ISmartArrayLike<T> {
  86546. /**
  86547. * The full set of data from the array.
  86548. */
  86549. data: Array<T>;
  86550. /**
  86551. * The active length of the array.
  86552. */
  86553. length: number;
  86554. protected _id: number;
  86555. /**
  86556. * Instantiates a Smart Array.
  86557. * @param capacity defines the default capacity of the array.
  86558. */
  86559. constructor(capacity: number);
  86560. /**
  86561. * Pushes a value at the end of the active data.
  86562. * @param value defines the object to push in the array.
  86563. */
  86564. push(value: T): void;
  86565. /**
  86566. * Iterates over the active data and apply the lambda to them.
  86567. * @param func defines the action to apply on each value.
  86568. */
  86569. forEach(func: (content: T) => void): void;
  86570. /**
  86571. * Sorts the full sets of data.
  86572. * @param compareFn defines the comparison function to apply.
  86573. */
  86574. sort(compareFn: (a: T, b: T) => number): void;
  86575. /**
  86576. * Resets the active data to an empty array.
  86577. */
  86578. reset(): void;
  86579. /**
  86580. * Releases all the data from the array as well as the array.
  86581. */
  86582. dispose(): void;
  86583. /**
  86584. * Concats the active data with a given array.
  86585. * @param array defines the data to concatenate with.
  86586. */
  86587. concat(array: any): void;
  86588. /**
  86589. * Returns the position of a value in the active data.
  86590. * @param value defines the value to find the index for
  86591. * @returns the index if found in the active data otherwise -1
  86592. */
  86593. indexOf(value: T): number;
  86594. /**
  86595. * Returns whether an element is part of the active data.
  86596. * @param value defines the value to look for
  86597. * @returns true if found in the active data otherwise false
  86598. */
  86599. contains(value: T): boolean;
  86600. private static _GlobalId;
  86601. }
  86602. /**
  86603. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86604. * The data in this array can only be present once
  86605. */
  86606. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  86607. private _duplicateId;
  86608. /**
  86609. * Pushes a value at the end of the active data.
  86610. * THIS DOES NOT PREVENT DUPPLICATE DATA
  86611. * @param value defines the object to push in the array.
  86612. */
  86613. push(value: T): void;
  86614. /**
  86615. * Pushes a value at the end of the active data.
  86616. * If the data is already present, it won t be added again
  86617. * @param value defines the object to push in the array.
  86618. * @returns true if added false if it was already present
  86619. */
  86620. pushNoDuplicate(value: T): boolean;
  86621. /**
  86622. * Resets the active data to an empty array.
  86623. */
  86624. reset(): void;
  86625. /**
  86626. * Concats the active data with a given array.
  86627. * This ensures no dupplicate will be present in the result.
  86628. * @param array defines the data to concatenate with.
  86629. */
  86630. concatWithNoDuplicate(array: any): void;
  86631. }
  86632. }
  86633. declare module BABYLON {
  86634. /**
  86635. * @ignore
  86636. * This is a list of all the different input types that are available in the application.
  86637. * Fo instance: ArcRotateCameraGamepadInput...
  86638. */
  86639. export var CameraInputTypes: {};
  86640. /**
  86641. * This is the contract to implement in order to create a new input class.
  86642. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86643. */
  86644. export interface ICameraInput<TCamera extends Camera> {
  86645. /**
  86646. * Defines the camera the input is attached to.
  86647. */
  86648. camera: Nullable<TCamera>;
  86649. /**
  86650. * Gets the class name of the current intput.
  86651. * @returns the class name
  86652. */
  86653. getClassName(): string;
  86654. /**
  86655. * Get the friendly name associated with the input class.
  86656. * @returns the input friendly name
  86657. */
  86658. getSimpleName(): string;
  86659. /**
  86660. * Attach the input controls to a specific dom element to get the input from.
  86661. * @param element Defines the element the controls should be listened from
  86662. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86663. */
  86664. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86665. /**
  86666. * Detach the current controls from the specified dom element.
  86667. * @param element Defines the element to stop listening the inputs from
  86668. */
  86669. detachControl(element: Nullable<HTMLElement>): void;
  86670. /**
  86671. * Update the current camera state depending on the inputs that have been used this frame.
  86672. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86673. */
  86674. checkInputs?: () => void;
  86675. }
  86676. /**
  86677. * Represents a map of input types to input instance or input index to input instance.
  86678. */
  86679. export interface CameraInputsMap<TCamera extends Camera> {
  86680. /**
  86681. * Accessor to the input by input type.
  86682. */
  86683. [name: string]: ICameraInput<TCamera>;
  86684. /**
  86685. * Accessor to the input by input index.
  86686. */
  86687. [idx: number]: ICameraInput<TCamera>;
  86688. }
  86689. /**
  86690. * This represents the input manager used within a camera.
  86691. * It helps dealing with all the different kind of input attached to a camera.
  86692. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86693. */
  86694. export class CameraInputsManager<TCamera extends Camera> {
  86695. /**
  86696. * Defines the list of inputs attahed to the camera.
  86697. */
  86698. attached: CameraInputsMap<TCamera>;
  86699. /**
  86700. * Defines the dom element the camera is collecting inputs from.
  86701. * This is null if the controls have not been attached.
  86702. */
  86703. attachedElement: Nullable<HTMLElement>;
  86704. /**
  86705. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86706. */
  86707. noPreventDefault: boolean;
  86708. /**
  86709. * Defined the camera the input manager belongs to.
  86710. */
  86711. camera: TCamera;
  86712. /**
  86713. * Update the current camera state depending on the inputs that have been used this frame.
  86714. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86715. */
  86716. checkInputs: () => void;
  86717. /**
  86718. * Instantiate a new Camera Input Manager.
  86719. * @param camera Defines the camera the input manager blongs to
  86720. */
  86721. constructor(camera: TCamera);
  86722. /**
  86723. * Add an input method to a camera
  86724. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86725. * @param input camera input method
  86726. */
  86727. add(input: ICameraInput<TCamera>): void;
  86728. /**
  86729. * Remove a specific input method from a camera
  86730. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86731. * @param inputToRemove camera input method
  86732. */
  86733. remove(inputToRemove: ICameraInput<TCamera>): void;
  86734. /**
  86735. * Remove a specific input type from a camera
  86736. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86737. * @param inputType the type of the input to remove
  86738. */
  86739. removeByType(inputType: string): void;
  86740. private _addCheckInputs;
  86741. /**
  86742. * Attach the input controls to the currently attached dom element to listen the events from.
  86743. * @param input Defines the input to attach
  86744. */
  86745. attachInput(input: ICameraInput<TCamera>): void;
  86746. /**
  86747. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86748. * @param element Defines the dom element to collect the events from
  86749. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86750. */
  86751. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86752. /**
  86753. * Detach the current manager inputs controls from a specific dom element.
  86754. * @param element Defines the dom element to collect the events from
  86755. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86756. */
  86757. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86758. /**
  86759. * Rebuild the dynamic inputCheck function from the current list of
  86760. * defined inputs in the manager.
  86761. */
  86762. rebuildInputCheck(): void;
  86763. /**
  86764. * Remove all attached input methods from a camera
  86765. */
  86766. clear(): void;
  86767. /**
  86768. * Serialize the current input manager attached to a camera.
  86769. * This ensures than once parsed,
  86770. * the input associated to the camera will be identical to the current ones
  86771. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86772. */
  86773. serialize(serializedCamera: any): void;
  86774. /**
  86775. * Parses an input manager serialized JSON to restore the previous list of inputs
  86776. * and states associated to a camera.
  86777. * @param parsedCamera Defines the JSON to parse
  86778. */
  86779. parse(parsedCamera: any): void;
  86780. }
  86781. }
  86782. declare module BABYLON {
  86783. /**
  86784. * Class used to store data that will be store in GPU memory
  86785. */
  86786. export class Buffer {
  86787. private _engine;
  86788. private _buffer;
  86789. /** @hidden */
  86790. _data: Nullable<DataArray>;
  86791. private _updatable;
  86792. private _instanced;
  86793. private _divisor;
  86794. /**
  86795. * Gets the byte stride.
  86796. */
  86797. readonly byteStride: number;
  86798. /**
  86799. * Constructor
  86800. * @param engine the engine
  86801. * @param data the data to use for this buffer
  86802. * @param updatable whether the data is updatable
  86803. * @param stride the stride (optional)
  86804. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86805. * @param instanced whether the buffer is instanced (optional)
  86806. * @param useBytes set to true if the stride in in bytes (optional)
  86807. * @param divisor sets an optional divisor for instances (1 by default)
  86808. */
  86809. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86810. /**
  86811. * Create a new VertexBuffer based on the current buffer
  86812. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86813. * @param offset defines offset in the buffer (0 by default)
  86814. * @param size defines the size in floats of attributes (position is 3 for instance)
  86815. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86816. * @param instanced defines if the vertex buffer contains indexed data
  86817. * @param useBytes defines if the offset and stride are in bytes *
  86818. * @param divisor sets an optional divisor for instances (1 by default)
  86819. * @returns the new vertex buffer
  86820. */
  86821. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86822. /**
  86823. * Gets a boolean indicating if the Buffer is updatable?
  86824. * @returns true if the buffer is updatable
  86825. */
  86826. isUpdatable(): boolean;
  86827. /**
  86828. * Gets current buffer's data
  86829. * @returns a DataArray or null
  86830. */
  86831. getData(): Nullable<DataArray>;
  86832. /**
  86833. * Gets underlying native buffer
  86834. * @returns underlying native buffer
  86835. */
  86836. getBuffer(): Nullable<DataBuffer>;
  86837. /**
  86838. * Gets the stride in float32 units (i.e. byte stride / 4).
  86839. * May not be an integer if the byte stride is not divisible by 4.
  86840. * @returns the stride in float32 units
  86841. * @deprecated Please use byteStride instead.
  86842. */
  86843. getStrideSize(): number;
  86844. /**
  86845. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86846. * @param data defines the data to store
  86847. */
  86848. create(data?: Nullable<DataArray>): void;
  86849. /** @hidden */
  86850. _rebuild(): void;
  86851. /**
  86852. * Update current buffer data
  86853. * @param data defines the data to store
  86854. */
  86855. update(data: DataArray): void;
  86856. /**
  86857. * Updates the data directly.
  86858. * @param data the new data
  86859. * @param offset the new offset
  86860. * @param vertexCount the vertex count (optional)
  86861. * @param useBytes set to true if the offset is in bytes
  86862. */
  86863. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86864. /**
  86865. * Release all resources
  86866. */
  86867. dispose(): void;
  86868. }
  86869. /**
  86870. * Specialized buffer used to store vertex data
  86871. */
  86872. export class VertexBuffer {
  86873. /** @hidden */
  86874. _buffer: Buffer;
  86875. private _kind;
  86876. private _size;
  86877. private _ownsBuffer;
  86878. private _instanced;
  86879. private _instanceDivisor;
  86880. /**
  86881. * The byte type.
  86882. */
  86883. static readonly BYTE: number;
  86884. /**
  86885. * The unsigned byte type.
  86886. */
  86887. static readonly UNSIGNED_BYTE: number;
  86888. /**
  86889. * The short type.
  86890. */
  86891. static readonly SHORT: number;
  86892. /**
  86893. * The unsigned short type.
  86894. */
  86895. static readonly UNSIGNED_SHORT: number;
  86896. /**
  86897. * The integer type.
  86898. */
  86899. static readonly INT: number;
  86900. /**
  86901. * The unsigned integer type.
  86902. */
  86903. static readonly UNSIGNED_INT: number;
  86904. /**
  86905. * The float type.
  86906. */
  86907. static readonly FLOAT: number;
  86908. /**
  86909. * Gets or sets the instance divisor when in instanced mode
  86910. */
  86911. get instanceDivisor(): number;
  86912. set instanceDivisor(value: number);
  86913. /**
  86914. * Gets the byte stride.
  86915. */
  86916. readonly byteStride: number;
  86917. /**
  86918. * Gets the byte offset.
  86919. */
  86920. readonly byteOffset: number;
  86921. /**
  86922. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86923. */
  86924. readonly normalized: boolean;
  86925. /**
  86926. * Gets the data type of each component in the array.
  86927. */
  86928. readonly type: number;
  86929. /**
  86930. * Constructor
  86931. * @param engine the engine
  86932. * @param data the data to use for this vertex buffer
  86933. * @param kind the vertex buffer kind
  86934. * @param updatable whether the data is updatable
  86935. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86936. * @param stride the stride (optional)
  86937. * @param instanced whether the buffer is instanced (optional)
  86938. * @param offset the offset of the data (optional)
  86939. * @param size the number of components (optional)
  86940. * @param type the type of the component (optional)
  86941. * @param normalized whether the data contains normalized data (optional)
  86942. * @param useBytes set to true if stride and offset are in bytes (optional)
  86943. * @param divisor defines the instance divisor to use (1 by default)
  86944. */
  86945. 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);
  86946. /** @hidden */
  86947. _rebuild(): void;
  86948. /**
  86949. * Returns the kind of the VertexBuffer (string)
  86950. * @returns a string
  86951. */
  86952. getKind(): string;
  86953. /**
  86954. * Gets a boolean indicating if the VertexBuffer is updatable?
  86955. * @returns true if the buffer is updatable
  86956. */
  86957. isUpdatable(): boolean;
  86958. /**
  86959. * Gets current buffer's data
  86960. * @returns a DataArray or null
  86961. */
  86962. getData(): Nullable<DataArray>;
  86963. /**
  86964. * Gets underlying native buffer
  86965. * @returns underlying native buffer
  86966. */
  86967. getBuffer(): Nullable<DataBuffer>;
  86968. /**
  86969. * Gets the stride in float32 units (i.e. byte stride / 4).
  86970. * May not be an integer if the byte stride is not divisible by 4.
  86971. * @returns the stride in float32 units
  86972. * @deprecated Please use byteStride instead.
  86973. */
  86974. getStrideSize(): number;
  86975. /**
  86976. * Returns the offset as a multiple of the type byte length.
  86977. * @returns the offset in bytes
  86978. * @deprecated Please use byteOffset instead.
  86979. */
  86980. getOffset(): number;
  86981. /**
  86982. * Returns the number of components per vertex attribute (integer)
  86983. * @returns the size in float
  86984. */
  86985. getSize(): number;
  86986. /**
  86987. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86988. * @returns true if this buffer is instanced
  86989. */
  86990. getIsInstanced(): boolean;
  86991. /**
  86992. * Returns the instancing divisor, zero for non-instanced (integer).
  86993. * @returns a number
  86994. */
  86995. getInstanceDivisor(): number;
  86996. /**
  86997. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86998. * @param data defines the data to store
  86999. */
  87000. create(data?: DataArray): void;
  87001. /**
  87002. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  87003. * This function will create a new buffer if the current one is not updatable
  87004. * @param data defines the data to store
  87005. */
  87006. update(data: DataArray): void;
  87007. /**
  87008. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  87009. * Returns the directly updated WebGLBuffer.
  87010. * @param data the new data
  87011. * @param offset the new offset
  87012. * @param useBytes set to true if the offset is in bytes
  87013. */
  87014. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  87015. /**
  87016. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  87017. */
  87018. dispose(): void;
  87019. /**
  87020. * Enumerates each value of this vertex buffer as numbers.
  87021. * @param count the number of values to enumerate
  87022. * @param callback the callback function called for each value
  87023. */
  87024. forEach(count: number, callback: (value: number, index: number) => void): void;
  87025. /**
  87026. * Positions
  87027. */
  87028. static readonly PositionKind: string;
  87029. /**
  87030. * Normals
  87031. */
  87032. static readonly NormalKind: string;
  87033. /**
  87034. * Tangents
  87035. */
  87036. static readonly TangentKind: string;
  87037. /**
  87038. * Texture coordinates
  87039. */
  87040. static readonly UVKind: string;
  87041. /**
  87042. * Texture coordinates 2
  87043. */
  87044. static readonly UV2Kind: string;
  87045. /**
  87046. * Texture coordinates 3
  87047. */
  87048. static readonly UV3Kind: string;
  87049. /**
  87050. * Texture coordinates 4
  87051. */
  87052. static readonly UV4Kind: string;
  87053. /**
  87054. * Texture coordinates 5
  87055. */
  87056. static readonly UV5Kind: string;
  87057. /**
  87058. * Texture coordinates 6
  87059. */
  87060. static readonly UV6Kind: string;
  87061. /**
  87062. * Colors
  87063. */
  87064. static readonly ColorKind: string;
  87065. /**
  87066. * Matrix indices (for bones)
  87067. */
  87068. static readonly MatricesIndicesKind: string;
  87069. /**
  87070. * Matrix weights (for bones)
  87071. */
  87072. static readonly MatricesWeightsKind: string;
  87073. /**
  87074. * Additional matrix indices (for bones)
  87075. */
  87076. static readonly MatricesIndicesExtraKind: string;
  87077. /**
  87078. * Additional matrix weights (for bones)
  87079. */
  87080. static readonly MatricesWeightsExtraKind: string;
  87081. /**
  87082. * Deduces the stride given a kind.
  87083. * @param kind The kind string to deduce
  87084. * @returns The deduced stride
  87085. */
  87086. static DeduceStride(kind: string): number;
  87087. /**
  87088. * Gets the byte length of the given type.
  87089. * @param type the type
  87090. * @returns the number of bytes
  87091. */
  87092. static GetTypeByteLength(type: number): number;
  87093. /**
  87094. * Enumerates each value of the given parameters as numbers.
  87095. * @param data the data to enumerate
  87096. * @param byteOffset the byte offset of the data
  87097. * @param byteStride the byte stride of the data
  87098. * @param componentCount the number of components per element
  87099. * @param componentType the type of the component
  87100. * @param count the number of values to enumerate
  87101. * @param normalized whether the data is normalized
  87102. * @param callback the callback function called for each value
  87103. */
  87104. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  87105. private static _GetFloatValue;
  87106. }
  87107. }
  87108. declare module BABYLON {
  87109. /**
  87110. * The options Interface for creating a Capsule Mesh
  87111. */
  87112. export interface ICreateCapsuleOptions {
  87113. /** The Orientation of the capsule. Default : Vector3.Up() */
  87114. orientation?: Vector3;
  87115. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  87116. subdivisions: number;
  87117. /** Number of cylindrical segments on the capsule. */
  87118. tessellation: number;
  87119. /** Height or Length of the capsule. */
  87120. height: number;
  87121. /** Radius of the capsule. */
  87122. radius: number;
  87123. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  87124. capSubdivisions: number;
  87125. /** Overwrite for the top radius. */
  87126. radiusTop?: number;
  87127. /** Overwrite for the bottom radius. */
  87128. radiusBottom?: number;
  87129. /** Overwrite for the top capSubdivisions. */
  87130. topCapSubdivisions?: number;
  87131. /** Overwrite for the bottom capSubdivisions. */
  87132. bottomCapSubdivisions?: number;
  87133. }
  87134. /**
  87135. * Class containing static functions to help procedurally build meshes
  87136. */
  87137. export class CapsuleBuilder {
  87138. /**
  87139. * Creates a capsule or a pill mesh
  87140. * @param name defines the name of the mesh
  87141. * @param options The constructors options.
  87142. * @param scene The scene the mesh is scoped to.
  87143. * @returns Capsule Mesh
  87144. */
  87145. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  87146. }
  87147. }
  87148. declare module BABYLON {
  87149. /**
  87150. * @hidden
  87151. */
  87152. export class IntersectionInfo {
  87153. bu: Nullable<number>;
  87154. bv: Nullable<number>;
  87155. distance: number;
  87156. faceId: number;
  87157. subMeshId: number;
  87158. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  87159. }
  87160. }
  87161. declare module BABYLON {
  87162. /**
  87163. * Class used to store bounding sphere information
  87164. */
  87165. export class BoundingSphere {
  87166. /**
  87167. * Gets the center of the bounding sphere in local space
  87168. */
  87169. readonly center: Vector3;
  87170. /**
  87171. * Radius of the bounding sphere in local space
  87172. */
  87173. radius: number;
  87174. /**
  87175. * Gets the center of the bounding sphere in world space
  87176. */
  87177. readonly centerWorld: Vector3;
  87178. /**
  87179. * Radius of the bounding sphere in world space
  87180. */
  87181. radiusWorld: number;
  87182. /**
  87183. * Gets the minimum vector in local space
  87184. */
  87185. readonly minimum: Vector3;
  87186. /**
  87187. * Gets the maximum vector in local space
  87188. */
  87189. readonly maximum: Vector3;
  87190. private _worldMatrix;
  87191. private static readonly TmpVector3;
  87192. /**
  87193. * Creates a new bounding sphere
  87194. * @param min defines the minimum vector (in local space)
  87195. * @param max defines the maximum vector (in local space)
  87196. * @param worldMatrix defines the new world matrix
  87197. */
  87198. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87199. /**
  87200. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  87201. * @param min defines the new minimum vector (in local space)
  87202. * @param max defines the new maximum vector (in local space)
  87203. * @param worldMatrix defines the new world matrix
  87204. */
  87205. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87206. /**
  87207. * Scale the current bounding sphere by applying a scale factor
  87208. * @param factor defines the scale factor to apply
  87209. * @returns the current bounding box
  87210. */
  87211. scale(factor: number): BoundingSphere;
  87212. /**
  87213. * Gets the world matrix of the bounding box
  87214. * @returns a matrix
  87215. */
  87216. getWorldMatrix(): DeepImmutable<Matrix>;
  87217. /** @hidden */
  87218. _update(worldMatrix: DeepImmutable<Matrix>): void;
  87219. /**
  87220. * Tests if the bounding sphere is intersecting the frustum planes
  87221. * @param frustumPlanes defines the frustum planes to test
  87222. * @returns true if there is an intersection
  87223. */
  87224. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87225. /**
  87226. * Tests if the bounding sphere center is in between the frustum planes.
  87227. * Used for optimistic fast inclusion.
  87228. * @param frustumPlanes defines the frustum planes to test
  87229. * @returns true if the sphere center is in between the frustum planes
  87230. */
  87231. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87232. /**
  87233. * Tests if a point is inside the bounding sphere
  87234. * @param point defines the point to test
  87235. * @returns true if the point is inside the bounding sphere
  87236. */
  87237. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87238. /**
  87239. * Checks if two sphere intersct
  87240. * @param sphere0 sphere 0
  87241. * @param sphere1 sphere 1
  87242. * @returns true if the speres intersect
  87243. */
  87244. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  87245. }
  87246. }
  87247. declare module BABYLON {
  87248. /**
  87249. * Class used to store bounding box information
  87250. */
  87251. export class BoundingBox implements ICullable {
  87252. /**
  87253. * Gets the 8 vectors representing the bounding box in local space
  87254. */
  87255. readonly vectors: Vector3[];
  87256. /**
  87257. * Gets the center of the bounding box in local space
  87258. */
  87259. readonly center: Vector3;
  87260. /**
  87261. * Gets the center of the bounding box in world space
  87262. */
  87263. readonly centerWorld: Vector3;
  87264. /**
  87265. * Gets the extend size in local space
  87266. */
  87267. readonly extendSize: Vector3;
  87268. /**
  87269. * Gets the extend size in world space
  87270. */
  87271. readonly extendSizeWorld: Vector3;
  87272. /**
  87273. * Gets the OBB (object bounding box) directions
  87274. */
  87275. readonly directions: Vector3[];
  87276. /**
  87277. * Gets the 8 vectors representing the bounding box in world space
  87278. */
  87279. readonly vectorsWorld: Vector3[];
  87280. /**
  87281. * Gets the minimum vector in world space
  87282. */
  87283. readonly minimumWorld: Vector3;
  87284. /**
  87285. * Gets the maximum vector in world space
  87286. */
  87287. readonly maximumWorld: Vector3;
  87288. /**
  87289. * Gets the minimum vector in local space
  87290. */
  87291. readonly minimum: Vector3;
  87292. /**
  87293. * Gets the maximum vector in local space
  87294. */
  87295. readonly maximum: Vector3;
  87296. private _worldMatrix;
  87297. private static readonly TmpVector3;
  87298. /**
  87299. * @hidden
  87300. */
  87301. _tag: number;
  87302. /**
  87303. * Creates a new bounding box
  87304. * @param min defines the minimum vector (in local space)
  87305. * @param max defines the maximum vector (in local space)
  87306. * @param worldMatrix defines the new world matrix
  87307. */
  87308. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87309. /**
  87310. * Recreates the entire bounding box from scratch as if we call the constructor in place
  87311. * @param min defines the new minimum vector (in local space)
  87312. * @param max defines the new maximum vector (in local space)
  87313. * @param worldMatrix defines the new world matrix
  87314. */
  87315. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87316. /**
  87317. * Scale the current bounding box by applying a scale factor
  87318. * @param factor defines the scale factor to apply
  87319. * @returns the current bounding box
  87320. */
  87321. scale(factor: number): BoundingBox;
  87322. /**
  87323. * Gets the world matrix of the bounding box
  87324. * @returns a matrix
  87325. */
  87326. getWorldMatrix(): DeepImmutable<Matrix>;
  87327. /** @hidden */
  87328. _update(world: DeepImmutable<Matrix>): void;
  87329. /**
  87330. * Tests if the bounding box is intersecting the frustum planes
  87331. * @param frustumPlanes defines the frustum planes to test
  87332. * @returns true if there is an intersection
  87333. */
  87334. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87335. /**
  87336. * Tests if the bounding box is entirely inside the frustum planes
  87337. * @param frustumPlanes defines the frustum planes to test
  87338. * @returns true if there is an inclusion
  87339. */
  87340. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87341. /**
  87342. * Tests if a point is inside the bounding box
  87343. * @param point defines the point to test
  87344. * @returns true if the point is inside the bounding box
  87345. */
  87346. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87347. /**
  87348. * Tests if the bounding box intersects with a bounding sphere
  87349. * @param sphere defines the sphere to test
  87350. * @returns true if there is an intersection
  87351. */
  87352. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  87353. /**
  87354. * Tests if the bounding box intersects with a box defined by a min and max vectors
  87355. * @param min defines the min vector to use
  87356. * @param max defines the max vector to use
  87357. * @returns true if there is an intersection
  87358. */
  87359. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  87360. /**
  87361. * Tests if two bounding boxes are intersections
  87362. * @param box0 defines the first box to test
  87363. * @param box1 defines the second box to test
  87364. * @returns true if there is an intersection
  87365. */
  87366. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  87367. /**
  87368. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  87369. * @param minPoint defines the minimum vector of the bounding box
  87370. * @param maxPoint defines the maximum vector of the bounding box
  87371. * @param sphereCenter defines the sphere center
  87372. * @param sphereRadius defines the sphere radius
  87373. * @returns true if there is an intersection
  87374. */
  87375. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  87376. /**
  87377. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  87378. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  87379. * @param frustumPlanes defines the frustum planes to test
  87380. * @return true if there is an inclusion
  87381. */
  87382. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87383. /**
  87384. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  87385. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  87386. * @param frustumPlanes defines the frustum planes to test
  87387. * @return true if there is an intersection
  87388. */
  87389. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87390. }
  87391. }
  87392. declare module BABYLON {
  87393. /** @hidden */
  87394. export class Collider {
  87395. /** Define if a collision was found */
  87396. collisionFound: boolean;
  87397. /**
  87398. * Define last intersection point in local space
  87399. */
  87400. intersectionPoint: Vector3;
  87401. /**
  87402. * Define last collided mesh
  87403. */
  87404. collidedMesh: Nullable<AbstractMesh>;
  87405. private _collisionPoint;
  87406. private _planeIntersectionPoint;
  87407. private _tempVector;
  87408. private _tempVector2;
  87409. private _tempVector3;
  87410. private _tempVector4;
  87411. private _edge;
  87412. private _baseToVertex;
  87413. private _destinationPoint;
  87414. private _slidePlaneNormal;
  87415. private _displacementVector;
  87416. /** @hidden */
  87417. _radius: Vector3;
  87418. /** @hidden */
  87419. _retry: number;
  87420. private _velocity;
  87421. private _basePoint;
  87422. private _epsilon;
  87423. /** @hidden */
  87424. _velocityWorldLength: number;
  87425. /** @hidden */
  87426. _basePointWorld: Vector3;
  87427. private _velocityWorld;
  87428. private _normalizedVelocity;
  87429. /** @hidden */
  87430. _initialVelocity: Vector3;
  87431. /** @hidden */
  87432. _initialPosition: Vector3;
  87433. private _nearestDistance;
  87434. private _collisionMask;
  87435. get collisionMask(): number;
  87436. set collisionMask(mask: number);
  87437. /**
  87438. * Gets the plane normal used to compute the sliding response (in local space)
  87439. */
  87440. get slidePlaneNormal(): Vector3;
  87441. /** @hidden */
  87442. _initialize(source: Vector3, dir: Vector3, e: number): void;
  87443. /** @hidden */
  87444. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  87445. /** @hidden */
  87446. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  87447. /** @hidden */
  87448. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  87449. /** @hidden */
  87450. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  87451. /** @hidden */
  87452. _getResponse(pos: Vector3, vel: Vector3): void;
  87453. }
  87454. }
  87455. declare module BABYLON {
  87456. /**
  87457. * Interface for cullable objects
  87458. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  87459. */
  87460. export interface ICullable {
  87461. /**
  87462. * Checks if the object or part of the object is in the frustum
  87463. * @param frustumPlanes Camera near/planes
  87464. * @returns true if the object is in frustum otherwise false
  87465. */
  87466. isInFrustum(frustumPlanes: Plane[]): boolean;
  87467. /**
  87468. * Checks if a cullable object (mesh...) is in the camera frustum
  87469. * Unlike isInFrustum this cheks the full bounding box
  87470. * @param frustumPlanes Camera near/planes
  87471. * @returns true if the object is in frustum otherwise false
  87472. */
  87473. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  87474. }
  87475. /**
  87476. * Info for a bounding data of a mesh
  87477. */
  87478. export class BoundingInfo implements ICullable {
  87479. /**
  87480. * Bounding box for the mesh
  87481. */
  87482. readonly boundingBox: BoundingBox;
  87483. /**
  87484. * Bounding sphere for the mesh
  87485. */
  87486. readonly boundingSphere: BoundingSphere;
  87487. private _isLocked;
  87488. private static readonly TmpVector3;
  87489. /**
  87490. * Constructs bounding info
  87491. * @param minimum min vector of the bounding box/sphere
  87492. * @param maximum max vector of the bounding box/sphere
  87493. * @param worldMatrix defines the new world matrix
  87494. */
  87495. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87496. /**
  87497. * Recreates the entire bounding info from scratch as if we call the constructor in place
  87498. * @param min defines the new minimum vector (in local space)
  87499. * @param max defines the new maximum vector (in local space)
  87500. * @param worldMatrix defines the new world matrix
  87501. */
  87502. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87503. /**
  87504. * min vector of the bounding box/sphere
  87505. */
  87506. get minimum(): Vector3;
  87507. /**
  87508. * max vector of the bounding box/sphere
  87509. */
  87510. get maximum(): Vector3;
  87511. /**
  87512. * If the info is locked and won't be updated to avoid perf overhead
  87513. */
  87514. get isLocked(): boolean;
  87515. set isLocked(value: boolean);
  87516. /**
  87517. * Updates the bounding sphere and box
  87518. * @param world world matrix to be used to update
  87519. */
  87520. update(world: DeepImmutable<Matrix>): void;
  87521. /**
  87522. * Recreate the bounding info to be centered around a specific point given a specific extend.
  87523. * @param center New center of the bounding info
  87524. * @param extend New extend of the bounding info
  87525. * @returns the current bounding info
  87526. */
  87527. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  87528. /**
  87529. * Scale the current bounding info by applying a scale factor
  87530. * @param factor defines the scale factor to apply
  87531. * @returns the current bounding info
  87532. */
  87533. scale(factor: number): BoundingInfo;
  87534. /**
  87535. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  87536. * @param frustumPlanes defines the frustum to test
  87537. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  87538. * @returns true if the bounding info is in the frustum planes
  87539. */
  87540. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  87541. /**
  87542. * Gets the world distance between the min and max points of the bounding box
  87543. */
  87544. get diagonalLength(): number;
  87545. /**
  87546. * Checks if a cullable object (mesh...) is in the camera frustum
  87547. * Unlike isInFrustum this cheks the full bounding box
  87548. * @param frustumPlanes Camera near/planes
  87549. * @returns true if the object is in frustum otherwise false
  87550. */
  87551. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87552. /** @hidden */
  87553. _checkCollision(collider: Collider): boolean;
  87554. /**
  87555. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  87556. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  87557. * @param point the point to check intersection with
  87558. * @returns if the point intersects
  87559. */
  87560. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87561. /**
  87562. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  87563. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  87564. * @param boundingInfo the bounding info to check intersection with
  87565. * @param precise if the intersection should be done using OBB
  87566. * @returns if the bounding info intersects
  87567. */
  87568. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  87569. }
  87570. }
  87571. declare module BABYLON {
  87572. /**
  87573. * Extracts minimum and maximum values from a list of indexed positions
  87574. * @param positions defines the positions to use
  87575. * @param indices defines the indices to the positions
  87576. * @param indexStart defines the start index
  87577. * @param indexCount defines the end index
  87578. * @param bias defines bias value to add to the result
  87579. * @return minimum and maximum values
  87580. */
  87581. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  87582. minimum: Vector3;
  87583. maximum: Vector3;
  87584. };
  87585. /**
  87586. * Extracts minimum and maximum values from a list of positions
  87587. * @param positions defines the positions to use
  87588. * @param start defines the start index in the positions array
  87589. * @param count defines the number of positions to handle
  87590. * @param bias defines bias value to add to the result
  87591. * @param stride defines the stride size to use (distance between two positions in the positions array)
  87592. * @return minimum and maximum values
  87593. */
  87594. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  87595. minimum: Vector3;
  87596. maximum: Vector3;
  87597. };
  87598. }
  87599. declare module BABYLON {
  87600. /** @hidden */
  87601. export class WebGLDataBuffer extends DataBuffer {
  87602. private _buffer;
  87603. constructor(resource: WebGLBuffer);
  87604. get underlyingResource(): any;
  87605. }
  87606. }
  87607. declare module BABYLON {
  87608. /** @hidden */
  87609. export class WebGLPipelineContext implements IPipelineContext {
  87610. engine: ThinEngine;
  87611. program: Nullable<WebGLProgram>;
  87612. context?: WebGLRenderingContext;
  87613. vertexShader?: WebGLShader;
  87614. fragmentShader?: WebGLShader;
  87615. isParallelCompiled: boolean;
  87616. onCompiled?: () => void;
  87617. transformFeedback?: WebGLTransformFeedback | null;
  87618. vertexCompilationError: Nullable<string>;
  87619. fragmentCompilationError: Nullable<string>;
  87620. programLinkError: Nullable<string>;
  87621. programValidationError: Nullable<string>;
  87622. get isAsync(): boolean;
  87623. get isReady(): boolean;
  87624. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  87625. _getVertexShaderCode(): string | null;
  87626. _getFragmentShaderCode(): string | null;
  87627. }
  87628. }
  87629. declare module BABYLON {
  87630. interface ThinEngine {
  87631. /**
  87632. * Create an uniform buffer
  87633. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87634. * @param elements defines the content of the uniform buffer
  87635. * @returns the webGL uniform buffer
  87636. */
  87637. createUniformBuffer(elements: FloatArray): DataBuffer;
  87638. /**
  87639. * Create a dynamic uniform buffer
  87640. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87641. * @param elements defines the content of the uniform buffer
  87642. * @returns the webGL uniform buffer
  87643. */
  87644. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  87645. /**
  87646. * Update an existing uniform buffer
  87647. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87648. * @param uniformBuffer defines the target uniform buffer
  87649. * @param elements defines the content to update
  87650. * @param offset defines the offset in the uniform buffer where update should start
  87651. * @param count defines the size of the data to update
  87652. */
  87653. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  87654. /**
  87655. * Bind an uniform buffer to the current webGL context
  87656. * @param buffer defines the buffer to bind
  87657. */
  87658. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  87659. /**
  87660. * Bind a buffer to the current webGL context at a given location
  87661. * @param buffer defines the buffer to bind
  87662. * @param location defines the index where to bind the buffer
  87663. */
  87664. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  87665. /**
  87666. * Bind a specific block at a given index in a specific shader program
  87667. * @param pipelineContext defines the pipeline context to use
  87668. * @param blockName defines the block name
  87669. * @param index defines the index where to bind the block
  87670. */
  87671. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  87672. }
  87673. }
  87674. declare module BABYLON {
  87675. /**
  87676. * Uniform buffer objects.
  87677. *
  87678. * Handles blocks of uniform on the GPU.
  87679. *
  87680. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87681. *
  87682. * For more information, please refer to :
  87683. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87684. */
  87685. export class UniformBuffer {
  87686. private _engine;
  87687. private _buffer;
  87688. private _data;
  87689. private _bufferData;
  87690. private _dynamic?;
  87691. private _uniformLocations;
  87692. private _uniformSizes;
  87693. private _uniformLocationPointer;
  87694. private _needSync;
  87695. private _noUBO;
  87696. private _currentEffect;
  87697. /** @hidden */
  87698. _alreadyBound: boolean;
  87699. private static _MAX_UNIFORM_SIZE;
  87700. private static _tempBuffer;
  87701. /**
  87702. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87703. * This is dynamic to allow compat with webgl 1 and 2.
  87704. * You will need to pass the name of the uniform as well as the value.
  87705. */
  87706. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87707. /**
  87708. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87709. * This is dynamic to allow compat with webgl 1 and 2.
  87710. * You will need to pass the name of the uniform as well as the value.
  87711. */
  87712. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87713. /**
  87714. * Lambda to Update a single float in a uniform buffer.
  87715. * This is dynamic to allow compat with webgl 1 and 2.
  87716. * You will need to pass the name of the uniform as well as the value.
  87717. */
  87718. updateFloat: (name: string, x: number) => void;
  87719. /**
  87720. * Lambda to Update a vec2 of float in a uniform buffer.
  87721. * This is dynamic to allow compat with webgl 1 and 2.
  87722. * You will need to pass the name of the uniform as well as the value.
  87723. */
  87724. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87725. /**
  87726. * Lambda to Update a vec3 of float in a uniform buffer.
  87727. * This is dynamic to allow compat with webgl 1 and 2.
  87728. * You will need to pass the name of the uniform as well as the value.
  87729. */
  87730. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87731. /**
  87732. * Lambda to Update a vec4 of float in a uniform buffer.
  87733. * This is dynamic to allow compat with webgl 1 and 2.
  87734. * You will need to pass the name of the uniform as well as the value.
  87735. */
  87736. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87737. /**
  87738. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87739. * This is dynamic to allow compat with webgl 1 and 2.
  87740. * You will need to pass the name of the uniform as well as the value.
  87741. */
  87742. updateMatrix: (name: string, mat: Matrix) => void;
  87743. /**
  87744. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87745. * This is dynamic to allow compat with webgl 1 and 2.
  87746. * You will need to pass the name of the uniform as well as the value.
  87747. */
  87748. updateVector3: (name: string, vector: Vector3) => void;
  87749. /**
  87750. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87751. * This is dynamic to allow compat with webgl 1 and 2.
  87752. * You will need to pass the name of the uniform as well as the value.
  87753. */
  87754. updateVector4: (name: string, vector: Vector4) => void;
  87755. /**
  87756. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87757. * This is dynamic to allow compat with webgl 1 and 2.
  87758. * You will need to pass the name of the uniform as well as the value.
  87759. */
  87760. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87761. /**
  87762. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87763. * This is dynamic to allow compat with webgl 1 and 2.
  87764. * You will need to pass the name of the uniform as well as the value.
  87765. */
  87766. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87767. /**
  87768. * Instantiates a new Uniform buffer objects.
  87769. *
  87770. * Handles blocks of uniform on the GPU.
  87771. *
  87772. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87773. *
  87774. * For more information, please refer to :
  87775. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87776. * @param engine Define the engine the buffer is associated with
  87777. * @param data Define the data contained in the buffer
  87778. * @param dynamic Define if the buffer is updatable
  87779. */
  87780. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87781. /**
  87782. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87783. * or just falling back on setUniformXXX calls.
  87784. */
  87785. get useUbo(): boolean;
  87786. /**
  87787. * Indicates if the WebGL underlying uniform buffer is in sync
  87788. * with the javascript cache data.
  87789. */
  87790. get isSync(): boolean;
  87791. /**
  87792. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87793. * Also, a dynamic UniformBuffer will disable cache verification and always
  87794. * update the underlying WebGL uniform buffer to the GPU.
  87795. * @returns if Dynamic, otherwise false
  87796. */
  87797. isDynamic(): boolean;
  87798. /**
  87799. * The data cache on JS side.
  87800. * @returns the underlying data as a float array
  87801. */
  87802. getData(): Float32Array;
  87803. /**
  87804. * The underlying WebGL Uniform buffer.
  87805. * @returns the webgl buffer
  87806. */
  87807. getBuffer(): Nullable<DataBuffer>;
  87808. /**
  87809. * std140 layout specifies how to align data within an UBO structure.
  87810. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87811. * for specs.
  87812. */
  87813. private _fillAlignment;
  87814. /**
  87815. * Adds an uniform in the buffer.
  87816. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87817. * for the layout to be correct !
  87818. * @param name Name of the uniform, as used in the uniform block in the shader.
  87819. * @param size Data size, or data directly.
  87820. */
  87821. addUniform(name: string, size: number | number[]): void;
  87822. /**
  87823. * Adds a Matrix 4x4 to the uniform buffer.
  87824. * @param name Name of the uniform, as used in the uniform block in the shader.
  87825. * @param mat A 4x4 matrix.
  87826. */
  87827. addMatrix(name: string, mat: Matrix): void;
  87828. /**
  87829. * Adds a vec2 to the uniform buffer.
  87830. * @param name Name of the uniform, as used in the uniform block in the shader.
  87831. * @param x Define the x component value of the vec2
  87832. * @param y Define the y component value of the vec2
  87833. */
  87834. addFloat2(name: string, x: number, y: number): void;
  87835. /**
  87836. * Adds a vec3 to the uniform buffer.
  87837. * @param name Name of the uniform, as used in the uniform block in the shader.
  87838. * @param x Define the x component value of the vec3
  87839. * @param y Define the y component value of the vec3
  87840. * @param z Define the z component value of the vec3
  87841. */
  87842. addFloat3(name: string, x: number, y: number, z: number): void;
  87843. /**
  87844. * Adds a vec3 to the uniform buffer.
  87845. * @param name Name of the uniform, as used in the uniform block in the shader.
  87846. * @param color Define the vec3 from a Color
  87847. */
  87848. addColor3(name: string, color: Color3): void;
  87849. /**
  87850. * Adds a vec4 to the uniform buffer.
  87851. * @param name Name of the uniform, as used in the uniform block in the shader.
  87852. * @param color Define the rgb components from a Color
  87853. * @param alpha Define the a component of the vec4
  87854. */
  87855. addColor4(name: string, color: Color3, alpha: number): void;
  87856. /**
  87857. * Adds a vec3 to the uniform buffer.
  87858. * @param name Name of the uniform, as used in the uniform block in the shader.
  87859. * @param vector Define the vec3 components from a Vector
  87860. */
  87861. addVector3(name: string, vector: Vector3): void;
  87862. /**
  87863. * Adds a Matrix 3x3 to the uniform buffer.
  87864. * @param name Name of the uniform, as used in the uniform block in the shader.
  87865. */
  87866. addMatrix3x3(name: string): void;
  87867. /**
  87868. * Adds a Matrix 2x2 to the uniform buffer.
  87869. * @param name Name of the uniform, as used in the uniform block in the shader.
  87870. */
  87871. addMatrix2x2(name: string): void;
  87872. /**
  87873. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87874. */
  87875. create(): void;
  87876. /** @hidden */
  87877. _rebuild(): void;
  87878. /**
  87879. * Updates the WebGL Uniform Buffer on the GPU.
  87880. * If the `dynamic` flag is set to true, no cache comparison is done.
  87881. * Otherwise, the buffer will be updated only if the cache differs.
  87882. */
  87883. update(): void;
  87884. /**
  87885. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87886. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87887. * @param data Define the flattened data
  87888. * @param size Define the size of the data.
  87889. */
  87890. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87891. private _valueCache;
  87892. private _cacheMatrix;
  87893. private _updateMatrix3x3ForUniform;
  87894. private _updateMatrix3x3ForEffect;
  87895. private _updateMatrix2x2ForEffect;
  87896. private _updateMatrix2x2ForUniform;
  87897. private _updateFloatForEffect;
  87898. private _updateFloatForUniform;
  87899. private _updateFloat2ForEffect;
  87900. private _updateFloat2ForUniform;
  87901. private _updateFloat3ForEffect;
  87902. private _updateFloat3ForUniform;
  87903. private _updateFloat4ForEffect;
  87904. private _updateFloat4ForUniform;
  87905. private _updateMatrixForEffect;
  87906. private _updateMatrixForUniform;
  87907. private _updateVector3ForEffect;
  87908. private _updateVector3ForUniform;
  87909. private _updateVector4ForEffect;
  87910. private _updateVector4ForUniform;
  87911. private _updateColor3ForEffect;
  87912. private _updateColor3ForUniform;
  87913. private _updateColor4ForEffect;
  87914. private _updateColor4ForUniform;
  87915. /**
  87916. * Sets a sampler uniform on the effect.
  87917. * @param name Define the name of the sampler.
  87918. * @param texture Define the texture to set in the sampler
  87919. */
  87920. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87921. /**
  87922. * Directly updates the value of the uniform in the cache AND on the GPU.
  87923. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87924. * @param data Define the flattened data
  87925. */
  87926. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87927. /**
  87928. * Binds this uniform buffer to an effect.
  87929. * @param effect Define the effect to bind the buffer to
  87930. * @param name Name of the uniform block in the shader.
  87931. */
  87932. bindToEffect(effect: Effect, name: string): void;
  87933. /**
  87934. * Disposes the uniform buffer.
  87935. */
  87936. dispose(): void;
  87937. }
  87938. }
  87939. declare module BABYLON {
  87940. /**
  87941. * Enum that determines the text-wrapping mode to use.
  87942. */
  87943. export enum InspectableType {
  87944. /**
  87945. * Checkbox for booleans
  87946. */
  87947. Checkbox = 0,
  87948. /**
  87949. * Sliders for numbers
  87950. */
  87951. Slider = 1,
  87952. /**
  87953. * Vector3
  87954. */
  87955. Vector3 = 2,
  87956. /**
  87957. * Quaternions
  87958. */
  87959. Quaternion = 3,
  87960. /**
  87961. * Color3
  87962. */
  87963. Color3 = 4,
  87964. /**
  87965. * String
  87966. */
  87967. String = 5
  87968. }
  87969. /**
  87970. * Interface used to define custom inspectable properties.
  87971. * This interface is used by the inspector to display custom property grids
  87972. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87973. */
  87974. export interface IInspectable {
  87975. /**
  87976. * Gets the label to display
  87977. */
  87978. label: string;
  87979. /**
  87980. * Gets the name of the property to edit
  87981. */
  87982. propertyName: string;
  87983. /**
  87984. * Gets the type of the editor to use
  87985. */
  87986. type: InspectableType;
  87987. /**
  87988. * Gets the minimum value of the property when using in "slider" mode
  87989. */
  87990. min?: number;
  87991. /**
  87992. * Gets the maximum value of the property when using in "slider" mode
  87993. */
  87994. max?: number;
  87995. /**
  87996. * Gets the setp to use when using in "slider" mode
  87997. */
  87998. step?: number;
  87999. }
  88000. }
  88001. declare module BABYLON {
  88002. /**
  88003. * Class used to provide helper for timing
  88004. */
  88005. export class TimingTools {
  88006. /**
  88007. * Polyfill for setImmediate
  88008. * @param action defines the action to execute after the current execution block
  88009. */
  88010. static SetImmediate(action: () => void): void;
  88011. }
  88012. }
  88013. declare module BABYLON {
  88014. /**
  88015. * Class used to enable instatition of objects by class name
  88016. */
  88017. export class InstantiationTools {
  88018. /**
  88019. * Use this object to register external classes like custom textures or material
  88020. * to allow the laoders to instantiate them
  88021. */
  88022. static RegisteredExternalClasses: {
  88023. [key: string]: Object;
  88024. };
  88025. /**
  88026. * Tries to instantiate a new object from a given class name
  88027. * @param className defines the class name to instantiate
  88028. * @returns the new object or null if the system was not able to do the instantiation
  88029. */
  88030. static Instantiate(className: string): any;
  88031. }
  88032. }
  88033. declare module BABYLON {
  88034. /**
  88035. * Define options used to create a depth texture
  88036. */
  88037. export class DepthTextureCreationOptions {
  88038. /** Specifies whether or not a stencil should be allocated in the texture */
  88039. generateStencil?: boolean;
  88040. /** Specifies whether or not bilinear filtering is enable on the texture */
  88041. bilinearFiltering?: boolean;
  88042. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  88043. comparisonFunction?: number;
  88044. /** Specifies if the created texture is a cube texture */
  88045. isCube?: boolean;
  88046. }
  88047. }
  88048. declare module BABYLON {
  88049. interface ThinEngine {
  88050. /**
  88051. * Creates a depth stencil cube texture.
  88052. * This is only available in WebGL 2.
  88053. * @param size The size of face edge in the cube texture.
  88054. * @param options The options defining the cube texture.
  88055. * @returns The cube texture
  88056. */
  88057. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  88058. /**
  88059. * Creates a cube texture
  88060. * @param rootUrl defines the url where the files to load is located
  88061. * @param scene defines the current scene
  88062. * @param files defines the list of files to load (1 per face)
  88063. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88064. * @param onLoad defines an optional callback raised when the texture is loaded
  88065. * @param onError defines an optional callback raised if there is an issue to load the texture
  88066. * @param format defines the format of the data
  88067. * @param forcedExtension defines the extension to use to pick the right loader
  88068. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  88069. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88070. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88071. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  88072. * @returns the cube texture as an InternalTexture
  88073. */
  88074. 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;
  88075. /**
  88076. * Creates a cube texture
  88077. * @param rootUrl defines the url where the files to load is located
  88078. * @param scene defines the current scene
  88079. * @param files defines the list of files to load (1 per face)
  88080. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88081. * @param onLoad defines an optional callback raised when the texture is loaded
  88082. * @param onError defines an optional callback raised if there is an issue to load the texture
  88083. * @param format defines the format of the data
  88084. * @param forcedExtension defines the extension to use to pick the right loader
  88085. * @returns the cube texture as an InternalTexture
  88086. */
  88087. 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;
  88088. /**
  88089. * Creates a cube texture
  88090. * @param rootUrl defines the url where the files to load is located
  88091. * @param scene defines the current scene
  88092. * @param files defines the list of files to load (1 per face)
  88093. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88094. * @param onLoad defines an optional callback raised when the texture is loaded
  88095. * @param onError defines an optional callback raised if there is an issue to load the texture
  88096. * @param format defines the format of the data
  88097. * @param forcedExtension defines the extension to use to pick the right loader
  88098. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  88099. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88100. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88101. * @returns the cube texture as an InternalTexture
  88102. */
  88103. 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;
  88104. /** @hidden */
  88105. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  88106. /** @hidden */
  88107. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  88108. /** @hidden */
  88109. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  88110. /** @hidden */
  88111. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  88112. /**
  88113. * @hidden
  88114. */
  88115. _setCubeMapTextureParams(loadMipmap: boolean): void;
  88116. }
  88117. }
  88118. declare module BABYLON {
  88119. /**
  88120. * Class for creating a cube texture
  88121. */
  88122. export class CubeTexture extends BaseTexture {
  88123. private _delayedOnLoad;
  88124. /**
  88125. * Observable triggered once the texture has been loaded.
  88126. */
  88127. onLoadObservable: Observable<CubeTexture>;
  88128. /**
  88129. * The url of the texture
  88130. */
  88131. url: string;
  88132. /**
  88133. * Gets or sets the center of the bounding box associated with the cube texture.
  88134. * It must define where the camera used to render the texture was set
  88135. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  88136. */
  88137. boundingBoxPosition: Vector3;
  88138. private _boundingBoxSize;
  88139. /**
  88140. * Gets or sets the size of the bounding box associated with the cube texture
  88141. * When defined, the cubemap will switch to local mode
  88142. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  88143. * @example https://www.babylonjs-playground.com/#RNASML
  88144. */
  88145. set boundingBoxSize(value: Vector3);
  88146. /**
  88147. * Returns the bounding box size
  88148. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  88149. */
  88150. get boundingBoxSize(): Vector3;
  88151. protected _rotationY: number;
  88152. /**
  88153. * Sets texture matrix rotation angle around Y axis in radians.
  88154. */
  88155. set rotationY(value: number);
  88156. /**
  88157. * Gets texture matrix rotation angle around Y axis radians.
  88158. */
  88159. get rotationY(): number;
  88160. /**
  88161. * Are mip maps generated for this texture or not.
  88162. */
  88163. get noMipmap(): boolean;
  88164. private _noMipmap;
  88165. private _files;
  88166. protected _forcedExtension: Nullable<string>;
  88167. private _extensions;
  88168. private _textureMatrix;
  88169. private _format;
  88170. private _createPolynomials;
  88171. /**
  88172. * Creates a cube texture from an array of image urls
  88173. * @param files defines an array of image urls
  88174. * @param scene defines the hosting scene
  88175. * @param noMipmap specifies if mip maps are not used
  88176. * @returns a cube texture
  88177. */
  88178. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  88179. /**
  88180. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  88181. * @param url defines the url of the prefiltered texture
  88182. * @param scene defines the scene the texture is attached to
  88183. * @param forcedExtension defines the extension of the file if different from the url
  88184. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  88185. * @return the prefiltered texture
  88186. */
  88187. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  88188. /**
  88189. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  88190. * as prefiltered data.
  88191. * @param rootUrl defines the url of the texture or the root name of the six images
  88192. * @param null defines the scene or engine the texture is attached to
  88193. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  88194. * @param noMipmap defines if mipmaps should be created or not
  88195. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  88196. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  88197. * @param onError defines a callback triggered in case of error during load
  88198. * @param format defines the internal format to use for the texture once loaded
  88199. * @param prefiltered defines whether or not the texture is created from prefiltered data
  88200. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  88201. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  88202. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88203. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88204. * @return the cube texture
  88205. */
  88206. 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);
  88207. /**
  88208. * Get the current class name of the texture useful for serialization or dynamic coding.
  88209. * @returns "CubeTexture"
  88210. */
  88211. getClassName(): string;
  88212. /**
  88213. * Update the url (and optional buffer) of this texture if url was null during construction.
  88214. * @param url the url of the texture
  88215. * @param forcedExtension defines the extension to use
  88216. * @param onLoad callback called when the texture is loaded (defaults to null)
  88217. * @param prefiltered Defines whether the updated texture is prefiltered or not
  88218. */
  88219. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  88220. /**
  88221. * Delays loading of the cube texture
  88222. * @param forcedExtension defines the extension to use
  88223. */
  88224. delayLoad(forcedExtension?: string): void;
  88225. /**
  88226. * Returns the reflection texture matrix
  88227. * @returns the reflection texture matrix
  88228. */
  88229. getReflectionTextureMatrix(): Matrix;
  88230. /**
  88231. * Sets the reflection texture matrix
  88232. * @param value Reflection texture matrix
  88233. */
  88234. setReflectionTextureMatrix(value: Matrix): void;
  88235. /**
  88236. * Parses text to create a cube texture
  88237. * @param parsedTexture define the serialized text to read from
  88238. * @param scene defines the hosting scene
  88239. * @param rootUrl defines the root url of the cube texture
  88240. * @returns a cube texture
  88241. */
  88242. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  88243. /**
  88244. * Makes a clone, or deep copy, of the cube texture
  88245. * @returns a new cube texture
  88246. */
  88247. clone(): CubeTexture;
  88248. }
  88249. }
  88250. declare module BABYLON {
  88251. /**
  88252. * Manages the defines for the Material
  88253. */
  88254. export class MaterialDefines {
  88255. /** @hidden */
  88256. protected _keys: string[];
  88257. private _isDirty;
  88258. /** @hidden */
  88259. _renderId: number;
  88260. /** @hidden */
  88261. _areLightsDirty: boolean;
  88262. /** @hidden */
  88263. _areLightsDisposed: boolean;
  88264. /** @hidden */
  88265. _areAttributesDirty: boolean;
  88266. /** @hidden */
  88267. _areTexturesDirty: boolean;
  88268. /** @hidden */
  88269. _areFresnelDirty: boolean;
  88270. /** @hidden */
  88271. _areMiscDirty: boolean;
  88272. /** @hidden */
  88273. _areImageProcessingDirty: boolean;
  88274. /** @hidden */
  88275. _normals: boolean;
  88276. /** @hidden */
  88277. _uvs: boolean;
  88278. /** @hidden */
  88279. _needNormals: boolean;
  88280. /** @hidden */
  88281. _needUVs: boolean;
  88282. [id: string]: any;
  88283. /**
  88284. * Specifies if the material needs to be re-calculated
  88285. */
  88286. get isDirty(): boolean;
  88287. /**
  88288. * Marks the material to indicate that it has been re-calculated
  88289. */
  88290. markAsProcessed(): void;
  88291. /**
  88292. * Marks the material to indicate that it needs to be re-calculated
  88293. */
  88294. markAsUnprocessed(): void;
  88295. /**
  88296. * Marks the material to indicate all of its defines need to be re-calculated
  88297. */
  88298. markAllAsDirty(): void;
  88299. /**
  88300. * Marks the material to indicate that image processing needs to be re-calculated
  88301. */
  88302. markAsImageProcessingDirty(): void;
  88303. /**
  88304. * Marks the material to indicate the lights need to be re-calculated
  88305. * @param disposed Defines whether the light is dirty due to dispose or not
  88306. */
  88307. markAsLightDirty(disposed?: boolean): void;
  88308. /**
  88309. * Marks the attribute state as changed
  88310. */
  88311. markAsAttributesDirty(): void;
  88312. /**
  88313. * Marks the texture state as changed
  88314. */
  88315. markAsTexturesDirty(): void;
  88316. /**
  88317. * Marks the fresnel state as changed
  88318. */
  88319. markAsFresnelDirty(): void;
  88320. /**
  88321. * Marks the misc state as changed
  88322. */
  88323. markAsMiscDirty(): void;
  88324. /**
  88325. * Rebuilds the material defines
  88326. */
  88327. rebuild(): void;
  88328. /**
  88329. * Specifies if two material defines are equal
  88330. * @param other - A material define instance to compare to
  88331. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  88332. */
  88333. isEqual(other: MaterialDefines): boolean;
  88334. /**
  88335. * Clones this instance's defines to another instance
  88336. * @param other - material defines to clone values to
  88337. */
  88338. cloneTo(other: MaterialDefines): void;
  88339. /**
  88340. * Resets the material define values
  88341. */
  88342. reset(): void;
  88343. /**
  88344. * Converts the material define values to a string
  88345. * @returns - String of material define information
  88346. */
  88347. toString(): string;
  88348. }
  88349. }
  88350. declare module BABYLON {
  88351. /**
  88352. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  88353. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  88354. * 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;
  88355. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  88356. */
  88357. export class ColorCurves {
  88358. private _dirty;
  88359. private _tempColor;
  88360. private _globalCurve;
  88361. private _highlightsCurve;
  88362. private _midtonesCurve;
  88363. private _shadowsCurve;
  88364. private _positiveCurve;
  88365. private _negativeCurve;
  88366. private _globalHue;
  88367. private _globalDensity;
  88368. private _globalSaturation;
  88369. private _globalExposure;
  88370. /**
  88371. * Gets the global Hue value.
  88372. * 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).
  88373. */
  88374. get globalHue(): number;
  88375. /**
  88376. * Sets the global Hue value.
  88377. * 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).
  88378. */
  88379. set globalHue(value: number);
  88380. /**
  88381. * Gets the global Density value.
  88382. * 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.
  88383. * Values less than zero provide a filter of opposite hue.
  88384. */
  88385. get globalDensity(): number;
  88386. /**
  88387. * Sets the global Density value.
  88388. * 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.
  88389. * Values less than zero provide a filter of opposite hue.
  88390. */
  88391. set globalDensity(value: number);
  88392. /**
  88393. * Gets the global Saturation value.
  88394. * 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.
  88395. */
  88396. get globalSaturation(): number;
  88397. /**
  88398. * Sets the global Saturation value.
  88399. * 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.
  88400. */
  88401. set globalSaturation(value: number);
  88402. /**
  88403. * Gets the global Exposure value.
  88404. * 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.
  88405. */
  88406. get globalExposure(): number;
  88407. /**
  88408. * Sets the global Exposure value.
  88409. * 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.
  88410. */
  88411. set globalExposure(value: number);
  88412. private _highlightsHue;
  88413. private _highlightsDensity;
  88414. private _highlightsSaturation;
  88415. private _highlightsExposure;
  88416. /**
  88417. * Gets the highlights Hue value.
  88418. * 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).
  88419. */
  88420. get highlightsHue(): number;
  88421. /**
  88422. * Sets the highlights Hue value.
  88423. * 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).
  88424. */
  88425. set highlightsHue(value: number);
  88426. /**
  88427. * Gets the highlights Density value.
  88428. * 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.
  88429. * Values less than zero provide a filter of opposite hue.
  88430. */
  88431. get highlightsDensity(): number;
  88432. /**
  88433. * Sets the highlights Density value.
  88434. * 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.
  88435. * Values less than zero provide a filter of opposite hue.
  88436. */
  88437. set highlightsDensity(value: number);
  88438. /**
  88439. * Gets the highlights Saturation value.
  88440. * 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.
  88441. */
  88442. get highlightsSaturation(): number;
  88443. /**
  88444. * Sets the highlights Saturation value.
  88445. * 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.
  88446. */
  88447. set highlightsSaturation(value: number);
  88448. /**
  88449. * Gets the highlights Exposure value.
  88450. * 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.
  88451. */
  88452. get highlightsExposure(): number;
  88453. /**
  88454. * Sets the highlights Exposure value.
  88455. * 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.
  88456. */
  88457. set highlightsExposure(value: number);
  88458. private _midtonesHue;
  88459. private _midtonesDensity;
  88460. private _midtonesSaturation;
  88461. private _midtonesExposure;
  88462. /**
  88463. * Gets the midtones Hue value.
  88464. * 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).
  88465. */
  88466. get midtonesHue(): number;
  88467. /**
  88468. * Sets the midtones Hue value.
  88469. * 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).
  88470. */
  88471. set midtonesHue(value: number);
  88472. /**
  88473. * Gets the midtones Density value.
  88474. * 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.
  88475. * Values less than zero provide a filter of opposite hue.
  88476. */
  88477. get midtonesDensity(): number;
  88478. /**
  88479. * Sets the midtones Density value.
  88480. * 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.
  88481. * Values less than zero provide a filter of opposite hue.
  88482. */
  88483. set midtonesDensity(value: number);
  88484. /**
  88485. * Gets the midtones Saturation value.
  88486. * 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.
  88487. */
  88488. get midtonesSaturation(): number;
  88489. /**
  88490. * Sets the midtones Saturation value.
  88491. * 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.
  88492. */
  88493. set midtonesSaturation(value: number);
  88494. /**
  88495. * Gets the midtones Exposure value.
  88496. * 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.
  88497. */
  88498. get midtonesExposure(): number;
  88499. /**
  88500. * Sets the midtones Exposure value.
  88501. * 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.
  88502. */
  88503. set midtonesExposure(value: number);
  88504. private _shadowsHue;
  88505. private _shadowsDensity;
  88506. private _shadowsSaturation;
  88507. private _shadowsExposure;
  88508. /**
  88509. * Gets the shadows Hue value.
  88510. * 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).
  88511. */
  88512. get shadowsHue(): number;
  88513. /**
  88514. * Sets the shadows Hue value.
  88515. * 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).
  88516. */
  88517. set shadowsHue(value: number);
  88518. /**
  88519. * Gets the shadows Density value.
  88520. * 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.
  88521. * Values less than zero provide a filter of opposite hue.
  88522. */
  88523. get shadowsDensity(): number;
  88524. /**
  88525. * Sets the shadows Density value.
  88526. * 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.
  88527. * Values less than zero provide a filter of opposite hue.
  88528. */
  88529. set shadowsDensity(value: number);
  88530. /**
  88531. * Gets the shadows Saturation value.
  88532. * 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.
  88533. */
  88534. get shadowsSaturation(): number;
  88535. /**
  88536. * Sets the shadows Saturation value.
  88537. * 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.
  88538. */
  88539. set shadowsSaturation(value: number);
  88540. /**
  88541. * Gets the shadows Exposure value.
  88542. * 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.
  88543. */
  88544. get shadowsExposure(): number;
  88545. /**
  88546. * Sets the shadows Exposure value.
  88547. * 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.
  88548. */
  88549. set shadowsExposure(value: number);
  88550. /**
  88551. * Returns the class name
  88552. * @returns The class name
  88553. */
  88554. getClassName(): string;
  88555. /**
  88556. * Binds the color curves to the shader.
  88557. * @param colorCurves The color curve to bind
  88558. * @param effect The effect to bind to
  88559. * @param positiveUniform The positive uniform shader parameter
  88560. * @param neutralUniform The neutral uniform shader parameter
  88561. * @param negativeUniform The negative uniform shader parameter
  88562. */
  88563. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  88564. /**
  88565. * Prepare the list of uniforms associated with the ColorCurves effects.
  88566. * @param uniformsList The list of uniforms used in the effect
  88567. */
  88568. static PrepareUniforms(uniformsList: string[]): void;
  88569. /**
  88570. * Returns color grading data based on a hue, density, saturation and exposure value.
  88571. * @param filterHue The hue of the color filter.
  88572. * @param filterDensity The density of the color filter.
  88573. * @param saturation The saturation.
  88574. * @param exposure The exposure.
  88575. * @param result The result data container.
  88576. */
  88577. private getColorGradingDataToRef;
  88578. /**
  88579. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  88580. * @param value The input slider value in range [-100,100].
  88581. * @returns Adjusted value.
  88582. */
  88583. private static applyColorGradingSliderNonlinear;
  88584. /**
  88585. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  88586. * @param hue The hue (H) input.
  88587. * @param saturation The saturation (S) input.
  88588. * @param brightness The brightness (B) input.
  88589. * @result An RGBA color represented as Vector4.
  88590. */
  88591. private static fromHSBToRef;
  88592. /**
  88593. * Returns a value clamped between min and max
  88594. * @param value The value to clamp
  88595. * @param min The minimum of value
  88596. * @param max The maximum of value
  88597. * @returns The clamped value.
  88598. */
  88599. private static clamp;
  88600. /**
  88601. * Clones the current color curve instance.
  88602. * @return The cloned curves
  88603. */
  88604. clone(): ColorCurves;
  88605. /**
  88606. * Serializes the current color curve instance to a json representation.
  88607. * @return a JSON representation
  88608. */
  88609. serialize(): any;
  88610. /**
  88611. * Parses the color curve from a json representation.
  88612. * @param source the JSON source to parse
  88613. * @return The parsed curves
  88614. */
  88615. static Parse(source: any): ColorCurves;
  88616. }
  88617. }
  88618. declare module BABYLON {
  88619. /**
  88620. * Interface to follow in your material defines to integrate easily the
  88621. * Image proccessing functions.
  88622. * @hidden
  88623. */
  88624. export interface IImageProcessingConfigurationDefines {
  88625. IMAGEPROCESSING: boolean;
  88626. VIGNETTE: boolean;
  88627. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88628. VIGNETTEBLENDMODEOPAQUE: boolean;
  88629. TONEMAPPING: boolean;
  88630. TONEMAPPING_ACES: boolean;
  88631. CONTRAST: boolean;
  88632. EXPOSURE: boolean;
  88633. COLORCURVES: boolean;
  88634. COLORGRADING: boolean;
  88635. COLORGRADING3D: boolean;
  88636. SAMPLER3DGREENDEPTH: boolean;
  88637. SAMPLER3DBGRMAP: boolean;
  88638. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88639. }
  88640. /**
  88641. * @hidden
  88642. */
  88643. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  88644. IMAGEPROCESSING: boolean;
  88645. VIGNETTE: boolean;
  88646. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88647. VIGNETTEBLENDMODEOPAQUE: boolean;
  88648. TONEMAPPING: boolean;
  88649. TONEMAPPING_ACES: boolean;
  88650. CONTRAST: boolean;
  88651. COLORCURVES: boolean;
  88652. COLORGRADING: boolean;
  88653. COLORGRADING3D: boolean;
  88654. SAMPLER3DGREENDEPTH: boolean;
  88655. SAMPLER3DBGRMAP: boolean;
  88656. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88657. EXPOSURE: boolean;
  88658. constructor();
  88659. }
  88660. /**
  88661. * This groups together the common properties used for image processing either in direct forward pass
  88662. * or through post processing effect depending on the use of the image processing pipeline in your scene
  88663. * or not.
  88664. */
  88665. export class ImageProcessingConfiguration {
  88666. /**
  88667. * Default tone mapping applied in BabylonJS.
  88668. */
  88669. static readonly TONEMAPPING_STANDARD: number;
  88670. /**
  88671. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  88672. * to other engines rendering to increase portability.
  88673. */
  88674. static readonly TONEMAPPING_ACES: number;
  88675. /**
  88676. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  88677. */
  88678. colorCurves: Nullable<ColorCurves>;
  88679. private _colorCurvesEnabled;
  88680. /**
  88681. * Gets wether the color curves effect is enabled.
  88682. */
  88683. get colorCurvesEnabled(): boolean;
  88684. /**
  88685. * Sets wether the color curves effect is enabled.
  88686. */
  88687. set colorCurvesEnabled(value: boolean);
  88688. private _colorGradingTexture;
  88689. /**
  88690. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88691. */
  88692. get colorGradingTexture(): Nullable<BaseTexture>;
  88693. /**
  88694. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88695. */
  88696. set colorGradingTexture(value: Nullable<BaseTexture>);
  88697. private _colorGradingEnabled;
  88698. /**
  88699. * Gets wether the color grading effect is enabled.
  88700. */
  88701. get colorGradingEnabled(): boolean;
  88702. /**
  88703. * Sets wether the color grading effect is enabled.
  88704. */
  88705. set colorGradingEnabled(value: boolean);
  88706. private _colorGradingWithGreenDepth;
  88707. /**
  88708. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88709. */
  88710. get colorGradingWithGreenDepth(): boolean;
  88711. /**
  88712. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88713. */
  88714. set colorGradingWithGreenDepth(value: boolean);
  88715. private _colorGradingBGR;
  88716. /**
  88717. * Gets wether the color grading texture contains BGR values.
  88718. */
  88719. get colorGradingBGR(): boolean;
  88720. /**
  88721. * Sets wether the color grading texture contains BGR values.
  88722. */
  88723. set colorGradingBGR(value: boolean);
  88724. /** @hidden */
  88725. _exposure: number;
  88726. /**
  88727. * Gets the Exposure used in the effect.
  88728. */
  88729. get exposure(): number;
  88730. /**
  88731. * Sets the Exposure used in the effect.
  88732. */
  88733. set exposure(value: number);
  88734. private _toneMappingEnabled;
  88735. /**
  88736. * Gets wether the tone mapping effect is enabled.
  88737. */
  88738. get toneMappingEnabled(): boolean;
  88739. /**
  88740. * Sets wether the tone mapping effect is enabled.
  88741. */
  88742. set toneMappingEnabled(value: boolean);
  88743. private _toneMappingType;
  88744. /**
  88745. * Gets the type of tone mapping effect.
  88746. */
  88747. get toneMappingType(): number;
  88748. /**
  88749. * Sets the type of tone mapping effect used in BabylonJS.
  88750. */
  88751. set toneMappingType(value: number);
  88752. protected _contrast: number;
  88753. /**
  88754. * Gets the contrast used in the effect.
  88755. */
  88756. get contrast(): number;
  88757. /**
  88758. * Sets the contrast used in the effect.
  88759. */
  88760. set contrast(value: number);
  88761. /**
  88762. * Vignette stretch size.
  88763. */
  88764. vignetteStretch: number;
  88765. /**
  88766. * Vignette centre X Offset.
  88767. */
  88768. vignetteCentreX: number;
  88769. /**
  88770. * Vignette centre Y Offset.
  88771. */
  88772. vignetteCentreY: number;
  88773. /**
  88774. * Vignette weight or intensity of the vignette effect.
  88775. */
  88776. vignetteWeight: number;
  88777. /**
  88778. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88779. * if vignetteEnabled is set to true.
  88780. */
  88781. vignetteColor: Color4;
  88782. /**
  88783. * Camera field of view used by the Vignette effect.
  88784. */
  88785. vignetteCameraFov: number;
  88786. private _vignetteBlendMode;
  88787. /**
  88788. * Gets the vignette blend mode allowing different kind of effect.
  88789. */
  88790. get vignetteBlendMode(): number;
  88791. /**
  88792. * Sets the vignette blend mode allowing different kind of effect.
  88793. */
  88794. set vignetteBlendMode(value: number);
  88795. private _vignetteEnabled;
  88796. /**
  88797. * Gets wether the vignette effect is enabled.
  88798. */
  88799. get vignetteEnabled(): boolean;
  88800. /**
  88801. * Sets wether the vignette effect is enabled.
  88802. */
  88803. set vignetteEnabled(value: boolean);
  88804. private _applyByPostProcess;
  88805. /**
  88806. * Gets wether the image processing is applied through a post process or not.
  88807. */
  88808. get applyByPostProcess(): boolean;
  88809. /**
  88810. * Sets wether the image processing is applied through a post process or not.
  88811. */
  88812. set applyByPostProcess(value: boolean);
  88813. private _isEnabled;
  88814. /**
  88815. * Gets wether the image processing is enabled or not.
  88816. */
  88817. get isEnabled(): boolean;
  88818. /**
  88819. * Sets wether the image processing is enabled or not.
  88820. */
  88821. set isEnabled(value: boolean);
  88822. /**
  88823. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88824. */
  88825. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88826. /**
  88827. * Method called each time the image processing information changes requires to recompile the effect.
  88828. */
  88829. protected _updateParameters(): void;
  88830. /**
  88831. * Gets the current class name.
  88832. * @return "ImageProcessingConfiguration"
  88833. */
  88834. getClassName(): string;
  88835. /**
  88836. * Prepare the list of uniforms associated with the Image Processing effects.
  88837. * @param uniforms The list of uniforms used in the effect
  88838. * @param defines the list of defines currently in use
  88839. */
  88840. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88841. /**
  88842. * Prepare the list of samplers associated with the Image Processing effects.
  88843. * @param samplersList The list of uniforms used in the effect
  88844. * @param defines the list of defines currently in use
  88845. */
  88846. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88847. /**
  88848. * Prepare the list of defines associated to the shader.
  88849. * @param defines the list of defines to complete
  88850. * @param forPostProcess Define if we are currently in post process mode or not
  88851. */
  88852. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88853. /**
  88854. * Returns true if all the image processing information are ready.
  88855. * @returns True if ready, otherwise, false
  88856. */
  88857. isReady(): boolean;
  88858. /**
  88859. * Binds the image processing to the shader.
  88860. * @param effect The effect to bind to
  88861. * @param overrideAspectRatio Override the aspect ratio of the effect
  88862. */
  88863. bind(effect: Effect, overrideAspectRatio?: number): void;
  88864. /**
  88865. * Clones the current image processing instance.
  88866. * @return The cloned image processing
  88867. */
  88868. clone(): ImageProcessingConfiguration;
  88869. /**
  88870. * Serializes the current image processing instance to a json representation.
  88871. * @return a JSON representation
  88872. */
  88873. serialize(): any;
  88874. /**
  88875. * Parses the image processing from a json representation.
  88876. * @param source the JSON source to parse
  88877. * @return The parsed image processing
  88878. */
  88879. static Parse(source: any): ImageProcessingConfiguration;
  88880. private static _VIGNETTEMODE_MULTIPLY;
  88881. private static _VIGNETTEMODE_OPAQUE;
  88882. /**
  88883. * Used to apply the vignette as a mix with the pixel color.
  88884. */
  88885. static get VIGNETTEMODE_MULTIPLY(): number;
  88886. /**
  88887. * Used to apply the vignette as a replacement of the pixel color.
  88888. */
  88889. static get VIGNETTEMODE_OPAQUE(): number;
  88890. }
  88891. }
  88892. declare module BABYLON {
  88893. /** @hidden */
  88894. export var postprocessVertexShader: {
  88895. name: string;
  88896. shader: string;
  88897. };
  88898. }
  88899. declare module BABYLON {
  88900. /**
  88901. * Type used to define a render target texture size (either with a number or with a rect width and height)
  88902. */
  88903. export type RenderTargetTextureSize = number | {
  88904. width: number;
  88905. height: number;
  88906. layers?: number;
  88907. };
  88908. interface ThinEngine {
  88909. /**
  88910. * Creates a new render target texture
  88911. * @param size defines the size of the texture
  88912. * @param options defines the options used to create the texture
  88913. * @returns a new render target texture stored in an InternalTexture
  88914. */
  88915. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88916. /**
  88917. * Creates a depth stencil texture.
  88918. * This is only available in WebGL 2 or with the depth texture extension available.
  88919. * @param size The size of face edge in the texture.
  88920. * @param options The options defining the texture.
  88921. * @returns The texture
  88922. */
  88923. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  88924. /** @hidden */
  88925. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  88926. }
  88927. }
  88928. declare module BABYLON {
  88929. /**
  88930. * Defines the kind of connection point for node based material
  88931. */
  88932. export enum NodeMaterialBlockConnectionPointTypes {
  88933. /** Float */
  88934. Float = 1,
  88935. /** Int */
  88936. Int = 2,
  88937. /** Vector2 */
  88938. Vector2 = 4,
  88939. /** Vector3 */
  88940. Vector3 = 8,
  88941. /** Vector4 */
  88942. Vector4 = 16,
  88943. /** Color3 */
  88944. Color3 = 32,
  88945. /** Color4 */
  88946. Color4 = 64,
  88947. /** Matrix */
  88948. Matrix = 128,
  88949. /** Custom object */
  88950. Object = 256,
  88951. /** Detect type based on connection */
  88952. AutoDetect = 1024,
  88953. /** Output type that will be defined by input type */
  88954. BasedOnInput = 2048
  88955. }
  88956. }
  88957. declare module BABYLON {
  88958. /**
  88959. * Enum used to define the target of a block
  88960. */
  88961. export enum NodeMaterialBlockTargets {
  88962. /** Vertex shader */
  88963. Vertex = 1,
  88964. /** Fragment shader */
  88965. Fragment = 2,
  88966. /** Neutral */
  88967. Neutral = 4,
  88968. /** Vertex and Fragment */
  88969. VertexAndFragment = 3
  88970. }
  88971. }
  88972. declare module BABYLON {
  88973. /**
  88974. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88975. */
  88976. export enum NodeMaterialBlockConnectionPointMode {
  88977. /** Value is an uniform */
  88978. Uniform = 0,
  88979. /** Value is a mesh attribute */
  88980. Attribute = 1,
  88981. /** Value is a varying between vertex and fragment shaders */
  88982. Varying = 2,
  88983. /** Mode is undefined */
  88984. Undefined = 3
  88985. }
  88986. }
  88987. declare module BABYLON {
  88988. /**
  88989. * Enum used to define system values e.g. values automatically provided by the system
  88990. */
  88991. export enum NodeMaterialSystemValues {
  88992. /** World */
  88993. World = 1,
  88994. /** View */
  88995. View = 2,
  88996. /** Projection */
  88997. Projection = 3,
  88998. /** ViewProjection */
  88999. ViewProjection = 4,
  89000. /** WorldView */
  89001. WorldView = 5,
  89002. /** WorldViewProjection */
  89003. WorldViewProjection = 6,
  89004. /** CameraPosition */
  89005. CameraPosition = 7,
  89006. /** Fog Color */
  89007. FogColor = 8,
  89008. /** Delta time */
  89009. DeltaTime = 9
  89010. }
  89011. }
  89012. declare module BABYLON {
  89013. /** Defines supported spaces */
  89014. export enum Space {
  89015. /** Local (object) space */
  89016. LOCAL = 0,
  89017. /** World space */
  89018. WORLD = 1,
  89019. /** Bone space */
  89020. BONE = 2
  89021. }
  89022. /** Defines the 3 main axes */
  89023. export class Axis {
  89024. /** X axis */
  89025. static X: Vector3;
  89026. /** Y axis */
  89027. static Y: Vector3;
  89028. /** Z axis */
  89029. static Z: Vector3;
  89030. }
  89031. }
  89032. declare module BABYLON {
  89033. /**
  89034. * Represents a camera frustum
  89035. */
  89036. export class Frustum {
  89037. /**
  89038. * Gets the planes representing the frustum
  89039. * @param transform matrix to be applied to the returned planes
  89040. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  89041. */
  89042. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  89043. /**
  89044. * Gets the near frustum plane transformed by the transform matrix
  89045. * @param transform transformation matrix to be applied to the resulting frustum plane
  89046. * @param frustumPlane the resuling frustum plane
  89047. */
  89048. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89049. /**
  89050. * Gets the far frustum plane transformed by the transform matrix
  89051. * @param transform transformation matrix to be applied to the resulting frustum plane
  89052. * @param frustumPlane the resuling frustum plane
  89053. */
  89054. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89055. /**
  89056. * Gets the left frustum plane transformed by the transform matrix
  89057. * @param transform transformation matrix to be applied to the resulting frustum plane
  89058. * @param frustumPlane the resuling frustum plane
  89059. */
  89060. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89061. /**
  89062. * Gets the right frustum plane transformed by the transform matrix
  89063. * @param transform transformation matrix to be applied to the resulting frustum plane
  89064. * @param frustumPlane the resuling frustum plane
  89065. */
  89066. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89067. /**
  89068. * Gets the top frustum plane transformed by the transform matrix
  89069. * @param transform transformation matrix to be applied to the resulting frustum plane
  89070. * @param frustumPlane the resuling frustum plane
  89071. */
  89072. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89073. /**
  89074. * Gets the bottom frustum plane transformed by the transform matrix
  89075. * @param transform transformation matrix to be applied to the resulting frustum plane
  89076. * @param frustumPlane the resuling frustum plane
  89077. */
  89078. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89079. /**
  89080. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  89081. * @param transform transformation matrix to be applied to the resulting frustum planes
  89082. * @param frustumPlanes the resuling frustum planes
  89083. */
  89084. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  89085. }
  89086. }
  89087. declare module BABYLON {
  89088. /**
  89089. * Interface for the size containing width and height
  89090. */
  89091. export interface ISize {
  89092. /**
  89093. * Width
  89094. */
  89095. width: number;
  89096. /**
  89097. * Heighht
  89098. */
  89099. height: number;
  89100. }
  89101. /**
  89102. * Size containing widht and height
  89103. */
  89104. export class Size implements ISize {
  89105. /**
  89106. * Width
  89107. */
  89108. width: number;
  89109. /**
  89110. * Height
  89111. */
  89112. height: number;
  89113. /**
  89114. * Creates a Size object from the given width and height (floats).
  89115. * @param width width of the new size
  89116. * @param height height of the new size
  89117. */
  89118. constructor(width: number, height: number);
  89119. /**
  89120. * Returns a string with the Size width and height
  89121. * @returns a string with the Size width and height
  89122. */
  89123. toString(): string;
  89124. /**
  89125. * "Size"
  89126. * @returns the string "Size"
  89127. */
  89128. getClassName(): string;
  89129. /**
  89130. * Returns the Size hash code.
  89131. * @returns a hash code for a unique width and height
  89132. */
  89133. getHashCode(): number;
  89134. /**
  89135. * Updates the current size from the given one.
  89136. * @param src the given size
  89137. */
  89138. copyFrom(src: Size): void;
  89139. /**
  89140. * Updates in place the current Size from the given floats.
  89141. * @param width width of the new size
  89142. * @param height height of the new size
  89143. * @returns the updated Size.
  89144. */
  89145. copyFromFloats(width: number, height: number): Size;
  89146. /**
  89147. * Updates in place the current Size from the given floats.
  89148. * @param width width to set
  89149. * @param height height to set
  89150. * @returns the updated Size.
  89151. */
  89152. set(width: number, height: number): Size;
  89153. /**
  89154. * Multiplies the width and height by numbers
  89155. * @param w factor to multiple the width by
  89156. * @param h factor to multiple the height by
  89157. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  89158. */
  89159. multiplyByFloats(w: number, h: number): Size;
  89160. /**
  89161. * Clones the size
  89162. * @returns a new Size copied from the given one.
  89163. */
  89164. clone(): Size;
  89165. /**
  89166. * True if the current Size and the given one width and height are strictly equal.
  89167. * @param other the other size to compare against
  89168. * @returns True if the current Size and the given one width and height are strictly equal.
  89169. */
  89170. equals(other: Size): boolean;
  89171. /**
  89172. * The surface of the Size : width * height (float).
  89173. */
  89174. get surface(): number;
  89175. /**
  89176. * Create a new size of zero
  89177. * @returns a new Size set to (0.0, 0.0)
  89178. */
  89179. static Zero(): Size;
  89180. /**
  89181. * Sums the width and height of two sizes
  89182. * @param otherSize size to add to this size
  89183. * @returns a new Size set as the addition result of the current Size and the given one.
  89184. */
  89185. add(otherSize: Size): Size;
  89186. /**
  89187. * Subtracts the width and height of two
  89188. * @param otherSize size to subtract to this size
  89189. * @returns a new Size set as the subtraction result of the given one from the current Size.
  89190. */
  89191. subtract(otherSize: Size): Size;
  89192. /**
  89193. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  89194. * @param start starting size to lerp between
  89195. * @param end end size to lerp between
  89196. * @param amount amount to lerp between the start and end values
  89197. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  89198. */
  89199. static Lerp(start: Size, end: Size, amount: number): Size;
  89200. }
  89201. }
  89202. declare module BABYLON {
  89203. /**
  89204. * Contains position and normal vectors for a vertex
  89205. */
  89206. export class PositionNormalVertex {
  89207. /** the position of the vertex (defaut: 0,0,0) */
  89208. position: Vector3;
  89209. /** the normal of the vertex (defaut: 0,1,0) */
  89210. normal: Vector3;
  89211. /**
  89212. * Creates a PositionNormalVertex
  89213. * @param position the position of the vertex (defaut: 0,0,0)
  89214. * @param normal the normal of the vertex (defaut: 0,1,0)
  89215. */
  89216. constructor(
  89217. /** the position of the vertex (defaut: 0,0,0) */
  89218. position?: Vector3,
  89219. /** the normal of the vertex (defaut: 0,1,0) */
  89220. normal?: Vector3);
  89221. /**
  89222. * Clones the PositionNormalVertex
  89223. * @returns the cloned PositionNormalVertex
  89224. */
  89225. clone(): PositionNormalVertex;
  89226. }
  89227. /**
  89228. * Contains position, normal and uv vectors for a vertex
  89229. */
  89230. export class PositionNormalTextureVertex {
  89231. /** the position of the vertex (defaut: 0,0,0) */
  89232. position: Vector3;
  89233. /** the normal of the vertex (defaut: 0,1,0) */
  89234. normal: Vector3;
  89235. /** the uv of the vertex (default: 0,0) */
  89236. uv: Vector2;
  89237. /**
  89238. * Creates a PositionNormalTextureVertex
  89239. * @param position the position of the vertex (defaut: 0,0,0)
  89240. * @param normal the normal of the vertex (defaut: 0,1,0)
  89241. * @param uv the uv of the vertex (default: 0,0)
  89242. */
  89243. constructor(
  89244. /** the position of the vertex (defaut: 0,0,0) */
  89245. position?: Vector3,
  89246. /** the normal of the vertex (defaut: 0,1,0) */
  89247. normal?: Vector3,
  89248. /** the uv of the vertex (default: 0,0) */
  89249. uv?: Vector2);
  89250. /**
  89251. * Clones the PositionNormalTextureVertex
  89252. * @returns the cloned PositionNormalTextureVertex
  89253. */
  89254. clone(): PositionNormalTextureVertex;
  89255. }
  89256. }
  89257. declare module BABYLON {
  89258. /**
  89259. * Enum defining the type of animations supported by InputBlock
  89260. */
  89261. export enum AnimatedInputBlockTypes {
  89262. /** No animation */
  89263. None = 0,
  89264. /** Time based animation. Will only work for floats */
  89265. Time = 1
  89266. }
  89267. }
  89268. declare module BABYLON {
  89269. /**
  89270. * Interface describing all the common properties and methods a shadow light needs to implement.
  89271. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  89272. * as well as binding the different shadow properties to the effects.
  89273. */
  89274. export interface IShadowLight extends Light {
  89275. /**
  89276. * The light id in the scene (used in scene.findLighById for instance)
  89277. */
  89278. id: string;
  89279. /**
  89280. * The position the shdow will be casted from.
  89281. */
  89282. position: Vector3;
  89283. /**
  89284. * In 2d mode (needCube being false), the direction used to cast the shadow.
  89285. */
  89286. direction: Vector3;
  89287. /**
  89288. * The transformed position. Position of the light in world space taking parenting in account.
  89289. */
  89290. transformedPosition: Vector3;
  89291. /**
  89292. * The transformed direction. Direction of the light in world space taking parenting in account.
  89293. */
  89294. transformedDirection: Vector3;
  89295. /**
  89296. * The friendly name of the light in the scene.
  89297. */
  89298. name: string;
  89299. /**
  89300. * Defines the shadow projection clipping minimum z value.
  89301. */
  89302. shadowMinZ: number;
  89303. /**
  89304. * Defines the shadow projection clipping maximum z value.
  89305. */
  89306. shadowMaxZ: number;
  89307. /**
  89308. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  89309. * @returns true if the information has been computed, false if it does not need to (no parenting)
  89310. */
  89311. computeTransformedInformation(): boolean;
  89312. /**
  89313. * Gets the scene the light belongs to.
  89314. * @returns The scene
  89315. */
  89316. getScene(): Scene;
  89317. /**
  89318. * Callback defining a custom Projection Matrix Builder.
  89319. * This can be used to override the default projection matrix computation.
  89320. */
  89321. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  89322. /**
  89323. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  89324. * @param matrix The materix to updated with the projection information
  89325. * @param viewMatrix The transform matrix of the light
  89326. * @param renderList The list of mesh to render in the map
  89327. * @returns The current light
  89328. */
  89329. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  89330. /**
  89331. * Gets the current depth scale used in ESM.
  89332. * @returns The scale
  89333. */
  89334. getDepthScale(): number;
  89335. /**
  89336. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  89337. * @returns true if a cube texture needs to be use
  89338. */
  89339. needCube(): boolean;
  89340. /**
  89341. * Detects if the projection matrix requires to be recomputed this frame.
  89342. * @returns true if it requires to be recomputed otherwise, false.
  89343. */
  89344. needProjectionMatrixCompute(): boolean;
  89345. /**
  89346. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  89347. */
  89348. forceProjectionMatrixCompute(): void;
  89349. /**
  89350. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  89351. * @param faceIndex The index of the face we are computed the direction to generate shadow
  89352. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  89353. */
  89354. getShadowDirection(faceIndex?: number): Vector3;
  89355. /**
  89356. * Gets the minZ used for shadow according to both the scene and the light.
  89357. * @param activeCamera The camera we are returning the min for
  89358. * @returns the depth min z
  89359. */
  89360. getDepthMinZ(activeCamera: Camera): number;
  89361. /**
  89362. * Gets the maxZ used for shadow according to both the scene and the light.
  89363. * @param activeCamera The camera we are returning the max for
  89364. * @returns the depth max z
  89365. */
  89366. getDepthMaxZ(activeCamera: Camera): number;
  89367. }
  89368. /**
  89369. * Base implementation IShadowLight
  89370. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  89371. */
  89372. export abstract class ShadowLight extends Light implements IShadowLight {
  89373. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  89374. protected _position: Vector3;
  89375. protected _setPosition(value: Vector3): void;
  89376. /**
  89377. * Sets the position the shadow will be casted from. Also use as the light position for both
  89378. * point and spot lights.
  89379. */
  89380. get position(): Vector3;
  89381. /**
  89382. * Sets the position the shadow will be casted from. Also use as the light position for both
  89383. * point and spot lights.
  89384. */
  89385. set position(value: Vector3);
  89386. protected _direction: Vector3;
  89387. protected _setDirection(value: Vector3): void;
  89388. /**
  89389. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  89390. * Also use as the light direction on spot and directional lights.
  89391. */
  89392. get direction(): Vector3;
  89393. /**
  89394. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  89395. * Also use as the light direction on spot and directional lights.
  89396. */
  89397. set direction(value: Vector3);
  89398. protected _shadowMinZ: number;
  89399. /**
  89400. * Gets the shadow projection clipping minimum z value.
  89401. */
  89402. get shadowMinZ(): number;
  89403. /**
  89404. * Sets the shadow projection clipping minimum z value.
  89405. */
  89406. set shadowMinZ(value: number);
  89407. protected _shadowMaxZ: number;
  89408. /**
  89409. * Sets the shadow projection clipping maximum z value.
  89410. */
  89411. get shadowMaxZ(): number;
  89412. /**
  89413. * Gets the shadow projection clipping maximum z value.
  89414. */
  89415. set shadowMaxZ(value: number);
  89416. /**
  89417. * Callback defining a custom Projection Matrix Builder.
  89418. * This can be used to override the default projection matrix computation.
  89419. */
  89420. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  89421. /**
  89422. * The transformed position. Position of the light in world space taking parenting in account.
  89423. */
  89424. transformedPosition: Vector3;
  89425. /**
  89426. * The transformed direction. Direction of the light in world space taking parenting in account.
  89427. */
  89428. transformedDirection: Vector3;
  89429. private _needProjectionMatrixCompute;
  89430. /**
  89431. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  89432. * @returns true if the information has been computed, false if it does not need to (no parenting)
  89433. */
  89434. computeTransformedInformation(): boolean;
  89435. /**
  89436. * Return the depth scale used for the shadow map.
  89437. * @returns the depth scale.
  89438. */
  89439. getDepthScale(): number;
  89440. /**
  89441. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  89442. * @param faceIndex The index of the face we are computed the direction to generate shadow
  89443. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  89444. */
  89445. getShadowDirection(faceIndex?: number): Vector3;
  89446. /**
  89447. * Returns the ShadowLight absolute position in the World.
  89448. * @returns the position vector in world space
  89449. */
  89450. getAbsolutePosition(): Vector3;
  89451. /**
  89452. * Sets the ShadowLight direction toward the passed target.
  89453. * @param target The point to target in local space
  89454. * @returns the updated ShadowLight direction
  89455. */
  89456. setDirectionToTarget(target: Vector3): Vector3;
  89457. /**
  89458. * Returns the light rotation in euler definition.
  89459. * @returns the x y z rotation in local space.
  89460. */
  89461. getRotation(): Vector3;
  89462. /**
  89463. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  89464. * @returns true if a cube texture needs to be use
  89465. */
  89466. needCube(): boolean;
  89467. /**
  89468. * Detects if the projection matrix requires to be recomputed this frame.
  89469. * @returns true if it requires to be recomputed otherwise, false.
  89470. */
  89471. needProjectionMatrixCompute(): boolean;
  89472. /**
  89473. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  89474. */
  89475. forceProjectionMatrixCompute(): void;
  89476. /** @hidden */
  89477. _initCache(): void;
  89478. /** @hidden */
  89479. _isSynchronized(): boolean;
  89480. /**
  89481. * Computes the world matrix of the node
  89482. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  89483. * @returns the world matrix
  89484. */
  89485. computeWorldMatrix(force?: boolean): Matrix;
  89486. /**
  89487. * Gets the minZ used for shadow according to both the scene and the light.
  89488. * @param activeCamera The camera we are returning the min for
  89489. * @returns the depth min z
  89490. */
  89491. getDepthMinZ(activeCamera: Camera): number;
  89492. /**
  89493. * Gets the maxZ used for shadow according to both the scene and the light.
  89494. * @param activeCamera The camera we are returning the max for
  89495. * @returns the depth max z
  89496. */
  89497. getDepthMaxZ(activeCamera: Camera): number;
  89498. /**
  89499. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  89500. * @param matrix The materix to updated with the projection information
  89501. * @param viewMatrix The transform matrix of the light
  89502. * @param renderList The list of mesh to render in the map
  89503. * @returns The current light
  89504. */
  89505. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  89506. }
  89507. }
  89508. declare module BABYLON {
  89509. /** @hidden */
  89510. export var packingFunctions: {
  89511. name: string;
  89512. shader: string;
  89513. };
  89514. }
  89515. declare module BABYLON {
  89516. /** @hidden */
  89517. export var bayerDitherFunctions: {
  89518. name: string;
  89519. shader: string;
  89520. };
  89521. }
  89522. declare module BABYLON {
  89523. /** @hidden */
  89524. export var shadowMapFragmentDeclaration: {
  89525. name: string;
  89526. shader: string;
  89527. };
  89528. }
  89529. declare module BABYLON {
  89530. /** @hidden */
  89531. export var clipPlaneFragmentDeclaration: {
  89532. name: string;
  89533. shader: string;
  89534. };
  89535. }
  89536. declare module BABYLON {
  89537. /** @hidden */
  89538. export var clipPlaneFragment: {
  89539. name: string;
  89540. shader: string;
  89541. };
  89542. }
  89543. declare module BABYLON {
  89544. /** @hidden */
  89545. export var shadowMapFragment: {
  89546. name: string;
  89547. shader: string;
  89548. };
  89549. }
  89550. declare module BABYLON {
  89551. /** @hidden */
  89552. export var shadowMapPixelShader: {
  89553. name: string;
  89554. shader: string;
  89555. };
  89556. }
  89557. declare module BABYLON {
  89558. /** @hidden */
  89559. export var bonesDeclaration: {
  89560. name: string;
  89561. shader: string;
  89562. };
  89563. }
  89564. declare module BABYLON {
  89565. /** @hidden */
  89566. export var morphTargetsVertexGlobalDeclaration: {
  89567. name: string;
  89568. shader: string;
  89569. };
  89570. }
  89571. declare module BABYLON {
  89572. /** @hidden */
  89573. export var morphTargetsVertexDeclaration: {
  89574. name: string;
  89575. shader: string;
  89576. };
  89577. }
  89578. declare module BABYLON {
  89579. /** @hidden */
  89580. export var instancesDeclaration: {
  89581. name: string;
  89582. shader: string;
  89583. };
  89584. }
  89585. declare module BABYLON {
  89586. /** @hidden */
  89587. export var helperFunctions: {
  89588. name: string;
  89589. shader: string;
  89590. };
  89591. }
  89592. declare module BABYLON {
  89593. /** @hidden */
  89594. export var shadowMapVertexDeclaration: {
  89595. name: string;
  89596. shader: string;
  89597. };
  89598. }
  89599. declare module BABYLON {
  89600. /** @hidden */
  89601. export var clipPlaneVertexDeclaration: {
  89602. name: string;
  89603. shader: string;
  89604. };
  89605. }
  89606. declare module BABYLON {
  89607. /** @hidden */
  89608. export var morphTargetsVertex: {
  89609. name: string;
  89610. shader: string;
  89611. };
  89612. }
  89613. declare module BABYLON {
  89614. /** @hidden */
  89615. export var instancesVertex: {
  89616. name: string;
  89617. shader: string;
  89618. };
  89619. }
  89620. declare module BABYLON {
  89621. /** @hidden */
  89622. export var bonesVertex: {
  89623. name: string;
  89624. shader: string;
  89625. };
  89626. }
  89627. declare module BABYLON {
  89628. /** @hidden */
  89629. export var shadowMapVertexNormalBias: {
  89630. name: string;
  89631. shader: string;
  89632. };
  89633. }
  89634. declare module BABYLON {
  89635. /** @hidden */
  89636. export var shadowMapVertexMetric: {
  89637. name: string;
  89638. shader: string;
  89639. };
  89640. }
  89641. declare module BABYLON {
  89642. /** @hidden */
  89643. export var clipPlaneVertex: {
  89644. name: string;
  89645. shader: string;
  89646. };
  89647. }
  89648. declare module BABYLON {
  89649. /** @hidden */
  89650. export var shadowMapVertexShader: {
  89651. name: string;
  89652. shader: string;
  89653. };
  89654. }
  89655. declare module BABYLON {
  89656. /** @hidden */
  89657. export var depthBoxBlurPixelShader: {
  89658. name: string;
  89659. shader: string;
  89660. };
  89661. }
  89662. declare module BABYLON {
  89663. /** @hidden */
  89664. export var shadowMapFragmentSoftTransparentShadow: {
  89665. name: string;
  89666. shader: string;
  89667. };
  89668. }
  89669. declare module BABYLON {
  89670. /**
  89671. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  89672. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  89673. */
  89674. export class EffectFallbacks implements IEffectFallbacks {
  89675. private _defines;
  89676. private _currentRank;
  89677. private _maxRank;
  89678. private _mesh;
  89679. /**
  89680. * Removes the fallback from the bound mesh.
  89681. */
  89682. unBindMesh(): void;
  89683. /**
  89684. * Adds a fallback on the specified property.
  89685. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89686. * @param define The name of the define in the shader
  89687. */
  89688. addFallback(rank: number, define: string): void;
  89689. /**
  89690. * Sets the mesh to use CPU skinning when needing to fallback.
  89691. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89692. * @param mesh The mesh to use the fallbacks.
  89693. */
  89694. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89695. /**
  89696. * Checks to see if more fallbacks are still availible.
  89697. */
  89698. get hasMoreFallbacks(): boolean;
  89699. /**
  89700. * Removes the defines that should be removed when falling back.
  89701. * @param currentDefines defines the current define statements for the shader.
  89702. * @param effect defines the current effect we try to compile
  89703. * @returns The resulting defines with defines of the current rank removed.
  89704. */
  89705. reduce(currentDefines: string, effect: Effect): string;
  89706. }
  89707. }
  89708. declare module BABYLON {
  89709. /**
  89710. * Interface used to define Action
  89711. */
  89712. export interface IAction {
  89713. /**
  89714. * Trigger for the action
  89715. */
  89716. trigger: number;
  89717. /** Options of the trigger */
  89718. triggerOptions: any;
  89719. /**
  89720. * Gets the trigger parameters
  89721. * @returns the trigger parameters
  89722. */
  89723. getTriggerParameter(): any;
  89724. /**
  89725. * Internal only - executes current action event
  89726. * @hidden
  89727. */
  89728. _executeCurrent(evt?: ActionEvent): void;
  89729. /**
  89730. * Serialize placeholder for child classes
  89731. * @param parent of child
  89732. * @returns the serialized object
  89733. */
  89734. serialize(parent: any): any;
  89735. /**
  89736. * Internal only
  89737. * @hidden
  89738. */
  89739. _prepare(): void;
  89740. /**
  89741. * Internal only - manager for action
  89742. * @hidden
  89743. */
  89744. _actionManager: Nullable<AbstractActionManager>;
  89745. /**
  89746. * Adds action to chain of actions, may be a DoNothingAction
  89747. * @param action defines the next action to execute
  89748. * @returns The action passed in
  89749. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89750. */
  89751. then(action: IAction): IAction;
  89752. }
  89753. /**
  89754. * The action to be carried out following a trigger
  89755. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89756. */
  89757. export class Action implements IAction {
  89758. /** the trigger, with or without parameters, for the action */
  89759. triggerOptions: any;
  89760. /**
  89761. * Trigger for the action
  89762. */
  89763. trigger: number;
  89764. /**
  89765. * Internal only - manager for action
  89766. * @hidden
  89767. */
  89768. _actionManager: ActionManager;
  89769. private _nextActiveAction;
  89770. private _child;
  89771. private _condition?;
  89772. private _triggerParameter;
  89773. /**
  89774. * An event triggered prior to action being executed.
  89775. */
  89776. onBeforeExecuteObservable: Observable<Action>;
  89777. /**
  89778. * Creates a new Action
  89779. * @param triggerOptions the trigger, with or without parameters, for the action
  89780. * @param condition an optional determinant of action
  89781. */
  89782. constructor(
  89783. /** the trigger, with or without parameters, for the action */
  89784. triggerOptions: any, condition?: Condition);
  89785. /**
  89786. * Internal only
  89787. * @hidden
  89788. */
  89789. _prepare(): void;
  89790. /**
  89791. * Gets the trigger parameters
  89792. * @returns the trigger parameters
  89793. */
  89794. getTriggerParameter(): any;
  89795. /**
  89796. * Internal only - executes current action event
  89797. * @hidden
  89798. */
  89799. _executeCurrent(evt?: ActionEvent): void;
  89800. /**
  89801. * Execute placeholder for child classes
  89802. * @param evt optional action event
  89803. */
  89804. execute(evt?: ActionEvent): void;
  89805. /**
  89806. * Skips to next active action
  89807. */
  89808. skipToNextActiveAction(): void;
  89809. /**
  89810. * Adds action to chain of actions, may be a DoNothingAction
  89811. * @param action defines the next action to execute
  89812. * @returns The action passed in
  89813. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89814. */
  89815. then(action: Action): Action;
  89816. /**
  89817. * Internal only
  89818. * @hidden
  89819. */
  89820. _getProperty(propertyPath: string): string;
  89821. /**
  89822. * Internal only
  89823. * @hidden
  89824. */
  89825. _getEffectiveTarget(target: any, propertyPath: string): any;
  89826. /**
  89827. * Serialize placeholder for child classes
  89828. * @param parent of child
  89829. * @returns the serialized object
  89830. */
  89831. serialize(parent: any): any;
  89832. /**
  89833. * Internal only called by serialize
  89834. * @hidden
  89835. */
  89836. protected _serialize(serializedAction: any, parent?: any): any;
  89837. /**
  89838. * Internal only
  89839. * @hidden
  89840. */
  89841. static _SerializeValueAsString: (value: any) => string;
  89842. /**
  89843. * Internal only
  89844. * @hidden
  89845. */
  89846. static _GetTargetProperty: (target: Scene | Node) => {
  89847. name: string;
  89848. targetType: string;
  89849. value: string;
  89850. };
  89851. }
  89852. }
  89853. declare module BABYLON {
  89854. /**
  89855. * A Condition applied to an Action
  89856. */
  89857. export class Condition {
  89858. /**
  89859. * Internal only - manager for action
  89860. * @hidden
  89861. */
  89862. _actionManager: ActionManager;
  89863. /**
  89864. * Internal only
  89865. * @hidden
  89866. */
  89867. _evaluationId: number;
  89868. /**
  89869. * Internal only
  89870. * @hidden
  89871. */
  89872. _currentResult: boolean;
  89873. /**
  89874. * Creates a new Condition
  89875. * @param actionManager the manager of the action the condition is applied to
  89876. */
  89877. constructor(actionManager: ActionManager);
  89878. /**
  89879. * Check if the current condition is valid
  89880. * @returns a boolean
  89881. */
  89882. isValid(): boolean;
  89883. /**
  89884. * Internal only
  89885. * @hidden
  89886. */
  89887. _getProperty(propertyPath: string): string;
  89888. /**
  89889. * Internal only
  89890. * @hidden
  89891. */
  89892. _getEffectiveTarget(target: any, propertyPath: string): any;
  89893. /**
  89894. * Serialize placeholder for child classes
  89895. * @returns the serialized object
  89896. */
  89897. serialize(): any;
  89898. /**
  89899. * Internal only
  89900. * @hidden
  89901. */
  89902. protected _serialize(serializedCondition: any): any;
  89903. }
  89904. /**
  89905. * Defines specific conditional operators as extensions of Condition
  89906. */
  89907. export class ValueCondition extends Condition {
  89908. /** path to specify the property of the target the conditional operator uses */
  89909. propertyPath: string;
  89910. /** the value compared by the conditional operator against the current value of the property */
  89911. value: any;
  89912. /** the conditional operator, default ValueCondition.IsEqual */
  89913. operator: number;
  89914. /**
  89915. * Internal only
  89916. * @hidden
  89917. */
  89918. private static _IsEqual;
  89919. /**
  89920. * Internal only
  89921. * @hidden
  89922. */
  89923. private static _IsDifferent;
  89924. /**
  89925. * Internal only
  89926. * @hidden
  89927. */
  89928. private static _IsGreater;
  89929. /**
  89930. * Internal only
  89931. * @hidden
  89932. */
  89933. private static _IsLesser;
  89934. /**
  89935. * returns the number for IsEqual
  89936. */
  89937. static get IsEqual(): number;
  89938. /**
  89939. * Returns the number for IsDifferent
  89940. */
  89941. static get IsDifferent(): number;
  89942. /**
  89943. * Returns the number for IsGreater
  89944. */
  89945. static get IsGreater(): number;
  89946. /**
  89947. * Returns the number for IsLesser
  89948. */
  89949. static get IsLesser(): number;
  89950. /**
  89951. * Internal only The action manager for the condition
  89952. * @hidden
  89953. */
  89954. _actionManager: ActionManager;
  89955. /**
  89956. * Internal only
  89957. * @hidden
  89958. */
  89959. private _target;
  89960. /**
  89961. * Internal only
  89962. * @hidden
  89963. */
  89964. private _effectiveTarget;
  89965. /**
  89966. * Internal only
  89967. * @hidden
  89968. */
  89969. private _property;
  89970. /**
  89971. * Creates a new ValueCondition
  89972. * @param actionManager manager for the action the condition applies to
  89973. * @param target for the action
  89974. * @param propertyPath path to specify the property of the target the conditional operator uses
  89975. * @param value the value compared by the conditional operator against the current value of the property
  89976. * @param operator the conditional operator, default ValueCondition.IsEqual
  89977. */
  89978. constructor(actionManager: ActionManager, target: any,
  89979. /** path to specify the property of the target the conditional operator uses */
  89980. propertyPath: string,
  89981. /** the value compared by the conditional operator against the current value of the property */
  89982. value: any,
  89983. /** the conditional operator, default ValueCondition.IsEqual */
  89984. operator?: number);
  89985. /**
  89986. * Compares the given value with the property value for the specified conditional operator
  89987. * @returns the result of the comparison
  89988. */
  89989. isValid(): boolean;
  89990. /**
  89991. * Serialize the ValueCondition into a JSON compatible object
  89992. * @returns serialization object
  89993. */
  89994. serialize(): any;
  89995. /**
  89996. * Gets the name of the conditional operator for the ValueCondition
  89997. * @param operator the conditional operator
  89998. * @returns the name
  89999. */
  90000. static GetOperatorName(operator: number): string;
  90001. }
  90002. /**
  90003. * Defines a predicate condition as an extension of Condition
  90004. */
  90005. export class PredicateCondition extends Condition {
  90006. /** defines the predicate function used to validate the condition */
  90007. predicate: () => boolean;
  90008. /**
  90009. * Internal only - manager for action
  90010. * @hidden
  90011. */
  90012. _actionManager: ActionManager;
  90013. /**
  90014. * Creates a new PredicateCondition
  90015. * @param actionManager manager for the action the condition applies to
  90016. * @param predicate defines the predicate function used to validate the condition
  90017. */
  90018. constructor(actionManager: ActionManager,
  90019. /** defines the predicate function used to validate the condition */
  90020. predicate: () => boolean);
  90021. /**
  90022. * @returns the validity of the predicate condition
  90023. */
  90024. isValid(): boolean;
  90025. }
  90026. /**
  90027. * Defines a state condition as an extension of Condition
  90028. */
  90029. export class StateCondition extends Condition {
  90030. /** Value to compare with target state */
  90031. value: string;
  90032. /**
  90033. * Internal only - manager for action
  90034. * @hidden
  90035. */
  90036. _actionManager: ActionManager;
  90037. /**
  90038. * Internal only
  90039. * @hidden
  90040. */
  90041. private _target;
  90042. /**
  90043. * Creates a new StateCondition
  90044. * @param actionManager manager for the action the condition applies to
  90045. * @param target of the condition
  90046. * @param value to compare with target state
  90047. */
  90048. constructor(actionManager: ActionManager, target: any,
  90049. /** Value to compare with target state */
  90050. value: string);
  90051. /**
  90052. * Gets a boolean indicating if the current condition is met
  90053. * @returns the validity of the state
  90054. */
  90055. isValid(): boolean;
  90056. /**
  90057. * Serialize the StateCondition into a JSON compatible object
  90058. * @returns serialization object
  90059. */
  90060. serialize(): any;
  90061. }
  90062. }
  90063. declare module BABYLON {
  90064. /**
  90065. * This defines an action responsible to toggle a boolean once triggered.
  90066. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90067. */
  90068. export class SwitchBooleanAction extends Action {
  90069. /**
  90070. * The path to the boolean property in the target object
  90071. */
  90072. propertyPath: string;
  90073. private _target;
  90074. private _effectiveTarget;
  90075. private _property;
  90076. /**
  90077. * Instantiate the action
  90078. * @param triggerOptions defines the trigger options
  90079. * @param target defines the object containing the boolean
  90080. * @param propertyPath defines the path to the boolean property in the target object
  90081. * @param condition defines the trigger related conditions
  90082. */
  90083. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  90084. /** @hidden */
  90085. _prepare(): void;
  90086. /**
  90087. * Execute the action toggle the boolean value.
  90088. */
  90089. execute(): void;
  90090. /**
  90091. * Serializes the actions and its related information.
  90092. * @param parent defines the object to serialize in
  90093. * @returns the serialized object
  90094. */
  90095. serialize(parent: any): any;
  90096. }
  90097. /**
  90098. * This defines an action responsible to set a the state field of the target
  90099. * to a desired value once triggered.
  90100. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90101. */
  90102. export class SetStateAction extends Action {
  90103. /**
  90104. * The value to store in the state field.
  90105. */
  90106. value: string;
  90107. private _target;
  90108. /**
  90109. * Instantiate the action
  90110. * @param triggerOptions defines the trigger options
  90111. * @param target defines the object containing the state property
  90112. * @param value defines the value to store in the state field
  90113. * @param condition defines the trigger related conditions
  90114. */
  90115. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  90116. /**
  90117. * Execute the action and store the value on the target state property.
  90118. */
  90119. execute(): void;
  90120. /**
  90121. * Serializes the actions and its related information.
  90122. * @param parent defines the object to serialize in
  90123. * @returns the serialized object
  90124. */
  90125. serialize(parent: any): any;
  90126. }
  90127. /**
  90128. * This defines an action responsible to set a property of the target
  90129. * to a desired value once triggered.
  90130. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90131. */
  90132. export class SetValueAction extends Action {
  90133. /**
  90134. * The path of the property to set in the target.
  90135. */
  90136. propertyPath: string;
  90137. /**
  90138. * The value to set in the property
  90139. */
  90140. value: any;
  90141. private _target;
  90142. private _effectiveTarget;
  90143. private _property;
  90144. /**
  90145. * Instantiate the action
  90146. * @param triggerOptions defines the trigger options
  90147. * @param target defines the object containing the property
  90148. * @param propertyPath defines the path of the property to set in the target
  90149. * @param value defines the value to set in the property
  90150. * @param condition defines the trigger related conditions
  90151. */
  90152. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  90153. /** @hidden */
  90154. _prepare(): void;
  90155. /**
  90156. * Execute the action and set the targetted property to the desired value.
  90157. */
  90158. execute(): void;
  90159. /**
  90160. * Serializes the actions and its related information.
  90161. * @param parent defines the object to serialize in
  90162. * @returns the serialized object
  90163. */
  90164. serialize(parent: any): any;
  90165. }
  90166. /**
  90167. * This defines an action responsible to increment the target value
  90168. * to a desired value once triggered.
  90169. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90170. */
  90171. export class IncrementValueAction extends Action {
  90172. /**
  90173. * The path of the property to increment in the target.
  90174. */
  90175. propertyPath: string;
  90176. /**
  90177. * The value we should increment the property by.
  90178. */
  90179. value: any;
  90180. private _target;
  90181. private _effectiveTarget;
  90182. private _property;
  90183. /**
  90184. * Instantiate the action
  90185. * @param triggerOptions defines the trigger options
  90186. * @param target defines the object containing the property
  90187. * @param propertyPath defines the path of the property to increment in the target
  90188. * @param value defines the value value we should increment the property by
  90189. * @param condition defines the trigger related conditions
  90190. */
  90191. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  90192. /** @hidden */
  90193. _prepare(): void;
  90194. /**
  90195. * Execute the action and increment the target of the value amount.
  90196. */
  90197. execute(): void;
  90198. /**
  90199. * Serializes the actions and its related information.
  90200. * @param parent defines the object to serialize in
  90201. * @returns the serialized object
  90202. */
  90203. serialize(parent: any): any;
  90204. }
  90205. /**
  90206. * This defines an action responsible to start an animation once triggered.
  90207. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90208. */
  90209. export class PlayAnimationAction extends Action {
  90210. /**
  90211. * Where the animation should start (animation frame)
  90212. */
  90213. from: number;
  90214. /**
  90215. * Where the animation should stop (animation frame)
  90216. */
  90217. to: number;
  90218. /**
  90219. * Define if the animation should loop or stop after the first play.
  90220. */
  90221. loop?: boolean;
  90222. private _target;
  90223. /**
  90224. * Instantiate the action
  90225. * @param triggerOptions defines the trigger options
  90226. * @param target defines the target animation or animation name
  90227. * @param from defines from where the animation should start (animation frame)
  90228. * @param end defines where the animation should stop (animation frame)
  90229. * @param loop defines if the animation should loop or stop after the first play
  90230. * @param condition defines the trigger related conditions
  90231. */
  90232. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  90233. /** @hidden */
  90234. _prepare(): void;
  90235. /**
  90236. * Execute the action and play the animation.
  90237. */
  90238. execute(): void;
  90239. /**
  90240. * Serializes the actions and its related information.
  90241. * @param parent defines the object to serialize in
  90242. * @returns the serialized object
  90243. */
  90244. serialize(parent: any): any;
  90245. }
  90246. /**
  90247. * This defines an action responsible to stop an animation once triggered.
  90248. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90249. */
  90250. export class StopAnimationAction extends Action {
  90251. private _target;
  90252. /**
  90253. * Instantiate the action
  90254. * @param triggerOptions defines the trigger options
  90255. * @param target defines the target animation or animation name
  90256. * @param condition defines the trigger related conditions
  90257. */
  90258. constructor(triggerOptions: any, target: any, condition?: Condition);
  90259. /** @hidden */
  90260. _prepare(): void;
  90261. /**
  90262. * Execute the action and stop the animation.
  90263. */
  90264. execute(): void;
  90265. /**
  90266. * Serializes the actions and its related information.
  90267. * @param parent defines the object to serialize in
  90268. * @returns the serialized object
  90269. */
  90270. serialize(parent: any): any;
  90271. }
  90272. /**
  90273. * This defines an action responsible that does nothing once triggered.
  90274. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90275. */
  90276. export class DoNothingAction extends Action {
  90277. /**
  90278. * Instantiate the action
  90279. * @param triggerOptions defines the trigger options
  90280. * @param condition defines the trigger related conditions
  90281. */
  90282. constructor(triggerOptions?: any, condition?: Condition);
  90283. /**
  90284. * Execute the action and do nothing.
  90285. */
  90286. execute(): void;
  90287. /**
  90288. * Serializes the actions and its related information.
  90289. * @param parent defines the object to serialize in
  90290. * @returns the serialized object
  90291. */
  90292. serialize(parent: any): any;
  90293. }
  90294. /**
  90295. * This defines an action responsible to trigger several actions once triggered.
  90296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90297. */
  90298. export class CombineAction extends Action {
  90299. /**
  90300. * The list of aggregated animations to run.
  90301. */
  90302. children: Action[];
  90303. /**
  90304. * Instantiate the action
  90305. * @param triggerOptions defines the trigger options
  90306. * @param children defines the list of aggregated animations to run
  90307. * @param condition defines the trigger related conditions
  90308. */
  90309. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  90310. /** @hidden */
  90311. _prepare(): void;
  90312. /**
  90313. * Execute the action and executes all the aggregated actions.
  90314. */
  90315. execute(evt: ActionEvent): void;
  90316. /**
  90317. * Serializes the actions and its related information.
  90318. * @param parent defines the object to serialize in
  90319. * @returns the serialized object
  90320. */
  90321. serialize(parent: any): any;
  90322. }
  90323. /**
  90324. * This defines an action responsible to run code (external event) once triggered.
  90325. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90326. */
  90327. export class ExecuteCodeAction extends Action {
  90328. /**
  90329. * The callback function to run.
  90330. */
  90331. func: (evt: ActionEvent) => void;
  90332. /**
  90333. * Instantiate the action
  90334. * @param triggerOptions defines the trigger options
  90335. * @param func defines the callback function to run
  90336. * @param condition defines the trigger related conditions
  90337. */
  90338. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  90339. /**
  90340. * Execute the action and run the attached code.
  90341. */
  90342. execute(evt: ActionEvent): void;
  90343. }
  90344. /**
  90345. * This defines an action responsible to set the parent property of the target once triggered.
  90346. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90347. */
  90348. export class SetParentAction extends Action {
  90349. private _parent;
  90350. private _target;
  90351. /**
  90352. * Instantiate the action
  90353. * @param triggerOptions defines the trigger options
  90354. * @param target defines the target containing the parent property
  90355. * @param parent defines from where the animation should start (animation frame)
  90356. * @param condition defines the trigger related conditions
  90357. */
  90358. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  90359. /** @hidden */
  90360. _prepare(): void;
  90361. /**
  90362. * Execute the action and set the parent property.
  90363. */
  90364. execute(): void;
  90365. /**
  90366. * Serializes the actions and its related information.
  90367. * @param parent defines the object to serialize in
  90368. * @returns the serialized object
  90369. */
  90370. serialize(parent: any): any;
  90371. }
  90372. }
  90373. declare module BABYLON {
  90374. /**
  90375. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  90376. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  90377. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90378. */
  90379. export class ActionManager extends AbstractActionManager {
  90380. /**
  90381. * Nothing
  90382. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90383. */
  90384. static readonly NothingTrigger: number;
  90385. /**
  90386. * On pick
  90387. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90388. */
  90389. static readonly OnPickTrigger: number;
  90390. /**
  90391. * On left pick
  90392. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90393. */
  90394. static readonly OnLeftPickTrigger: number;
  90395. /**
  90396. * On right pick
  90397. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90398. */
  90399. static readonly OnRightPickTrigger: number;
  90400. /**
  90401. * On center pick
  90402. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90403. */
  90404. static readonly OnCenterPickTrigger: number;
  90405. /**
  90406. * On pick down
  90407. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90408. */
  90409. static readonly OnPickDownTrigger: number;
  90410. /**
  90411. * On double pick
  90412. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90413. */
  90414. static readonly OnDoublePickTrigger: number;
  90415. /**
  90416. * On pick up
  90417. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90418. */
  90419. static readonly OnPickUpTrigger: number;
  90420. /**
  90421. * On pick out.
  90422. * This trigger will only be raised if you also declared a OnPickDown
  90423. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90424. */
  90425. static readonly OnPickOutTrigger: number;
  90426. /**
  90427. * On long press
  90428. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90429. */
  90430. static readonly OnLongPressTrigger: number;
  90431. /**
  90432. * On pointer over
  90433. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90434. */
  90435. static readonly OnPointerOverTrigger: number;
  90436. /**
  90437. * On pointer out
  90438. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90439. */
  90440. static readonly OnPointerOutTrigger: number;
  90441. /**
  90442. * On every frame
  90443. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90444. */
  90445. static readonly OnEveryFrameTrigger: number;
  90446. /**
  90447. * On intersection enter
  90448. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90449. */
  90450. static readonly OnIntersectionEnterTrigger: number;
  90451. /**
  90452. * On intersection exit
  90453. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90454. */
  90455. static readonly OnIntersectionExitTrigger: number;
  90456. /**
  90457. * On key down
  90458. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90459. */
  90460. static readonly OnKeyDownTrigger: number;
  90461. /**
  90462. * On key up
  90463. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90464. */
  90465. static readonly OnKeyUpTrigger: number;
  90466. private _scene;
  90467. /**
  90468. * Creates a new action manager
  90469. * @param scene defines the hosting scene
  90470. */
  90471. constructor(scene: Scene);
  90472. /**
  90473. * Releases all associated resources
  90474. */
  90475. dispose(): void;
  90476. /**
  90477. * Gets hosting scene
  90478. * @returns the hosting scene
  90479. */
  90480. getScene(): Scene;
  90481. /**
  90482. * Does this action manager handles actions of any of the given triggers
  90483. * @param triggers defines the triggers to be tested
  90484. * @return a boolean indicating whether one (or more) of the triggers is handled
  90485. */
  90486. hasSpecificTriggers(triggers: number[]): boolean;
  90487. /**
  90488. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  90489. * speed.
  90490. * @param triggerA defines the trigger to be tested
  90491. * @param triggerB defines the trigger to be tested
  90492. * @return a boolean indicating whether one (or more) of the triggers is handled
  90493. */
  90494. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  90495. /**
  90496. * Does this action manager handles actions of a given trigger
  90497. * @param trigger defines the trigger to be tested
  90498. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  90499. * @return whether the trigger is handled
  90500. */
  90501. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  90502. /**
  90503. * Does this action manager has pointer triggers
  90504. */
  90505. get hasPointerTriggers(): boolean;
  90506. /**
  90507. * Does this action manager has pick triggers
  90508. */
  90509. get hasPickTriggers(): boolean;
  90510. /**
  90511. * Registers an action to this action manager
  90512. * @param action defines the action to be registered
  90513. * @return the action amended (prepared) after registration
  90514. */
  90515. registerAction(action: IAction): Nullable<IAction>;
  90516. /**
  90517. * Unregisters an action to this action manager
  90518. * @param action defines the action to be unregistered
  90519. * @return a boolean indicating whether the action has been unregistered
  90520. */
  90521. unregisterAction(action: IAction): Boolean;
  90522. /**
  90523. * Process a specific trigger
  90524. * @param trigger defines the trigger to process
  90525. * @param evt defines the event details to be processed
  90526. */
  90527. processTrigger(trigger: number, evt?: IActionEvent): void;
  90528. /** @hidden */
  90529. _getEffectiveTarget(target: any, propertyPath: string): any;
  90530. /** @hidden */
  90531. _getProperty(propertyPath: string): string;
  90532. /**
  90533. * Serialize this manager to a JSON object
  90534. * @param name defines the property name to store this manager
  90535. * @returns a JSON representation of this manager
  90536. */
  90537. serialize(name: string): any;
  90538. /**
  90539. * Creates a new ActionManager from a JSON data
  90540. * @param parsedActions defines the JSON data to read from
  90541. * @param object defines the hosting mesh
  90542. * @param scene defines the hosting scene
  90543. */
  90544. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  90545. /**
  90546. * Get a trigger name by index
  90547. * @param trigger defines the trigger index
  90548. * @returns a trigger name
  90549. */
  90550. static GetTriggerName(trigger: number): string;
  90551. }
  90552. }
  90553. declare module BABYLON {
  90554. /**
  90555. * Class used to represent a sprite
  90556. * @see https://doc.babylonjs.com/babylon101/sprites
  90557. */
  90558. export class Sprite implements IAnimatable {
  90559. /** defines the name */
  90560. name: string;
  90561. /** Gets or sets the current world position */
  90562. position: Vector3;
  90563. /** Gets or sets the main color */
  90564. color: Color4;
  90565. /** Gets or sets the width */
  90566. width: number;
  90567. /** Gets or sets the height */
  90568. height: number;
  90569. /** Gets or sets rotation angle */
  90570. angle: number;
  90571. /** Gets or sets the cell index in the sprite sheet */
  90572. cellIndex: number;
  90573. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  90574. cellRef: string;
  90575. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  90576. invertU: boolean;
  90577. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  90578. invertV: boolean;
  90579. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  90580. disposeWhenFinishedAnimating: boolean;
  90581. /** Gets the list of attached animations */
  90582. animations: Nullable<Array<Animation>>;
  90583. /** Gets or sets a boolean indicating if the sprite can be picked */
  90584. isPickable: boolean;
  90585. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  90586. useAlphaForPicking: boolean;
  90587. /** @hidden */
  90588. _xOffset: number;
  90589. /** @hidden */
  90590. _yOffset: number;
  90591. /** @hidden */
  90592. _xSize: number;
  90593. /** @hidden */
  90594. _ySize: number;
  90595. /**
  90596. * Gets or sets the associated action manager
  90597. */
  90598. actionManager: Nullable<ActionManager>;
  90599. /**
  90600. * An event triggered when the control has been disposed
  90601. */
  90602. onDisposeObservable: Observable<Sprite>;
  90603. private _animationStarted;
  90604. private _loopAnimation;
  90605. private _fromIndex;
  90606. private _toIndex;
  90607. private _delay;
  90608. private _direction;
  90609. private _manager;
  90610. private _time;
  90611. private _onAnimationEnd;
  90612. /**
  90613. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  90614. */
  90615. isVisible: boolean;
  90616. /**
  90617. * Gets or sets the sprite size
  90618. */
  90619. get size(): number;
  90620. set size(value: number);
  90621. /**
  90622. * Returns a boolean indicating if the animation is started
  90623. */
  90624. get animationStarted(): boolean;
  90625. /**
  90626. * Gets or sets the unique id of the sprite
  90627. */
  90628. uniqueId: number;
  90629. /**
  90630. * Gets the manager of this sprite
  90631. */
  90632. get manager(): ISpriteManager;
  90633. /**
  90634. * Creates a new Sprite
  90635. * @param name defines the name
  90636. * @param manager defines the manager
  90637. */
  90638. constructor(
  90639. /** defines the name */
  90640. name: string, manager: ISpriteManager);
  90641. /**
  90642. * Returns the string "Sprite"
  90643. * @returns "Sprite"
  90644. */
  90645. getClassName(): string;
  90646. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  90647. get fromIndex(): number;
  90648. set fromIndex(value: number);
  90649. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  90650. get toIndex(): number;
  90651. set toIndex(value: number);
  90652. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  90653. get loopAnimation(): boolean;
  90654. set loopAnimation(value: boolean);
  90655. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  90656. get delay(): number;
  90657. set delay(value: number);
  90658. /**
  90659. * Starts an animation
  90660. * @param from defines the initial key
  90661. * @param to defines the end key
  90662. * @param loop defines if the animation must loop
  90663. * @param delay defines the start delay (in ms)
  90664. * @param onAnimationEnd defines a callback to call when animation ends
  90665. */
  90666. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  90667. /** Stops current animation (if any) */
  90668. stopAnimation(): void;
  90669. /** @hidden */
  90670. _animate(deltaTime: number): void;
  90671. /** Release associated resources */
  90672. dispose(): void;
  90673. /**
  90674. * Serializes the sprite to a JSON object
  90675. * @returns the JSON object
  90676. */
  90677. serialize(): any;
  90678. /**
  90679. * Parses a JSON object to create a new sprite
  90680. * @param parsedSprite The JSON object to parse
  90681. * @param manager defines the hosting manager
  90682. * @returns the new sprite
  90683. */
  90684. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90685. }
  90686. }
  90687. declare module BABYLON {
  90688. /**
  90689. * Information about the result of picking within a scene
  90690. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90691. */
  90692. export class PickingInfo {
  90693. /** @hidden */
  90694. _pickingUnavailable: boolean;
  90695. /**
  90696. * If the pick collided with an object
  90697. */
  90698. hit: boolean;
  90699. /**
  90700. * Distance away where the pick collided
  90701. */
  90702. distance: number;
  90703. /**
  90704. * The location of pick collision
  90705. */
  90706. pickedPoint: Nullable<Vector3>;
  90707. /**
  90708. * The mesh corresponding the the pick collision
  90709. */
  90710. pickedMesh: Nullable<AbstractMesh>;
  90711. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90712. bu: number;
  90713. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90714. bv: number;
  90715. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90716. faceId: number;
  90717. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90718. subMeshFaceId: number;
  90719. /** Id of the the submesh that was picked */
  90720. subMeshId: number;
  90721. /** If a sprite was picked, this will be the sprite the pick collided with */
  90722. pickedSprite: Nullable<Sprite>;
  90723. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90724. thinInstanceIndex: number;
  90725. /**
  90726. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90727. */
  90728. originMesh: Nullable<AbstractMesh>;
  90729. /**
  90730. * The ray that was used to perform the picking.
  90731. */
  90732. ray: Nullable<Ray>;
  90733. /**
  90734. * Gets the normal correspodning to the face the pick collided with
  90735. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90736. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90737. * @returns The normal correspodning to the face the pick collided with
  90738. */
  90739. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90740. /**
  90741. * Gets the texture coordinates of where the pick occured
  90742. * @returns the vector containing the coordnates of the texture
  90743. */
  90744. getTextureCoordinates(): Nullable<Vector2>;
  90745. }
  90746. }
  90747. declare module BABYLON {
  90748. /**
  90749. * Class representing a ray with position and direction
  90750. */
  90751. export class Ray {
  90752. /** origin point */
  90753. origin: Vector3;
  90754. /** direction */
  90755. direction: Vector3;
  90756. /** length of the ray */
  90757. length: number;
  90758. private static readonly _TmpVector3;
  90759. private _tmpRay;
  90760. /**
  90761. * Creates a new ray
  90762. * @param origin origin point
  90763. * @param direction direction
  90764. * @param length length of the ray
  90765. */
  90766. constructor(
  90767. /** origin point */
  90768. origin: Vector3,
  90769. /** direction */
  90770. direction: Vector3,
  90771. /** length of the ray */
  90772. length?: number);
  90773. /**
  90774. * Checks if the ray intersects a box
  90775. * This does not account for the ray lenght by design to improve perfs.
  90776. * @param minimum bound of the box
  90777. * @param maximum bound of the box
  90778. * @param intersectionTreshold extra extend to be added to the box in all direction
  90779. * @returns if the box was hit
  90780. */
  90781. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90782. /**
  90783. * Checks if the ray intersects a box
  90784. * This does not account for the ray lenght by design to improve perfs.
  90785. * @param box the bounding box to check
  90786. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90787. * @returns if the box was hit
  90788. */
  90789. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90790. /**
  90791. * If the ray hits a sphere
  90792. * @param sphere the bounding sphere to check
  90793. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90794. * @returns true if it hits the sphere
  90795. */
  90796. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90797. /**
  90798. * If the ray hits a triange
  90799. * @param vertex0 triangle vertex
  90800. * @param vertex1 triangle vertex
  90801. * @param vertex2 triangle vertex
  90802. * @returns intersection information if hit
  90803. */
  90804. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90805. /**
  90806. * Checks if ray intersects a plane
  90807. * @param plane the plane to check
  90808. * @returns the distance away it was hit
  90809. */
  90810. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90811. /**
  90812. * Calculate the intercept of a ray on a given axis
  90813. * @param axis to check 'x' | 'y' | 'z'
  90814. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90815. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90816. */
  90817. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90818. /**
  90819. * Checks if ray intersects a mesh
  90820. * @param mesh the mesh to check
  90821. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90822. * @returns picking info of the intersecton
  90823. */
  90824. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90825. /**
  90826. * Checks if ray intersects a mesh
  90827. * @param meshes the meshes to check
  90828. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90829. * @param results array to store result in
  90830. * @returns Array of picking infos
  90831. */
  90832. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90833. private _comparePickingInfo;
  90834. private static smallnum;
  90835. private static rayl;
  90836. /**
  90837. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90838. * @param sega the first point of the segment to test the intersection against
  90839. * @param segb the second point of the segment to test the intersection against
  90840. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90841. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90842. */
  90843. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90844. /**
  90845. * Update the ray from viewport position
  90846. * @param x position
  90847. * @param y y position
  90848. * @param viewportWidth viewport width
  90849. * @param viewportHeight viewport height
  90850. * @param world world matrix
  90851. * @param view view matrix
  90852. * @param projection projection matrix
  90853. * @returns this ray updated
  90854. */
  90855. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90856. /**
  90857. * Creates a ray with origin and direction of 0,0,0
  90858. * @returns the new ray
  90859. */
  90860. static Zero(): Ray;
  90861. /**
  90862. * Creates a new ray from screen space and viewport
  90863. * @param x position
  90864. * @param y y position
  90865. * @param viewportWidth viewport width
  90866. * @param viewportHeight viewport height
  90867. * @param world world matrix
  90868. * @param view view matrix
  90869. * @param projection projection matrix
  90870. * @returns new ray
  90871. */
  90872. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90873. /**
  90874. * 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
  90875. * transformed to the given world matrix.
  90876. * @param origin The origin point
  90877. * @param end The end point
  90878. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90879. * @returns the new ray
  90880. */
  90881. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90882. /**
  90883. * Transforms a ray by a matrix
  90884. * @param ray ray to transform
  90885. * @param matrix matrix to apply
  90886. * @returns the resulting new ray
  90887. */
  90888. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90889. /**
  90890. * Transforms a ray by a matrix
  90891. * @param ray ray to transform
  90892. * @param matrix matrix to apply
  90893. * @param result ray to store result in
  90894. */
  90895. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90896. /**
  90897. * Unproject a ray from screen space to object space
  90898. * @param sourceX defines the screen space x coordinate to use
  90899. * @param sourceY defines the screen space y coordinate to use
  90900. * @param viewportWidth defines the current width of the viewport
  90901. * @param viewportHeight defines the current height of the viewport
  90902. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90903. * @param view defines the view matrix to use
  90904. * @param projection defines the projection matrix to use
  90905. */
  90906. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90907. }
  90908. /**
  90909. * Type used to define predicate used to select faces when a mesh intersection is detected
  90910. */
  90911. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90912. interface Scene {
  90913. /** @hidden */
  90914. _tempPickingRay: Nullable<Ray>;
  90915. /** @hidden */
  90916. _cachedRayForTransform: Ray;
  90917. /** @hidden */
  90918. _pickWithRayInverseMatrix: Matrix;
  90919. /** @hidden */
  90920. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90921. /** @hidden */
  90922. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90923. /** @hidden */
  90924. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90925. }
  90926. }
  90927. declare module BABYLON {
  90928. /**
  90929. * Groups all the scene component constants in one place to ease maintenance.
  90930. * @hidden
  90931. */
  90932. export class SceneComponentConstants {
  90933. static readonly NAME_EFFECTLAYER: string;
  90934. static readonly NAME_LAYER: string;
  90935. static readonly NAME_LENSFLARESYSTEM: string;
  90936. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90937. static readonly NAME_PARTICLESYSTEM: string;
  90938. static readonly NAME_GAMEPAD: string;
  90939. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90940. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90941. static readonly NAME_PREPASSRENDERER: string;
  90942. static readonly NAME_DEPTHRENDERER: string;
  90943. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90944. static readonly NAME_SPRITE: string;
  90945. static readonly NAME_SUBSURFACE: string;
  90946. static readonly NAME_OUTLINERENDERER: string;
  90947. static readonly NAME_PROCEDURALTEXTURE: string;
  90948. static readonly NAME_SHADOWGENERATOR: string;
  90949. static readonly NAME_OCTREE: string;
  90950. static readonly NAME_PHYSICSENGINE: string;
  90951. static readonly NAME_AUDIO: string;
  90952. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90953. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90954. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90955. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90956. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90957. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90958. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90959. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90960. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90961. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90962. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90963. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90964. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90965. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90966. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90967. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90968. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90969. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90970. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90971. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90972. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90973. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90974. static readonly STEP_AFTERRENDER_AUDIO: number;
  90975. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90976. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90977. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90978. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90979. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90980. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90981. static readonly STEP_POINTERMOVE_SPRITE: number;
  90982. static readonly STEP_POINTERDOWN_SPRITE: number;
  90983. static readonly STEP_POINTERUP_SPRITE: number;
  90984. }
  90985. /**
  90986. * This represents a scene component.
  90987. *
  90988. * This is used to decouple the dependency the scene is having on the different workloads like
  90989. * layers, post processes...
  90990. */
  90991. export interface ISceneComponent {
  90992. /**
  90993. * The name of the component. Each component must have a unique name.
  90994. */
  90995. name: string;
  90996. /**
  90997. * The scene the component belongs to.
  90998. */
  90999. scene: Scene;
  91000. /**
  91001. * Register the component to one instance of a scene.
  91002. */
  91003. register(): void;
  91004. /**
  91005. * Rebuilds the elements related to this component in case of
  91006. * context lost for instance.
  91007. */
  91008. rebuild(): void;
  91009. /**
  91010. * Disposes the component and the associated ressources.
  91011. */
  91012. dispose(): void;
  91013. }
  91014. /**
  91015. * This represents a SERIALIZABLE scene component.
  91016. *
  91017. * This extends Scene Component to add Serialization methods on top.
  91018. */
  91019. export interface ISceneSerializableComponent extends ISceneComponent {
  91020. /**
  91021. * Adds all the elements from the container to the scene
  91022. * @param container the container holding the elements
  91023. */
  91024. addFromContainer(container: AbstractScene): void;
  91025. /**
  91026. * Removes all the elements in the container from the scene
  91027. * @param container contains the elements to remove
  91028. * @param dispose if the removed element should be disposed (default: false)
  91029. */
  91030. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  91031. /**
  91032. * Serializes the component data to the specified json object
  91033. * @param serializationObject The object to serialize to
  91034. */
  91035. serialize(serializationObject: any): void;
  91036. }
  91037. /**
  91038. * Strong typing of a Mesh related stage step action
  91039. */
  91040. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  91041. /**
  91042. * Strong typing of a Evaluate Sub Mesh related stage step action
  91043. */
  91044. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  91045. /**
  91046. * Strong typing of a Active Mesh related stage step action
  91047. */
  91048. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  91049. /**
  91050. * Strong typing of a Camera related stage step action
  91051. */
  91052. export type CameraStageAction = (camera: Camera) => void;
  91053. /**
  91054. * Strong typing of a Camera Frame buffer related stage step action
  91055. */
  91056. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  91057. /**
  91058. * Strong typing of a Render Target related stage step action
  91059. */
  91060. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  91061. /**
  91062. * Strong typing of a RenderingGroup related stage step action
  91063. */
  91064. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  91065. /**
  91066. * Strong typing of a Mesh Render related stage step action
  91067. */
  91068. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  91069. /**
  91070. * Strong typing of a simple stage step action
  91071. */
  91072. export type SimpleStageAction = () => void;
  91073. /**
  91074. * Strong typing of a render target action.
  91075. */
  91076. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  91077. /**
  91078. * Strong typing of a pointer move action.
  91079. */
  91080. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  91081. /**
  91082. * Strong typing of a pointer up/down action.
  91083. */
  91084. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  91085. /**
  91086. * Representation of a stage in the scene (Basically a list of ordered steps)
  91087. * @hidden
  91088. */
  91089. export class Stage<T extends Function> extends Array<{
  91090. index: number;
  91091. component: ISceneComponent;
  91092. action: T;
  91093. }> {
  91094. /**
  91095. * Hide ctor from the rest of the world.
  91096. * @param items The items to add.
  91097. */
  91098. private constructor();
  91099. /**
  91100. * Creates a new Stage.
  91101. * @returns A new instance of a Stage
  91102. */
  91103. static Create<T extends Function>(): Stage<T>;
  91104. /**
  91105. * Registers a step in an ordered way in the targeted stage.
  91106. * @param index Defines the position to register the step in
  91107. * @param component Defines the component attached to the step
  91108. * @param action Defines the action to launch during the step
  91109. */
  91110. registerStep(index: number, component: ISceneComponent, action: T): void;
  91111. /**
  91112. * Clears all the steps from the stage.
  91113. */
  91114. clear(): void;
  91115. }
  91116. }
  91117. declare module BABYLON {
  91118. interface Scene {
  91119. /** @hidden */
  91120. _pointerOverSprite: Nullable<Sprite>;
  91121. /** @hidden */
  91122. _pickedDownSprite: Nullable<Sprite>;
  91123. /** @hidden */
  91124. _tempSpritePickingRay: Nullable<Ray>;
  91125. /**
  91126. * All of the sprite managers added to this scene
  91127. * @see https://doc.babylonjs.com/babylon101/sprites
  91128. */
  91129. spriteManagers: Array<ISpriteManager>;
  91130. /**
  91131. * An event triggered when sprites rendering is about to start
  91132. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  91133. */
  91134. onBeforeSpritesRenderingObservable: Observable<Scene>;
  91135. /**
  91136. * An event triggered when sprites rendering is done
  91137. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  91138. */
  91139. onAfterSpritesRenderingObservable: Observable<Scene>;
  91140. /** @hidden */
  91141. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91142. /** Launch a ray to try to pick a sprite in the scene
  91143. * @param x position on screen
  91144. * @param y position on screen
  91145. * @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
  91146. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91147. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  91148. * @returns a PickingInfo
  91149. */
  91150. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91151. /** Use the given ray to pick a sprite in the scene
  91152. * @param ray The ray (in world space) to use to pick meshes
  91153. * @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
  91154. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91155. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  91156. * @returns a PickingInfo
  91157. */
  91158. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91159. /** @hidden */
  91160. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91161. /** Launch a ray to try to pick sprites in the scene
  91162. * @param x position on screen
  91163. * @param y position on screen
  91164. * @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
  91165. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  91166. * @returns a PickingInfo array
  91167. */
  91168. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91169. /** Use the given ray to pick sprites in the scene
  91170. * @param ray The ray (in world space) to use to pick meshes
  91171. * @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
  91172. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  91173. * @returns a PickingInfo array
  91174. */
  91175. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91176. /**
  91177. * Force the sprite under the pointer
  91178. * @param sprite defines the sprite to use
  91179. */
  91180. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  91181. /**
  91182. * Gets the sprite under the pointer
  91183. * @returns a Sprite or null if no sprite is under the pointer
  91184. */
  91185. getPointerOverSprite(): Nullable<Sprite>;
  91186. }
  91187. /**
  91188. * Defines the sprite scene component responsible to manage sprites
  91189. * in a given scene.
  91190. */
  91191. export class SpriteSceneComponent implements ISceneComponent {
  91192. /**
  91193. * The component name helpfull to identify the component in the list of scene components.
  91194. */
  91195. readonly name: string;
  91196. /**
  91197. * The scene the component belongs to.
  91198. */
  91199. scene: Scene;
  91200. /** @hidden */
  91201. private _spritePredicate;
  91202. /**
  91203. * Creates a new instance of the component for the given scene
  91204. * @param scene Defines the scene to register the component in
  91205. */
  91206. constructor(scene: Scene);
  91207. /**
  91208. * Registers the component in a given scene
  91209. */
  91210. register(): void;
  91211. /**
  91212. * Rebuilds the elements related to this component in case of
  91213. * context lost for instance.
  91214. */
  91215. rebuild(): void;
  91216. /**
  91217. * Disposes the component and the associated ressources.
  91218. */
  91219. dispose(): void;
  91220. private _pickSpriteButKeepRay;
  91221. private _pointerMove;
  91222. private _pointerDown;
  91223. private _pointerUp;
  91224. }
  91225. }
  91226. declare module BABYLON {
  91227. /** @hidden */
  91228. export var fogFragmentDeclaration: {
  91229. name: string;
  91230. shader: string;
  91231. };
  91232. }
  91233. declare module BABYLON {
  91234. /** @hidden */
  91235. export var fogFragment: {
  91236. name: string;
  91237. shader: string;
  91238. };
  91239. }
  91240. declare module BABYLON {
  91241. /** @hidden */
  91242. export var spritesPixelShader: {
  91243. name: string;
  91244. shader: string;
  91245. };
  91246. }
  91247. declare module BABYLON {
  91248. /** @hidden */
  91249. export var fogVertexDeclaration: {
  91250. name: string;
  91251. shader: string;
  91252. };
  91253. }
  91254. declare module BABYLON {
  91255. /** @hidden */
  91256. export var spritesVertexShader: {
  91257. name: string;
  91258. shader: string;
  91259. };
  91260. }
  91261. declare module BABYLON {
  91262. /**
  91263. * Defines the minimum interface to fullfil in order to be a sprite manager.
  91264. */
  91265. export interface ISpriteManager extends IDisposable {
  91266. /**
  91267. * Gets manager's name
  91268. */
  91269. name: string;
  91270. /**
  91271. * Restricts the camera to viewing objects with the same layerMask.
  91272. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  91273. */
  91274. layerMask: number;
  91275. /**
  91276. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  91277. */
  91278. isPickable: boolean;
  91279. /**
  91280. * Gets the hosting scene
  91281. */
  91282. scene: Scene;
  91283. /**
  91284. * Specifies the rendering group id for this mesh (0 by default)
  91285. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  91286. */
  91287. renderingGroupId: number;
  91288. /**
  91289. * Defines the list of sprites managed by the manager.
  91290. */
  91291. sprites: Array<Sprite>;
  91292. /**
  91293. * Gets or sets the spritesheet texture
  91294. */
  91295. texture: Texture;
  91296. /** Defines the default width of a cell in the spritesheet */
  91297. cellWidth: number;
  91298. /** Defines the default height of a cell in the spritesheet */
  91299. cellHeight: number;
  91300. /**
  91301. * Tests the intersection of a sprite with a specific ray.
  91302. * @param ray The ray we are sending to test the collision
  91303. * @param camera The camera space we are sending rays in
  91304. * @param predicate A predicate allowing excluding sprites from the list of object to test
  91305. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91306. * @returns picking info or null.
  91307. */
  91308. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  91309. /**
  91310. * Intersects the sprites with a ray
  91311. * @param ray defines the ray to intersect with
  91312. * @param camera defines the current active camera
  91313. * @param predicate defines a predicate used to select candidate sprites
  91314. * @returns null if no hit or a PickingInfo array
  91315. */
  91316. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  91317. /**
  91318. * Renders the list of sprites on screen.
  91319. */
  91320. render(): void;
  91321. }
  91322. /**
  91323. * Class used to manage multiple sprites on the same spritesheet
  91324. * @see https://doc.babylonjs.com/babylon101/sprites
  91325. */
  91326. export class SpriteManager implements ISpriteManager {
  91327. /** defines the manager's name */
  91328. name: string;
  91329. /** Define the Url to load snippets */
  91330. static SnippetUrl: string;
  91331. /** Snippet ID if the manager was created from the snippet server */
  91332. snippetId: string;
  91333. /** Gets the list of sprites */
  91334. sprites: Sprite[];
  91335. /** Gets or sets the rendering group id (0 by default) */
  91336. renderingGroupId: number;
  91337. /** Gets or sets camera layer mask */
  91338. layerMask: number;
  91339. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  91340. fogEnabled: boolean;
  91341. /** Gets or sets a boolean indicating if the sprites are pickable */
  91342. isPickable: boolean;
  91343. /** Defines the default width of a cell in the spritesheet */
  91344. cellWidth: number;
  91345. /** Defines the default height of a cell in the spritesheet */
  91346. cellHeight: number;
  91347. /** Associative array from JSON sprite data file */
  91348. private _cellData;
  91349. /** Array of sprite names from JSON sprite data file */
  91350. private _spriteMap;
  91351. /** True when packed cell data from JSON file is ready*/
  91352. private _packedAndReady;
  91353. private _textureContent;
  91354. private _useInstancing;
  91355. /**
  91356. * An event triggered when the manager is disposed.
  91357. */
  91358. onDisposeObservable: Observable<SpriteManager>;
  91359. private _onDisposeObserver;
  91360. /**
  91361. * Callback called when the manager is disposed
  91362. */
  91363. set onDispose(callback: () => void);
  91364. private _capacity;
  91365. private _fromPacked;
  91366. private _spriteTexture;
  91367. private _epsilon;
  91368. private _scene;
  91369. private _vertexData;
  91370. private _buffer;
  91371. private _vertexBuffers;
  91372. private _spriteBuffer;
  91373. private _indexBuffer;
  91374. private _effectBase;
  91375. private _effectFog;
  91376. private _vertexBufferSize;
  91377. /**
  91378. * Gets or sets the unique id of the sprite
  91379. */
  91380. uniqueId: number;
  91381. /**
  91382. * Gets the array of sprites
  91383. */
  91384. get children(): Sprite[];
  91385. /**
  91386. * Gets the hosting scene
  91387. */
  91388. get scene(): Scene;
  91389. /**
  91390. * Gets the capacity of the manager
  91391. */
  91392. get capacity(): number;
  91393. /**
  91394. * Gets or sets the spritesheet texture
  91395. */
  91396. get texture(): Texture;
  91397. set texture(value: Texture);
  91398. private _blendMode;
  91399. /**
  91400. * Blend mode use to render the particle, it can be any of
  91401. * the static Constants.ALPHA_x properties provided in this class.
  91402. * Default value is Constants.ALPHA_COMBINE
  91403. */
  91404. get blendMode(): number;
  91405. set blendMode(blendMode: number);
  91406. /** Disables writing to the depth buffer when rendering the sprites.
  91407. * It can be handy to disable depth writing when using textures without alpha channel
  91408. * and setting some specific blend modes.
  91409. */
  91410. disableDepthWrite: boolean;
  91411. /**
  91412. * Creates a new sprite manager
  91413. * @param name defines the manager's name
  91414. * @param imgUrl defines the sprite sheet url
  91415. * @param capacity defines the maximum allowed number of sprites
  91416. * @param cellSize defines the size of a sprite cell
  91417. * @param scene defines the hosting scene
  91418. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  91419. * @param samplingMode defines the smapling mode to use with spritesheet
  91420. * @param fromPacked set to false; do not alter
  91421. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  91422. */
  91423. constructor(
  91424. /** defines the manager's name */
  91425. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  91426. /**
  91427. * Returns the string "SpriteManager"
  91428. * @returns "SpriteManager"
  91429. */
  91430. getClassName(): string;
  91431. private _makePacked;
  91432. private _appendSpriteVertex;
  91433. private _checkTextureAlpha;
  91434. /**
  91435. * Intersects the sprites with a ray
  91436. * @param ray defines the ray to intersect with
  91437. * @param camera defines the current active camera
  91438. * @param predicate defines a predicate used to select candidate sprites
  91439. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  91440. * @returns null if no hit or a PickingInfo
  91441. */
  91442. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  91443. /**
  91444. * Intersects the sprites with a ray
  91445. * @param ray defines the ray to intersect with
  91446. * @param camera defines the current active camera
  91447. * @param predicate defines a predicate used to select candidate sprites
  91448. * @returns null if no hit or a PickingInfo array
  91449. */
  91450. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  91451. /**
  91452. * Render all child sprites
  91453. */
  91454. render(): void;
  91455. /**
  91456. * Release associated resources
  91457. */
  91458. dispose(): void;
  91459. /**
  91460. * Serializes the sprite manager to a JSON object
  91461. * @param serializeTexture defines if the texture must be serialized as well
  91462. * @returns the JSON object
  91463. */
  91464. serialize(serializeTexture?: boolean): any;
  91465. /**
  91466. * Parses a JSON object to create a new sprite manager.
  91467. * @param parsedManager The JSON object to parse
  91468. * @param scene The scene to create the sprite managerin
  91469. * @param rootUrl The root url to use to load external dependencies like texture
  91470. * @returns the new sprite manager
  91471. */
  91472. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  91473. /**
  91474. * Creates a sprite manager from a snippet saved in a remote file
  91475. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  91476. * @param url defines the url to load from
  91477. * @param scene defines the hosting scene
  91478. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  91479. * @returns a promise that will resolve to the new sprite manager
  91480. */
  91481. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  91482. /**
  91483. * Creates a sprite manager from a snippet saved by the sprite editor
  91484. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  91485. * @param scene defines the hosting scene
  91486. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  91487. * @returns a promise that will resolve to the new sprite manager
  91488. */
  91489. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  91490. }
  91491. }
  91492. declare module BABYLON {
  91493. /** Interface used by value gradients (color, factor, ...) */
  91494. export interface IValueGradient {
  91495. /**
  91496. * Gets or sets the gradient value (between 0 and 1)
  91497. */
  91498. gradient: number;
  91499. }
  91500. /** Class used to store color4 gradient */
  91501. export class ColorGradient implements IValueGradient {
  91502. /**
  91503. * Gets or sets the gradient value (between 0 and 1)
  91504. */
  91505. gradient: number;
  91506. /**
  91507. * Gets or sets first associated color
  91508. */
  91509. color1: Color4;
  91510. /**
  91511. * Gets or sets second associated color
  91512. */
  91513. color2?: Color4 | undefined;
  91514. /**
  91515. * Creates a new color4 gradient
  91516. * @param gradient gets or sets the gradient value (between 0 and 1)
  91517. * @param color1 gets or sets first associated color
  91518. * @param color2 gets or sets first second color
  91519. */
  91520. constructor(
  91521. /**
  91522. * Gets or sets the gradient value (between 0 and 1)
  91523. */
  91524. gradient: number,
  91525. /**
  91526. * Gets or sets first associated color
  91527. */
  91528. color1: Color4,
  91529. /**
  91530. * Gets or sets second associated color
  91531. */
  91532. color2?: Color4 | undefined);
  91533. /**
  91534. * Will get a color picked randomly between color1 and color2.
  91535. * If color2 is undefined then color1 will be used
  91536. * @param result defines the target Color4 to store the result in
  91537. */
  91538. getColorToRef(result: Color4): void;
  91539. }
  91540. /** Class used to store color 3 gradient */
  91541. export class Color3Gradient implements IValueGradient {
  91542. /**
  91543. * Gets or sets the gradient value (between 0 and 1)
  91544. */
  91545. gradient: number;
  91546. /**
  91547. * Gets or sets the associated color
  91548. */
  91549. color: Color3;
  91550. /**
  91551. * Creates a new color3 gradient
  91552. * @param gradient gets or sets the gradient value (between 0 and 1)
  91553. * @param color gets or sets associated color
  91554. */
  91555. constructor(
  91556. /**
  91557. * Gets or sets the gradient value (between 0 and 1)
  91558. */
  91559. gradient: number,
  91560. /**
  91561. * Gets or sets the associated color
  91562. */
  91563. color: Color3);
  91564. }
  91565. /** Class used to store factor gradient */
  91566. export class FactorGradient implements IValueGradient {
  91567. /**
  91568. * Gets or sets the gradient value (between 0 and 1)
  91569. */
  91570. gradient: number;
  91571. /**
  91572. * Gets or sets first associated factor
  91573. */
  91574. factor1: number;
  91575. /**
  91576. * Gets or sets second associated factor
  91577. */
  91578. factor2?: number | undefined;
  91579. /**
  91580. * Creates a new factor gradient
  91581. * @param gradient gets or sets the gradient value (between 0 and 1)
  91582. * @param factor1 gets or sets first associated factor
  91583. * @param factor2 gets or sets second associated factor
  91584. */
  91585. constructor(
  91586. /**
  91587. * Gets or sets the gradient value (between 0 and 1)
  91588. */
  91589. gradient: number,
  91590. /**
  91591. * Gets or sets first associated factor
  91592. */
  91593. factor1: number,
  91594. /**
  91595. * Gets or sets second associated factor
  91596. */
  91597. factor2?: number | undefined);
  91598. /**
  91599. * Will get a number picked randomly between factor1 and factor2.
  91600. * If factor2 is undefined then factor1 will be used
  91601. * @returns the picked number
  91602. */
  91603. getFactor(): number;
  91604. }
  91605. /**
  91606. * Helper used to simplify some generic gradient tasks
  91607. */
  91608. export class GradientHelper {
  91609. /**
  91610. * Gets the current gradient from an array of IValueGradient
  91611. * @param ratio defines the current ratio to get
  91612. * @param gradients defines the array of IValueGradient
  91613. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  91614. */
  91615. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  91616. }
  91617. }
  91618. declare module BABYLON {
  91619. interface ThinEngine {
  91620. /**
  91621. * Creates a raw texture
  91622. * @param data defines the data to store in the texture
  91623. * @param width defines the width of the texture
  91624. * @param height defines the height of the texture
  91625. * @param format defines the format of the data
  91626. * @param generateMipMaps defines if the engine should generate the mip levels
  91627. * @param invertY defines if data must be stored with Y axis inverted
  91628. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  91629. * @param compression defines the compression used (null by default)
  91630. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91631. * @returns the raw texture inside an InternalTexture
  91632. */
  91633. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  91634. /**
  91635. * Update a raw texture
  91636. * @param texture defines the texture to update
  91637. * @param data defines the data to store in the texture
  91638. * @param format defines the format of the data
  91639. * @param invertY defines if data must be stored with Y axis inverted
  91640. */
  91641. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91642. /**
  91643. * Update a raw texture
  91644. * @param texture defines the texture to update
  91645. * @param data defines the data to store in the texture
  91646. * @param format defines the format of the data
  91647. * @param invertY defines if data must be stored with Y axis inverted
  91648. * @param compression defines the compression used (null by default)
  91649. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91650. */
  91651. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  91652. /**
  91653. * Creates a new raw cube texture
  91654. * @param data defines the array of data to use to create each face
  91655. * @param size defines the size of the textures
  91656. * @param format defines the format of the data
  91657. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91658. * @param generateMipMaps defines if the engine should generate the mip levels
  91659. * @param invertY defines if data must be stored with Y axis inverted
  91660. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91661. * @param compression defines the compression used (null by default)
  91662. * @returns the cube texture as an InternalTexture
  91663. */
  91664. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  91665. /**
  91666. * Update a raw cube texture
  91667. * @param texture defines the texture to udpdate
  91668. * @param data defines the data to store
  91669. * @param format defines the data format
  91670. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91671. * @param invertY defines if data must be stored with Y axis inverted
  91672. */
  91673. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  91674. /**
  91675. * Update a raw cube texture
  91676. * @param texture defines the texture to udpdate
  91677. * @param data defines the data to store
  91678. * @param format defines the data format
  91679. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91680. * @param invertY defines if data must be stored with Y axis inverted
  91681. * @param compression defines the compression used (null by default)
  91682. */
  91683. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91684. /**
  91685. * Update a raw cube texture
  91686. * @param texture defines the texture to udpdate
  91687. * @param data defines the data to store
  91688. * @param format defines the data format
  91689. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91690. * @param invertY defines if data must be stored with Y axis inverted
  91691. * @param compression defines the compression used (null by default)
  91692. * @param level defines which level of the texture to update
  91693. */
  91694. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91695. /**
  91696. * Creates a new raw cube texture from a specified url
  91697. * @param url defines the url where the data is located
  91698. * @param scene defines the current scene
  91699. * @param size defines the size of the textures
  91700. * @param format defines the format of the data
  91701. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91702. * @param noMipmap defines if the engine should avoid generating the mip levels
  91703. * @param callback defines a callback used to extract texture data from loaded data
  91704. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91705. * @param onLoad defines a callback called when texture is loaded
  91706. * @param onError defines a callback called if there is an error
  91707. * @returns the cube texture as an InternalTexture
  91708. */
  91709. 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;
  91710. /**
  91711. * Creates a new raw cube texture from a specified url
  91712. * @param url defines the url where the data is located
  91713. * @param scene defines the current scene
  91714. * @param size defines the size of the textures
  91715. * @param format defines the format of the data
  91716. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91717. * @param noMipmap defines if the engine should avoid generating the mip levels
  91718. * @param callback defines a callback used to extract texture data from loaded data
  91719. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91720. * @param onLoad defines a callback called when texture is loaded
  91721. * @param onError defines a callback called if there is an error
  91722. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91723. * @param invertY defines if data must be stored with Y axis inverted
  91724. * @returns the cube texture as an InternalTexture
  91725. */
  91726. 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;
  91727. /**
  91728. * Creates a new raw 3D texture
  91729. * @param data defines the data used to create the texture
  91730. * @param width defines the width of the texture
  91731. * @param height defines the height of the texture
  91732. * @param depth defines the depth of the texture
  91733. * @param format defines the format of the texture
  91734. * @param generateMipMaps defines if the engine must generate mip levels
  91735. * @param invertY defines if data must be stored with Y axis inverted
  91736. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91737. * @param compression defines the compressed used (can be null)
  91738. * @param textureType defines the compressed used (can be null)
  91739. * @returns a new raw 3D texture (stored in an InternalTexture)
  91740. */
  91741. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91742. /**
  91743. * Update a raw 3D texture
  91744. * @param texture defines the texture to update
  91745. * @param data defines the data to store
  91746. * @param format defines the data format
  91747. * @param invertY defines if data must be stored with Y axis inverted
  91748. */
  91749. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91750. /**
  91751. * Update a raw 3D texture
  91752. * @param texture defines the texture to update
  91753. * @param data defines the data to store
  91754. * @param format defines the data format
  91755. * @param invertY defines if data must be stored with Y axis inverted
  91756. * @param compression defines the used compression (can be null)
  91757. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91758. */
  91759. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91760. /**
  91761. * Creates a new raw 2D array texture
  91762. * @param data defines the data used to create the texture
  91763. * @param width defines the width of the texture
  91764. * @param height defines the height of the texture
  91765. * @param depth defines the number of layers of the texture
  91766. * @param format defines the format of the texture
  91767. * @param generateMipMaps defines if the engine must generate mip levels
  91768. * @param invertY defines if data must be stored with Y axis inverted
  91769. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91770. * @param compression defines the compressed used (can be null)
  91771. * @param textureType defines the compressed used (can be null)
  91772. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91773. */
  91774. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91775. /**
  91776. * Update a raw 2D array texture
  91777. * @param texture defines the texture to update
  91778. * @param data defines the data to store
  91779. * @param format defines the data format
  91780. * @param invertY defines if data must be stored with Y axis inverted
  91781. */
  91782. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91783. /**
  91784. * Update a raw 2D array texture
  91785. * @param texture defines the texture to update
  91786. * @param data defines the data to store
  91787. * @param format defines the data format
  91788. * @param invertY defines if data must be stored with Y axis inverted
  91789. * @param compression defines the used compression (can be null)
  91790. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91791. */
  91792. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91793. }
  91794. }
  91795. declare module BABYLON {
  91796. /**
  91797. * Raw texture can help creating a texture directly from an array of data.
  91798. * This can be super useful if you either get the data from an uncompressed source or
  91799. * if you wish to create your texture pixel by pixel.
  91800. */
  91801. export class RawTexture extends Texture {
  91802. /**
  91803. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91804. */
  91805. format: number;
  91806. /**
  91807. * Instantiates a new RawTexture.
  91808. * Raw texture can help creating a texture directly from an array of data.
  91809. * This can be super useful if you either get the data from an uncompressed source or
  91810. * if you wish to create your texture pixel by pixel.
  91811. * @param data define the array of data to use to create the texture
  91812. * @param width define the width of the texture
  91813. * @param height define the height of the texture
  91814. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91815. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91816. * @param generateMipMaps define whether mip maps should be generated or not
  91817. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91818. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91819. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91820. */
  91821. constructor(data: ArrayBufferView, width: number, height: number,
  91822. /**
  91823. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91824. */
  91825. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91826. /**
  91827. * Updates the texture underlying data.
  91828. * @param data Define the new data of the texture
  91829. */
  91830. update(data: ArrayBufferView): void;
  91831. /**
  91832. * Creates a luminance texture from some data.
  91833. * @param data Define the texture data
  91834. * @param width Define the width of the texture
  91835. * @param height Define the height of the texture
  91836. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91837. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91838. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91839. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91840. * @returns the luminance texture
  91841. */
  91842. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91843. /**
  91844. * Creates a luminance alpha texture from some data.
  91845. * @param data Define the texture data
  91846. * @param width Define the width of the texture
  91847. * @param height Define the height of the texture
  91848. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91849. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91850. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91851. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91852. * @returns the luminance alpha texture
  91853. */
  91854. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91855. /**
  91856. * Creates an alpha texture from some data.
  91857. * @param data Define the texture data
  91858. * @param width Define the width of the texture
  91859. * @param height Define the height of the texture
  91860. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91861. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91862. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91863. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91864. * @returns the alpha texture
  91865. */
  91866. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91867. /**
  91868. * Creates a RGB texture from some data.
  91869. * @param data Define the texture data
  91870. * @param width Define the width of the texture
  91871. * @param height Define the height of the texture
  91872. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91873. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91874. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91875. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91876. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91877. * @returns the RGB alpha texture
  91878. */
  91879. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91880. /**
  91881. * Creates a RGBA texture from some data.
  91882. * @param data Define the texture data
  91883. * @param width Define the width of the texture
  91884. * @param height Define the height of the texture
  91885. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91886. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91887. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91888. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91889. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91890. * @returns the RGBA texture
  91891. */
  91892. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91893. /**
  91894. * Creates a R texture from some data.
  91895. * @param data Define the texture data
  91896. * @param width Define the width of the texture
  91897. * @param height Define the height of the texture
  91898. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91899. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91900. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91901. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91902. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91903. * @returns the R texture
  91904. */
  91905. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91906. }
  91907. }
  91908. declare module BABYLON {
  91909. interface ThinEngine {
  91910. /**
  91911. * Update a dynamic index buffer
  91912. * @param indexBuffer defines the target index buffer
  91913. * @param indices defines the data to update
  91914. * @param offset defines the offset in the target index buffer where update should start
  91915. */
  91916. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91917. /**
  91918. * Updates a dynamic vertex buffer.
  91919. * @param vertexBuffer the vertex buffer to update
  91920. * @param data the data used to update the vertex buffer
  91921. * @param byteOffset the byte offset of the data
  91922. * @param byteLength the byte length of the data
  91923. */
  91924. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91925. }
  91926. }
  91927. declare module BABYLON {
  91928. interface AbstractScene {
  91929. /**
  91930. * The list of procedural textures added to the scene
  91931. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91932. */
  91933. proceduralTextures: Array<ProceduralTexture>;
  91934. }
  91935. /**
  91936. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91937. * in a given scene.
  91938. */
  91939. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91940. /**
  91941. * The component name helpfull to identify the component in the list of scene components.
  91942. */
  91943. readonly name: string;
  91944. /**
  91945. * The scene the component belongs to.
  91946. */
  91947. scene: Scene;
  91948. /**
  91949. * Creates a new instance of the component for the given scene
  91950. * @param scene Defines the scene to register the component in
  91951. */
  91952. constructor(scene: Scene);
  91953. /**
  91954. * Registers the component in a given scene
  91955. */
  91956. register(): void;
  91957. /**
  91958. * Rebuilds the elements related to this component in case of
  91959. * context lost for instance.
  91960. */
  91961. rebuild(): void;
  91962. /**
  91963. * Disposes the component and the associated ressources.
  91964. */
  91965. dispose(): void;
  91966. private _beforeClear;
  91967. }
  91968. }
  91969. declare module BABYLON {
  91970. interface ThinEngine {
  91971. /**
  91972. * Creates a new render target cube texture
  91973. * @param size defines the size of the texture
  91974. * @param options defines the options used to create the texture
  91975. * @returns a new render target cube texture stored in an InternalTexture
  91976. */
  91977. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91978. }
  91979. }
  91980. declare module BABYLON {
  91981. /** @hidden */
  91982. export var proceduralVertexShader: {
  91983. name: string;
  91984. shader: string;
  91985. };
  91986. }
  91987. declare module BABYLON {
  91988. /**
  91989. * 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.
  91990. * This is the base class of any Procedural texture and contains most of the shareable code.
  91991. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91992. */
  91993. export class ProceduralTexture extends Texture {
  91994. /**
  91995. * Define if the texture is enabled or not (disabled texture will not render)
  91996. */
  91997. isEnabled: boolean;
  91998. /**
  91999. * Define if the texture must be cleared before rendering (default is true)
  92000. */
  92001. autoClear: boolean;
  92002. /**
  92003. * Callback called when the texture is generated
  92004. */
  92005. onGenerated: () => void;
  92006. /**
  92007. * Event raised when the texture is generated
  92008. */
  92009. onGeneratedObservable: Observable<ProceduralTexture>;
  92010. /**
  92011. * Event raised before the texture is generated
  92012. */
  92013. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  92014. /**
  92015. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  92016. */
  92017. nodeMaterialSource: Nullable<NodeMaterial>;
  92018. /** @hidden */
  92019. _generateMipMaps: boolean;
  92020. /** @hidden **/
  92021. _effect: Effect;
  92022. /** @hidden */
  92023. _textures: {
  92024. [key: string]: Texture;
  92025. };
  92026. /** @hidden */
  92027. protected _fallbackTexture: Nullable<Texture>;
  92028. private _size;
  92029. private _currentRefreshId;
  92030. private _frameId;
  92031. private _refreshRate;
  92032. private _vertexBuffers;
  92033. private _indexBuffer;
  92034. private _uniforms;
  92035. private _samplers;
  92036. private _fragment;
  92037. private _floats;
  92038. private _ints;
  92039. private _floatsArrays;
  92040. private _colors3;
  92041. private _colors4;
  92042. private _vectors2;
  92043. private _vectors3;
  92044. private _matrices;
  92045. private _fallbackTextureUsed;
  92046. private _fullEngine;
  92047. private _cachedDefines;
  92048. private _contentUpdateId;
  92049. private _contentData;
  92050. /**
  92051. * Instantiates a new procedural texture.
  92052. * 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.
  92053. * This is the base class of any Procedural texture and contains most of the shareable code.
  92054. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  92055. * @param name Define the name of the texture
  92056. * @param size Define the size of the texture to create
  92057. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  92058. * @param scene Define the scene the texture belongs to
  92059. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  92060. * @param generateMipMaps Define if the texture should creates mip maps or not
  92061. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  92062. */
  92063. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  92064. /**
  92065. * The effect that is created when initializing the post process.
  92066. * @returns The created effect corresponding the the postprocess.
  92067. */
  92068. getEffect(): Effect;
  92069. /**
  92070. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  92071. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  92072. */
  92073. getContent(): Nullable<ArrayBufferView>;
  92074. private _createIndexBuffer;
  92075. /** @hidden */
  92076. _rebuild(): void;
  92077. /**
  92078. * Resets the texture in order to recreate its associated resources.
  92079. * This can be called in case of context loss
  92080. */
  92081. reset(): void;
  92082. protected _getDefines(): string;
  92083. /**
  92084. * Is the texture ready to be used ? (rendered at least once)
  92085. * @returns true if ready, otherwise, false.
  92086. */
  92087. isReady(): boolean;
  92088. /**
  92089. * Resets the refresh counter of the texture and start bak from scratch.
  92090. * Could be useful to regenerate the texture if it is setup to render only once.
  92091. */
  92092. resetRefreshCounter(): void;
  92093. /**
  92094. * Set the fragment shader to use in order to render the texture.
  92095. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  92096. */
  92097. setFragment(fragment: any): void;
  92098. /**
  92099. * Define the refresh rate of the texture or the rendering frequency.
  92100. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  92101. */
  92102. get refreshRate(): number;
  92103. set refreshRate(value: number);
  92104. /** @hidden */
  92105. _shouldRender(): boolean;
  92106. /**
  92107. * Get the size the texture is rendering at.
  92108. * @returns the size (on cube texture it is always squared)
  92109. */
  92110. getRenderSize(): RenderTargetTextureSize;
  92111. /**
  92112. * Resize the texture to new value.
  92113. * @param size Define the new size the texture should have
  92114. * @param generateMipMaps Define whether the new texture should create mip maps
  92115. */
  92116. resize(size: number, generateMipMaps: boolean): void;
  92117. private _checkUniform;
  92118. /**
  92119. * Set a texture in the shader program used to render.
  92120. * @param name Define the name of the uniform samplers as defined in the shader
  92121. * @param texture Define the texture to bind to this sampler
  92122. * @return the texture itself allowing "fluent" like uniform updates
  92123. */
  92124. setTexture(name: string, texture: Texture): ProceduralTexture;
  92125. /**
  92126. * Set a float in the shader.
  92127. * @param name Define the name of the uniform as defined in the shader
  92128. * @param value Define the value to give to the uniform
  92129. * @return the texture itself allowing "fluent" like uniform updates
  92130. */
  92131. setFloat(name: string, value: number): ProceduralTexture;
  92132. /**
  92133. * Set a int in the shader.
  92134. * @param name Define the name of the uniform as defined in the shader
  92135. * @param value Define the value to give to the uniform
  92136. * @return the texture itself allowing "fluent" like uniform updates
  92137. */
  92138. setInt(name: string, value: number): ProceduralTexture;
  92139. /**
  92140. * Set an array of floats in the shader.
  92141. * @param name Define the name of the uniform as defined in the shader
  92142. * @param value Define the value to give to the uniform
  92143. * @return the texture itself allowing "fluent" like uniform updates
  92144. */
  92145. setFloats(name: string, value: number[]): ProceduralTexture;
  92146. /**
  92147. * Set a vec3 in the shader from a Color3.
  92148. * @param name Define the name of the uniform as defined in the shader
  92149. * @param value Define the value to give to the uniform
  92150. * @return the texture itself allowing "fluent" like uniform updates
  92151. */
  92152. setColor3(name: string, value: Color3): ProceduralTexture;
  92153. /**
  92154. * Set a vec4 in the shader from a Color4.
  92155. * @param name Define the name of the uniform as defined in the shader
  92156. * @param value Define the value to give to the uniform
  92157. * @return the texture itself allowing "fluent" like uniform updates
  92158. */
  92159. setColor4(name: string, value: Color4): ProceduralTexture;
  92160. /**
  92161. * Set a vec2 in the shader from a Vector2.
  92162. * @param name Define the name of the uniform as defined in the shader
  92163. * @param value Define the value to give to the uniform
  92164. * @return the texture itself allowing "fluent" like uniform updates
  92165. */
  92166. setVector2(name: string, value: Vector2): ProceduralTexture;
  92167. /**
  92168. * Set a vec3 in the shader from a Vector3.
  92169. * @param name Define the name of the uniform as defined in the shader
  92170. * @param value Define the value to give to the uniform
  92171. * @return the texture itself allowing "fluent" like uniform updates
  92172. */
  92173. setVector3(name: string, value: Vector3): ProceduralTexture;
  92174. /**
  92175. * Set a mat4 in the shader from a MAtrix.
  92176. * @param name Define the name of the uniform as defined in the shader
  92177. * @param value Define the value to give to the uniform
  92178. * @return the texture itself allowing "fluent" like uniform updates
  92179. */
  92180. setMatrix(name: string, value: Matrix): ProceduralTexture;
  92181. /**
  92182. * Render the texture to its associated render target.
  92183. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  92184. */
  92185. render(useCameraPostProcess?: boolean): void;
  92186. /**
  92187. * Clone the texture.
  92188. * @returns the cloned texture
  92189. */
  92190. clone(): ProceduralTexture;
  92191. /**
  92192. * Dispose the texture and release its asoociated resources.
  92193. */
  92194. dispose(): void;
  92195. }
  92196. }
  92197. declare module BABYLON {
  92198. /**
  92199. * This represents the base class for particle system in Babylon.
  92200. * 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.
  92201. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92202. * @example https://doc.babylonjs.com/babylon101/particles
  92203. */
  92204. export class BaseParticleSystem {
  92205. /**
  92206. * Source color is added to the destination color without alpha affecting the result
  92207. */
  92208. static BLENDMODE_ONEONE: number;
  92209. /**
  92210. * Blend current color and particle color using particle’s alpha
  92211. */
  92212. static BLENDMODE_STANDARD: number;
  92213. /**
  92214. * Add current color and particle color multiplied by particle’s alpha
  92215. */
  92216. static BLENDMODE_ADD: number;
  92217. /**
  92218. * Multiply current color with particle color
  92219. */
  92220. static BLENDMODE_MULTIPLY: number;
  92221. /**
  92222. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  92223. */
  92224. static BLENDMODE_MULTIPLYADD: number;
  92225. /**
  92226. * List of animations used by the particle system.
  92227. */
  92228. animations: Animation[];
  92229. /**
  92230. * Gets or sets the unique id of the particle system
  92231. */
  92232. uniqueId: number;
  92233. /**
  92234. * The id of the Particle system.
  92235. */
  92236. id: string;
  92237. /**
  92238. * The friendly name of the Particle system.
  92239. */
  92240. name: string;
  92241. /**
  92242. * Snippet ID if the particle system was created from the snippet server
  92243. */
  92244. snippetId: string;
  92245. /**
  92246. * The rendering group used by the Particle system to chose when to render.
  92247. */
  92248. renderingGroupId: number;
  92249. /**
  92250. * The emitter represents the Mesh or position we are attaching the particle system to.
  92251. */
  92252. emitter: Nullable<AbstractMesh | Vector3>;
  92253. /**
  92254. * The maximum number of particles to emit per frame
  92255. */
  92256. emitRate: number;
  92257. /**
  92258. * If you want to launch only a few particles at once, that can be done, as well.
  92259. */
  92260. manualEmitCount: number;
  92261. /**
  92262. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  92263. */
  92264. updateSpeed: number;
  92265. /**
  92266. * The amount of time the particle system is running (depends of the overall update speed).
  92267. */
  92268. targetStopDuration: number;
  92269. /**
  92270. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  92271. */
  92272. disposeOnStop: boolean;
  92273. /**
  92274. * Minimum power of emitting particles.
  92275. */
  92276. minEmitPower: number;
  92277. /**
  92278. * Maximum power of emitting particles.
  92279. */
  92280. maxEmitPower: number;
  92281. /**
  92282. * Minimum life time of emitting particles.
  92283. */
  92284. minLifeTime: number;
  92285. /**
  92286. * Maximum life time of emitting particles.
  92287. */
  92288. maxLifeTime: number;
  92289. /**
  92290. * Minimum Size of emitting particles.
  92291. */
  92292. minSize: number;
  92293. /**
  92294. * Maximum Size of emitting particles.
  92295. */
  92296. maxSize: number;
  92297. /**
  92298. * Minimum scale of emitting particles on X axis.
  92299. */
  92300. minScaleX: number;
  92301. /**
  92302. * Maximum scale of emitting particles on X axis.
  92303. */
  92304. maxScaleX: number;
  92305. /**
  92306. * Minimum scale of emitting particles on Y axis.
  92307. */
  92308. minScaleY: number;
  92309. /**
  92310. * Maximum scale of emitting particles on Y axis.
  92311. */
  92312. maxScaleY: number;
  92313. /**
  92314. * Gets or sets the minimal initial rotation in radians.
  92315. */
  92316. minInitialRotation: number;
  92317. /**
  92318. * Gets or sets the maximal initial rotation in radians.
  92319. */
  92320. maxInitialRotation: number;
  92321. /**
  92322. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  92323. */
  92324. minAngularSpeed: number;
  92325. /**
  92326. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  92327. */
  92328. maxAngularSpeed: number;
  92329. /**
  92330. * The texture used to render each particle. (this can be a spritesheet)
  92331. */
  92332. particleTexture: Nullable<BaseTexture>;
  92333. /**
  92334. * The layer mask we are rendering the particles through.
  92335. */
  92336. layerMask: number;
  92337. /**
  92338. * This can help using your own shader to render the particle system.
  92339. * The according effect will be created
  92340. */
  92341. customShader: any;
  92342. /**
  92343. * By default particle system starts as soon as they are created. This prevents the
  92344. * automatic start to happen and let you decide when to start emitting particles.
  92345. */
  92346. preventAutoStart: boolean;
  92347. private _noiseTexture;
  92348. /**
  92349. * Gets or sets a texture used to add random noise to particle positions
  92350. */
  92351. get noiseTexture(): Nullable<ProceduralTexture>;
  92352. set noiseTexture(value: Nullable<ProceduralTexture>);
  92353. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  92354. noiseStrength: Vector3;
  92355. /**
  92356. * Callback triggered when the particle animation is ending.
  92357. */
  92358. onAnimationEnd: Nullable<() => void>;
  92359. /**
  92360. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  92361. */
  92362. blendMode: number;
  92363. /**
  92364. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  92365. * to override the particles.
  92366. */
  92367. forceDepthWrite: boolean;
  92368. /** 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 */
  92369. preWarmCycles: number;
  92370. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  92371. preWarmStepOffset: number;
  92372. /**
  92373. * 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)
  92374. */
  92375. spriteCellChangeSpeed: number;
  92376. /**
  92377. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  92378. */
  92379. startSpriteCellID: number;
  92380. /**
  92381. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  92382. */
  92383. endSpriteCellID: number;
  92384. /**
  92385. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  92386. */
  92387. spriteCellWidth: number;
  92388. /**
  92389. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  92390. */
  92391. spriteCellHeight: number;
  92392. /**
  92393. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  92394. */
  92395. spriteRandomStartCell: boolean;
  92396. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  92397. translationPivot: Vector2;
  92398. /** @hidden */
  92399. protected _isAnimationSheetEnabled: boolean;
  92400. /**
  92401. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  92402. */
  92403. beginAnimationOnStart: boolean;
  92404. /**
  92405. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  92406. */
  92407. beginAnimationFrom: number;
  92408. /**
  92409. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  92410. */
  92411. beginAnimationTo: number;
  92412. /**
  92413. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  92414. */
  92415. beginAnimationLoop: boolean;
  92416. /**
  92417. * Gets or sets a world offset applied to all particles
  92418. */
  92419. worldOffset: Vector3;
  92420. /**
  92421. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  92422. */
  92423. get isAnimationSheetEnabled(): boolean;
  92424. set isAnimationSheetEnabled(value: boolean);
  92425. /**
  92426. * Get hosting scene
  92427. * @returns the scene
  92428. */
  92429. getScene(): Nullable<Scene>;
  92430. /**
  92431. * You can use gravity if you want to give an orientation to your particles.
  92432. */
  92433. gravity: Vector3;
  92434. protected _colorGradients: Nullable<Array<ColorGradient>>;
  92435. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  92436. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  92437. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  92438. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  92439. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  92440. protected _dragGradients: Nullable<Array<FactorGradient>>;
  92441. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  92442. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  92443. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  92444. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  92445. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  92446. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  92447. /**
  92448. * Defines the delay in milliseconds before starting the system (0 by default)
  92449. */
  92450. startDelay: number;
  92451. /**
  92452. * Gets the current list of drag gradients.
  92453. * You must use addDragGradient and removeDragGradient to udpate this list
  92454. * @returns the list of drag gradients
  92455. */
  92456. getDragGradients(): Nullable<Array<FactorGradient>>;
  92457. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  92458. limitVelocityDamping: number;
  92459. /**
  92460. * Gets the current list of limit velocity gradients.
  92461. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  92462. * @returns the list of limit velocity gradients
  92463. */
  92464. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  92465. /**
  92466. * Gets the current list of color gradients.
  92467. * You must use addColorGradient and removeColorGradient to udpate this list
  92468. * @returns the list of color gradients
  92469. */
  92470. getColorGradients(): Nullable<Array<ColorGradient>>;
  92471. /**
  92472. * Gets the current list of size gradients.
  92473. * You must use addSizeGradient and removeSizeGradient to udpate this list
  92474. * @returns the list of size gradients
  92475. */
  92476. getSizeGradients(): Nullable<Array<FactorGradient>>;
  92477. /**
  92478. * Gets the current list of color remap gradients.
  92479. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  92480. * @returns the list of color remap gradients
  92481. */
  92482. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  92483. /**
  92484. * Gets the current list of alpha remap gradients.
  92485. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  92486. * @returns the list of alpha remap gradients
  92487. */
  92488. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  92489. /**
  92490. * Gets the current list of life time gradients.
  92491. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  92492. * @returns the list of life time gradients
  92493. */
  92494. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  92495. /**
  92496. * Gets the current list of angular speed gradients.
  92497. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  92498. * @returns the list of angular speed gradients
  92499. */
  92500. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  92501. /**
  92502. * Gets the current list of velocity gradients.
  92503. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  92504. * @returns the list of velocity gradients
  92505. */
  92506. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  92507. /**
  92508. * Gets the current list of start size gradients.
  92509. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  92510. * @returns the list of start size gradients
  92511. */
  92512. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  92513. /**
  92514. * Gets the current list of emit rate gradients.
  92515. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  92516. * @returns the list of emit rate gradients
  92517. */
  92518. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  92519. /**
  92520. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92521. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92522. */
  92523. get direction1(): Vector3;
  92524. set direction1(value: Vector3);
  92525. /**
  92526. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92527. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92528. */
  92529. get direction2(): Vector3;
  92530. set direction2(value: Vector3);
  92531. /**
  92532. * 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.
  92533. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92534. */
  92535. get minEmitBox(): Vector3;
  92536. set minEmitBox(value: Vector3);
  92537. /**
  92538. * 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.
  92539. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92540. */
  92541. get maxEmitBox(): Vector3;
  92542. set maxEmitBox(value: Vector3);
  92543. /**
  92544. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  92545. */
  92546. color1: Color4;
  92547. /**
  92548. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  92549. */
  92550. color2: Color4;
  92551. /**
  92552. * Color the particle will have at the end of its lifetime
  92553. */
  92554. colorDead: Color4;
  92555. /**
  92556. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  92557. */
  92558. textureMask: Color4;
  92559. /**
  92560. * The particle emitter type defines the emitter used by the particle system.
  92561. * It can be for example box, sphere, or cone...
  92562. */
  92563. particleEmitterType: IParticleEmitterType;
  92564. /** @hidden */
  92565. _isSubEmitter: boolean;
  92566. /**
  92567. * Gets or sets the billboard mode to use when isBillboardBased = true.
  92568. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  92569. */
  92570. billboardMode: number;
  92571. protected _isBillboardBased: boolean;
  92572. /**
  92573. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  92574. */
  92575. get isBillboardBased(): boolean;
  92576. set isBillboardBased(value: boolean);
  92577. /**
  92578. * The scene the particle system belongs to.
  92579. */
  92580. protected _scene: Nullable<Scene>;
  92581. /**
  92582. * The engine the particle system belongs to.
  92583. */
  92584. protected _engine: ThinEngine;
  92585. /**
  92586. * Local cache of defines for image processing.
  92587. */
  92588. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  92589. /**
  92590. * Default configuration related to image processing available in the standard Material.
  92591. */
  92592. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  92593. /**
  92594. * Gets the image processing configuration used either in this material.
  92595. */
  92596. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  92597. /**
  92598. * Sets the Default image processing configuration used either in the this material.
  92599. *
  92600. * If sets to null, the scene one is in use.
  92601. */
  92602. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  92603. /**
  92604. * Attaches a new image processing configuration to the Standard Material.
  92605. * @param configuration
  92606. */
  92607. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  92608. /** @hidden */
  92609. protected _reset(): void;
  92610. /** @hidden */
  92611. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  92612. /**
  92613. * Instantiates a particle system.
  92614. * 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.
  92615. * @param name The name of the particle system
  92616. */
  92617. constructor(name: string);
  92618. /**
  92619. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  92620. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92621. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92622. * @returns the emitter
  92623. */
  92624. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  92625. /**
  92626. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  92627. * @param radius The radius of the hemisphere to emit from
  92628. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92629. * @returns the emitter
  92630. */
  92631. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  92632. /**
  92633. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  92634. * @param radius The radius of the sphere to emit from
  92635. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92636. * @returns the emitter
  92637. */
  92638. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  92639. /**
  92640. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  92641. * @param radius The radius of the sphere to emit from
  92642. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  92643. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  92644. * @returns the emitter
  92645. */
  92646. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  92647. /**
  92648. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  92649. * @param radius The radius of the emission cylinder
  92650. * @param height The height of the emission cylinder
  92651. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  92652. * @param directionRandomizer How much to randomize the particle direction [0-1]
  92653. * @returns the emitter
  92654. */
  92655. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  92656. /**
  92657. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  92658. * @param radius The radius of the cylinder to emit from
  92659. * @param height The height of the emission cylinder
  92660. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92661. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  92662. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  92663. * @returns the emitter
  92664. */
  92665. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  92666. /**
  92667. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  92668. * @param radius The radius of the cone to emit from
  92669. * @param angle The base angle of the cone
  92670. * @returns the emitter
  92671. */
  92672. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  92673. /**
  92674. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92675. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92676. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92677. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92678. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92679. * @returns the emitter
  92680. */
  92681. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92682. }
  92683. }
  92684. declare module BABYLON {
  92685. /**
  92686. * Type of sub emitter
  92687. */
  92688. export enum SubEmitterType {
  92689. /**
  92690. * Attached to the particle over it's lifetime
  92691. */
  92692. ATTACHED = 0,
  92693. /**
  92694. * Created when the particle dies
  92695. */
  92696. END = 1
  92697. }
  92698. /**
  92699. * Sub emitter class used to emit particles from an existing particle
  92700. */
  92701. export class SubEmitter {
  92702. /**
  92703. * the particle system to be used by the sub emitter
  92704. */
  92705. particleSystem: ParticleSystem;
  92706. /**
  92707. * Type of the submitter (Default: END)
  92708. */
  92709. type: SubEmitterType;
  92710. /**
  92711. * 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)
  92712. * Note: This only is supported when using an emitter of type Mesh
  92713. */
  92714. inheritDirection: boolean;
  92715. /**
  92716. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92717. */
  92718. inheritedVelocityAmount: number;
  92719. /**
  92720. * Creates a sub emitter
  92721. * @param particleSystem the particle system to be used by the sub emitter
  92722. */
  92723. constructor(
  92724. /**
  92725. * the particle system to be used by the sub emitter
  92726. */
  92727. particleSystem: ParticleSystem);
  92728. /**
  92729. * Clones the sub emitter
  92730. * @returns the cloned sub emitter
  92731. */
  92732. clone(): SubEmitter;
  92733. /**
  92734. * Serialize current object to a JSON object
  92735. * @returns the serialized object
  92736. */
  92737. serialize(): any;
  92738. /** @hidden */
  92739. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92740. /**
  92741. * Creates a new SubEmitter from a serialized JSON version
  92742. * @param serializationObject defines the JSON object to read from
  92743. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92744. * @param rootUrl defines the rootUrl for data loading
  92745. * @returns a new SubEmitter
  92746. */
  92747. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92748. /** Release associated resources */
  92749. dispose(): void;
  92750. }
  92751. }
  92752. declare module BABYLON {
  92753. /** @hidden */
  92754. export var imageProcessingDeclaration: {
  92755. name: string;
  92756. shader: string;
  92757. };
  92758. }
  92759. declare module BABYLON {
  92760. /** @hidden */
  92761. export var imageProcessingFunctions: {
  92762. name: string;
  92763. shader: string;
  92764. };
  92765. }
  92766. declare module BABYLON {
  92767. /** @hidden */
  92768. export var particlesPixelShader: {
  92769. name: string;
  92770. shader: string;
  92771. };
  92772. }
  92773. declare module BABYLON {
  92774. /** @hidden */
  92775. export var particlesVertexShader: {
  92776. name: string;
  92777. shader: string;
  92778. };
  92779. }
  92780. declare module BABYLON {
  92781. /**
  92782. * Interface used to define entities containing multiple clip planes
  92783. */
  92784. export interface IClipPlanesHolder {
  92785. /**
  92786. * Gets or sets the active clipplane 1
  92787. */
  92788. clipPlane: Nullable<Plane>;
  92789. /**
  92790. * Gets or sets the active clipplane 2
  92791. */
  92792. clipPlane2: Nullable<Plane>;
  92793. /**
  92794. * Gets or sets the active clipplane 3
  92795. */
  92796. clipPlane3: Nullable<Plane>;
  92797. /**
  92798. * Gets or sets the active clipplane 4
  92799. */
  92800. clipPlane4: Nullable<Plane>;
  92801. /**
  92802. * Gets or sets the active clipplane 5
  92803. */
  92804. clipPlane5: Nullable<Plane>;
  92805. /**
  92806. * Gets or sets the active clipplane 6
  92807. */
  92808. clipPlane6: Nullable<Plane>;
  92809. }
  92810. }
  92811. declare module BABYLON {
  92812. /**
  92813. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92814. *
  92815. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92816. *
  92817. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92818. */
  92819. export class ThinMaterialHelper {
  92820. /**
  92821. * Binds the clip plane information from the holder to the effect.
  92822. * @param effect The effect we are binding the data to
  92823. * @param holder The entity containing the clip plane information
  92824. */
  92825. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92826. }
  92827. }
  92828. declare module BABYLON {
  92829. interface ThinEngine {
  92830. /**
  92831. * Sets alpha constants used by some alpha blending modes
  92832. * @param r defines the red component
  92833. * @param g defines the green component
  92834. * @param b defines the blue component
  92835. * @param a defines the alpha component
  92836. */
  92837. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92838. /**
  92839. * Sets the current alpha mode
  92840. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92841. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92842. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92843. */
  92844. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92845. /**
  92846. * Gets the current alpha mode
  92847. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92848. * @returns the current alpha mode
  92849. */
  92850. getAlphaMode(): number;
  92851. /**
  92852. * Sets the current alpha equation
  92853. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92854. */
  92855. setAlphaEquation(equation: number): void;
  92856. /**
  92857. * Gets the current alpha equation.
  92858. * @returns the current alpha equation
  92859. */
  92860. getAlphaEquation(): number;
  92861. }
  92862. }
  92863. declare module BABYLON {
  92864. /**
  92865. * This represents a particle system in Babylon.
  92866. * 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.
  92867. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92868. * @example https://doc.babylonjs.com/babylon101/particles
  92869. */
  92870. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92871. /**
  92872. * Billboard mode will only apply to Y axis
  92873. */
  92874. static readonly BILLBOARDMODE_Y: number;
  92875. /**
  92876. * Billboard mode will apply to all axes
  92877. */
  92878. static readonly BILLBOARDMODE_ALL: number;
  92879. /**
  92880. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92881. */
  92882. static readonly BILLBOARDMODE_STRETCHED: number;
  92883. /**
  92884. * This function can be defined to provide custom update for active particles.
  92885. * This function will be called instead of regular update (age, position, color, etc.).
  92886. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92887. */
  92888. updateFunction: (particles: Particle[]) => void;
  92889. private _emitterWorldMatrix;
  92890. /**
  92891. * This function can be defined to specify initial direction for every new particle.
  92892. * It by default use the emitterType defined function
  92893. */
  92894. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92895. /**
  92896. * This function can be defined to specify initial position for every new particle.
  92897. * It by default use the emitterType defined function
  92898. */
  92899. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92900. /**
  92901. * @hidden
  92902. */
  92903. _inheritedVelocityOffset: Vector3;
  92904. /**
  92905. * An event triggered when the system is disposed
  92906. */
  92907. onDisposeObservable: Observable<IParticleSystem>;
  92908. private _onDisposeObserver;
  92909. /**
  92910. * Sets a callback that will be triggered when the system is disposed
  92911. */
  92912. set onDispose(callback: () => void);
  92913. private _particles;
  92914. private _epsilon;
  92915. private _capacity;
  92916. private _stockParticles;
  92917. private _newPartsExcess;
  92918. private _vertexData;
  92919. private _vertexBuffer;
  92920. private _vertexBuffers;
  92921. private _spriteBuffer;
  92922. private _indexBuffer;
  92923. private _effect;
  92924. private _customEffect;
  92925. private _cachedDefines;
  92926. private _scaledColorStep;
  92927. private _colorDiff;
  92928. private _scaledDirection;
  92929. private _scaledGravity;
  92930. private _currentRenderId;
  92931. private _alive;
  92932. private _useInstancing;
  92933. private _started;
  92934. private _stopped;
  92935. private _actualFrame;
  92936. private _scaledUpdateSpeed;
  92937. private _vertexBufferSize;
  92938. /** @hidden */
  92939. _currentEmitRateGradient: Nullable<FactorGradient>;
  92940. /** @hidden */
  92941. _currentEmitRate1: number;
  92942. /** @hidden */
  92943. _currentEmitRate2: number;
  92944. /** @hidden */
  92945. _currentStartSizeGradient: Nullable<FactorGradient>;
  92946. /** @hidden */
  92947. _currentStartSize1: number;
  92948. /** @hidden */
  92949. _currentStartSize2: number;
  92950. private readonly _rawTextureWidth;
  92951. private _rampGradientsTexture;
  92952. private _useRampGradients;
  92953. /** Gets or sets a matrix to use to compute projection */
  92954. defaultProjectionMatrix: Matrix;
  92955. /** Gets or sets a matrix to use to compute view */
  92956. defaultViewMatrix: Matrix;
  92957. /** Gets or sets a boolean indicating that ramp gradients must be used
  92958. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92959. */
  92960. get useRampGradients(): boolean;
  92961. set useRampGradients(value: boolean);
  92962. /**
  92963. * 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.
  92964. * 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: [])
  92965. */
  92966. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92967. private _subEmitters;
  92968. /**
  92969. * @hidden
  92970. * If the particle systems emitter should be disposed when the particle system is disposed
  92971. */
  92972. _disposeEmitterOnDispose: boolean;
  92973. /**
  92974. * The current active Sub-systems, this property is used by the root particle system only.
  92975. */
  92976. activeSubSystems: Array<ParticleSystem>;
  92977. /**
  92978. * Specifies if the particles are updated in emitter local space or world space
  92979. */
  92980. isLocal: boolean;
  92981. private _rootParticleSystem;
  92982. /**
  92983. * Gets the current list of active particles
  92984. */
  92985. get particles(): Particle[];
  92986. /**
  92987. * Gets the number of particles active at the same time.
  92988. * @returns The number of active particles.
  92989. */
  92990. getActiveCount(): number;
  92991. /**
  92992. * Returns the string "ParticleSystem"
  92993. * @returns a string containing the class name
  92994. */
  92995. getClassName(): string;
  92996. /**
  92997. * Gets a boolean indicating that the system is stopping
  92998. * @returns true if the system is currently stopping
  92999. */
  93000. isStopping(): boolean;
  93001. /**
  93002. * Gets the custom effect used to render the particles
  93003. * @param blendMode Blend mode for which the effect should be retrieved
  93004. * @returns The effect
  93005. */
  93006. getCustomEffect(blendMode?: number): Nullable<Effect>;
  93007. /**
  93008. * Sets the custom effect used to render the particles
  93009. * @param effect The effect to set
  93010. * @param blendMode Blend mode for which the effect should be set
  93011. */
  93012. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  93013. /** @hidden */
  93014. private _onBeforeDrawParticlesObservable;
  93015. /**
  93016. * Observable that will be called just before the particles are drawn
  93017. */
  93018. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  93019. /**
  93020. * Gets the name of the particle vertex shader
  93021. */
  93022. get vertexShaderName(): string;
  93023. /**
  93024. * Instantiates a particle system.
  93025. * 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.
  93026. * @param name The name of the particle system
  93027. * @param capacity The max number of particles alive at the same time
  93028. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  93029. * @param customEffect a custom effect used to change the way particles are rendered by default
  93030. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  93031. * @param epsilon Offset used to render the particles
  93032. */
  93033. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  93034. private _addFactorGradient;
  93035. private _removeFactorGradient;
  93036. /**
  93037. * Adds a new life time gradient
  93038. * @param gradient defines the gradient to use (between 0 and 1)
  93039. * @param factor defines the life time factor to affect to the specified gradient
  93040. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93041. * @returns the current particle system
  93042. */
  93043. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93044. /**
  93045. * Remove a specific life time gradient
  93046. * @param gradient defines the gradient to remove
  93047. * @returns the current particle system
  93048. */
  93049. removeLifeTimeGradient(gradient: number): IParticleSystem;
  93050. /**
  93051. * Adds a new size gradient
  93052. * @param gradient defines the gradient to use (between 0 and 1)
  93053. * @param factor defines the size factor to affect to the specified gradient
  93054. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93055. * @returns the current particle system
  93056. */
  93057. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93058. /**
  93059. * Remove a specific size gradient
  93060. * @param gradient defines the gradient to remove
  93061. * @returns the current particle system
  93062. */
  93063. removeSizeGradient(gradient: number): IParticleSystem;
  93064. /**
  93065. * Adds a new color remap gradient
  93066. * @param gradient defines the gradient to use (between 0 and 1)
  93067. * @param min defines the color remap minimal range
  93068. * @param max defines the color remap maximal range
  93069. * @returns the current particle system
  93070. */
  93071. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93072. /**
  93073. * Remove a specific color remap gradient
  93074. * @param gradient defines the gradient to remove
  93075. * @returns the current particle system
  93076. */
  93077. removeColorRemapGradient(gradient: number): IParticleSystem;
  93078. /**
  93079. * Adds a new alpha remap gradient
  93080. * @param gradient defines the gradient to use (between 0 and 1)
  93081. * @param min defines the alpha remap minimal range
  93082. * @param max defines the alpha remap maximal range
  93083. * @returns the current particle system
  93084. */
  93085. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93086. /**
  93087. * Remove a specific alpha remap gradient
  93088. * @param gradient defines the gradient to remove
  93089. * @returns the current particle system
  93090. */
  93091. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  93092. /**
  93093. * Adds a new angular speed gradient
  93094. * @param gradient defines the gradient to use (between 0 and 1)
  93095. * @param factor defines the angular speed to affect to the specified gradient
  93096. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93097. * @returns the current particle system
  93098. */
  93099. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93100. /**
  93101. * Remove a specific angular speed gradient
  93102. * @param gradient defines the gradient to remove
  93103. * @returns the current particle system
  93104. */
  93105. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93106. /**
  93107. * Adds a new velocity gradient
  93108. * @param gradient defines the gradient to use (between 0 and 1)
  93109. * @param factor defines the velocity to affect to the specified gradient
  93110. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93111. * @returns the current particle system
  93112. */
  93113. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93114. /**
  93115. * Remove a specific velocity gradient
  93116. * @param gradient defines the gradient to remove
  93117. * @returns the current particle system
  93118. */
  93119. removeVelocityGradient(gradient: number): IParticleSystem;
  93120. /**
  93121. * Adds a new limit velocity gradient
  93122. * @param gradient defines the gradient to use (between 0 and 1)
  93123. * @param factor defines the limit velocity value to affect to the specified gradient
  93124. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93125. * @returns the current particle system
  93126. */
  93127. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93128. /**
  93129. * Remove a specific limit velocity gradient
  93130. * @param gradient defines the gradient to remove
  93131. * @returns the current particle system
  93132. */
  93133. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  93134. /**
  93135. * Adds a new drag gradient
  93136. * @param gradient defines the gradient to use (between 0 and 1)
  93137. * @param factor defines the drag value to affect to the specified gradient
  93138. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93139. * @returns the current particle system
  93140. */
  93141. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93142. /**
  93143. * Remove a specific drag gradient
  93144. * @param gradient defines the gradient to remove
  93145. * @returns the current particle system
  93146. */
  93147. removeDragGradient(gradient: number): IParticleSystem;
  93148. /**
  93149. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  93150. * @param gradient defines the gradient to use (between 0 and 1)
  93151. * @param factor defines the emit rate value to affect to the specified gradient
  93152. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93153. * @returns the current particle system
  93154. */
  93155. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93156. /**
  93157. * Remove a specific emit rate gradient
  93158. * @param gradient defines the gradient to remove
  93159. * @returns the current particle system
  93160. */
  93161. removeEmitRateGradient(gradient: number): IParticleSystem;
  93162. /**
  93163. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  93164. * @param gradient defines the gradient to use (between 0 and 1)
  93165. * @param factor defines the start size value to affect to the specified gradient
  93166. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93167. * @returns the current particle system
  93168. */
  93169. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93170. /**
  93171. * Remove a specific start size gradient
  93172. * @param gradient defines the gradient to remove
  93173. * @returns the current particle system
  93174. */
  93175. removeStartSizeGradient(gradient: number): IParticleSystem;
  93176. private _createRampGradientTexture;
  93177. /**
  93178. * Gets the current list of ramp gradients.
  93179. * You must use addRampGradient and removeRampGradient to udpate this list
  93180. * @returns the list of ramp gradients
  93181. */
  93182. getRampGradients(): Nullable<Array<Color3Gradient>>;
  93183. /** Force the system to rebuild all gradients that need to be resync */
  93184. forceRefreshGradients(): void;
  93185. private _syncRampGradientTexture;
  93186. /**
  93187. * Adds a new ramp gradient used to remap particle colors
  93188. * @param gradient defines the gradient to use (between 0 and 1)
  93189. * @param color defines the color to affect to the specified gradient
  93190. * @returns the current particle system
  93191. */
  93192. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  93193. /**
  93194. * Remove a specific ramp gradient
  93195. * @param gradient defines the gradient to remove
  93196. * @returns the current particle system
  93197. */
  93198. removeRampGradient(gradient: number): ParticleSystem;
  93199. /**
  93200. * Adds a new color gradient
  93201. * @param gradient defines the gradient to use (between 0 and 1)
  93202. * @param color1 defines the color to affect to the specified gradient
  93203. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93204. * @returns this particle system
  93205. */
  93206. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93207. /**
  93208. * Remove a specific color gradient
  93209. * @param gradient defines the gradient to remove
  93210. * @returns this particle system
  93211. */
  93212. removeColorGradient(gradient: number): IParticleSystem;
  93213. private _fetchR;
  93214. protected _reset(): void;
  93215. private _resetEffect;
  93216. private _createVertexBuffers;
  93217. private _createIndexBuffer;
  93218. /**
  93219. * Gets the maximum number of particles active at the same time.
  93220. * @returns The max number of active particles.
  93221. */
  93222. getCapacity(): number;
  93223. /**
  93224. * Gets whether there are still active particles in the system.
  93225. * @returns True if it is alive, otherwise false.
  93226. */
  93227. isAlive(): boolean;
  93228. /**
  93229. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93230. * @returns True if it has been started, otherwise false.
  93231. */
  93232. isStarted(): boolean;
  93233. private _prepareSubEmitterInternalArray;
  93234. /**
  93235. * Starts the particle system and begins to emit
  93236. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  93237. */
  93238. start(delay?: number): void;
  93239. /**
  93240. * Stops the particle system.
  93241. * @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.
  93242. */
  93243. stop(stopSubEmitters?: boolean): void;
  93244. /**
  93245. * Remove all active particles
  93246. */
  93247. reset(): void;
  93248. /**
  93249. * @hidden (for internal use only)
  93250. */
  93251. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  93252. /**
  93253. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  93254. * Its lifetime will start back at 0.
  93255. */
  93256. recycleParticle: (particle: Particle) => void;
  93257. private _stopSubEmitters;
  93258. private _createParticle;
  93259. private _removeFromRoot;
  93260. private _emitFromParticle;
  93261. private _update;
  93262. /** @hidden */
  93263. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  93264. /** @hidden */
  93265. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  93266. /**
  93267. * Fill the defines array according to the current settings of the particle system
  93268. * @param defines Array to be updated
  93269. * @param blendMode blend mode to take into account when updating the array
  93270. */
  93271. fillDefines(defines: Array<string>, blendMode: number): void;
  93272. /**
  93273. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93274. * @param uniforms Uniforms array to fill
  93275. * @param attributes Attributes array to fill
  93276. * @param samplers Samplers array to fill
  93277. */
  93278. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93279. /** @hidden */
  93280. private _getEffect;
  93281. /**
  93282. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  93283. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  93284. */
  93285. animate(preWarmOnly?: boolean): void;
  93286. private _appendParticleVertices;
  93287. /**
  93288. * Rebuilds the particle system.
  93289. */
  93290. rebuild(): void;
  93291. /**
  93292. * Is this system ready to be used/rendered
  93293. * @return true if the system is ready
  93294. */
  93295. isReady(): boolean;
  93296. private _render;
  93297. /**
  93298. * Renders the particle system in its current state.
  93299. * @returns the current number of particles
  93300. */
  93301. render(): number;
  93302. /**
  93303. * Disposes the particle system and free the associated resources
  93304. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93305. */
  93306. dispose(disposeTexture?: boolean): void;
  93307. /**
  93308. * Clones the particle system.
  93309. * @param name The name of the cloned object
  93310. * @param newEmitter The new emitter to use
  93311. * @returns the cloned particle system
  93312. */
  93313. clone(name: string, newEmitter: any): ParticleSystem;
  93314. /**
  93315. * Serializes the particle system to a JSON object
  93316. * @param serializeTexture defines if the texture must be serialized as well
  93317. * @returns the JSON object
  93318. */
  93319. serialize(serializeTexture?: boolean): any;
  93320. /** @hidden */
  93321. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  93322. /** @hidden */
  93323. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  93324. /**
  93325. * Parses a JSON object to create a particle system.
  93326. * @param parsedParticleSystem The JSON object to parse
  93327. * @param sceneOrEngine The scene or the engine to create the particle system in
  93328. * @param rootUrl The root url to use to load external dependencies like texture
  93329. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  93330. * @returns the Parsed particle system
  93331. */
  93332. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  93333. }
  93334. }
  93335. declare module BABYLON {
  93336. /**
  93337. * A particle represents one of the element emitted by a particle system.
  93338. * This is mainly define by its coordinates, direction, velocity and age.
  93339. */
  93340. export class Particle {
  93341. /**
  93342. * The particle system the particle belongs to.
  93343. */
  93344. particleSystem: ParticleSystem;
  93345. private static _Count;
  93346. /**
  93347. * Unique ID of the particle
  93348. */
  93349. id: number;
  93350. /**
  93351. * The world position of the particle in the scene.
  93352. */
  93353. position: Vector3;
  93354. /**
  93355. * The world direction of the particle in the scene.
  93356. */
  93357. direction: Vector3;
  93358. /**
  93359. * The color of the particle.
  93360. */
  93361. color: Color4;
  93362. /**
  93363. * The color change of the particle per step.
  93364. */
  93365. colorStep: Color4;
  93366. /**
  93367. * Defines how long will the life of the particle be.
  93368. */
  93369. lifeTime: number;
  93370. /**
  93371. * The current age of the particle.
  93372. */
  93373. age: number;
  93374. /**
  93375. * The current size of the particle.
  93376. */
  93377. size: number;
  93378. /**
  93379. * The current scale of the particle.
  93380. */
  93381. scale: Vector2;
  93382. /**
  93383. * The current angle of the particle.
  93384. */
  93385. angle: number;
  93386. /**
  93387. * Defines how fast is the angle changing.
  93388. */
  93389. angularSpeed: number;
  93390. /**
  93391. * Defines the cell index used by the particle to be rendered from a sprite.
  93392. */
  93393. cellIndex: number;
  93394. /**
  93395. * The information required to support color remapping
  93396. */
  93397. remapData: Vector4;
  93398. /** @hidden */
  93399. _randomCellOffset?: number;
  93400. /** @hidden */
  93401. _initialDirection: Nullable<Vector3>;
  93402. /** @hidden */
  93403. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  93404. /** @hidden */
  93405. _initialStartSpriteCellID: number;
  93406. /** @hidden */
  93407. _initialEndSpriteCellID: number;
  93408. /** @hidden */
  93409. _currentColorGradient: Nullable<ColorGradient>;
  93410. /** @hidden */
  93411. _currentColor1: Color4;
  93412. /** @hidden */
  93413. _currentColor2: Color4;
  93414. /** @hidden */
  93415. _currentSizeGradient: Nullable<FactorGradient>;
  93416. /** @hidden */
  93417. _currentSize1: number;
  93418. /** @hidden */
  93419. _currentSize2: number;
  93420. /** @hidden */
  93421. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  93422. /** @hidden */
  93423. _currentAngularSpeed1: number;
  93424. /** @hidden */
  93425. _currentAngularSpeed2: number;
  93426. /** @hidden */
  93427. _currentVelocityGradient: Nullable<FactorGradient>;
  93428. /** @hidden */
  93429. _currentVelocity1: number;
  93430. /** @hidden */
  93431. _currentVelocity2: number;
  93432. /** @hidden */
  93433. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  93434. /** @hidden */
  93435. _currentLimitVelocity1: number;
  93436. /** @hidden */
  93437. _currentLimitVelocity2: number;
  93438. /** @hidden */
  93439. _currentDragGradient: Nullable<FactorGradient>;
  93440. /** @hidden */
  93441. _currentDrag1: number;
  93442. /** @hidden */
  93443. _currentDrag2: number;
  93444. /** @hidden */
  93445. _randomNoiseCoordinates1: Vector3;
  93446. /** @hidden */
  93447. _randomNoiseCoordinates2: Vector3;
  93448. /** @hidden */
  93449. _localPosition?: Vector3;
  93450. /**
  93451. * Creates a new instance Particle
  93452. * @param particleSystem the particle system the particle belongs to
  93453. */
  93454. constructor(
  93455. /**
  93456. * The particle system the particle belongs to.
  93457. */
  93458. particleSystem: ParticleSystem);
  93459. private updateCellInfoFromSystem;
  93460. /**
  93461. * Defines how the sprite cell index is updated for the particle
  93462. */
  93463. updateCellIndex(): void;
  93464. /** @hidden */
  93465. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  93466. /** @hidden */
  93467. _inheritParticleInfoToSubEmitters(): void;
  93468. /** @hidden */
  93469. _reset(): void;
  93470. /**
  93471. * Copy the properties of particle to another one.
  93472. * @param other the particle to copy the information to.
  93473. */
  93474. copyTo(other: Particle): void;
  93475. }
  93476. }
  93477. declare module BABYLON {
  93478. /**
  93479. * Particle emitter represents a volume emitting particles.
  93480. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  93481. */
  93482. export interface IParticleEmitterType {
  93483. /**
  93484. * Called by the particle System when the direction is computed for the created particle.
  93485. * @param worldMatrix is the world matrix of the particle system
  93486. * @param directionToUpdate is the direction vector to update with the result
  93487. * @param particle is the particle we are computed the direction for
  93488. * @param isLocal defines if the direction should be set in local space
  93489. */
  93490. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93491. /**
  93492. * Called by the particle System when the position is computed for the created particle.
  93493. * @param worldMatrix is the world matrix of the particle system
  93494. * @param positionToUpdate is the position vector to update with the result
  93495. * @param particle is the particle we are computed the position for
  93496. * @param isLocal defines if the position should be set in local space
  93497. */
  93498. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93499. /**
  93500. * Clones the current emitter and returns a copy of it
  93501. * @returns the new emitter
  93502. */
  93503. clone(): IParticleEmitterType;
  93504. /**
  93505. * Called by the GPUParticleSystem to setup the update shader
  93506. * @param effect defines the update shader
  93507. */
  93508. applyToShader(effect: Effect): void;
  93509. /**
  93510. * Returns a string to use to update the GPU particles update shader
  93511. * @returns the effect defines string
  93512. */
  93513. getEffectDefines(): string;
  93514. /**
  93515. * Returns a string representing the class name
  93516. * @returns a string containing the class name
  93517. */
  93518. getClassName(): string;
  93519. /**
  93520. * Serializes the particle system to a JSON object.
  93521. * @returns the JSON object
  93522. */
  93523. serialize(): any;
  93524. /**
  93525. * Parse properties from a JSON object
  93526. * @param serializationObject defines the JSON object
  93527. * @param scene defines the hosting scene
  93528. */
  93529. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93530. }
  93531. }
  93532. declare module BABYLON {
  93533. /**
  93534. * Particle emitter emitting particles from the inside of a box.
  93535. * It emits the particles randomly between 2 given directions.
  93536. */
  93537. export class BoxParticleEmitter implements IParticleEmitterType {
  93538. /**
  93539. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93540. */
  93541. direction1: Vector3;
  93542. /**
  93543. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93544. */
  93545. direction2: Vector3;
  93546. /**
  93547. * 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.
  93548. */
  93549. minEmitBox: Vector3;
  93550. /**
  93551. * 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.
  93552. */
  93553. maxEmitBox: Vector3;
  93554. /**
  93555. * Creates a new instance BoxParticleEmitter
  93556. */
  93557. constructor();
  93558. /**
  93559. * Called by the particle System when the direction is computed for the created particle.
  93560. * @param worldMatrix is the world matrix of the particle system
  93561. * @param directionToUpdate is the direction vector to update with the result
  93562. * @param particle is the particle we are computed the direction for
  93563. * @param isLocal defines if the direction should be set in local space
  93564. */
  93565. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93566. /**
  93567. * Called by the particle System when the position is computed for the created particle.
  93568. * @param worldMatrix is the world matrix of the particle system
  93569. * @param positionToUpdate is the position vector to update with the result
  93570. * @param particle is the particle we are computed the position for
  93571. * @param isLocal defines if the position should be set in local space
  93572. */
  93573. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93574. /**
  93575. * Clones the current emitter and returns a copy of it
  93576. * @returns the new emitter
  93577. */
  93578. clone(): BoxParticleEmitter;
  93579. /**
  93580. * Called by the GPUParticleSystem to setup the update shader
  93581. * @param effect defines the update shader
  93582. */
  93583. applyToShader(effect: Effect): void;
  93584. /**
  93585. * Returns a string to use to update the GPU particles update shader
  93586. * @returns a string containng the defines string
  93587. */
  93588. getEffectDefines(): string;
  93589. /**
  93590. * Returns the string "BoxParticleEmitter"
  93591. * @returns a string containing the class name
  93592. */
  93593. getClassName(): string;
  93594. /**
  93595. * Serializes the particle system to a JSON object.
  93596. * @returns the JSON object
  93597. */
  93598. serialize(): any;
  93599. /**
  93600. * Parse properties from a JSON object
  93601. * @param serializationObject defines the JSON object
  93602. */
  93603. parse(serializationObject: any): void;
  93604. }
  93605. }
  93606. declare module BABYLON {
  93607. /**
  93608. * Particle emitter emitting particles from the inside of a cone.
  93609. * It emits the particles alongside the cone volume from the base to the particle.
  93610. * The emission direction might be randomized.
  93611. */
  93612. export class ConeParticleEmitter implements IParticleEmitterType {
  93613. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93614. directionRandomizer: number;
  93615. private _radius;
  93616. private _angle;
  93617. private _height;
  93618. /**
  93619. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  93620. */
  93621. radiusRange: number;
  93622. /**
  93623. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  93624. */
  93625. heightRange: number;
  93626. /**
  93627. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  93628. */
  93629. emitFromSpawnPointOnly: boolean;
  93630. /**
  93631. * Gets or sets the radius of the emission cone
  93632. */
  93633. get radius(): number;
  93634. set radius(value: number);
  93635. /**
  93636. * Gets or sets the angle of the emission cone
  93637. */
  93638. get angle(): number;
  93639. set angle(value: number);
  93640. private _buildHeight;
  93641. /**
  93642. * Creates a new instance ConeParticleEmitter
  93643. * @param radius the radius of the emission cone (1 by default)
  93644. * @param angle the cone base angle (PI by default)
  93645. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  93646. */
  93647. constructor(radius?: number, angle?: number,
  93648. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93649. directionRandomizer?: number);
  93650. /**
  93651. * Called by the particle System when the direction is computed for the created particle.
  93652. * @param worldMatrix is the world matrix of the particle system
  93653. * @param directionToUpdate is the direction vector to update with the result
  93654. * @param particle is the particle we are computed the direction for
  93655. * @param isLocal defines if the direction should be set in local space
  93656. */
  93657. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93658. /**
  93659. * Called by the particle System when the position is computed for the created particle.
  93660. * @param worldMatrix is the world matrix of the particle system
  93661. * @param positionToUpdate is the position vector to update with the result
  93662. * @param particle is the particle we are computed the position for
  93663. * @param isLocal defines if the position should be set in local space
  93664. */
  93665. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93666. /**
  93667. * Clones the current emitter and returns a copy of it
  93668. * @returns the new emitter
  93669. */
  93670. clone(): ConeParticleEmitter;
  93671. /**
  93672. * Called by the GPUParticleSystem to setup the update shader
  93673. * @param effect defines the update shader
  93674. */
  93675. applyToShader(effect: Effect): void;
  93676. /**
  93677. * Returns a string to use to update the GPU particles update shader
  93678. * @returns a string containng the defines string
  93679. */
  93680. getEffectDefines(): string;
  93681. /**
  93682. * Returns the string "ConeParticleEmitter"
  93683. * @returns a string containing the class name
  93684. */
  93685. getClassName(): string;
  93686. /**
  93687. * Serializes the particle system to a JSON object.
  93688. * @returns the JSON object
  93689. */
  93690. serialize(): any;
  93691. /**
  93692. * Parse properties from a JSON object
  93693. * @param serializationObject defines the JSON object
  93694. */
  93695. parse(serializationObject: any): void;
  93696. }
  93697. }
  93698. declare module BABYLON {
  93699. /**
  93700. * Particle emitter emitting particles from the inside of a cylinder.
  93701. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93702. */
  93703. export class CylinderParticleEmitter implements IParticleEmitterType {
  93704. /**
  93705. * The radius of the emission cylinder.
  93706. */
  93707. radius: number;
  93708. /**
  93709. * The height of the emission cylinder.
  93710. */
  93711. height: number;
  93712. /**
  93713. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93714. */
  93715. radiusRange: number;
  93716. /**
  93717. * How much to randomize the particle direction [0-1].
  93718. */
  93719. directionRandomizer: number;
  93720. /**
  93721. * Creates a new instance CylinderParticleEmitter
  93722. * @param radius the radius of the emission cylinder (1 by default)
  93723. * @param height the height of the emission cylinder (1 by default)
  93724. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93725. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93726. */
  93727. constructor(
  93728. /**
  93729. * The radius of the emission cylinder.
  93730. */
  93731. radius?: number,
  93732. /**
  93733. * The height of the emission cylinder.
  93734. */
  93735. height?: number,
  93736. /**
  93737. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93738. */
  93739. radiusRange?: number,
  93740. /**
  93741. * How much to randomize the particle direction [0-1].
  93742. */
  93743. directionRandomizer?: number);
  93744. /**
  93745. * Called by the particle System when the direction is computed for the created particle.
  93746. * @param worldMatrix is the world matrix of the particle system
  93747. * @param directionToUpdate is the direction vector to update with the result
  93748. * @param particle is the particle we are computed the direction for
  93749. * @param isLocal defines if the direction should be set in local space
  93750. */
  93751. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93752. /**
  93753. * Called by the particle System when the position is computed for the created particle.
  93754. * @param worldMatrix is the world matrix of the particle system
  93755. * @param positionToUpdate is the position vector to update with the result
  93756. * @param particle is the particle we are computed the position for
  93757. * @param isLocal defines if the position should be set in local space
  93758. */
  93759. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93760. /**
  93761. * Clones the current emitter and returns a copy of it
  93762. * @returns the new emitter
  93763. */
  93764. clone(): CylinderParticleEmitter;
  93765. /**
  93766. * Called by the GPUParticleSystem to setup the update shader
  93767. * @param effect defines the update shader
  93768. */
  93769. applyToShader(effect: Effect): void;
  93770. /**
  93771. * Returns a string to use to update the GPU particles update shader
  93772. * @returns a string containng the defines string
  93773. */
  93774. getEffectDefines(): string;
  93775. /**
  93776. * Returns the string "CylinderParticleEmitter"
  93777. * @returns a string containing the class name
  93778. */
  93779. getClassName(): string;
  93780. /**
  93781. * Serializes the particle system to a JSON object.
  93782. * @returns the JSON object
  93783. */
  93784. serialize(): any;
  93785. /**
  93786. * Parse properties from a JSON object
  93787. * @param serializationObject defines the JSON object
  93788. */
  93789. parse(serializationObject: any): void;
  93790. }
  93791. /**
  93792. * Particle emitter emitting particles from the inside of a cylinder.
  93793. * It emits the particles randomly between two vectors.
  93794. */
  93795. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93796. /**
  93797. * The min limit of the emission direction.
  93798. */
  93799. direction1: Vector3;
  93800. /**
  93801. * The max limit of the emission direction.
  93802. */
  93803. direction2: Vector3;
  93804. /**
  93805. * Creates a new instance CylinderDirectedParticleEmitter
  93806. * @param radius the radius of the emission cylinder (1 by default)
  93807. * @param height the height of the emission cylinder (1 by default)
  93808. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93809. * @param direction1 the min limit of the emission direction (up vector by default)
  93810. * @param direction2 the max limit of the emission direction (up vector by default)
  93811. */
  93812. constructor(radius?: number, height?: number, radiusRange?: number,
  93813. /**
  93814. * The min limit of the emission direction.
  93815. */
  93816. direction1?: Vector3,
  93817. /**
  93818. * The max limit of the emission direction.
  93819. */
  93820. direction2?: Vector3);
  93821. /**
  93822. * Called by the particle System when the direction is computed for the created particle.
  93823. * @param worldMatrix is the world matrix of the particle system
  93824. * @param directionToUpdate is the direction vector to update with the result
  93825. * @param particle is the particle we are computed the direction for
  93826. */
  93827. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93828. /**
  93829. * Clones the current emitter and returns a copy of it
  93830. * @returns the new emitter
  93831. */
  93832. clone(): CylinderDirectedParticleEmitter;
  93833. /**
  93834. * Called by the GPUParticleSystem to setup the update shader
  93835. * @param effect defines the update shader
  93836. */
  93837. applyToShader(effect: Effect): void;
  93838. /**
  93839. * Returns a string to use to update the GPU particles update shader
  93840. * @returns a string containng the defines string
  93841. */
  93842. getEffectDefines(): string;
  93843. /**
  93844. * Returns the string "CylinderDirectedParticleEmitter"
  93845. * @returns a string containing the class name
  93846. */
  93847. getClassName(): string;
  93848. /**
  93849. * Serializes the particle system to a JSON object.
  93850. * @returns the JSON object
  93851. */
  93852. serialize(): any;
  93853. /**
  93854. * Parse properties from a JSON object
  93855. * @param serializationObject defines the JSON object
  93856. */
  93857. parse(serializationObject: any): void;
  93858. }
  93859. }
  93860. declare module BABYLON {
  93861. /**
  93862. * Particle emitter emitting particles from the inside of a hemisphere.
  93863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93864. */
  93865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93866. /**
  93867. * The radius of the emission hemisphere.
  93868. */
  93869. radius: number;
  93870. /**
  93871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93872. */
  93873. radiusRange: number;
  93874. /**
  93875. * How much to randomize the particle direction [0-1].
  93876. */
  93877. directionRandomizer: number;
  93878. /**
  93879. * Creates a new instance HemisphericParticleEmitter
  93880. * @param radius the radius of the emission hemisphere (1 by default)
  93881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93883. */
  93884. constructor(
  93885. /**
  93886. * The radius of the emission hemisphere.
  93887. */
  93888. radius?: number,
  93889. /**
  93890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93891. */
  93892. radiusRange?: number,
  93893. /**
  93894. * How much to randomize the particle direction [0-1].
  93895. */
  93896. directionRandomizer?: number);
  93897. /**
  93898. * Called by the particle System when the direction is computed for the created particle.
  93899. * @param worldMatrix is the world matrix of the particle system
  93900. * @param directionToUpdate is the direction vector to update with the result
  93901. * @param particle is the particle we are computed the direction for
  93902. * @param isLocal defines if the direction should be set in local space
  93903. */
  93904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93905. /**
  93906. * Called by the particle System when the position is computed for the created particle.
  93907. * @param worldMatrix is the world matrix of the particle system
  93908. * @param positionToUpdate is the position vector to update with the result
  93909. * @param particle is the particle we are computed the position for
  93910. * @param isLocal defines if the position should be set in local space
  93911. */
  93912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93913. /**
  93914. * Clones the current emitter and returns a copy of it
  93915. * @returns the new emitter
  93916. */
  93917. clone(): HemisphericParticleEmitter;
  93918. /**
  93919. * Called by the GPUParticleSystem to setup the update shader
  93920. * @param effect defines the update shader
  93921. */
  93922. applyToShader(effect: Effect): void;
  93923. /**
  93924. * Returns a string to use to update the GPU particles update shader
  93925. * @returns a string containng the defines string
  93926. */
  93927. getEffectDefines(): string;
  93928. /**
  93929. * Returns the string "HemisphericParticleEmitter"
  93930. * @returns a string containing the class name
  93931. */
  93932. getClassName(): string;
  93933. /**
  93934. * Serializes the particle system to a JSON object.
  93935. * @returns the JSON object
  93936. */
  93937. serialize(): any;
  93938. /**
  93939. * Parse properties from a JSON object
  93940. * @param serializationObject defines the JSON object
  93941. */
  93942. parse(serializationObject: any): void;
  93943. }
  93944. }
  93945. declare module BABYLON {
  93946. /**
  93947. * Particle emitter emitting particles from a point.
  93948. * It emits the particles randomly between 2 given directions.
  93949. */
  93950. export class PointParticleEmitter implements IParticleEmitterType {
  93951. /**
  93952. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93953. */
  93954. direction1: Vector3;
  93955. /**
  93956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93957. */
  93958. direction2: Vector3;
  93959. /**
  93960. * Creates a new instance PointParticleEmitter
  93961. */
  93962. constructor();
  93963. /**
  93964. * Called by the particle System when the direction is computed for the created particle.
  93965. * @param worldMatrix is the world matrix of the particle system
  93966. * @param directionToUpdate is the direction vector to update with the result
  93967. * @param particle is the particle we are computed the direction for
  93968. * @param isLocal defines if the direction should be set in local space
  93969. */
  93970. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93971. /**
  93972. * Called by the particle System when the position is computed for the created particle.
  93973. * @param worldMatrix is the world matrix of the particle system
  93974. * @param positionToUpdate is the position vector to update with the result
  93975. * @param particle is the particle we are computed the position for
  93976. * @param isLocal defines if the position should be set in local space
  93977. */
  93978. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93979. /**
  93980. * Clones the current emitter and returns a copy of it
  93981. * @returns the new emitter
  93982. */
  93983. clone(): PointParticleEmitter;
  93984. /**
  93985. * Called by the GPUParticleSystem to setup the update shader
  93986. * @param effect defines the update shader
  93987. */
  93988. applyToShader(effect: Effect): void;
  93989. /**
  93990. * Returns a string to use to update the GPU particles update shader
  93991. * @returns a string containng the defines string
  93992. */
  93993. getEffectDefines(): string;
  93994. /**
  93995. * Returns the string "PointParticleEmitter"
  93996. * @returns a string containing the class name
  93997. */
  93998. getClassName(): string;
  93999. /**
  94000. * Serializes the particle system to a JSON object.
  94001. * @returns the JSON object
  94002. */
  94003. serialize(): any;
  94004. /**
  94005. * Parse properties from a JSON object
  94006. * @param serializationObject defines the JSON object
  94007. */
  94008. parse(serializationObject: any): void;
  94009. }
  94010. }
  94011. declare module BABYLON {
  94012. /**
  94013. * Particle emitter emitting particles from the inside of a sphere.
  94014. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  94015. */
  94016. export class SphereParticleEmitter implements IParticleEmitterType {
  94017. /**
  94018. * The radius of the emission sphere.
  94019. */
  94020. radius: number;
  94021. /**
  94022. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94023. */
  94024. radiusRange: number;
  94025. /**
  94026. * How much to randomize the particle direction [0-1].
  94027. */
  94028. directionRandomizer: number;
  94029. /**
  94030. * Creates a new instance SphereParticleEmitter
  94031. * @param radius the radius of the emission sphere (1 by default)
  94032. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94033. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  94034. */
  94035. constructor(
  94036. /**
  94037. * The radius of the emission sphere.
  94038. */
  94039. radius?: number,
  94040. /**
  94041. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94042. */
  94043. radiusRange?: number,
  94044. /**
  94045. * How much to randomize the particle direction [0-1].
  94046. */
  94047. directionRandomizer?: number);
  94048. /**
  94049. * Called by the particle System when the direction is computed for the created particle.
  94050. * @param worldMatrix is the world matrix of the particle system
  94051. * @param directionToUpdate is the direction vector to update with the result
  94052. * @param particle is the particle we are computed the direction for
  94053. * @param isLocal defines if the direction should be set in local space
  94054. */
  94055. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94056. /**
  94057. * Called by the particle System when the position is computed for the created particle.
  94058. * @param worldMatrix is the world matrix of the particle system
  94059. * @param positionToUpdate is the position vector to update with the result
  94060. * @param particle is the particle we are computed the position for
  94061. * @param isLocal defines if the position should be set in local space
  94062. */
  94063. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94064. /**
  94065. * Clones the current emitter and returns a copy of it
  94066. * @returns the new emitter
  94067. */
  94068. clone(): SphereParticleEmitter;
  94069. /**
  94070. * Called by the GPUParticleSystem to setup the update shader
  94071. * @param effect defines the update shader
  94072. */
  94073. applyToShader(effect: Effect): void;
  94074. /**
  94075. * Returns a string to use to update the GPU particles update shader
  94076. * @returns a string containng the defines string
  94077. */
  94078. getEffectDefines(): string;
  94079. /**
  94080. * Returns the string "SphereParticleEmitter"
  94081. * @returns a string containing the class name
  94082. */
  94083. getClassName(): string;
  94084. /**
  94085. * Serializes the particle system to a JSON object.
  94086. * @returns the JSON object
  94087. */
  94088. serialize(): any;
  94089. /**
  94090. * Parse properties from a JSON object
  94091. * @param serializationObject defines the JSON object
  94092. */
  94093. parse(serializationObject: any): void;
  94094. }
  94095. /**
  94096. * Particle emitter emitting particles from the inside of a sphere.
  94097. * It emits the particles randomly between two vectors.
  94098. */
  94099. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  94100. /**
  94101. * The min limit of the emission direction.
  94102. */
  94103. direction1: Vector3;
  94104. /**
  94105. * The max limit of the emission direction.
  94106. */
  94107. direction2: Vector3;
  94108. /**
  94109. * Creates a new instance SphereDirectedParticleEmitter
  94110. * @param radius the radius of the emission sphere (1 by default)
  94111. * @param direction1 the min limit of the emission direction (up vector by default)
  94112. * @param direction2 the max limit of the emission direction (up vector by default)
  94113. */
  94114. constructor(radius?: number,
  94115. /**
  94116. * The min limit of the emission direction.
  94117. */
  94118. direction1?: Vector3,
  94119. /**
  94120. * The max limit of the emission direction.
  94121. */
  94122. direction2?: Vector3);
  94123. /**
  94124. * Called by the particle System when the direction is computed for the created particle.
  94125. * @param worldMatrix is the world matrix of the particle system
  94126. * @param directionToUpdate is the direction vector to update with the result
  94127. * @param particle is the particle we are computed the direction for
  94128. */
  94129. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  94130. /**
  94131. * Clones the current emitter and returns a copy of it
  94132. * @returns the new emitter
  94133. */
  94134. clone(): SphereDirectedParticleEmitter;
  94135. /**
  94136. * Called by the GPUParticleSystem to setup the update shader
  94137. * @param effect defines the update shader
  94138. */
  94139. applyToShader(effect: Effect): void;
  94140. /**
  94141. * Returns a string to use to update the GPU particles update shader
  94142. * @returns a string containng the defines string
  94143. */
  94144. getEffectDefines(): string;
  94145. /**
  94146. * Returns the string "SphereDirectedParticleEmitter"
  94147. * @returns a string containing the class name
  94148. */
  94149. getClassName(): string;
  94150. /**
  94151. * Serializes the particle system to a JSON object.
  94152. * @returns the JSON object
  94153. */
  94154. serialize(): any;
  94155. /**
  94156. * Parse properties from a JSON object
  94157. * @param serializationObject defines the JSON object
  94158. */
  94159. parse(serializationObject: any): void;
  94160. }
  94161. }
  94162. declare module BABYLON {
  94163. /**
  94164. * Particle emitter emitting particles from a custom list of positions.
  94165. */
  94166. export class CustomParticleEmitter implements IParticleEmitterType {
  94167. /**
  94168. * Gets or sets the position generator that will create the inital position of each particle.
  94169. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  94170. */
  94171. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  94172. /**
  94173. * Gets or sets the destination generator that will create the final destination of each particle.
  94174. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  94175. */
  94176. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  94177. /**
  94178. * Creates a new instance CustomParticleEmitter
  94179. */
  94180. constructor();
  94181. /**
  94182. * Called by the particle System when the direction is computed for the created particle.
  94183. * @param worldMatrix is the world matrix of the particle system
  94184. * @param directionToUpdate is the direction vector to update with the result
  94185. * @param particle is the particle we are computed the direction for
  94186. * @param isLocal defines if the direction should be set in local space
  94187. */
  94188. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94189. /**
  94190. * Called by the particle System when the position is computed for the created particle.
  94191. * @param worldMatrix is the world matrix of the particle system
  94192. * @param positionToUpdate is the position vector to update with the result
  94193. * @param particle is the particle we are computed the position for
  94194. * @param isLocal defines if the position should be set in local space
  94195. */
  94196. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94197. /**
  94198. * Clones the current emitter and returns a copy of it
  94199. * @returns the new emitter
  94200. */
  94201. clone(): CustomParticleEmitter;
  94202. /**
  94203. * Called by the GPUParticleSystem to setup the update shader
  94204. * @param effect defines the update shader
  94205. */
  94206. applyToShader(effect: Effect): void;
  94207. /**
  94208. * Returns a string to use to update the GPU particles update shader
  94209. * @returns a string containng the defines string
  94210. */
  94211. getEffectDefines(): string;
  94212. /**
  94213. * Returns the string "PointParticleEmitter"
  94214. * @returns a string containing the class name
  94215. */
  94216. getClassName(): string;
  94217. /**
  94218. * Serializes the particle system to a JSON object.
  94219. * @returns the JSON object
  94220. */
  94221. serialize(): any;
  94222. /**
  94223. * Parse properties from a JSON object
  94224. * @param serializationObject defines the JSON object
  94225. */
  94226. parse(serializationObject: any): void;
  94227. }
  94228. }
  94229. declare module BABYLON {
  94230. /**
  94231. * Particle emitter emitting particles from the inside of a box.
  94232. * It emits the particles randomly between 2 given directions.
  94233. */
  94234. export class MeshParticleEmitter implements IParticleEmitterType {
  94235. private _indices;
  94236. private _positions;
  94237. private _normals;
  94238. private _storedNormal;
  94239. private _mesh;
  94240. /**
  94241. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94242. */
  94243. direction1: Vector3;
  94244. /**
  94245. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94246. */
  94247. direction2: Vector3;
  94248. /**
  94249. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  94250. */
  94251. useMeshNormalsForDirection: boolean;
  94252. /** Defines the mesh to use as source */
  94253. get mesh(): Nullable<AbstractMesh>;
  94254. set mesh(value: Nullable<AbstractMesh>);
  94255. /**
  94256. * Creates a new instance MeshParticleEmitter
  94257. * @param mesh defines the mesh to use as source
  94258. */
  94259. constructor(mesh?: Nullable<AbstractMesh>);
  94260. /**
  94261. * Called by the particle System when the direction is computed for the created particle.
  94262. * @param worldMatrix is the world matrix of the particle system
  94263. * @param directionToUpdate is the direction vector to update with the result
  94264. * @param particle is the particle we are computed the direction for
  94265. * @param isLocal defines if the direction should be set in local space
  94266. */
  94267. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94268. /**
  94269. * Called by the particle System when the position is computed for the created particle.
  94270. * @param worldMatrix is the world matrix of the particle system
  94271. * @param positionToUpdate is the position vector to update with the result
  94272. * @param particle is the particle we are computed the position for
  94273. * @param isLocal defines if the position should be set in local space
  94274. */
  94275. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94276. /**
  94277. * Clones the current emitter and returns a copy of it
  94278. * @returns the new emitter
  94279. */
  94280. clone(): MeshParticleEmitter;
  94281. /**
  94282. * Called by the GPUParticleSystem to setup the update shader
  94283. * @param effect defines the update shader
  94284. */
  94285. applyToShader(effect: Effect): void;
  94286. /**
  94287. * Returns a string to use to update the GPU particles update shader
  94288. * @returns a string containng the defines string
  94289. */
  94290. getEffectDefines(): string;
  94291. /**
  94292. * Returns the string "BoxParticleEmitter"
  94293. * @returns a string containing the class name
  94294. */
  94295. getClassName(): string;
  94296. /**
  94297. * Serializes the particle system to a JSON object.
  94298. * @returns the JSON object
  94299. */
  94300. serialize(): any;
  94301. /**
  94302. * Parse properties from a JSON object
  94303. * @param serializationObject defines the JSON object
  94304. * @param scene defines the hosting scene
  94305. */
  94306. parse(serializationObject: any, scene: Nullable<Scene>): void;
  94307. }
  94308. }
  94309. declare module BABYLON {
  94310. /**
  94311. * Interface representing a particle system in Babylon.js.
  94312. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  94313. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  94314. */
  94315. export interface IParticleSystem {
  94316. /**
  94317. * List of animations used by the particle system.
  94318. */
  94319. animations: Animation[];
  94320. /**
  94321. * The id of the Particle system.
  94322. */
  94323. id: string;
  94324. /**
  94325. * The name of the Particle system.
  94326. */
  94327. name: string;
  94328. /**
  94329. * The emitter represents the Mesh or position we are attaching the particle system to.
  94330. */
  94331. emitter: Nullable<AbstractMesh | Vector3>;
  94332. /**
  94333. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  94334. */
  94335. isBillboardBased: boolean;
  94336. /**
  94337. * The rendering group used by the Particle system to chose when to render.
  94338. */
  94339. renderingGroupId: number;
  94340. /**
  94341. * The layer mask we are rendering the particles through.
  94342. */
  94343. layerMask: number;
  94344. /**
  94345. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  94346. */
  94347. updateSpeed: number;
  94348. /**
  94349. * The amount of time the particle system is running (depends of the overall update speed).
  94350. */
  94351. targetStopDuration: number;
  94352. /**
  94353. * The texture used to render each particle. (this can be a spritesheet)
  94354. */
  94355. particleTexture: Nullable<BaseTexture>;
  94356. /**
  94357. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  94358. */
  94359. blendMode: number;
  94360. /**
  94361. * Minimum life time of emitting particles.
  94362. */
  94363. minLifeTime: number;
  94364. /**
  94365. * Maximum life time of emitting particles.
  94366. */
  94367. maxLifeTime: number;
  94368. /**
  94369. * Minimum Size of emitting particles.
  94370. */
  94371. minSize: number;
  94372. /**
  94373. * Maximum Size of emitting particles.
  94374. */
  94375. maxSize: number;
  94376. /**
  94377. * Minimum scale of emitting particles on X axis.
  94378. */
  94379. minScaleX: number;
  94380. /**
  94381. * Maximum scale of emitting particles on X axis.
  94382. */
  94383. maxScaleX: number;
  94384. /**
  94385. * Minimum scale of emitting particles on Y axis.
  94386. */
  94387. minScaleY: number;
  94388. /**
  94389. * Maximum scale of emitting particles on Y axis.
  94390. */
  94391. maxScaleY: number;
  94392. /**
  94393. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  94394. */
  94395. color1: Color4;
  94396. /**
  94397. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  94398. */
  94399. color2: Color4;
  94400. /**
  94401. * Color the particle will have at the end of its lifetime.
  94402. */
  94403. colorDead: Color4;
  94404. /**
  94405. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  94406. */
  94407. emitRate: number;
  94408. /**
  94409. * You can use gravity if you want to give an orientation to your particles.
  94410. */
  94411. gravity: Vector3;
  94412. /**
  94413. * Minimum power of emitting particles.
  94414. */
  94415. minEmitPower: number;
  94416. /**
  94417. * Maximum power of emitting particles.
  94418. */
  94419. maxEmitPower: number;
  94420. /**
  94421. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  94422. */
  94423. minAngularSpeed: number;
  94424. /**
  94425. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  94426. */
  94427. maxAngularSpeed: number;
  94428. /**
  94429. * Gets or sets the minimal initial rotation in radians.
  94430. */
  94431. minInitialRotation: number;
  94432. /**
  94433. * Gets or sets the maximal initial rotation in radians.
  94434. */
  94435. maxInitialRotation: number;
  94436. /**
  94437. * The particle emitter type defines the emitter used by the particle system.
  94438. * It can be for example box, sphere, or cone...
  94439. */
  94440. particleEmitterType: Nullable<IParticleEmitterType>;
  94441. /**
  94442. * Defines the delay in milliseconds before starting the system (0 by default)
  94443. */
  94444. startDelay: number;
  94445. /**
  94446. * 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
  94447. */
  94448. preWarmCycles: number;
  94449. /**
  94450. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  94451. */
  94452. preWarmStepOffset: number;
  94453. /**
  94454. * 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)
  94455. */
  94456. spriteCellChangeSpeed: number;
  94457. /**
  94458. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  94459. */
  94460. startSpriteCellID: number;
  94461. /**
  94462. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  94463. */
  94464. endSpriteCellID: number;
  94465. /**
  94466. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  94467. */
  94468. spriteCellWidth: number;
  94469. /**
  94470. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  94471. */
  94472. spriteCellHeight: number;
  94473. /**
  94474. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  94475. */
  94476. spriteRandomStartCell: boolean;
  94477. /**
  94478. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  94479. */
  94480. isAnimationSheetEnabled: boolean;
  94481. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  94482. translationPivot: Vector2;
  94483. /**
  94484. * Gets or sets a texture used to add random noise to particle positions
  94485. */
  94486. noiseTexture: Nullable<BaseTexture>;
  94487. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  94488. noiseStrength: Vector3;
  94489. /**
  94490. * Gets or sets the billboard mode to use when isBillboardBased = true.
  94491. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  94492. */
  94493. billboardMode: number;
  94494. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  94495. limitVelocityDamping: number;
  94496. /**
  94497. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  94498. */
  94499. beginAnimationOnStart: boolean;
  94500. /**
  94501. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  94502. */
  94503. beginAnimationFrom: number;
  94504. /**
  94505. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  94506. */
  94507. beginAnimationTo: number;
  94508. /**
  94509. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  94510. */
  94511. beginAnimationLoop: boolean;
  94512. /**
  94513. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  94514. */
  94515. disposeOnStop: boolean;
  94516. /**
  94517. * Specifies if the particles are updated in emitter local space or world space
  94518. */
  94519. isLocal: boolean;
  94520. /** Snippet ID if the particle system was created from the snippet server */
  94521. snippetId: string;
  94522. /** Gets or sets a matrix to use to compute projection */
  94523. defaultProjectionMatrix: Matrix;
  94524. /**
  94525. * Gets the maximum number of particles active at the same time.
  94526. * @returns The max number of active particles.
  94527. */
  94528. getCapacity(): number;
  94529. /**
  94530. * Gets the number of particles active at the same time.
  94531. * @returns The number of active particles.
  94532. */
  94533. getActiveCount(): number;
  94534. /**
  94535. * Gets if the system has been started. (Note: this will still be true after stop is called)
  94536. * @returns True if it has been started, otherwise false.
  94537. */
  94538. isStarted(): boolean;
  94539. /**
  94540. * Animates the particle system for this frame.
  94541. */
  94542. animate(): void;
  94543. /**
  94544. * Renders the particle system in its current state.
  94545. * @returns the current number of particles
  94546. */
  94547. render(): number;
  94548. /**
  94549. * Dispose the particle system and frees its associated resources.
  94550. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  94551. */
  94552. dispose(disposeTexture?: boolean): void;
  94553. /**
  94554. * An event triggered when the system is disposed
  94555. */
  94556. onDisposeObservable: Observable<IParticleSystem>;
  94557. /**
  94558. * Clones the particle system.
  94559. * @param name The name of the cloned object
  94560. * @param newEmitter The new emitter to use
  94561. * @returns the cloned particle system
  94562. */
  94563. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  94564. /**
  94565. * Serializes the particle system to a JSON object
  94566. * @param serializeTexture defines if the texture must be serialized as well
  94567. * @returns the JSON object
  94568. */
  94569. serialize(serializeTexture: boolean): any;
  94570. /**
  94571. * Rebuild the particle system
  94572. */
  94573. rebuild(): void;
  94574. /** Force the system to rebuild all gradients that need to be resync */
  94575. forceRefreshGradients(): void;
  94576. /**
  94577. * Starts the particle system and begins to emit
  94578. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  94579. */
  94580. start(delay?: number): void;
  94581. /**
  94582. * Stops the particle system.
  94583. */
  94584. stop(): void;
  94585. /**
  94586. * Remove all active particles
  94587. */
  94588. reset(): void;
  94589. /**
  94590. * Gets a boolean indicating that the system is stopping
  94591. * @returns true if the system is currently stopping
  94592. */
  94593. isStopping(): boolean;
  94594. /**
  94595. * Is this system ready to be used/rendered
  94596. * @return true if the system is ready
  94597. */
  94598. isReady(): boolean;
  94599. /**
  94600. * Returns the string "ParticleSystem"
  94601. * @returns a string containing the class name
  94602. */
  94603. getClassName(): string;
  94604. /**
  94605. * Gets the custom effect used to render the particles
  94606. * @param blendMode Blend mode for which the effect should be retrieved
  94607. * @returns The effect
  94608. */
  94609. getCustomEffect(blendMode: number): Nullable<Effect>;
  94610. /**
  94611. * Sets the custom effect used to render the particles
  94612. * @param effect The effect to set
  94613. * @param blendMode Blend mode for which the effect should be set
  94614. */
  94615. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  94616. /**
  94617. * Fill the defines array according to the current settings of the particle system
  94618. * @param defines Array to be updated
  94619. * @param blendMode blend mode to take into account when updating the array
  94620. */
  94621. fillDefines(defines: Array<string>, blendMode: number): void;
  94622. /**
  94623. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  94624. * @param uniforms Uniforms array to fill
  94625. * @param attributes Attributes array to fill
  94626. * @param samplers Samplers array to fill
  94627. */
  94628. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  94629. /**
  94630. * Observable that will be called just before the particles are drawn
  94631. */
  94632. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  94633. /**
  94634. * Gets the name of the particle vertex shader
  94635. */
  94636. vertexShaderName: string;
  94637. /**
  94638. * Adds a new color gradient
  94639. * @param gradient defines the gradient to use (between 0 and 1)
  94640. * @param color1 defines the color to affect to the specified gradient
  94641. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  94642. * @returns the current particle system
  94643. */
  94644. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  94645. /**
  94646. * Remove a specific color gradient
  94647. * @param gradient defines the gradient to remove
  94648. * @returns the current particle system
  94649. */
  94650. removeColorGradient(gradient: number): IParticleSystem;
  94651. /**
  94652. * Adds a new size gradient
  94653. * @param gradient defines the gradient to use (between 0 and 1)
  94654. * @param factor defines the size factor to affect to the specified gradient
  94655. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94656. * @returns the current particle system
  94657. */
  94658. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94659. /**
  94660. * Remove a specific size gradient
  94661. * @param gradient defines the gradient to remove
  94662. * @returns the current particle system
  94663. */
  94664. removeSizeGradient(gradient: number): IParticleSystem;
  94665. /**
  94666. * Gets the current list of color gradients.
  94667. * You must use addColorGradient and removeColorGradient to udpate this list
  94668. * @returns the list of color gradients
  94669. */
  94670. getColorGradients(): Nullable<Array<ColorGradient>>;
  94671. /**
  94672. * Gets the current list of size gradients.
  94673. * You must use addSizeGradient and removeSizeGradient to udpate this list
  94674. * @returns the list of size gradients
  94675. */
  94676. getSizeGradients(): Nullable<Array<FactorGradient>>;
  94677. /**
  94678. * Gets the current list of angular speed gradients.
  94679. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  94680. * @returns the list of angular speed gradients
  94681. */
  94682. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  94683. /**
  94684. * Adds a new angular speed gradient
  94685. * @param gradient defines the gradient to use (between 0 and 1)
  94686. * @param factor defines the angular speed to affect to the specified gradient
  94687. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94688. * @returns the current particle system
  94689. */
  94690. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94691. /**
  94692. * Remove a specific angular speed gradient
  94693. * @param gradient defines the gradient to remove
  94694. * @returns the current particle system
  94695. */
  94696. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94697. /**
  94698. * Gets the current list of velocity gradients.
  94699. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94700. * @returns the list of velocity gradients
  94701. */
  94702. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94703. /**
  94704. * Adds a new velocity gradient
  94705. * @param gradient defines the gradient to use (between 0 and 1)
  94706. * @param factor defines the velocity to affect to the specified gradient
  94707. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94708. * @returns the current particle system
  94709. */
  94710. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94711. /**
  94712. * Remove a specific velocity gradient
  94713. * @param gradient defines the gradient to remove
  94714. * @returns the current particle system
  94715. */
  94716. removeVelocityGradient(gradient: number): IParticleSystem;
  94717. /**
  94718. * Gets the current list of limit velocity gradients.
  94719. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94720. * @returns the list of limit velocity gradients
  94721. */
  94722. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94723. /**
  94724. * Adds a new limit velocity gradient
  94725. * @param gradient defines the gradient to use (between 0 and 1)
  94726. * @param factor defines the limit velocity to affect to the specified gradient
  94727. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94728. * @returns the current particle system
  94729. */
  94730. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94731. /**
  94732. * Remove a specific limit velocity gradient
  94733. * @param gradient defines the gradient to remove
  94734. * @returns the current particle system
  94735. */
  94736. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94737. /**
  94738. * Adds a new drag gradient
  94739. * @param gradient defines the gradient to use (between 0 and 1)
  94740. * @param factor defines the drag to affect to the specified gradient
  94741. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94742. * @returns the current particle system
  94743. */
  94744. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94745. /**
  94746. * Remove a specific drag gradient
  94747. * @param gradient defines the gradient to remove
  94748. * @returns the current particle system
  94749. */
  94750. removeDragGradient(gradient: number): IParticleSystem;
  94751. /**
  94752. * Gets the current list of drag gradients.
  94753. * You must use addDragGradient and removeDragGradient to udpate this list
  94754. * @returns the list of drag gradients
  94755. */
  94756. getDragGradients(): Nullable<Array<FactorGradient>>;
  94757. /**
  94758. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94759. * @param gradient defines the gradient to use (between 0 and 1)
  94760. * @param factor defines the emit rate to affect to the specified gradient
  94761. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94762. * @returns the current particle system
  94763. */
  94764. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94765. /**
  94766. * Remove a specific emit rate gradient
  94767. * @param gradient defines the gradient to remove
  94768. * @returns the current particle system
  94769. */
  94770. removeEmitRateGradient(gradient: number): IParticleSystem;
  94771. /**
  94772. * Gets the current list of emit rate gradients.
  94773. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94774. * @returns the list of emit rate gradients
  94775. */
  94776. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94777. /**
  94778. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94779. * @param gradient defines the gradient to use (between 0 and 1)
  94780. * @param factor defines the start size to affect to the specified gradient
  94781. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94782. * @returns the current particle system
  94783. */
  94784. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94785. /**
  94786. * Remove a specific start size gradient
  94787. * @param gradient defines the gradient to remove
  94788. * @returns the current particle system
  94789. */
  94790. removeStartSizeGradient(gradient: number): IParticleSystem;
  94791. /**
  94792. * Gets the current list of start size gradients.
  94793. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94794. * @returns the list of start size gradients
  94795. */
  94796. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94797. /**
  94798. * Adds a new life time gradient
  94799. * @param gradient defines the gradient to use (between 0 and 1)
  94800. * @param factor defines the life time factor to affect to the specified gradient
  94801. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94802. * @returns the current particle system
  94803. */
  94804. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94805. /**
  94806. * Remove a specific life time gradient
  94807. * @param gradient defines the gradient to remove
  94808. * @returns the current particle system
  94809. */
  94810. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94811. /**
  94812. * Gets the current list of life time gradients.
  94813. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94814. * @returns the list of life time gradients
  94815. */
  94816. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94817. /**
  94818. * Gets the current list of color gradients.
  94819. * You must use addColorGradient and removeColorGradient to udpate this list
  94820. * @returns the list of color gradients
  94821. */
  94822. getColorGradients(): Nullable<Array<ColorGradient>>;
  94823. /**
  94824. * Adds a new ramp gradient used to remap particle colors
  94825. * @param gradient defines the gradient to use (between 0 and 1)
  94826. * @param color defines the color to affect to the specified gradient
  94827. * @returns the current particle system
  94828. */
  94829. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94830. /**
  94831. * Gets the current list of ramp gradients.
  94832. * You must use addRampGradient and removeRampGradient to udpate this list
  94833. * @returns the list of ramp gradients
  94834. */
  94835. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94836. /** Gets or sets a boolean indicating that ramp gradients must be used
  94837. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94838. */
  94839. useRampGradients: boolean;
  94840. /**
  94841. * Adds a new color remap gradient
  94842. * @param gradient defines the gradient to use (between 0 and 1)
  94843. * @param min defines the color remap minimal range
  94844. * @param max defines the color remap maximal range
  94845. * @returns the current particle system
  94846. */
  94847. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94848. /**
  94849. * Gets the current list of color remap gradients.
  94850. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94851. * @returns the list of color remap gradients
  94852. */
  94853. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94854. /**
  94855. * Adds a new alpha remap gradient
  94856. * @param gradient defines the gradient to use (between 0 and 1)
  94857. * @param min defines the alpha remap minimal range
  94858. * @param max defines the alpha remap maximal range
  94859. * @returns the current particle system
  94860. */
  94861. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94862. /**
  94863. * Gets the current list of alpha remap gradients.
  94864. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94865. * @returns the list of alpha remap gradients
  94866. */
  94867. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94868. /**
  94869. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94870. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94871. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94872. * @returns the emitter
  94873. */
  94874. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94875. /**
  94876. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94877. * @param radius The radius of the hemisphere to emit from
  94878. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94879. * @returns the emitter
  94880. */
  94881. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94882. /**
  94883. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94884. * @param radius The radius of the sphere to emit from
  94885. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94886. * @returns the emitter
  94887. */
  94888. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94889. /**
  94890. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94891. * @param radius The radius of the sphere to emit from
  94892. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94893. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94894. * @returns the emitter
  94895. */
  94896. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94897. /**
  94898. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94899. * @param radius The radius of the emission cylinder
  94900. * @param height The height of the emission cylinder
  94901. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94902. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94903. * @returns the emitter
  94904. */
  94905. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94906. /**
  94907. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94908. * @param radius The radius of the cylinder to emit from
  94909. * @param height The height of the emission cylinder
  94910. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94911. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94912. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94913. * @returns the emitter
  94914. */
  94915. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94916. /**
  94917. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94918. * @param radius The radius of the cone to emit from
  94919. * @param angle The base angle of the cone
  94920. * @returns the emitter
  94921. */
  94922. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94923. /**
  94924. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94925. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94926. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94927. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94928. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94929. * @returns the emitter
  94930. */
  94931. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94932. /**
  94933. * Get hosting scene
  94934. * @returns the scene
  94935. */
  94936. getScene(): Nullable<Scene>;
  94937. }
  94938. }
  94939. declare module BABYLON {
  94940. /**
  94941. * 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.
  94942. * @see https://doc.babylonjs.com/how_to/transformnode
  94943. */
  94944. export class TransformNode extends Node {
  94945. /**
  94946. * Object will not rotate to face the camera
  94947. */
  94948. static BILLBOARDMODE_NONE: number;
  94949. /**
  94950. * Object will rotate to face the camera but only on the x axis
  94951. */
  94952. static BILLBOARDMODE_X: number;
  94953. /**
  94954. * Object will rotate to face the camera but only on the y axis
  94955. */
  94956. static BILLBOARDMODE_Y: number;
  94957. /**
  94958. * Object will rotate to face the camera but only on the z axis
  94959. */
  94960. static BILLBOARDMODE_Z: number;
  94961. /**
  94962. * Object will rotate to face the camera
  94963. */
  94964. static BILLBOARDMODE_ALL: number;
  94965. /**
  94966. * Object will rotate to face the camera's position instead of orientation
  94967. */
  94968. static BILLBOARDMODE_USE_POSITION: number;
  94969. private static _TmpRotation;
  94970. private static _TmpScaling;
  94971. private static _TmpTranslation;
  94972. private _forward;
  94973. private _forwardInverted;
  94974. private _up;
  94975. private _right;
  94976. private _rightInverted;
  94977. private _position;
  94978. private _rotation;
  94979. private _rotationQuaternion;
  94980. protected _scaling: Vector3;
  94981. protected _isDirty: boolean;
  94982. private _transformToBoneReferal;
  94983. private _isAbsoluteSynced;
  94984. private _billboardMode;
  94985. /**
  94986. * Gets or sets the billboard mode. Default is 0.
  94987. *
  94988. * | Value | Type | Description |
  94989. * | --- | --- | --- |
  94990. * | 0 | BILLBOARDMODE_NONE | |
  94991. * | 1 | BILLBOARDMODE_X | |
  94992. * | 2 | BILLBOARDMODE_Y | |
  94993. * | 4 | BILLBOARDMODE_Z | |
  94994. * | 7 | BILLBOARDMODE_ALL | |
  94995. *
  94996. */
  94997. get billboardMode(): number;
  94998. set billboardMode(value: number);
  94999. private _preserveParentRotationForBillboard;
  95000. /**
  95001. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  95002. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  95003. */
  95004. get preserveParentRotationForBillboard(): boolean;
  95005. set preserveParentRotationForBillboard(value: boolean);
  95006. /**
  95007. * 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
  95008. */
  95009. scalingDeterminant: number;
  95010. private _infiniteDistance;
  95011. /**
  95012. * Gets or sets the distance of the object to max, often used by skybox
  95013. */
  95014. get infiniteDistance(): boolean;
  95015. set infiniteDistance(value: boolean);
  95016. /**
  95017. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  95018. * By default the system will update normals to compensate
  95019. */
  95020. ignoreNonUniformScaling: boolean;
  95021. /**
  95022. * 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
  95023. */
  95024. reIntegrateRotationIntoRotationQuaternion: boolean;
  95025. /** @hidden */
  95026. _poseMatrix: Nullable<Matrix>;
  95027. /** @hidden */
  95028. _localMatrix: Matrix;
  95029. private _usePivotMatrix;
  95030. private _absolutePosition;
  95031. private _absoluteScaling;
  95032. private _absoluteRotationQuaternion;
  95033. private _pivotMatrix;
  95034. private _pivotMatrixInverse;
  95035. /** @hidden */
  95036. _postMultiplyPivotMatrix: boolean;
  95037. protected _isWorldMatrixFrozen: boolean;
  95038. /** @hidden */
  95039. _indexInSceneTransformNodesArray: number;
  95040. /**
  95041. * An event triggered after the world matrix is updated
  95042. */
  95043. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  95044. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  95045. /**
  95046. * Gets a string identifying the name of the class
  95047. * @returns "TransformNode" string
  95048. */
  95049. getClassName(): string;
  95050. /**
  95051. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  95052. */
  95053. get position(): Vector3;
  95054. set position(newPosition: Vector3);
  95055. /**
  95056. * 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)).
  95057. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  95058. */
  95059. get rotation(): Vector3;
  95060. set rotation(newRotation: Vector3);
  95061. /**
  95062. * 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)).
  95063. */
  95064. get scaling(): Vector3;
  95065. set scaling(newScaling: Vector3);
  95066. /**
  95067. * 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).
  95068. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  95069. */
  95070. get rotationQuaternion(): Nullable<Quaternion>;
  95071. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  95072. /**
  95073. * The forward direction of that transform in world space.
  95074. */
  95075. get forward(): Vector3;
  95076. /**
  95077. * The up direction of that transform in world space.
  95078. */
  95079. get up(): Vector3;
  95080. /**
  95081. * The right direction of that transform in world space.
  95082. */
  95083. get right(): Vector3;
  95084. /**
  95085. * Copies the parameter passed Matrix into the mesh Pose matrix.
  95086. * @param matrix the matrix to copy the pose from
  95087. * @returns this TransformNode.
  95088. */
  95089. updatePoseMatrix(matrix: Matrix): TransformNode;
  95090. /**
  95091. * Returns the mesh Pose matrix.
  95092. * @returns the pose matrix
  95093. */
  95094. getPoseMatrix(): Matrix;
  95095. /** @hidden */
  95096. _isSynchronized(): boolean;
  95097. /** @hidden */
  95098. _initCache(): void;
  95099. /**
  95100. * Flag the transform node as dirty (Forcing it to update everything)
  95101. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  95102. * @returns this transform node
  95103. */
  95104. markAsDirty(property: string): TransformNode;
  95105. /**
  95106. * Returns the current mesh absolute position.
  95107. * Returns a Vector3.
  95108. */
  95109. get absolutePosition(): Vector3;
  95110. /**
  95111. * Returns the current mesh absolute scaling.
  95112. * Returns a Vector3.
  95113. */
  95114. get absoluteScaling(): Vector3;
  95115. /**
  95116. * Returns the current mesh absolute rotation.
  95117. * Returns a Quaternion.
  95118. */
  95119. get absoluteRotationQuaternion(): Quaternion;
  95120. /**
  95121. * Sets a new matrix to apply before all other transformation
  95122. * @param matrix defines the transform matrix
  95123. * @returns the current TransformNode
  95124. */
  95125. setPreTransformMatrix(matrix: Matrix): TransformNode;
  95126. /**
  95127. * Sets a new pivot matrix to the current node
  95128. * @param matrix defines the new pivot matrix to use
  95129. * @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
  95130. * @returns the current TransformNode
  95131. */
  95132. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  95133. /**
  95134. * Returns the mesh pivot matrix.
  95135. * Default : Identity.
  95136. * @returns the matrix
  95137. */
  95138. getPivotMatrix(): Matrix;
  95139. /**
  95140. * Instantiate (when possible) or clone that node with its hierarchy
  95141. * @param newParent defines the new parent to use for the instance (or clone)
  95142. * @param options defines options to configure how copy is done
  95143. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  95144. * @returns an instance (or a clone) of the current node with its hiearchy
  95145. */
  95146. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  95147. doNotInstantiate: boolean;
  95148. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  95149. /**
  95150. * Prevents the World matrix to be computed any longer
  95151. * @param newWorldMatrix defines an optional matrix to use as world matrix
  95152. * @returns the TransformNode.
  95153. */
  95154. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  95155. /**
  95156. * Allows back the World matrix computation.
  95157. * @returns the TransformNode.
  95158. */
  95159. unfreezeWorldMatrix(): this;
  95160. /**
  95161. * True if the World matrix has been frozen.
  95162. */
  95163. get isWorldMatrixFrozen(): boolean;
  95164. /**
  95165. * Retuns the mesh absolute position in the World.
  95166. * @returns a Vector3.
  95167. */
  95168. getAbsolutePosition(): Vector3;
  95169. /**
  95170. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  95171. * @param absolutePosition the absolute position to set
  95172. * @returns the TransformNode.
  95173. */
  95174. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  95175. /**
  95176. * Sets the mesh position in its local space.
  95177. * @param vector3 the position to set in localspace
  95178. * @returns the TransformNode.
  95179. */
  95180. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  95181. /**
  95182. * Returns the mesh position in the local space from the current World matrix values.
  95183. * @returns a new Vector3.
  95184. */
  95185. getPositionExpressedInLocalSpace(): Vector3;
  95186. /**
  95187. * Translates the mesh along the passed Vector3 in its local space.
  95188. * @param vector3 the distance to translate in localspace
  95189. * @returns the TransformNode.
  95190. */
  95191. locallyTranslate(vector3: Vector3): TransformNode;
  95192. private static _lookAtVectorCache;
  95193. /**
  95194. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  95195. * @param targetPoint the position (must be in same space as current mesh) to look at
  95196. * @param yawCor optional yaw (y-axis) correction in radians
  95197. * @param pitchCor optional pitch (x-axis) correction in radians
  95198. * @param rollCor optional roll (z-axis) correction in radians
  95199. * @param space the choosen space of the target
  95200. * @returns the TransformNode.
  95201. */
  95202. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  95203. /**
  95204. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  95205. * This Vector3 is expressed in the World space.
  95206. * @param localAxis axis to rotate
  95207. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  95208. */
  95209. getDirection(localAxis: Vector3): Vector3;
  95210. /**
  95211. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  95212. * localAxis is expressed in the mesh local space.
  95213. * result is computed in the Wordl space from the mesh World matrix.
  95214. * @param localAxis axis to rotate
  95215. * @param result the resulting transformnode
  95216. * @returns this TransformNode.
  95217. */
  95218. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  95219. /**
  95220. * Sets this transform node rotation to the given local axis.
  95221. * @param localAxis the axis in local space
  95222. * @param yawCor optional yaw (y-axis) correction in radians
  95223. * @param pitchCor optional pitch (x-axis) correction in radians
  95224. * @param rollCor optional roll (z-axis) correction in radians
  95225. * @returns this TransformNode
  95226. */
  95227. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  95228. /**
  95229. * Sets a new pivot point to the current node
  95230. * @param point defines the new pivot point to use
  95231. * @param space defines if the point is in world or local space (local by default)
  95232. * @returns the current TransformNode
  95233. */
  95234. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  95235. /**
  95236. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  95237. * @returns the pivot point
  95238. */
  95239. getPivotPoint(): Vector3;
  95240. /**
  95241. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  95242. * @param result the vector3 to store the result
  95243. * @returns this TransformNode.
  95244. */
  95245. getPivotPointToRef(result: Vector3): TransformNode;
  95246. /**
  95247. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  95248. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  95249. */
  95250. getAbsolutePivotPoint(): Vector3;
  95251. /**
  95252. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  95253. * @param result vector3 to store the result
  95254. * @returns this TransformNode.
  95255. */
  95256. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  95257. /**
  95258. * Defines the passed node as the parent of the current node.
  95259. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  95260. * @see https://doc.babylonjs.com/how_to/parenting
  95261. * @param node the node ot set as the parent
  95262. * @returns this TransformNode.
  95263. */
  95264. setParent(node: Nullable<Node>): TransformNode;
  95265. private _nonUniformScaling;
  95266. /**
  95267. * True if the scaling property of this object is non uniform eg. (1,2,1)
  95268. */
  95269. get nonUniformScaling(): boolean;
  95270. /** @hidden */
  95271. _updateNonUniformScalingState(value: boolean): boolean;
  95272. /**
  95273. * Attach the current TransformNode to another TransformNode associated with a bone
  95274. * @param bone Bone affecting the TransformNode
  95275. * @param affectedTransformNode TransformNode associated with the bone
  95276. * @returns this object
  95277. */
  95278. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  95279. /**
  95280. * Detach the transform node if its associated with a bone
  95281. * @returns this object
  95282. */
  95283. detachFromBone(): TransformNode;
  95284. private static _rotationAxisCache;
  95285. /**
  95286. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  95287. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  95288. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  95289. * The passed axis is also normalized.
  95290. * @param axis the axis to rotate around
  95291. * @param amount the amount to rotate in radians
  95292. * @param space Space to rotate in (Default: local)
  95293. * @returns the TransformNode.
  95294. */
  95295. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  95296. /**
  95297. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  95298. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  95299. * The passed axis is also normalized. .
  95300. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  95301. * @param point the point to rotate around
  95302. * @param axis the axis to rotate around
  95303. * @param amount the amount to rotate in radians
  95304. * @returns the TransformNode
  95305. */
  95306. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  95307. /**
  95308. * Translates the mesh along the axis vector for the passed distance in the given space.
  95309. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  95310. * @param axis the axis to translate in
  95311. * @param distance the distance to translate
  95312. * @param space Space to rotate in (Default: local)
  95313. * @returns the TransformNode.
  95314. */
  95315. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  95316. /**
  95317. * Adds a rotation step to the mesh current rotation.
  95318. * x, y, z are Euler angles expressed in radians.
  95319. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  95320. * This means this rotation is made in the mesh local space only.
  95321. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  95322. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  95323. * ```javascript
  95324. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  95325. * ```
  95326. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  95327. * 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.
  95328. * @param x Rotation to add
  95329. * @param y Rotation to add
  95330. * @param z Rotation to add
  95331. * @returns the TransformNode.
  95332. */
  95333. addRotation(x: number, y: number, z: number): TransformNode;
  95334. /**
  95335. * @hidden
  95336. */
  95337. protected _getEffectiveParent(): Nullable<Node>;
  95338. /**
  95339. * Computes the world matrix of the node
  95340. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95341. * @returns the world matrix
  95342. */
  95343. computeWorldMatrix(force?: boolean): Matrix;
  95344. /**
  95345. * Resets this nodeTransform's local matrix to Matrix.Identity().
  95346. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  95347. */
  95348. resetLocalMatrix(independentOfChildren?: boolean): void;
  95349. protected _afterComputeWorldMatrix(): void;
  95350. /**
  95351. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  95352. * @param func callback function to add
  95353. *
  95354. * @returns the TransformNode.
  95355. */
  95356. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  95357. /**
  95358. * Removes a registered callback function.
  95359. * @param func callback function to remove
  95360. * @returns the TransformNode.
  95361. */
  95362. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  95363. /**
  95364. * Gets the position of the current mesh in camera space
  95365. * @param camera defines the camera to use
  95366. * @returns a position
  95367. */
  95368. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  95369. /**
  95370. * Returns the distance from the mesh to the active camera
  95371. * @param camera defines the camera to use
  95372. * @returns the distance
  95373. */
  95374. getDistanceToCamera(camera?: Nullable<Camera>): number;
  95375. /**
  95376. * Clone the current transform node
  95377. * @param name Name of the new clone
  95378. * @param newParent New parent for the clone
  95379. * @param doNotCloneChildren Do not clone children hierarchy
  95380. * @returns the new transform node
  95381. */
  95382. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  95383. /**
  95384. * Serializes the objects information.
  95385. * @param currentSerializationObject defines the object to serialize in
  95386. * @returns the serialized object
  95387. */
  95388. serialize(currentSerializationObject?: any): any;
  95389. /**
  95390. * Returns a new TransformNode object parsed from the source provided.
  95391. * @param parsedTransformNode is the source.
  95392. * @param scene the scne the object belongs to
  95393. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  95394. * @returns a new TransformNode object parsed from the source provided.
  95395. */
  95396. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  95397. /**
  95398. * Get all child-transformNodes of this node
  95399. * @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
  95400. * @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
  95401. * @returns an array of TransformNode
  95402. */
  95403. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  95404. /**
  95405. * Releases resources associated with this transform node.
  95406. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95407. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95408. */
  95409. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95410. /**
  95411. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  95412. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  95413. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  95414. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  95415. * @returns the current mesh
  95416. */
  95417. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  95418. private _syncAbsoluteScalingAndRotation;
  95419. }
  95420. }
  95421. declare module BABYLON {
  95422. /**
  95423. * Class used to override all child animations of a given target
  95424. */
  95425. export class AnimationPropertiesOverride {
  95426. /**
  95427. * Gets or sets a value indicating if animation blending must be used
  95428. */
  95429. enableBlending: boolean;
  95430. /**
  95431. * Gets or sets the blending speed to use when enableBlending is true
  95432. */
  95433. blendingSpeed: number;
  95434. /**
  95435. * Gets or sets the default loop mode to use
  95436. */
  95437. loopMode: number;
  95438. }
  95439. }
  95440. declare module BABYLON {
  95441. /**
  95442. * Class used to store bone information
  95443. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95444. */
  95445. export class Bone extends Node {
  95446. /**
  95447. * defines the bone name
  95448. */
  95449. name: string;
  95450. private static _tmpVecs;
  95451. private static _tmpQuat;
  95452. private static _tmpMats;
  95453. /**
  95454. * Gets the list of child bones
  95455. */
  95456. children: Bone[];
  95457. /** Gets the animations associated with this bone */
  95458. animations: Animation[];
  95459. /**
  95460. * Gets or sets bone length
  95461. */
  95462. length: number;
  95463. /**
  95464. * @hidden Internal only
  95465. * Set this value to map this bone to a different index in the transform matrices
  95466. * Set this value to -1 to exclude the bone from the transform matrices
  95467. */
  95468. _index: Nullable<number>;
  95469. private _skeleton;
  95470. private _localMatrix;
  95471. private _restPose;
  95472. private _bindPose;
  95473. private _baseMatrix;
  95474. private _absoluteTransform;
  95475. private _invertedAbsoluteTransform;
  95476. private _parent;
  95477. private _scalingDeterminant;
  95478. private _worldTransform;
  95479. private _localScaling;
  95480. private _localRotation;
  95481. private _localPosition;
  95482. private _needToDecompose;
  95483. private _needToCompose;
  95484. /** @hidden */
  95485. _linkedTransformNode: Nullable<TransformNode>;
  95486. /** @hidden */
  95487. _waitingTransformNodeId: Nullable<string>;
  95488. /** @hidden */
  95489. get _matrix(): Matrix;
  95490. /** @hidden */
  95491. set _matrix(value: Matrix);
  95492. /**
  95493. * Create a new bone
  95494. * @param name defines the bone name
  95495. * @param skeleton defines the parent skeleton
  95496. * @param parentBone defines the parent (can be null if the bone is the root)
  95497. * @param localMatrix defines the local matrix
  95498. * @param restPose defines the rest pose matrix
  95499. * @param baseMatrix defines the base matrix
  95500. * @param index defines index of the bone in the hiearchy
  95501. */
  95502. constructor(
  95503. /**
  95504. * defines the bone name
  95505. */
  95506. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  95507. /**
  95508. * Gets the current object class name.
  95509. * @return the class name
  95510. */
  95511. getClassName(): string;
  95512. /**
  95513. * Gets the parent skeleton
  95514. * @returns a skeleton
  95515. */
  95516. getSkeleton(): Skeleton;
  95517. /**
  95518. * Gets parent bone
  95519. * @returns a bone or null if the bone is the root of the bone hierarchy
  95520. */
  95521. getParent(): Nullable<Bone>;
  95522. /**
  95523. * Returns an array containing the root bones
  95524. * @returns an array containing the root bones
  95525. */
  95526. getChildren(): Array<Bone>;
  95527. /**
  95528. * Gets the node index in matrix array generated for rendering
  95529. * @returns the node index
  95530. */
  95531. getIndex(): number;
  95532. /**
  95533. * Sets the parent bone
  95534. * @param parent defines the parent (can be null if the bone is the root)
  95535. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  95536. */
  95537. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  95538. /**
  95539. * Gets the local matrix
  95540. * @returns a matrix
  95541. */
  95542. getLocalMatrix(): Matrix;
  95543. /**
  95544. * Gets the base matrix (initial matrix which remains unchanged)
  95545. * @returns a matrix
  95546. */
  95547. getBaseMatrix(): Matrix;
  95548. /**
  95549. * Gets the rest pose matrix
  95550. * @returns a matrix
  95551. */
  95552. getRestPose(): Matrix;
  95553. /**
  95554. * Sets the rest pose matrix
  95555. * @param matrix the local-space rest pose to set for this bone
  95556. */
  95557. setRestPose(matrix: Matrix): void;
  95558. /**
  95559. * Gets the bind pose matrix
  95560. * @returns the bind pose matrix
  95561. */
  95562. getBindPose(): Matrix;
  95563. /**
  95564. * Sets the bind pose matrix
  95565. * @param matrix the local-space bind pose to set for this bone
  95566. */
  95567. setBindPose(matrix: Matrix): void;
  95568. /**
  95569. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  95570. */
  95571. getWorldMatrix(): Matrix;
  95572. /**
  95573. * Sets the local matrix to rest pose matrix
  95574. */
  95575. returnToRest(): void;
  95576. /**
  95577. * Gets the inverse of the absolute transform matrix.
  95578. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  95579. * @returns a matrix
  95580. */
  95581. getInvertedAbsoluteTransform(): Matrix;
  95582. /**
  95583. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  95584. * @returns a matrix
  95585. */
  95586. getAbsoluteTransform(): Matrix;
  95587. /**
  95588. * Links with the given transform node.
  95589. * The local matrix of this bone is copied from the transform node every frame.
  95590. * @param transformNode defines the transform node to link to
  95591. */
  95592. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  95593. /**
  95594. * Gets the node used to drive the bone's transformation
  95595. * @returns a transform node or null
  95596. */
  95597. getTransformNode(): Nullable<TransformNode>;
  95598. /** Gets or sets current position (in local space) */
  95599. get position(): Vector3;
  95600. set position(newPosition: Vector3);
  95601. /** Gets or sets current rotation (in local space) */
  95602. get rotation(): Vector3;
  95603. set rotation(newRotation: Vector3);
  95604. /** Gets or sets current rotation quaternion (in local space) */
  95605. get rotationQuaternion(): Quaternion;
  95606. set rotationQuaternion(newRotation: Quaternion);
  95607. /** Gets or sets current scaling (in local space) */
  95608. get scaling(): Vector3;
  95609. set scaling(newScaling: Vector3);
  95610. /**
  95611. * Gets the animation properties override
  95612. */
  95613. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95614. private _decompose;
  95615. private _compose;
  95616. /**
  95617. * Update the base and local matrices
  95618. * @param matrix defines the new base or local matrix
  95619. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  95620. * @param updateLocalMatrix defines if the local matrix should be updated
  95621. */
  95622. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  95623. /** @hidden */
  95624. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  95625. /**
  95626. * Flag the bone as dirty (Forcing it to update everything)
  95627. */
  95628. markAsDirty(): void;
  95629. /** @hidden */
  95630. _markAsDirtyAndCompose(): void;
  95631. private _markAsDirtyAndDecompose;
  95632. /**
  95633. * Translate the bone in local or world space
  95634. * @param vec The amount to translate the bone
  95635. * @param space The space that the translation is in
  95636. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95637. */
  95638. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95639. /**
  95640. * Set the postion of the bone in local or world space
  95641. * @param position The position to set the bone
  95642. * @param space The space that the position is in
  95643. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95644. */
  95645. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95646. /**
  95647. * Set the absolute position of the bone (world space)
  95648. * @param position The position to set the bone
  95649. * @param mesh The mesh that this bone is attached to
  95650. */
  95651. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  95652. /**
  95653. * Scale the bone on the x, y and z axes (in local space)
  95654. * @param x The amount to scale the bone on the x axis
  95655. * @param y The amount to scale the bone on the y axis
  95656. * @param z The amount to scale the bone on the z axis
  95657. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  95658. */
  95659. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  95660. /**
  95661. * Set the bone scaling in local space
  95662. * @param scale defines the scaling vector
  95663. */
  95664. setScale(scale: Vector3): void;
  95665. /**
  95666. * Gets the current scaling in local space
  95667. * @returns the current scaling vector
  95668. */
  95669. getScale(): Vector3;
  95670. /**
  95671. * Gets the current scaling in local space and stores it in a target vector
  95672. * @param result defines the target vector
  95673. */
  95674. getScaleToRef(result: Vector3): void;
  95675. /**
  95676. * Set the yaw, pitch, and roll of the bone in local or world space
  95677. * @param yaw The rotation of the bone on the y axis
  95678. * @param pitch The rotation of the bone on the x axis
  95679. * @param roll The rotation of the bone on the z axis
  95680. * @param space The space that the axes of rotation are in
  95681. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95682. */
  95683. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  95684. /**
  95685. * Add a rotation to the bone on an axis in local or world space
  95686. * @param axis The axis to rotate the bone on
  95687. * @param amount The amount to rotate the bone
  95688. * @param space The space that the axis is in
  95689. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95690. */
  95691. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95692. /**
  95693. * Set the rotation of the bone to a particular axis angle in local or world space
  95694. * @param axis The axis to rotate the bone on
  95695. * @param angle The angle that the bone should be rotated to
  95696. * @param space The space that the axis is in
  95697. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95698. */
  95699. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95700. /**
  95701. * Set the euler rotation of the bone in local or world space
  95702. * @param rotation The euler rotation that the bone should be set to
  95703. * @param space The space that the rotation is in
  95704. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95705. */
  95706. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95707. /**
  95708. * Set the quaternion rotation of the bone in local or world space
  95709. * @param quat The quaternion rotation that the bone should be set to
  95710. * @param space The space that the rotation is in
  95711. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95712. */
  95713. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95714. /**
  95715. * Set the rotation matrix of the bone in local or world space
  95716. * @param rotMat The rotation matrix that the bone should be set to
  95717. * @param space The space that the rotation is in
  95718. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95719. */
  95720. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95721. private _rotateWithMatrix;
  95722. private _getNegativeRotationToRef;
  95723. /**
  95724. * Get the position of the bone in local or world space
  95725. * @param space The space that the returned position is in
  95726. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95727. * @returns The position of the bone
  95728. */
  95729. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95730. /**
  95731. * Copy the position of the bone to a vector3 in local or world space
  95732. * @param space The space that the returned position is in
  95733. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95734. * @param result The vector3 to copy the position to
  95735. */
  95736. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95737. /**
  95738. * Get the absolute position of the bone (world space)
  95739. * @param mesh The mesh that this bone is attached to
  95740. * @returns The absolute position of the bone
  95741. */
  95742. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95743. /**
  95744. * Copy the absolute position of the bone (world space) to the result param
  95745. * @param mesh The mesh that this bone is attached to
  95746. * @param result The vector3 to copy the absolute position to
  95747. */
  95748. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95749. /**
  95750. * Compute the absolute transforms of this bone and its children
  95751. */
  95752. computeAbsoluteTransforms(): void;
  95753. /**
  95754. * Get the world direction from an axis that is in the local space of the bone
  95755. * @param localAxis The local direction that is used to compute the world direction
  95756. * @param mesh The mesh that this bone is attached to
  95757. * @returns The world direction
  95758. */
  95759. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95760. /**
  95761. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95762. * @param localAxis The local direction that is used to compute the world direction
  95763. * @param mesh The mesh that this bone is attached to
  95764. * @param result The vector3 that the world direction will be copied to
  95765. */
  95766. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95767. /**
  95768. * Get the euler rotation of the bone in local or world space
  95769. * @param space The space that the rotation should be in
  95770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95771. * @returns The euler rotation
  95772. */
  95773. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95774. /**
  95775. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95776. * @param space The space that the rotation should be in
  95777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95778. * @param result The vector3 that the rotation should be copied to
  95779. */
  95780. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95781. /**
  95782. * Get the quaternion rotation of the bone in either local or world space
  95783. * @param space The space that the rotation should be in
  95784. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95785. * @returns The quaternion rotation
  95786. */
  95787. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95788. /**
  95789. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95790. * @param space The space that the rotation should be in
  95791. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95792. * @param result The quaternion that the rotation should be copied to
  95793. */
  95794. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95795. /**
  95796. * Get the rotation matrix of the bone in local or world space
  95797. * @param space The space that the rotation should be in
  95798. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95799. * @returns The rotation matrix
  95800. */
  95801. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95802. /**
  95803. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95804. * @param space The space that the rotation should be in
  95805. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95806. * @param result The quaternion that the rotation should be copied to
  95807. */
  95808. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95809. /**
  95810. * Get the world position of a point that is in the local space of the bone
  95811. * @param position The local position
  95812. * @param mesh The mesh that this bone is attached to
  95813. * @returns The world position
  95814. */
  95815. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95816. /**
  95817. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95818. * @param position The local position
  95819. * @param mesh The mesh that this bone is attached to
  95820. * @param result The vector3 that the world position should be copied to
  95821. */
  95822. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95823. /**
  95824. * Get the local position of a point that is in world space
  95825. * @param position The world position
  95826. * @param mesh The mesh that this bone is attached to
  95827. * @returns The local position
  95828. */
  95829. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95830. /**
  95831. * Get the local position of a point that is in world space and copy it to the result param
  95832. * @param position The world position
  95833. * @param mesh The mesh that this bone is attached to
  95834. * @param result The vector3 that the local position should be copied to
  95835. */
  95836. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95837. /**
  95838. * Set the current local matrix as the restPose for this bone.
  95839. */
  95840. setCurrentPoseAsRest(): void;
  95841. }
  95842. }
  95843. declare module BABYLON {
  95844. /**
  95845. * Defines a runtime animation
  95846. */
  95847. export class RuntimeAnimation {
  95848. private _events;
  95849. /**
  95850. * The current frame of the runtime animation
  95851. */
  95852. private _currentFrame;
  95853. /**
  95854. * The animation used by the runtime animation
  95855. */
  95856. private _animation;
  95857. /**
  95858. * The target of the runtime animation
  95859. */
  95860. private _target;
  95861. /**
  95862. * The initiating animatable
  95863. */
  95864. private _host;
  95865. /**
  95866. * The original value of the runtime animation
  95867. */
  95868. private _originalValue;
  95869. /**
  95870. * The original blend value of the runtime animation
  95871. */
  95872. private _originalBlendValue;
  95873. /**
  95874. * The offsets cache of the runtime animation
  95875. */
  95876. private _offsetsCache;
  95877. /**
  95878. * The high limits cache of the runtime animation
  95879. */
  95880. private _highLimitsCache;
  95881. /**
  95882. * Specifies if the runtime animation has been stopped
  95883. */
  95884. private _stopped;
  95885. /**
  95886. * The blending factor of the runtime animation
  95887. */
  95888. private _blendingFactor;
  95889. /**
  95890. * The BabylonJS scene
  95891. */
  95892. private _scene;
  95893. /**
  95894. * The current value of the runtime animation
  95895. */
  95896. private _currentValue;
  95897. /** @hidden */
  95898. _animationState: _IAnimationState;
  95899. /**
  95900. * The active target of the runtime animation
  95901. */
  95902. private _activeTargets;
  95903. private _currentActiveTarget;
  95904. private _directTarget;
  95905. /**
  95906. * The target path of the runtime animation
  95907. */
  95908. private _targetPath;
  95909. /**
  95910. * The weight of the runtime animation
  95911. */
  95912. private _weight;
  95913. /**
  95914. * The ratio offset of the runtime animation
  95915. */
  95916. private _ratioOffset;
  95917. /**
  95918. * The previous delay of the runtime animation
  95919. */
  95920. private _previousDelay;
  95921. /**
  95922. * The previous ratio of the runtime animation
  95923. */
  95924. private _previousRatio;
  95925. private _enableBlending;
  95926. private _keys;
  95927. private _minFrame;
  95928. private _maxFrame;
  95929. private _minValue;
  95930. private _maxValue;
  95931. private _targetIsArray;
  95932. /**
  95933. * Gets the current frame of the runtime animation
  95934. */
  95935. get currentFrame(): number;
  95936. /**
  95937. * Gets the weight of the runtime animation
  95938. */
  95939. get weight(): number;
  95940. /**
  95941. * Gets the current value of the runtime animation
  95942. */
  95943. get currentValue(): any;
  95944. /**
  95945. * Gets the target path of the runtime animation
  95946. */
  95947. get targetPath(): string;
  95948. /**
  95949. * Gets the actual target of the runtime animation
  95950. */
  95951. get target(): any;
  95952. /**
  95953. * Gets the additive state of the runtime animation
  95954. */
  95955. get isAdditive(): boolean;
  95956. /** @hidden */
  95957. _onLoop: () => void;
  95958. /**
  95959. * Create a new RuntimeAnimation object
  95960. * @param target defines the target of the animation
  95961. * @param animation defines the source animation object
  95962. * @param scene defines the hosting scene
  95963. * @param host defines the initiating Animatable
  95964. */
  95965. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95966. private _preparePath;
  95967. /**
  95968. * Gets the animation from the runtime animation
  95969. */
  95970. get animation(): Animation;
  95971. /**
  95972. * Resets the runtime animation to the beginning
  95973. * @param restoreOriginal defines whether to restore the target property to the original value
  95974. */
  95975. reset(restoreOriginal?: boolean): void;
  95976. /**
  95977. * Specifies if the runtime animation is stopped
  95978. * @returns Boolean specifying if the runtime animation is stopped
  95979. */
  95980. isStopped(): boolean;
  95981. /**
  95982. * Disposes of the runtime animation
  95983. */
  95984. dispose(): void;
  95985. /**
  95986. * Apply the interpolated value to the target
  95987. * @param currentValue defines the value computed by the animation
  95988. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95989. */
  95990. setValue(currentValue: any, weight: number): void;
  95991. private _getOriginalValues;
  95992. private _setValue;
  95993. /**
  95994. * Gets the loop pmode of the runtime animation
  95995. * @returns Loop Mode
  95996. */
  95997. private _getCorrectLoopMode;
  95998. /**
  95999. * Move the current animation to a given frame
  96000. * @param frame defines the frame to move to
  96001. */
  96002. goToFrame(frame: number): void;
  96003. /**
  96004. * @hidden Internal use only
  96005. */
  96006. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  96007. /**
  96008. * Execute the current animation
  96009. * @param delay defines the delay to add to the current frame
  96010. * @param from defines the lower bound of the animation range
  96011. * @param to defines the upper bound of the animation range
  96012. * @param loop defines if the current animation must loop
  96013. * @param speedRatio defines the current speed ratio
  96014. * @param weight defines the weight of the animation (default is -1 so no weight)
  96015. * @param onLoop optional callback called when animation loops
  96016. * @returns a boolean indicating if the animation is running
  96017. */
  96018. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  96019. }
  96020. }
  96021. declare module BABYLON {
  96022. /**
  96023. * Class used to store an actual running animation
  96024. */
  96025. export class Animatable {
  96026. /** defines the target object */
  96027. target: any;
  96028. /** defines the starting frame number (default is 0) */
  96029. fromFrame: number;
  96030. /** defines the ending frame number (default is 100) */
  96031. toFrame: number;
  96032. /** defines if the animation must loop (default is false) */
  96033. loopAnimation: boolean;
  96034. /** defines a callback to call when animation ends if it is not looping */
  96035. onAnimationEnd?: (() => void) | null | undefined;
  96036. /** defines a callback to call when animation loops */
  96037. onAnimationLoop?: (() => void) | null | undefined;
  96038. /** defines whether the animation should be evaluated additively */
  96039. isAdditive: boolean;
  96040. private _localDelayOffset;
  96041. private _pausedDelay;
  96042. private _runtimeAnimations;
  96043. private _paused;
  96044. private _scene;
  96045. private _speedRatio;
  96046. private _weight;
  96047. private _syncRoot;
  96048. /**
  96049. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  96050. * This will only apply for non looping animation (default is true)
  96051. */
  96052. disposeOnEnd: boolean;
  96053. /**
  96054. * Gets a boolean indicating if the animation has started
  96055. */
  96056. animationStarted: boolean;
  96057. /**
  96058. * Observer raised when the animation ends
  96059. */
  96060. onAnimationEndObservable: Observable<Animatable>;
  96061. /**
  96062. * Observer raised when the animation loops
  96063. */
  96064. onAnimationLoopObservable: Observable<Animatable>;
  96065. /**
  96066. * Gets the root Animatable used to synchronize and normalize animations
  96067. */
  96068. get syncRoot(): Nullable<Animatable>;
  96069. /**
  96070. * Gets the current frame of the first RuntimeAnimation
  96071. * Used to synchronize Animatables
  96072. */
  96073. get masterFrame(): number;
  96074. /**
  96075. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  96076. */
  96077. get weight(): number;
  96078. set weight(value: number);
  96079. /**
  96080. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  96081. */
  96082. get speedRatio(): number;
  96083. set speedRatio(value: number);
  96084. /**
  96085. * Creates a new Animatable
  96086. * @param scene defines the hosting scene
  96087. * @param target defines the target object
  96088. * @param fromFrame defines the starting frame number (default is 0)
  96089. * @param toFrame defines the ending frame number (default is 100)
  96090. * @param loopAnimation defines if the animation must loop (default is false)
  96091. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  96092. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  96093. * @param animations defines a group of animation to add to the new Animatable
  96094. * @param onAnimationLoop defines a callback to call when animation loops
  96095. * @param isAdditive defines whether the animation should be evaluated additively
  96096. */
  96097. constructor(scene: Scene,
  96098. /** defines the target object */
  96099. target: any,
  96100. /** defines the starting frame number (default is 0) */
  96101. fromFrame?: number,
  96102. /** defines the ending frame number (default is 100) */
  96103. toFrame?: number,
  96104. /** defines if the animation must loop (default is false) */
  96105. loopAnimation?: boolean, speedRatio?: number,
  96106. /** defines a callback to call when animation ends if it is not looping */
  96107. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  96108. /** defines a callback to call when animation loops */
  96109. onAnimationLoop?: (() => void) | null | undefined,
  96110. /** defines whether the animation should be evaluated additively */
  96111. isAdditive?: boolean);
  96112. /**
  96113. * Synchronize and normalize current Animatable with a source Animatable
  96114. * This is useful when using animation weights and when animations are not of the same length
  96115. * @param root defines the root Animatable to synchronize with
  96116. * @returns the current Animatable
  96117. */
  96118. syncWith(root: Animatable): Animatable;
  96119. /**
  96120. * Gets the list of runtime animations
  96121. * @returns an array of RuntimeAnimation
  96122. */
  96123. getAnimations(): RuntimeAnimation[];
  96124. /**
  96125. * Adds more animations to the current animatable
  96126. * @param target defines the target of the animations
  96127. * @param animations defines the new animations to add
  96128. */
  96129. appendAnimations(target: any, animations: Animation[]): void;
  96130. /**
  96131. * Gets the source animation for a specific property
  96132. * @param property defines the propertyu to look for
  96133. * @returns null or the source animation for the given property
  96134. */
  96135. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  96136. /**
  96137. * Gets the runtime animation for a specific property
  96138. * @param property defines the propertyu to look for
  96139. * @returns null or the runtime animation for the given property
  96140. */
  96141. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  96142. /**
  96143. * Resets the animatable to its original state
  96144. */
  96145. reset(): void;
  96146. /**
  96147. * Allows the animatable to blend with current running animations
  96148. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96149. * @param blendingSpeed defines the blending speed to use
  96150. */
  96151. enableBlending(blendingSpeed: number): void;
  96152. /**
  96153. * Disable animation blending
  96154. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96155. */
  96156. disableBlending(): void;
  96157. /**
  96158. * Jump directly to a given frame
  96159. * @param frame defines the frame to jump to
  96160. */
  96161. goToFrame(frame: number): void;
  96162. /**
  96163. * Pause the animation
  96164. */
  96165. pause(): void;
  96166. /**
  96167. * Restart the animation
  96168. */
  96169. restart(): void;
  96170. private _raiseOnAnimationEnd;
  96171. /**
  96172. * Stop and delete the current animation
  96173. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  96174. * @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)
  96175. */
  96176. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  96177. /**
  96178. * Wait asynchronously for the animation to end
  96179. * @returns a promise which will be fullfilled when the animation ends
  96180. */
  96181. waitAsync(): Promise<Animatable>;
  96182. /** @hidden */
  96183. _animate(delay: number): boolean;
  96184. }
  96185. interface Scene {
  96186. /** @hidden */
  96187. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  96188. /** @hidden */
  96189. _processLateAnimationBindingsForMatrices(holder: {
  96190. totalWeight: number;
  96191. totalAdditiveWeight: number;
  96192. animations: RuntimeAnimation[];
  96193. additiveAnimations: RuntimeAnimation[];
  96194. originalValue: Matrix;
  96195. }): any;
  96196. /** @hidden */
  96197. _processLateAnimationBindingsForQuaternions(holder: {
  96198. totalWeight: number;
  96199. totalAdditiveWeight: number;
  96200. animations: RuntimeAnimation[];
  96201. additiveAnimations: RuntimeAnimation[];
  96202. originalValue: Quaternion;
  96203. }, refQuaternion: Quaternion): Quaternion;
  96204. /** @hidden */
  96205. _processLateAnimationBindings(): void;
  96206. /**
  96207. * Will start the animation sequence of a given target
  96208. * @param target defines the target
  96209. * @param from defines from which frame should animation start
  96210. * @param to defines until which frame should animation run.
  96211. * @param weight defines the weight to apply to the animation (1.0 by default)
  96212. * @param loop defines if the animation loops
  96213. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96214. * @param onAnimationEnd defines the function to be executed when the animation ends
  96215. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96216. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  96217. * @param onAnimationLoop defines the callback to call when an animation loops
  96218. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96219. * @returns the animatable object created for this animation
  96220. */
  96221. 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;
  96222. /**
  96223. * Will start the animation sequence of a given target
  96224. * @param target defines the target
  96225. * @param from defines from which frame should animation start
  96226. * @param to defines until which frame should animation run.
  96227. * @param loop defines if the animation loops
  96228. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96229. * @param onAnimationEnd defines the function to be executed when the animation ends
  96230. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96231. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  96232. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  96233. * @param onAnimationLoop defines the callback to call when an animation loops
  96234. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96235. * @returns the animatable object created for this animation
  96236. */
  96237. 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;
  96238. /**
  96239. * Will start the animation sequence of a given target and its hierarchy
  96240. * @param target defines the target
  96241. * @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.
  96242. * @param from defines from which frame should animation start
  96243. * @param to defines until which frame should animation run.
  96244. * @param loop defines if the animation loops
  96245. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96246. * @param onAnimationEnd defines the function to be executed when the animation ends
  96247. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96248. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  96249. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  96250. * @param onAnimationLoop defines the callback to call when an animation loops
  96251. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96252. * @returns the list of created animatables
  96253. */
  96254. 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[];
  96255. /**
  96256. * Begin a new animation on a given node
  96257. * @param target defines the target where the animation will take place
  96258. * @param animations defines the list of animations to start
  96259. * @param from defines the initial value
  96260. * @param to defines the final value
  96261. * @param loop defines if you want animation to loop (off by default)
  96262. * @param speedRatio defines the speed ratio to apply to all animations
  96263. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96264. * @param onAnimationLoop defines the callback to call when an animation loops
  96265. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96266. * @returns the list of created animatables
  96267. */
  96268. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  96269. /**
  96270. * Begin a new animation on a given node and its hierarchy
  96271. * @param target defines the root node where the animation will take place
  96272. * @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.
  96273. * @param animations defines the list of animations to start
  96274. * @param from defines the initial value
  96275. * @param to defines the final value
  96276. * @param loop defines if you want animation to loop (off by default)
  96277. * @param speedRatio defines the speed ratio to apply to all animations
  96278. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96279. * @param onAnimationLoop defines the callback to call when an animation loops
  96280. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96281. * @returns the list of animatables created for all nodes
  96282. */
  96283. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  96284. /**
  96285. * Gets the animatable associated with a specific target
  96286. * @param target defines the target of the animatable
  96287. * @returns the required animatable if found
  96288. */
  96289. getAnimatableByTarget(target: any): Nullable<Animatable>;
  96290. /**
  96291. * Gets all animatables associated with a given target
  96292. * @param target defines the target to look animatables for
  96293. * @returns an array of Animatables
  96294. */
  96295. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  96296. /**
  96297. * Stops and removes all animations that have been applied to the scene
  96298. */
  96299. stopAllAnimations(): void;
  96300. /**
  96301. * Gets the current delta time used by animation engine
  96302. */
  96303. deltaTime: number;
  96304. }
  96305. interface Bone {
  96306. /**
  96307. * Copy an animation range from another bone
  96308. * @param source defines the source bone
  96309. * @param rangeName defines the range name to copy
  96310. * @param frameOffset defines the frame offset
  96311. * @param rescaleAsRequired defines if rescaling must be applied if required
  96312. * @param skelDimensionsRatio defines the scaling ratio
  96313. * @returns true if operation was successful
  96314. */
  96315. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  96316. }
  96317. }
  96318. declare module BABYLON {
  96319. /**
  96320. * Class used to handle skinning animations
  96321. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  96322. */
  96323. export class Skeleton implements IAnimatable {
  96324. /** defines the skeleton name */
  96325. name: string;
  96326. /** defines the skeleton Id */
  96327. id: string;
  96328. /**
  96329. * Defines the list of child bones
  96330. */
  96331. bones: Bone[];
  96332. /**
  96333. * Defines an estimate of the dimension of the skeleton at rest
  96334. */
  96335. dimensionsAtRest: Vector3;
  96336. /**
  96337. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  96338. */
  96339. needInitialSkinMatrix: boolean;
  96340. /**
  96341. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  96342. */
  96343. overrideMesh: Nullable<AbstractMesh>;
  96344. /**
  96345. * Gets the list of animations attached to this skeleton
  96346. */
  96347. animations: Array<Animation>;
  96348. private _scene;
  96349. private _isDirty;
  96350. private _transformMatrices;
  96351. private _transformMatrixTexture;
  96352. private _meshesWithPoseMatrix;
  96353. private _animatables;
  96354. private _identity;
  96355. private _synchronizedWithMesh;
  96356. private _ranges;
  96357. private _lastAbsoluteTransformsUpdateId;
  96358. private _canUseTextureForBones;
  96359. private _uniqueId;
  96360. /** @hidden */
  96361. _numBonesWithLinkedTransformNode: number;
  96362. /** @hidden */
  96363. _hasWaitingData: Nullable<boolean>;
  96364. /** @hidden */
  96365. _waitingOverrideMeshId: Nullable<string>;
  96366. /**
  96367. * Specifies if the skeleton should be serialized
  96368. */
  96369. doNotSerialize: boolean;
  96370. private _useTextureToStoreBoneMatrices;
  96371. /**
  96372. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  96373. * Please note that this option is not available if the hardware does not support it
  96374. */
  96375. get useTextureToStoreBoneMatrices(): boolean;
  96376. set useTextureToStoreBoneMatrices(value: boolean);
  96377. private _animationPropertiesOverride;
  96378. /**
  96379. * Gets or sets the animation properties override
  96380. */
  96381. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  96382. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  96383. /**
  96384. * List of inspectable custom properties (used by the Inspector)
  96385. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  96386. */
  96387. inspectableCustomProperties: IInspectable[];
  96388. /**
  96389. * An observable triggered before computing the skeleton's matrices
  96390. */
  96391. onBeforeComputeObservable: Observable<Skeleton>;
  96392. /**
  96393. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  96394. */
  96395. get isUsingTextureForMatrices(): boolean;
  96396. /**
  96397. * Gets the unique ID of this skeleton
  96398. */
  96399. get uniqueId(): number;
  96400. /**
  96401. * Creates a new skeleton
  96402. * @param name defines the skeleton name
  96403. * @param id defines the skeleton Id
  96404. * @param scene defines the hosting scene
  96405. */
  96406. constructor(
  96407. /** defines the skeleton name */
  96408. name: string,
  96409. /** defines the skeleton Id */
  96410. id: string, scene: Scene);
  96411. /**
  96412. * Gets the current object class name.
  96413. * @return the class name
  96414. */
  96415. getClassName(): string;
  96416. /**
  96417. * Returns an array containing the root bones
  96418. * @returns an array containing the root bones
  96419. */
  96420. getChildren(): Array<Bone>;
  96421. /**
  96422. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  96423. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  96424. * @returns a Float32Array containing matrices data
  96425. */
  96426. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  96427. /**
  96428. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  96429. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  96430. * @returns a raw texture containing the data
  96431. */
  96432. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  96433. /**
  96434. * Gets the current hosting scene
  96435. * @returns a scene object
  96436. */
  96437. getScene(): Scene;
  96438. /**
  96439. * Gets a string representing the current skeleton data
  96440. * @param fullDetails defines a boolean indicating if we want a verbose version
  96441. * @returns a string representing the current skeleton data
  96442. */
  96443. toString(fullDetails?: boolean): string;
  96444. /**
  96445. * Get bone's index searching by name
  96446. * @param name defines bone's name to search for
  96447. * @return the indice of the bone. Returns -1 if not found
  96448. */
  96449. getBoneIndexByName(name: string): number;
  96450. /**
  96451. * Creater a new animation range
  96452. * @param name defines the name of the range
  96453. * @param from defines the start key
  96454. * @param to defines the end key
  96455. */
  96456. createAnimationRange(name: string, from: number, to: number): void;
  96457. /**
  96458. * Delete a specific animation range
  96459. * @param name defines the name of the range
  96460. * @param deleteFrames defines if frames must be removed as well
  96461. */
  96462. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  96463. /**
  96464. * Gets a specific animation range
  96465. * @param name defines the name of the range to look for
  96466. * @returns the requested animation range or null if not found
  96467. */
  96468. getAnimationRange(name: string): Nullable<AnimationRange>;
  96469. /**
  96470. * Gets the list of all animation ranges defined on this skeleton
  96471. * @returns an array
  96472. */
  96473. getAnimationRanges(): Nullable<AnimationRange>[];
  96474. /**
  96475. * Copy animation range from a source skeleton.
  96476. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  96477. * @param source defines the source skeleton
  96478. * @param name defines the name of the range to copy
  96479. * @param rescaleAsRequired defines if rescaling must be applied if required
  96480. * @returns true if operation was successful
  96481. */
  96482. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  96483. /**
  96484. * Forces the skeleton to go to rest pose
  96485. */
  96486. returnToRest(): void;
  96487. private _getHighestAnimationFrame;
  96488. /**
  96489. * Begin a specific animation range
  96490. * @param name defines the name of the range to start
  96491. * @param loop defines if looping must be turned on (false by default)
  96492. * @param speedRatio defines the speed ratio to apply (1 by default)
  96493. * @param onAnimationEnd defines a callback which will be called when animation will end
  96494. * @returns a new animatable
  96495. */
  96496. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  96497. /**
  96498. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  96499. * @param skeleton defines the Skeleton containing the animation range to convert
  96500. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  96501. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  96502. * @returns the original skeleton
  96503. */
  96504. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  96505. /** @hidden */
  96506. _markAsDirty(): void;
  96507. /** @hidden */
  96508. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  96509. /** @hidden */
  96510. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  96511. private _computeTransformMatrices;
  96512. /**
  96513. * Build all resources required to render a skeleton
  96514. */
  96515. prepare(): void;
  96516. /**
  96517. * Gets the list of animatables currently running for this skeleton
  96518. * @returns an array of animatables
  96519. */
  96520. getAnimatables(): IAnimatable[];
  96521. /**
  96522. * Clone the current skeleton
  96523. * @param name defines the name of the new skeleton
  96524. * @param id defines the id of the new skeleton
  96525. * @returns the new skeleton
  96526. */
  96527. clone(name: string, id?: string): Skeleton;
  96528. /**
  96529. * Enable animation blending for this skeleton
  96530. * @param blendingSpeed defines the blending speed to apply
  96531. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96532. */
  96533. enableBlending(blendingSpeed?: number): void;
  96534. /**
  96535. * Releases all resources associated with the current skeleton
  96536. */
  96537. dispose(): void;
  96538. /**
  96539. * Serialize the skeleton in a JSON object
  96540. * @returns a JSON object
  96541. */
  96542. serialize(): any;
  96543. /**
  96544. * Creates a new skeleton from serialized data
  96545. * @param parsedSkeleton defines the serialized data
  96546. * @param scene defines the hosting scene
  96547. * @returns a new skeleton
  96548. */
  96549. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  96550. /**
  96551. * Compute all node absolute transforms
  96552. * @param forceUpdate defines if computation must be done even if cache is up to date
  96553. */
  96554. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  96555. /**
  96556. * Gets the root pose matrix
  96557. * @returns a matrix
  96558. */
  96559. getPoseMatrix(): Nullable<Matrix>;
  96560. /**
  96561. * Sorts bones per internal index
  96562. */
  96563. sortBones(): void;
  96564. private _sortBones;
  96565. /**
  96566. * Set the current local matrix as the restPose for all bones in the skeleton.
  96567. */
  96568. setCurrentPoseAsRest(): void;
  96569. }
  96570. }
  96571. declare module BABYLON {
  96572. /**
  96573. * Creates an instance based on a source mesh.
  96574. */
  96575. export class InstancedMesh extends AbstractMesh {
  96576. private _sourceMesh;
  96577. private _currentLOD;
  96578. /** @hidden */
  96579. _indexInSourceMeshInstanceArray: number;
  96580. constructor(name: string, source: Mesh);
  96581. /**
  96582. * Returns the string "InstancedMesh".
  96583. */
  96584. getClassName(): string;
  96585. /** Gets the list of lights affecting that mesh */
  96586. get lightSources(): Light[];
  96587. _resyncLightSources(): void;
  96588. _resyncLightSource(light: Light): void;
  96589. _removeLightSource(light: Light, dispose: boolean): void;
  96590. /**
  96591. * If the source mesh receives shadows
  96592. */
  96593. get receiveShadows(): boolean;
  96594. /**
  96595. * The material of the source mesh
  96596. */
  96597. get material(): Nullable<Material>;
  96598. /**
  96599. * Visibility of the source mesh
  96600. */
  96601. get visibility(): number;
  96602. /**
  96603. * Skeleton of the source mesh
  96604. */
  96605. get skeleton(): Nullable<Skeleton>;
  96606. /**
  96607. * Rendering ground id of the source mesh
  96608. */
  96609. get renderingGroupId(): number;
  96610. set renderingGroupId(value: number);
  96611. /**
  96612. * Returns the total number of vertices (integer).
  96613. */
  96614. getTotalVertices(): number;
  96615. /**
  96616. * Returns a positive integer : the total number of indices in this mesh geometry.
  96617. * @returns the numner of indices or zero if the mesh has no geometry.
  96618. */
  96619. getTotalIndices(): number;
  96620. /**
  96621. * The source mesh of the instance
  96622. */
  96623. get sourceMesh(): Mesh;
  96624. /**
  96625. * Creates a new InstancedMesh object from the mesh model.
  96626. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96627. * @param name defines the name of the new instance
  96628. * @returns a new InstancedMesh
  96629. */
  96630. createInstance(name: string): InstancedMesh;
  96631. /**
  96632. * Is this node ready to be used/rendered
  96633. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  96634. * @return {boolean} is it ready
  96635. */
  96636. isReady(completeCheck?: boolean): boolean;
  96637. /**
  96638. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  96639. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  96640. * @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.
  96641. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  96642. */
  96643. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  96644. /**
  96645. * Sets the vertex data of the mesh geometry for the requested `kind`.
  96646. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  96647. * The `data` are either a numeric array either a Float32Array.
  96648. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  96649. * 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).
  96650. * Note that a new underlying VertexBuffer object is created each call.
  96651. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  96652. *
  96653. * Possible `kind` values :
  96654. * - VertexBuffer.PositionKind
  96655. * - VertexBuffer.UVKind
  96656. * - VertexBuffer.UV2Kind
  96657. * - VertexBuffer.UV3Kind
  96658. * - VertexBuffer.UV4Kind
  96659. * - VertexBuffer.UV5Kind
  96660. * - VertexBuffer.UV6Kind
  96661. * - VertexBuffer.ColorKind
  96662. * - VertexBuffer.MatricesIndicesKind
  96663. * - VertexBuffer.MatricesIndicesExtraKind
  96664. * - VertexBuffer.MatricesWeightsKind
  96665. * - VertexBuffer.MatricesWeightsExtraKind
  96666. *
  96667. * Returns the Mesh.
  96668. */
  96669. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  96670. /**
  96671. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  96672. * If the mesh has no geometry, it is simply returned as it is.
  96673. * The `data` are either a numeric array either a Float32Array.
  96674. * No new underlying VertexBuffer object is created.
  96675. * 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.
  96676. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  96677. *
  96678. * Possible `kind` values :
  96679. * - VertexBuffer.PositionKind
  96680. * - VertexBuffer.UVKind
  96681. * - VertexBuffer.UV2Kind
  96682. * - VertexBuffer.UV3Kind
  96683. * - VertexBuffer.UV4Kind
  96684. * - VertexBuffer.UV5Kind
  96685. * - VertexBuffer.UV6Kind
  96686. * - VertexBuffer.ColorKind
  96687. * - VertexBuffer.MatricesIndicesKind
  96688. * - VertexBuffer.MatricesIndicesExtraKind
  96689. * - VertexBuffer.MatricesWeightsKind
  96690. * - VertexBuffer.MatricesWeightsExtraKind
  96691. *
  96692. * Returns the Mesh.
  96693. */
  96694. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  96695. /**
  96696. * Sets the mesh indices.
  96697. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96698. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96699. * This method creates a new index buffer each call.
  96700. * Returns the Mesh.
  96701. */
  96702. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96703. /**
  96704. * Boolean : True if the mesh owns the requested kind of data.
  96705. */
  96706. isVerticesDataPresent(kind: string): boolean;
  96707. /**
  96708. * Returns an array of indices (IndicesArray).
  96709. */
  96710. getIndices(): Nullable<IndicesArray>;
  96711. get _positions(): Nullable<Vector3[]>;
  96712. /**
  96713. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96714. * This means the mesh underlying bounding box and sphere are recomputed.
  96715. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96716. * @returns the current mesh
  96717. */
  96718. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96719. /** @hidden */
  96720. _preActivate(): InstancedMesh;
  96721. /** @hidden */
  96722. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96723. /** @hidden */
  96724. _postActivate(): void;
  96725. getWorldMatrix(): Matrix;
  96726. get isAnInstance(): boolean;
  96727. /**
  96728. * Returns the current associated LOD AbstractMesh.
  96729. */
  96730. getLOD(camera: Camera): AbstractMesh;
  96731. /** @hidden */
  96732. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96733. /** @hidden */
  96734. _syncSubMeshes(): InstancedMesh;
  96735. /** @hidden */
  96736. _generatePointsArray(): boolean;
  96737. /** @hidden */
  96738. _updateBoundingInfo(): AbstractMesh;
  96739. /**
  96740. * Creates a new InstancedMesh from the current mesh.
  96741. * - name (string) : the cloned mesh name
  96742. * - newParent (optional Node) : the optional Node to parent the clone to.
  96743. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96744. *
  96745. * Returns the clone.
  96746. */
  96747. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96748. /**
  96749. * Disposes the InstancedMesh.
  96750. * Returns nothing.
  96751. */
  96752. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96753. }
  96754. interface Mesh {
  96755. /**
  96756. * Register a custom buffer that will be instanced
  96757. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96758. * @param kind defines the buffer kind
  96759. * @param stride defines the stride in floats
  96760. */
  96761. registerInstancedBuffer(kind: string, stride: number): void;
  96762. /**
  96763. * true to use the edge renderer for all instances of this mesh
  96764. */
  96765. edgesShareWithInstances: boolean;
  96766. /** @hidden */
  96767. _userInstancedBuffersStorage: {
  96768. data: {
  96769. [key: string]: Float32Array;
  96770. };
  96771. sizes: {
  96772. [key: string]: number;
  96773. };
  96774. vertexBuffers: {
  96775. [key: string]: Nullable<VertexBuffer>;
  96776. };
  96777. strides: {
  96778. [key: string]: number;
  96779. };
  96780. };
  96781. }
  96782. interface AbstractMesh {
  96783. /**
  96784. * Object used to store instanced buffers defined by user
  96785. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96786. */
  96787. instancedBuffers: {
  96788. [key: string]: any;
  96789. };
  96790. }
  96791. }
  96792. declare module BABYLON {
  96793. /**
  96794. * Defines the options associated with the creation of a shader material.
  96795. */
  96796. export interface IShaderMaterialOptions {
  96797. /**
  96798. * Does the material work in alpha blend mode
  96799. */
  96800. needAlphaBlending: boolean;
  96801. /**
  96802. * Does the material work in alpha test mode
  96803. */
  96804. needAlphaTesting: boolean;
  96805. /**
  96806. * The list of attribute names used in the shader
  96807. */
  96808. attributes: string[];
  96809. /**
  96810. * The list of unifrom names used in the shader
  96811. */
  96812. uniforms: string[];
  96813. /**
  96814. * The list of UBO names used in the shader
  96815. */
  96816. uniformBuffers: string[];
  96817. /**
  96818. * The list of sampler names used in the shader
  96819. */
  96820. samplers: string[];
  96821. /**
  96822. * The list of defines used in the shader
  96823. */
  96824. defines: string[];
  96825. }
  96826. /**
  96827. * 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.
  96828. *
  96829. * This returned material effects how the mesh will look based on the code in the shaders.
  96830. *
  96831. * @see https://doc.babylonjs.com/how_to/shader_material
  96832. */
  96833. export class ShaderMaterial extends Material {
  96834. private _shaderPath;
  96835. private _options;
  96836. private _textures;
  96837. private _textureArrays;
  96838. private _floats;
  96839. private _ints;
  96840. private _floatsArrays;
  96841. private _colors3;
  96842. private _colors3Arrays;
  96843. private _colors4;
  96844. private _colors4Arrays;
  96845. private _vectors2;
  96846. private _vectors3;
  96847. private _vectors4;
  96848. private _matrices;
  96849. private _matrixArrays;
  96850. private _matrices3x3;
  96851. private _matrices2x2;
  96852. private _vectors2Arrays;
  96853. private _vectors3Arrays;
  96854. private _vectors4Arrays;
  96855. private _cachedWorldViewMatrix;
  96856. private _cachedWorldViewProjectionMatrix;
  96857. private _renderId;
  96858. private _multiview;
  96859. private _cachedDefines;
  96860. /** Define the Url to load snippets */
  96861. static SnippetUrl: string;
  96862. /** Snippet ID if the material was created from the snippet server */
  96863. snippetId: string;
  96864. /**
  96865. * Instantiate a new shader material.
  96866. * 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.
  96867. * This returned material effects how the mesh will look based on the code in the shaders.
  96868. * @see https://doc.babylonjs.com/how_to/shader_material
  96869. * @param name Define the name of the material in the scene
  96870. * @param scene Define the scene the material belongs to
  96871. * @param shaderPath Defines the route to the shader code in one of three ways:
  96872. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96873. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96874. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96875. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96876. * @param options Define the options used to create the shader
  96877. */
  96878. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96879. /**
  96880. * Gets the shader path used to define the shader code
  96881. * It can be modified to trigger a new compilation
  96882. */
  96883. get shaderPath(): any;
  96884. /**
  96885. * Sets the shader path used to define the shader code
  96886. * It can be modified to trigger a new compilation
  96887. */
  96888. set shaderPath(shaderPath: any);
  96889. /**
  96890. * Gets the options used to compile the shader.
  96891. * They can be modified to trigger a new compilation
  96892. */
  96893. get options(): IShaderMaterialOptions;
  96894. /**
  96895. * Gets the current class name of the material e.g. "ShaderMaterial"
  96896. * Mainly use in serialization.
  96897. * @returns the class name
  96898. */
  96899. getClassName(): string;
  96900. /**
  96901. * Specifies if the material will require alpha blending
  96902. * @returns a boolean specifying if alpha blending is needed
  96903. */
  96904. needAlphaBlending(): boolean;
  96905. /**
  96906. * Specifies if this material should be rendered in alpha test mode
  96907. * @returns a boolean specifying if an alpha test is needed.
  96908. */
  96909. needAlphaTesting(): boolean;
  96910. private _checkUniform;
  96911. /**
  96912. * Set a texture in the shader.
  96913. * @param name Define the name of the uniform samplers as defined in the shader
  96914. * @param texture Define the texture to bind to this sampler
  96915. * @return the material itself allowing "fluent" like uniform updates
  96916. */
  96917. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96918. /**
  96919. * Set a texture array in the shader.
  96920. * @param name Define the name of the uniform sampler array as defined in the shader
  96921. * @param textures Define the list of textures to bind to this sampler
  96922. * @return the material itself allowing "fluent" like uniform updates
  96923. */
  96924. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96925. /**
  96926. * Set a float in the shader.
  96927. * @param name Define the name of the uniform as defined in the shader
  96928. * @param value Define the value to give to the uniform
  96929. * @return the material itself allowing "fluent" like uniform updates
  96930. */
  96931. setFloat(name: string, value: number): ShaderMaterial;
  96932. /**
  96933. * Set a int in the shader.
  96934. * @param name Define the name of the uniform as defined in the shader
  96935. * @param value Define the value to give to the uniform
  96936. * @return the material itself allowing "fluent" like uniform updates
  96937. */
  96938. setInt(name: string, value: number): ShaderMaterial;
  96939. /**
  96940. * Set an array of floats in the shader.
  96941. * @param name Define the name of the uniform as defined in the shader
  96942. * @param value Define the value to give to the uniform
  96943. * @return the material itself allowing "fluent" like uniform updates
  96944. */
  96945. setFloats(name: string, value: number[]): ShaderMaterial;
  96946. /**
  96947. * Set a vec3 in the shader from a Color3.
  96948. * @param name Define the name of the uniform as defined in the shader
  96949. * @param value Define the value to give to the uniform
  96950. * @return the material itself allowing "fluent" like uniform updates
  96951. */
  96952. setColor3(name: string, value: Color3): ShaderMaterial;
  96953. /**
  96954. * Set a vec3 array in the shader from a Color3 array.
  96955. * @param name Define the name of the uniform as defined in the shader
  96956. * @param value Define the value to give to the uniform
  96957. * @return the material itself allowing "fluent" like uniform updates
  96958. */
  96959. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96960. /**
  96961. * Set a vec4 in the shader from a Color4.
  96962. * @param name Define the name of the uniform as defined in the shader
  96963. * @param value Define the value to give to the uniform
  96964. * @return the material itself allowing "fluent" like uniform updates
  96965. */
  96966. setColor4(name: string, value: Color4): ShaderMaterial;
  96967. /**
  96968. * Set a vec4 array in the shader from a Color4 array.
  96969. * @param name Define the name of the uniform as defined in the shader
  96970. * @param value Define the value to give to the uniform
  96971. * @return the material itself allowing "fluent" like uniform updates
  96972. */
  96973. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96974. /**
  96975. * Set a vec2 in the shader from a Vector2.
  96976. * @param name Define the name of the uniform as defined in the shader
  96977. * @param value Define the value to give to the uniform
  96978. * @return the material itself allowing "fluent" like uniform updates
  96979. */
  96980. setVector2(name: string, value: Vector2): ShaderMaterial;
  96981. /**
  96982. * Set a vec3 in the shader from a Vector3.
  96983. * @param name Define the name of the uniform as defined in the shader
  96984. * @param value Define the value to give to the uniform
  96985. * @return the material itself allowing "fluent" like uniform updates
  96986. */
  96987. setVector3(name: string, value: Vector3): ShaderMaterial;
  96988. /**
  96989. * Set a vec4 in the shader from a Vector4.
  96990. * @param name Define the name of the uniform as defined in the shader
  96991. * @param value Define the value to give to the uniform
  96992. * @return the material itself allowing "fluent" like uniform updates
  96993. */
  96994. setVector4(name: string, value: Vector4): ShaderMaterial;
  96995. /**
  96996. * Set a mat4 in the shader from a Matrix.
  96997. * @param name Define the name of the uniform as defined in the shader
  96998. * @param value Define the value to give to the uniform
  96999. * @return the material itself allowing "fluent" like uniform updates
  97000. */
  97001. setMatrix(name: string, value: Matrix): ShaderMaterial;
  97002. /**
  97003. * Set a float32Array in the shader from a matrix array.
  97004. * @param name Define the name of the uniform as defined in the shader
  97005. * @param value Define the value to give to the uniform
  97006. * @return the material itself allowing "fluent" like uniform updates
  97007. */
  97008. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  97009. /**
  97010. * Set a mat3 in the shader from a Float32Array.
  97011. * @param name Define the name of the uniform as defined in the shader
  97012. * @param value Define the value to give to the uniform
  97013. * @return the material itself allowing "fluent" like uniform updates
  97014. */
  97015. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  97016. /**
  97017. * Set a mat2 in the shader from a Float32Array.
  97018. * @param name Define the name of the uniform as defined in the shader
  97019. * @param value Define the value to give to the uniform
  97020. * @return the material itself allowing "fluent" like uniform updates
  97021. */
  97022. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  97023. /**
  97024. * Set a vec2 array in the shader from a number array.
  97025. * @param name Define the name of the uniform as defined in the shader
  97026. * @param value Define the value to give to the uniform
  97027. * @return the material itself allowing "fluent" like uniform updates
  97028. */
  97029. setArray2(name: string, value: number[]): ShaderMaterial;
  97030. /**
  97031. * Set a vec3 array in the shader from a number array.
  97032. * @param name Define the name of the uniform as defined in the shader
  97033. * @param value Define the value to give to the uniform
  97034. * @return the material itself allowing "fluent" like uniform updates
  97035. */
  97036. setArray3(name: string, value: number[]): ShaderMaterial;
  97037. /**
  97038. * Set a vec4 array in the shader from a number array.
  97039. * @param name Define the name of the uniform as defined in the shader
  97040. * @param value Define the value to give to the uniform
  97041. * @return the material itself allowing "fluent" like uniform updates
  97042. */
  97043. setArray4(name: string, value: number[]): ShaderMaterial;
  97044. private _checkCache;
  97045. /**
  97046. * Specifies that the submesh is ready to be used
  97047. * @param mesh defines the mesh to check
  97048. * @param subMesh defines which submesh to check
  97049. * @param useInstances specifies that instances should be used
  97050. * @returns a boolean indicating that the submesh is ready or not
  97051. */
  97052. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  97053. /**
  97054. * Checks if the material is ready to render the requested mesh
  97055. * @param mesh Define the mesh to render
  97056. * @param useInstances Define whether or not the material is used with instances
  97057. * @returns true if ready, otherwise false
  97058. */
  97059. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  97060. /**
  97061. * Binds the world matrix to the material
  97062. * @param world defines the world transformation matrix
  97063. * @param effectOverride - If provided, use this effect instead of internal effect
  97064. */
  97065. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  97066. /**
  97067. * Binds the submesh to this material by preparing the effect and shader to draw
  97068. * @param world defines the world transformation matrix
  97069. * @param mesh defines the mesh containing the submesh
  97070. * @param subMesh defines the submesh to bind the material to
  97071. */
  97072. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  97073. /**
  97074. * Binds the material to the mesh
  97075. * @param world defines the world transformation matrix
  97076. * @param mesh defines the mesh to bind the material to
  97077. * @param effectOverride - If provided, use this effect instead of internal effect
  97078. */
  97079. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  97080. protected _afterBind(mesh?: Mesh): void;
  97081. /**
  97082. * Gets the active textures from the material
  97083. * @returns an array of textures
  97084. */
  97085. getActiveTextures(): BaseTexture[];
  97086. /**
  97087. * Specifies if the material uses a texture
  97088. * @param texture defines the texture to check against the material
  97089. * @returns a boolean specifying if the material uses the texture
  97090. */
  97091. hasTexture(texture: BaseTexture): boolean;
  97092. /**
  97093. * Makes a duplicate of the material, and gives it a new name
  97094. * @param name defines the new name for the duplicated material
  97095. * @returns the cloned material
  97096. */
  97097. clone(name: string): ShaderMaterial;
  97098. /**
  97099. * Disposes the material
  97100. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  97101. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  97102. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  97103. */
  97104. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  97105. /**
  97106. * Serializes this material in a JSON representation
  97107. * @returns the serialized material object
  97108. */
  97109. serialize(): any;
  97110. /**
  97111. * Creates a shader material from parsed shader material data
  97112. * @param source defines the JSON represnetation of the material
  97113. * @param scene defines the hosting scene
  97114. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97115. * @returns a new material
  97116. */
  97117. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  97118. /**
  97119. * Creates a new ShaderMaterial from a snippet saved in a remote file
  97120. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  97121. * @param url defines the url to load from
  97122. * @param scene defines the hosting scene
  97123. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97124. * @returns a promise that will resolve to the new ShaderMaterial
  97125. */
  97126. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  97127. /**
  97128. * Creates a ShaderMaterial from a snippet saved by the Inspector
  97129. * @param snippetId defines the snippet to load
  97130. * @param scene defines the hosting scene
  97131. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97132. * @returns a promise that will resolve to the new ShaderMaterial
  97133. */
  97134. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  97135. }
  97136. }
  97137. declare module BABYLON {
  97138. /** @hidden */
  97139. export var colorPixelShader: {
  97140. name: string;
  97141. shader: string;
  97142. };
  97143. }
  97144. declare module BABYLON {
  97145. /** @hidden */
  97146. export var colorVertexShader: {
  97147. name: string;
  97148. shader: string;
  97149. };
  97150. }
  97151. declare module BABYLON {
  97152. /**
  97153. * Line mesh
  97154. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  97155. */
  97156. export class LinesMesh extends Mesh {
  97157. /**
  97158. * If vertex color should be applied to the mesh
  97159. */
  97160. readonly useVertexColor?: boolean | undefined;
  97161. /**
  97162. * If vertex alpha should be applied to the mesh
  97163. */
  97164. readonly useVertexAlpha?: boolean | undefined;
  97165. /**
  97166. * Color of the line (Default: White)
  97167. */
  97168. color: Color3;
  97169. /**
  97170. * Alpha of the line (Default: 1)
  97171. */
  97172. alpha: number;
  97173. /**
  97174. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  97175. * This margin is expressed in world space coordinates, so its value may vary.
  97176. * Default value is 0.1
  97177. */
  97178. intersectionThreshold: number;
  97179. private _colorShader;
  97180. private color4;
  97181. /**
  97182. * Creates a new LinesMesh
  97183. * @param name defines the name
  97184. * @param scene defines the hosting scene
  97185. * @param parent defines the parent mesh if any
  97186. * @param source defines the optional source LinesMesh used to clone data from
  97187. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  97188. * When false, achieved by calling a clone(), also passing False.
  97189. * This will make creation of children, recursive.
  97190. * @param useVertexColor defines if this LinesMesh supports vertex color
  97191. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  97192. */
  97193. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  97194. /**
  97195. * If vertex color should be applied to the mesh
  97196. */
  97197. useVertexColor?: boolean | undefined,
  97198. /**
  97199. * If vertex alpha should be applied to the mesh
  97200. */
  97201. useVertexAlpha?: boolean | undefined);
  97202. private _addClipPlaneDefine;
  97203. private _removeClipPlaneDefine;
  97204. isReady(): boolean;
  97205. /**
  97206. * Returns the string "LineMesh"
  97207. */
  97208. getClassName(): string;
  97209. /**
  97210. * @hidden
  97211. */
  97212. get material(): Material;
  97213. /**
  97214. * @hidden
  97215. */
  97216. set material(value: Material);
  97217. /**
  97218. * @hidden
  97219. */
  97220. get checkCollisions(): boolean;
  97221. /** @hidden */
  97222. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  97223. /** @hidden */
  97224. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  97225. /**
  97226. * Disposes of the line mesh
  97227. * @param doNotRecurse If children should be disposed
  97228. */
  97229. dispose(doNotRecurse?: boolean): void;
  97230. /**
  97231. * Returns a new LineMesh object cloned from the current one.
  97232. */
  97233. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  97234. /**
  97235. * Creates a new InstancedLinesMesh object from the mesh model.
  97236. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  97237. * @param name defines the name of the new instance
  97238. * @returns a new InstancedLinesMesh
  97239. */
  97240. createInstance(name: string): InstancedLinesMesh;
  97241. }
  97242. /**
  97243. * Creates an instance based on a source LinesMesh
  97244. */
  97245. export class InstancedLinesMesh extends InstancedMesh {
  97246. /**
  97247. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  97248. * This margin is expressed in world space coordinates, so its value may vary.
  97249. * Initilized with the intersectionThreshold value of the source LinesMesh
  97250. */
  97251. intersectionThreshold: number;
  97252. constructor(name: string, source: LinesMesh);
  97253. /**
  97254. * Returns the string "InstancedLinesMesh".
  97255. */
  97256. getClassName(): string;
  97257. }
  97258. }
  97259. declare module BABYLON {
  97260. /** @hidden */
  97261. export var linePixelShader: {
  97262. name: string;
  97263. shader: string;
  97264. };
  97265. }
  97266. declare module BABYLON {
  97267. /** @hidden */
  97268. export var lineVertexShader: {
  97269. name: string;
  97270. shader: string;
  97271. };
  97272. }
  97273. declare module BABYLON {
  97274. interface Scene {
  97275. /** @hidden */
  97276. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  97277. }
  97278. interface AbstractMesh {
  97279. /**
  97280. * Gets the edgesRenderer associated with the mesh
  97281. */
  97282. edgesRenderer: Nullable<EdgesRenderer>;
  97283. }
  97284. interface LinesMesh {
  97285. /**
  97286. * Enables the edge rendering mode on the mesh.
  97287. * This mode makes the mesh edges visible
  97288. * @param epsilon defines the maximal distance between two angles to detect a face
  97289. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  97290. * @returns the currentAbstractMesh
  97291. * @see https://www.babylonjs-playground.com/#19O9TU#0
  97292. */
  97293. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  97294. }
  97295. interface InstancedLinesMesh {
  97296. /**
  97297. * Enables the edge rendering mode on the mesh.
  97298. * This mode makes the mesh edges visible
  97299. * @param epsilon defines the maximal distance between two angles to detect a face
  97300. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  97301. * @returns the current InstancedLinesMesh
  97302. * @see https://www.babylonjs-playground.com/#19O9TU#0
  97303. */
  97304. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  97305. }
  97306. /**
  97307. * Defines the minimum contract an Edges renderer should follow.
  97308. */
  97309. export interface IEdgesRenderer extends IDisposable {
  97310. /**
  97311. * Gets or sets a boolean indicating if the edgesRenderer is active
  97312. */
  97313. isEnabled: boolean;
  97314. /**
  97315. * Renders the edges of the attached mesh,
  97316. */
  97317. render(): void;
  97318. /**
  97319. * Checks wether or not the edges renderer is ready to render.
  97320. * @return true if ready, otherwise false.
  97321. */
  97322. isReady(): boolean;
  97323. /**
  97324. * List of instances to render in case the source mesh has instances
  97325. */
  97326. customInstances: SmartArray<Matrix>;
  97327. }
  97328. /**
  97329. * Defines the additional options of the edges renderer
  97330. */
  97331. export interface IEdgesRendererOptions {
  97332. /**
  97333. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  97334. * If not defined, the default value is true
  97335. */
  97336. useAlternateEdgeFinder?: boolean;
  97337. /**
  97338. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  97339. * If not defined, the default value is true.
  97340. * 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)
  97341. * This option is used only if useAlternateEdgeFinder = true
  97342. */
  97343. useFastVertexMerger?: boolean;
  97344. /**
  97345. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  97346. * The default value is 1e-6
  97347. * This option is used only if useAlternateEdgeFinder = true
  97348. */
  97349. epsilonVertexMerge?: number;
  97350. /**
  97351. * 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
  97352. * 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.
  97353. * This option is used only if useAlternateEdgeFinder = true
  97354. */
  97355. applyTessellation?: boolean;
  97356. /**
  97357. * 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
  97358. * The default value is 1e-6
  97359. * This option is used only if useAlternateEdgeFinder = true
  97360. */
  97361. epsilonVertexAligned?: number;
  97362. }
  97363. /**
  97364. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  97365. */
  97366. export class EdgesRenderer implements IEdgesRenderer {
  97367. /**
  97368. * Define the size of the edges with an orthographic camera
  97369. */
  97370. edgesWidthScalerForOrthographic: number;
  97371. /**
  97372. * Define the size of the edges with a perspective camera
  97373. */
  97374. edgesWidthScalerForPerspective: number;
  97375. protected _source: AbstractMesh;
  97376. protected _linesPositions: number[];
  97377. protected _linesNormals: number[];
  97378. protected _linesIndices: number[];
  97379. protected _epsilon: number;
  97380. protected _indicesCount: number;
  97381. protected _lineShader: ShaderMaterial;
  97382. protected _ib: DataBuffer;
  97383. protected _buffers: {
  97384. [key: string]: Nullable<VertexBuffer>;
  97385. };
  97386. protected _buffersForInstances: {
  97387. [key: string]: Nullable<VertexBuffer>;
  97388. };
  97389. protected _checkVerticesInsteadOfIndices: boolean;
  97390. protected _options: Nullable<IEdgesRendererOptions>;
  97391. private _meshRebuildObserver;
  97392. private _meshDisposeObserver;
  97393. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  97394. isEnabled: boolean;
  97395. /**
  97396. * List of instances to render in case the source mesh has instances
  97397. */
  97398. customInstances: SmartArray<Matrix>;
  97399. private static GetShader;
  97400. /**
  97401. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  97402. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  97403. * @param source Mesh used to create edges
  97404. * @param epsilon sum of angles in adjacency to check for edge
  97405. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  97406. * @param generateEdgesLines - should generate Lines or only prepare resources.
  97407. * @param options The options to apply when generating the edges
  97408. */
  97409. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  97410. protected _prepareRessources(): void;
  97411. /** @hidden */
  97412. _rebuild(): void;
  97413. /**
  97414. * Releases the required resources for the edges renderer
  97415. */
  97416. dispose(): void;
  97417. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  97418. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  97419. /**
  97420. * Checks if the pair of p0 and p1 is en edge
  97421. * @param faceIndex
  97422. * @param edge
  97423. * @param faceNormals
  97424. * @param p0
  97425. * @param p1
  97426. * @private
  97427. */
  97428. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  97429. /**
  97430. * push line into the position, normal and index buffer
  97431. * @protected
  97432. */
  97433. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  97434. /**
  97435. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  97436. */
  97437. private _tessellateTriangle;
  97438. private _generateEdgesLinesAlternate;
  97439. /**
  97440. * Generates lines edges from adjacencjes
  97441. * @private
  97442. */
  97443. _generateEdgesLines(): void;
  97444. /**
  97445. * Checks wether or not the edges renderer is ready to render.
  97446. * @return true if ready, otherwise false.
  97447. */
  97448. isReady(): boolean;
  97449. /**
  97450. * Renders the edges of the attached mesh,
  97451. */
  97452. render(): void;
  97453. }
  97454. /**
  97455. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  97456. */
  97457. export class LineEdgesRenderer extends EdgesRenderer {
  97458. /**
  97459. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  97460. * @param source LineMesh used to generate edges
  97461. * @param epsilon not important (specified angle for edge detection)
  97462. * @param checkVerticesInsteadOfIndices not important for LineMesh
  97463. */
  97464. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  97465. /**
  97466. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  97467. */
  97468. _generateEdgesLines(): void;
  97469. }
  97470. }
  97471. declare module BABYLON {
  97472. /**
  97473. * This represents the object necessary to create a rendering group.
  97474. * This is exclusively used and created by the rendering manager.
  97475. * To modify the behavior, you use the available helpers in your scene or meshes.
  97476. * @hidden
  97477. */
  97478. export class RenderingGroup {
  97479. index: number;
  97480. private static _zeroVector;
  97481. private _scene;
  97482. private _opaqueSubMeshes;
  97483. private _transparentSubMeshes;
  97484. private _alphaTestSubMeshes;
  97485. private _depthOnlySubMeshes;
  97486. private _particleSystems;
  97487. private _spriteManagers;
  97488. private _opaqueSortCompareFn;
  97489. private _alphaTestSortCompareFn;
  97490. private _transparentSortCompareFn;
  97491. private _renderOpaque;
  97492. private _renderAlphaTest;
  97493. private _renderTransparent;
  97494. /** @hidden */
  97495. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  97496. onBeforeTransparentRendering: () => void;
  97497. /**
  97498. * Set the opaque sort comparison function.
  97499. * If null the sub meshes will be render in the order they were created
  97500. */
  97501. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  97502. /**
  97503. * Set the alpha test sort comparison function.
  97504. * If null the sub meshes will be render in the order they were created
  97505. */
  97506. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  97507. /**
  97508. * Set the transparent sort comparison function.
  97509. * If null the sub meshes will be render in the order they were created
  97510. */
  97511. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  97512. /**
  97513. * Creates a new rendering group.
  97514. * @param index The rendering group index
  97515. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  97516. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  97517. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  97518. */
  97519. 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>);
  97520. /**
  97521. * Render all the sub meshes contained in the group.
  97522. * @param customRenderFunction Used to override the default render behaviour of the group.
  97523. * @returns true if rendered some submeshes.
  97524. */
  97525. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  97526. /**
  97527. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  97528. * @param subMeshes The submeshes to render
  97529. */
  97530. private renderOpaqueSorted;
  97531. /**
  97532. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  97533. * @param subMeshes The submeshes to render
  97534. */
  97535. private renderAlphaTestSorted;
  97536. /**
  97537. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  97538. * @param subMeshes The submeshes to render
  97539. */
  97540. private renderTransparentSorted;
  97541. /**
  97542. * Renders the submeshes in a specified order.
  97543. * @param subMeshes The submeshes to sort before render
  97544. * @param sortCompareFn The comparison function use to sort
  97545. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  97546. * @param transparent Specifies to activate blending if true
  97547. */
  97548. private static renderSorted;
  97549. /**
  97550. * Renders the submeshes in the order they were dispatched (no sort applied).
  97551. * @param subMeshes The submeshes to render
  97552. */
  97553. private static renderUnsorted;
  97554. /**
  97555. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97556. * are rendered back to front if in the same alpha index.
  97557. *
  97558. * @param a The first submesh
  97559. * @param b The second submesh
  97560. * @returns The result of the comparison
  97561. */
  97562. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  97563. /**
  97564. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97565. * are rendered back to front.
  97566. *
  97567. * @param a The first submesh
  97568. * @param b The second submesh
  97569. * @returns The result of the comparison
  97570. */
  97571. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  97572. /**
  97573. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97574. * are rendered front to back (prevent overdraw).
  97575. *
  97576. * @param a The first submesh
  97577. * @param b The second submesh
  97578. * @returns The result of the comparison
  97579. */
  97580. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  97581. /**
  97582. * Resets the different lists of submeshes to prepare a new frame.
  97583. */
  97584. prepare(): void;
  97585. dispose(): void;
  97586. /**
  97587. * Inserts the submesh in its correct queue depending on its material.
  97588. * @param subMesh The submesh to dispatch
  97589. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97590. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97591. */
  97592. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97593. dispatchSprites(spriteManager: ISpriteManager): void;
  97594. dispatchParticles(particleSystem: IParticleSystem): void;
  97595. private _renderParticles;
  97596. private _renderSprites;
  97597. }
  97598. }
  97599. declare module BABYLON {
  97600. /**
  97601. * Interface describing the different options available in the rendering manager
  97602. * regarding Auto Clear between groups.
  97603. */
  97604. export interface IRenderingManagerAutoClearSetup {
  97605. /**
  97606. * Defines whether or not autoclear is enable.
  97607. */
  97608. autoClear: boolean;
  97609. /**
  97610. * Defines whether or not to autoclear the depth buffer.
  97611. */
  97612. depth: boolean;
  97613. /**
  97614. * Defines whether or not to autoclear the stencil buffer.
  97615. */
  97616. stencil: boolean;
  97617. }
  97618. /**
  97619. * This class is used by the onRenderingGroupObservable
  97620. */
  97621. export class RenderingGroupInfo {
  97622. /**
  97623. * The Scene that being rendered
  97624. */
  97625. scene: Scene;
  97626. /**
  97627. * The camera currently used for the rendering pass
  97628. */
  97629. camera: Nullable<Camera>;
  97630. /**
  97631. * The ID of the renderingGroup being processed
  97632. */
  97633. renderingGroupId: number;
  97634. }
  97635. /**
  97636. * This is the manager responsible of all the rendering for meshes sprites and particles.
  97637. * It is enable to manage the different groups as well as the different necessary sort functions.
  97638. * This should not be used directly aside of the few static configurations
  97639. */
  97640. export class RenderingManager {
  97641. /**
  97642. * The max id used for rendering groups (not included)
  97643. */
  97644. static MAX_RENDERINGGROUPS: number;
  97645. /**
  97646. * The min id used for rendering groups (included)
  97647. */
  97648. static MIN_RENDERINGGROUPS: number;
  97649. /**
  97650. * Used to globally prevent autoclearing scenes.
  97651. */
  97652. static AUTOCLEAR: boolean;
  97653. /**
  97654. * @hidden
  97655. */
  97656. _useSceneAutoClearSetup: boolean;
  97657. private _scene;
  97658. private _renderingGroups;
  97659. private _depthStencilBufferAlreadyCleaned;
  97660. private _autoClearDepthStencil;
  97661. private _customOpaqueSortCompareFn;
  97662. private _customAlphaTestSortCompareFn;
  97663. private _customTransparentSortCompareFn;
  97664. private _renderingGroupInfo;
  97665. /**
  97666. * Instantiates a new rendering group for a particular scene
  97667. * @param scene Defines the scene the groups belongs to
  97668. */
  97669. constructor(scene: Scene);
  97670. private _clearDepthStencilBuffer;
  97671. /**
  97672. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  97673. * @hidden
  97674. */
  97675. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  97676. /**
  97677. * Resets the different information of the group to prepare a new frame
  97678. * @hidden
  97679. */
  97680. reset(): void;
  97681. /**
  97682. * Dispose and release the group and its associated resources.
  97683. * @hidden
  97684. */
  97685. dispose(): void;
  97686. /**
  97687. * Clear the info related to rendering groups preventing retention points during dispose.
  97688. */
  97689. freeRenderingGroups(): void;
  97690. private _prepareRenderingGroup;
  97691. /**
  97692. * Add a sprite manager to the rendering manager in order to render it this frame.
  97693. * @param spriteManager Define the sprite manager to render
  97694. */
  97695. dispatchSprites(spriteManager: ISpriteManager): void;
  97696. /**
  97697. * Add a particle system to the rendering manager in order to render it this frame.
  97698. * @param particleSystem Define the particle system to render
  97699. */
  97700. dispatchParticles(particleSystem: IParticleSystem): void;
  97701. /**
  97702. * Add a submesh to the manager in order to render it this frame
  97703. * @param subMesh The submesh to dispatch
  97704. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97705. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97706. */
  97707. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97708. /**
  97709. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97710. * This allowed control for front to back rendering or reversly depending of the special needs.
  97711. *
  97712. * @param renderingGroupId The rendering group id corresponding to its index
  97713. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97714. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97715. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97716. */
  97717. 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;
  97718. /**
  97719. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97720. *
  97721. * @param renderingGroupId The rendering group id corresponding to its index
  97722. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97723. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97724. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97725. */
  97726. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97727. /**
  97728. * Gets the current auto clear configuration for one rendering group of the rendering
  97729. * manager.
  97730. * @param index the rendering group index to get the information for
  97731. * @returns The auto clear setup for the requested rendering group
  97732. */
  97733. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97734. }
  97735. }
  97736. declare module BABYLON {
  97737. /**
  97738. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97739. */
  97740. export interface ICustomShaderOptions {
  97741. /**
  97742. * Gets or sets the custom shader name to use
  97743. */
  97744. shaderName: string;
  97745. /**
  97746. * The list of attribute names used in the shader
  97747. */
  97748. attributes?: string[];
  97749. /**
  97750. * The list of unifrom names used in the shader
  97751. */
  97752. uniforms?: string[];
  97753. /**
  97754. * The list of sampler names used in the shader
  97755. */
  97756. samplers?: string[];
  97757. /**
  97758. * The list of defines used in the shader
  97759. */
  97760. defines?: string[];
  97761. }
  97762. /**
  97763. * Interface to implement to create a shadow generator compatible with BJS.
  97764. */
  97765. export interface IShadowGenerator {
  97766. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97767. id: string;
  97768. /**
  97769. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97770. * @returns The render target texture if present otherwise, null
  97771. */
  97772. getShadowMap(): Nullable<RenderTargetTexture>;
  97773. /**
  97774. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97775. * @param subMesh The submesh we want to render in the shadow map
  97776. * @param useInstances Defines wether will draw in the map using instances
  97777. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97778. * @returns true if ready otherwise, false
  97779. */
  97780. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97781. /**
  97782. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97783. * @param defines Defines of the material we want to update
  97784. * @param lightIndex Index of the light in the enabled light list of the material
  97785. */
  97786. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97787. /**
  97788. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97789. * defined in the generator but impacting the effect).
  97790. * It implies the unifroms available on the materials are the standard BJS ones.
  97791. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97792. * @param effect The effect we are binfing the information for
  97793. */
  97794. bindShadowLight(lightIndex: string, effect: Effect): void;
  97795. /**
  97796. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97797. * (eq to shadow prjection matrix * light transform matrix)
  97798. * @returns The transform matrix used to create the shadow map
  97799. */
  97800. getTransformMatrix(): Matrix;
  97801. /**
  97802. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97803. * Cube and 2D textures for instance.
  97804. */
  97805. recreateShadowMap(): void;
  97806. /**
  97807. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97808. * @param onCompiled Callback triggered at the and of the effects compilation
  97809. * @param options Sets of optional options forcing the compilation with different modes
  97810. */
  97811. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97812. useInstances: boolean;
  97813. }>): void;
  97814. /**
  97815. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97816. * @param options Sets of optional options forcing the compilation with different modes
  97817. * @returns A promise that resolves when the compilation completes
  97818. */
  97819. forceCompilationAsync(options?: Partial<{
  97820. useInstances: boolean;
  97821. }>): Promise<void>;
  97822. /**
  97823. * Serializes the shadow generator setup to a json object.
  97824. * @returns The serialized JSON object
  97825. */
  97826. serialize(): any;
  97827. /**
  97828. * Disposes the Shadow map and related Textures and effects.
  97829. */
  97830. dispose(): void;
  97831. }
  97832. /**
  97833. * Default implementation IShadowGenerator.
  97834. * This is the main object responsible of generating shadows in the framework.
  97835. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97836. */
  97837. export class ShadowGenerator implements IShadowGenerator {
  97838. /**
  97839. * Name of the shadow generator class
  97840. */
  97841. static CLASSNAME: string;
  97842. /**
  97843. * Shadow generator mode None: no filtering applied.
  97844. */
  97845. static readonly FILTER_NONE: number;
  97846. /**
  97847. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97848. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97849. */
  97850. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97851. /**
  97852. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97853. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97854. */
  97855. static readonly FILTER_POISSONSAMPLING: number;
  97856. /**
  97857. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97858. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97859. */
  97860. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97861. /**
  97862. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97863. * edge artifacts on steep falloff.
  97864. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97865. */
  97866. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97867. /**
  97868. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97869. * edge artifacts on steep falloff.
  97870. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97871. */
  97872. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97873. /**
  97874. * Shadow generator mode PCF: Percentage Closer Filtering
  97875. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97876. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97877. */
  97878. static readonly FILTER_PCF: number;
  97879. /**
  97880. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97881. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97882. * Contact Hardening
  97883. */
  97884. static readonly FILTER_PCSS: number;
  97885. /**
  97886. * Reserved for PCF and PCSS
  97887. * Highest Quality.
  97888. *
  97889. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97890. *
  97891. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97892. */
  97893. static readonly QUALITY_HIGH: number;
  97894. /**
  97895. * Reserved for PCF and PCSS
  97896. * Good tradeoff for quality/perf cross devices
  97897. *
  97898. * Execute PCF on a 3*3 kernel.
  97899. *
  97900. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97901. */
  97902. static readonly QUALITY_MEDIUM: number;
  97903. /**
  97904. * Reserved for PCF and PCSS
  97905. * The lowest quality but the fastest.
  97906. *
  97907. * Execute PCF on a 1*1 kernel.
  97908. *
  97909. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97910. */
  97911. static readonly QUALITY_LOW: number;
  97912. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97913. id: string;
  97914. /** Gets or sets the custom shader name to use */
  97915. customShaderOptions: ICustomShaderOptions;
  97916. /**
  97917. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97918. */
  97919. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97920. /**
  97921. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97922. */
  97923. onAfterShadowMapRenderObservable: Observable<Effect>;
  97924. /**
  97925. * Observable triggered before a mesh is rendered in the shadow map.
  97926. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97927. */
  97928. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97929. /**
  97930. * Observable triggered after a mesh is rendered in the shadow map.
  97931. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97932. */
  97933. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97934. protected _bias: number;
  97935. /**
  97936. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97937. */
  97938. get bias(): number;
  97939. /**
  97940. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97941. */
  97942. set bias(bias: number);
  97943. protected _normalBias: number;
  97944. /**
  97945. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97946. */
  97947. get normalBias(): number;
  97948. /**
  97949. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97950. */
  97951. set normalBias(normalBias: number);
  97952. protected _blurBoxOffset: number;
  97953. /**
  97954. * Gets the blur box offset: offset applied during the blur pass.
  97955. * Only useful if useKernelBlur = false
  97956. */
  97957. get blurBoxOffset(): number;
  97958. /**
  97959. * Sets the blur box offset: offset applied during the blur pass.
  97960. * Only useful if useKernelBlur = false
  97961. */
  97962. set blurBoxOffset(value: number);
  97963. protected _blurScale: number;
  97964. /**
  97965. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97966. * 2 means half of the size.
  97967. */
  97968. get blurScale(): number;
  97969. /**
  97970. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97971. * 2 means half of the size.
  97972. */
  97973. set blurScale(value: number);
  97974. protected _blurKernel: number;
  97975. /**
  97976. * Gets the blur kernel: kernel size of the blur pass.
  97977. * Only useful if useKernelBlur = true
  97978. */
  97979. get blurKernel(): number;
  97980. /**
  97981. * Sets the blur kernel: kernel size of the blur pass.
  97982. * Only useful if useKernelBlur = true
  97983. */
  97984. set blurKernel(value: number);
  97985. protected _useKernelBlur: boolean;
  97986. /**
  97987. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97988. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97989. */
  97990. get useKernelBlur(): boolean;
  97991. /**
  97992. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97993. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97994. */
  97995. set useKernelBlur(value: boolean);
  97996. protected _depthScale: number;
  97997. /**
  97998. * Gets the depth scale used in ESM mode.
  97999. */
  98000. get depthScale(): number;
  98001. /**
  98002. * Sets the depth scale used in ESM mode.
  98003. * This can override the scale stored on the light.
  98004. */
  98005. set depthScale(value: number);
  98006. protected _validateFilter(filter: number): number;
  98007. protected _filter: number;
  98008. /**
  98009. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  98010. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  98011. */
  98012. get filter(): number;
  98013. /**
  98014. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  98015. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  98016. */
  98017. set filter(value: number);
  98018. /**
  98019. * Gets if the current filter is set to Poisson Sampling.
  98020. */
  98021. get usePoissonSampling(): boolean;
  98022. /**
  98023. * Sets the current filter to Poisson Sampling.
  98024. */
  98025. set usePoissonSampling(value: boolean);
  98026. /**
  98027. * Gets if the current filter is set to ESM.
  98028. */
  98029. get useExponentialShadowMap(): boolean;
  98030. /**
  98031. * Sets the current filter is to ESM.
  98032. */
  98033. set useExponentialShadowMap(value: boolean);
  98034. /**
  98035. * Gets if the current filter is set to filtered ESM.
  98036. */
  98037. get useBlurExponentialShadowMap(): boolean;
  98038. /**
  98039. * Gets if the current filter is set to filtered ESM.
  98040. */
  98041. set useBlurExponentialShadowMap(value: boolean);
  98042. /**
  98043. * Gets if the current filter is set to "close ESM" (using the inverse of the
  98044. * exponential to prevent steep falloff artifacts).
  98045. */
  98046. get useCloseExponentialShadowMap(): boolean;
  98047. /**
  98048. * Sets the current filter to "close ESM" (using the inverse of the
  98049. * exponential to prevent steep falloff artifacts).
  98050. */
  98051. set useCloseExponentialShadowMap(value: boolean);
  98052. /**
  98053. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  98054. * exponential to prevent steep falloff artifacts).
  98055. */
  98056. get useBlurCloseExponentialShadowMap(): boolean;
  98057. /**
  98058. * Sets the current filter to filtered "close ESM" (using the inverse of the
  98059. * exponential to prevent steep falloff artifacts).
  98060. */
  98061. set useBlurCloseExponentialShadowMap(value: boolean);
  98062. /**
  98063. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  98064. */
  98065. get usePercentageCloserFiltering(): boolean;
  98066. /**
  98067. * Sets the current filter to "PCF" (percentage closer filtering).
  98068. */
  98069. set usePercentageCloserFiltering(value: boolean);
  98070. protected _filteringQuality: number;
  98071. /**
  98072. * Gets the PCF or PCSS Quality.
  98073. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  98074. */
  98075. get filteringQuality(): number;
  98076. /**
  98077. * Sets the PCF or PCSS Quality.
  98078. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  98079. */
  98080. set filteringQuality(filteringQuality: number);
  98081. /**
  98082. * Gets if the current filter is set to "PCSS" (contact hardening).
  98083. */
  98084. get useContactHardeningShadow(): boolean;
  98085. /**
  98086. * Sets the current filter to "PCSS" (contact hardening).
  98087. */
  98088. set useContactHardeningShadow(value: boolean);
  98089. protected _contactHardeningLightSizeUVRatio: number;
  98090. /**
  98091. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  98092. * Using a ratio helps keeping shape stability independently of the map size.
  98093. *
  98094. * It does not account for the light projection as it was having too much
  98095. * instability during the light setup or during light position changes.
  98096. *
  98097. * Only valid if useContactHardeningShadow is true.
  98098. */
  98099. get contactHardeningLightSizeUVRatio(): number;
  98100. /**
  98101. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  98102. * Using a ratio helps keeping shape stability independently of the map size.
  98103. *
  98104. * It does not account for the light projection as it was having too much
  98105. * instability during the light setup or during light position changes.
  98106. *
  98107. * Only valid if useContactHardeningShadow is true.
  98108. */
  98109. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  98110. protected _darkness: number;
  98111. /** Gets or sets the actual darkness of a shadow */
  98112. get darkness(): number;
  98113. set darkness(value: number);
  98114. /**
  98115. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  98116. * 0 means strongest and 1 would means no shadow.
  98117. * @returns the darkness.
  98118. */
  98119. getDarkness(): number;
  98120. /**
  98121. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  98122. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  98123. * @returns the shadow generator allowing fluent coding.
  98124. */
  98125. setDarkness(darkness: number): ShadowGenerator;
  98126. protected _transparencyShadow: boolean;
  98127. /** Gets or sets the ability to have transparent shadow */
  98128. get transparencyShadow(): boolean;
  98129. set transparencyShadow(value: boolean);
  98130. /**
  98131. * Sets the ability to have transparent shadow (boolean).
  98132. * @param transparent True if transparent else False
  98133. * @returns the shadow generator allowing fluent coding
  98134. */
  98135. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  98136. /**
  98137. * Enables or disables shadows with varying strength based on the transparency
  98138. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  98139. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  98140. * mesh.visibility * alphaTexture.a
  98141. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  98142. */
  98143. enableSoftTransparentShadow: boolean;
  98144. protected _shadowMap: Nullable<RenderTargetTexture>;
  98145. protected _shadowMap2: Nullable<RenderTargetTexture>;
  98146. /**
  98147. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  98148. * @returns The render target texture if present otherwise, null
  98149. */
  98150. getShadowMap(): Nullable<RenderTargetTexture>;
  98151. /**
  98152. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  98153. * @returns The render target texture if the shadow map is present otherwise, null
  98154. */
  98155. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  98156. /**
  98157. * Gets the class name of that object
  98158. * @returns "ShadowGenerator"
  98159. */
  98160. getClassName(): string;
  98161. /**
  98162. * Helper function to add a mesh and its descendants to the list of shadow casters.
  98163. * @param mesh Mesh to add
  98164. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  98165. * @returns the Shadow Generator itself
  98166. */
  98167. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  98168. /**
  98169. * Helper function to remove a mesh and its descendants from the list of shadow casters
  98170. * @param mesh Mesh to remove
  98171. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  98172. * @returns the Shadow Generator itself
  98173. */
  98174. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  98175. /**
  98176. * Controls the extent to which the shadows fade out at the edge of the frustum
  98177. */
  98178. frustumEdgeFalloff: number;
  98179. protected _light: IShadowLight;
  98180. /**
  98181. * Returns the associated light object.
  98182. * @returns the light generating the shadow
  98183. */
  98184. getLight(): IShadowLight;
  98185. /**
  98186. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  98187. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  98188. * It might on the other hand introduce peter panning.
  98189. */
  98190. forceBackFacesOnly: boolean;
  98191. protected _scene: Scene;
  98192. protected _lightDirection: Vector3;
  98193. protected _effect: Effect;
  98194. protected _viewMatrix: Matrix;
  98195. protected _projectionMatrix: Matrix;
  98196. protected _transformMatrix: Matrix;
  98197. protected _cachedPosition: Vector3;
  98198. protected _cachedDirection: Vector3;
  98199. protected _cachedDefines: string;
  98200. protected _currentRenderID: number;
  98201. protected _boxBlurPostprocess: Nullable<PostProcess>;
  98202. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  98203. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  98204. protected _blurPostProcesses: PostProcess[];
  98205. protected _mapSize: number;
  98206. protected _currentFaceIndex: number;
  98207. protected _currentFaceIndexCache: number;
  98208. protected _textureType: number;
  98209. protected _defaultTextureMatrix: Matrix;
  98210. protected _storedUniqueId: Nullable<number>;
  98211. /** @hidden */
  98212. static _SceneComponentInitialization: (scene: Scene) => void;
  98213. /**
  98214. * Creates a ShadowGenerator object.
  98215. * A ShadowGenerator is the required tool to use the shadows.
  98216. * Each light casting shadows needs to use its own ShadowGenerator.
  98217. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  98218. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  98219. * @param light The light object generating the shadows.
  98220. * @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.
  98221. */
  98222. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  98223. protected _initializeGenerator(): void;
  98224. protected _createTargetRenderTexture(): void;
  98225. protected _initializeShadowMap(): void;
  98226. protected _initializeBlurRTTAndPostProcesses(): void;
  98227. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  98228. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  98229. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  98230. protected _applyFilterValues(): void;
  98231. /**
  98232. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98233. * @param onCompiled Callback triggered at the and of the effects compilation
  98234. * @param options Sets of optional options forcing the compilation with different modes
  98235. */
  98236. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  98237. useInstances: boolean;
  98238. }>): void;
  98239. /**
  98240. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98241. * @param options Sets of optional options forcing the compilation with different modes
  98242. * @returns A promise that resolves when the compilation completes
  98243. */
  98244. forceCompilationAsync(options?: Partial<{
  98245. useInstances: boolean;
  98246. }>): Promise<void>;
  98247. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  98248. private _prepareShadowDefines;
  98249. /**
  98250. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  98251. * @param subMesh The submesh we want to render in the shadow map
  98252. * @param useInstances Defines wether will draw in the map using instances
  98253. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  98254. * @returns true if ready otherwise, false
  98255. */
  98256. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  98257. /**
  98258. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  98259. * @param defines Defines of the material we want to update
  98260. * @param lightIndex Index of the light in the enabled light list of the material
  98261. */
  98262. prepareDefines(defines: any, lightIndex: number): void;
  98263. /**
  98264. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  98265. * defined in the generator but impacting the effect).
  98266. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  98267. * @param effect The effect we are binfing the information for
  98268. */
  98269. bindShadowLight(lightIndex: string, effect: Effect): void;
  98270. /**
  98271. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  98272. * (eq to shadow prjection matrix * light transform matrix)
  98273. * @returns The transform matrix used to create the shadow map
  98274. */
  98275. getTransformMatrix(): Matrix;
  98276. /**
  98277. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  98278. * Cube and 2D textures for instance.
  98279. */
  98280. recreateShadowMap(): void;
  98281. protected _disposeBlurPostProcesses(): void;
  98282. protected _disposeRTTandPostProcesses(): void;
  98283. /**
  98284. * Disposes the ShadowGenerator.
  98285. * Returns nothing.
  98286. */
  98287. dispose(): void;
  98288. /**
  98289. * Serializes the shadow generator setup to a json object.
  98290. * @returns The serialized JSON object
  98291. */
  98292. serialize(): any;
  98293. /**
  98294. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  98295. * @param parsedShadowGenerator The JSON object to parse
  98296. * @param scene The scene to create the shadow map for
  98297. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  98298. * @returns The parsed shadow generator
  98299. */
  98300. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  98301. }
  98302. }
  98303. declare module BABYLON {
  98304. /**
  98305. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  98306. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  98307. * 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.
  98308. */
  98309. export abstract class Light extends Node {
  98310. /**
  98311. * Falloff Default: light is falling off following the material specification:
  98312. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  98313. */
  98314. static readonly FALLOFF_DEFAULT: number;
  98315. /**
  98316. * Falloff Physical: light is falling off following the inverse squared distance law.
  98317. */
  98318. static readonly FALLOFF_PHYSICAL: number;
  98319. /**
  98320. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  98321. * to enhance interoperability with other engines.
  98322. */
  98323. static readonly FALLOFF_GLTF: number;
  98324. /**
  98325. * Falloff Standard: light is falling off like in the standard material
  98326. * to enhance interoperability with other materials.
  98327. */
  98328. static readonly FALLOFF_STANDARD: number;
  98329. /**
  98330. * If every light affecting the material is in this lightmapMode,
  98331. * material.lightmapTexture adds or multiplies
  98332. * (depends on material.useLightmapAsShadowmap)
  98333. * after every other light calculations.
  98334. */
  98335. static readonly LIGHTMAP_DEFAULT: number;
  98336. /**
  98337. * material.lightmapTexture as only diffuse lighting from this light
  98338. * adds only specular lighting from this light
  98339. * adds dynamic shadows
  98340. */
  98341. static readonly LIGHTMAP_SPECULAR: number;
  98342. /**
  98343. * material.lightmapTexture as only lighting
  98344. * no light calculation from this light
  98345. * only adds dynamic shadows from this light
  98346. */
  98347. static readonly LIGHTMAP_SHADOWSONLY: number;
  98348. /**
  98349. * Each light type uses the default quantity according to its type:
  98350. * point/spot lights use luminous intensity
  98351. * directional lights use illuminance
  98352. */
  98353. static readonly INTENSITYMODE_AUTOMATIC: number;
  98354. /**
  98355. * lumen (lm)
  98356. */
  98357. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  98358. /**
  98359. * candela (lm/sr)
  98360. */
  98361. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  98362. /**
  98363. * lux (lm/m^2)
  98364. */
  98365. static readonly INTENSITYMODE_ILLUMINANCE: number;
  98366. /**
  98367. * nit (cd/m^2)
  98368. */
  98369. static readonly INTENSITYMODE_LUMINANCE: number;
  98370. /**
  98371. * Light type const id of the point light.
  98372. */
  98373. static readonly LIGHTTYPEID_POINTLIGHT: number;
  98374. /**
  98375. * Light type const id of the directional light.
  98376. */
  98377. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  98378. /**
  98379. * Light type const id of the spot light.
  98380. */
  98381. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  98382. /**
  98383. * Light type const id of the hemispheric light.
  98384. */
  98385. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  98386. /**
  98387. * Diffuse gives the basic color to an object.
  98388. */
  98389. diffuse: Color3;
  98390. /**
  98391. * Specular produces a highlight color on an object.
  98392. * Note: This is note affecting PBR materials.
  98393. */
  98394. specular: Color3;
  98395. /**
  98396. * Defines the falloff type for this light. This lets overrriding how punctual light are
  98397. * falling off base on range or angle.
  98398. * This can be set to any values in Light.FALLOFF_x.
  98399. *
  98400. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  98401. * other types of materials.
  98402. */
  98403. falloffType: number;
  98404. /**
  98405. * Strength of the light.
  98406. * Note: By default it is define in the framework own unit.
  98407. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  98408. */
  98409. intensity: number;
  98410. private _range;
  98411. protected _inverseSquaredRange: number;
  98412. /**
  98413. * Defines how far from the source the light is impacting in scene units.
  98414. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  98415. */
  98416. get range(): number;
  98417. /**
  98418. * Defines how far from the source the light is impacting in scene units.
  98419. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  98420. */
  98421. set range(value: number);
  98422. /**
  98423. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  98424. * of light.
  98425. */
  98426. private _photometricScale;
  98427. private _intensityMode;
  98428. /**
  98429. * Gets the photometric scale used to interpret the intensity.
  98430. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  98431. */
  98432. get intensityMode(): number;
  98433. /**
  98434. * Sets the photometric scale used to interpret the intensity.
  98435. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  98436. */
  98437. set intensityMode(value: number);
  98438. private _radius;
  98439. /**
  98440. * Gets the light radius used by PBR Materials to simulate soft area lights.
  98441. */
  98442. get radius(): number;
  98443. /**
  98444. * sets the light radius used by PBR Materials to simulate soft area lights.
  98445. */
  98446. set radius(value: number);
  98447. private _renderPriority;
  98448. /**
  98449. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  98450. * exceeding the number allowed of the materials.
  98451. */
  98452. renderPriority: number;
  98453. private _shadowEnabled;
  98454. /**
  98455. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  98456. * the current shadow generator.
  98457. */
  98458. get shadowEnabled(): boolean;
  98459. /**
  98460. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  98461. * the current shadow generator.
  98462. */
  98463. set shadowEnabled(value: boolean);
  98464. private _includedOnlyMeshes;
  98465. /**
  98466. * Gets the only meshes impacted by this light.
  98467. */
  98468. get includedOnlyMeshes(): AbstractMesh[];
  98469. /**
  98470. * Sets the only meshes impacted by this light.
  98471. */
  98472. set includedOnlyMeshes(value: AbstractMesh[]);
  98473. private _excludedMeshes;
  98474. /**
  98475. * Gets the meshes not impacted by this light.
  98476. */
  98477. get excludedMeshes(): AbstractMesh[];
  98478. /**
  98479. * Sets the meshes not impacted by this light.
  98480. */
  98481. set excludedMeshes(value: AbstractMesh[]);
  98482. private _excludeWithLayerMask;
  98483. /**
  98484. * Gets the layer id use to find what meshes are not impacted by the light.
  98485. * Inactive if 0
  98486. */
  98487. get excludeWithLayerMask(): number;
  98488. /**
  98489. * Sets the layer id use to find what meshes are not impacted by the light.
  98490. * Inactive if 0
  98491. */
  98492. set excludeWithLayerMask(value: number);
  98493. private _includeOnlyWithLayerMask;
  98494. /**
  98495. * Gets the layer id use to find what meshes are impacted by the light.
  98496. * Inactive if 0
  98497. */
  98498. get includeOnlyWithLayerMask(): number;
  98499. /**
  98500. * Sets the layer id use to find what meshes are impacted by the light.
  98501. * Inactive if 0
  98502. */
  98503. set includeOnlyWithLayerMask(value: number);
  98504. private _lightmapMode;
  98505. /**
  98506. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  98507. */
  98508. get lightmapMode(): number;
  98509. /**
  98510. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  98511. */
  98512. set lightmapMode(value: number);
  98513. /**
  98514. * Shadow generator associted to the light.
  98515. * @hidden Internal use only.
  98516. */
  98517. _shadowGenerator: Nullable<IShadowGenerator>;
  98518. /**
  98519. * @hidden Internal use only.
  98520. */
  98521. _excludedMeshesIds: string[];
  98522. /**
  98523. * @hidden Internal use only.
  98524. */
  98525. _includedOnlyMeshesIds: string[];
  98526. /**
  98527. * The current light unifom buffer.
  98528. * @hidden Internal use only.
  98529. */
  98530. _uniformBuffer: UniformBuffer;
  98531. /** @hidden */
  98532. _renderId: number;
  98533. /**
  98534. * Creates a Light object in the scene.
  98535. * Documentation : https://doc.babylonjs.com/babylon101/lights
  98536. * @param name The firendly name of the light
  98537. * @param scene The scene the light belongs too
  98538. */
  98539. constructor(name: string, scene: Scene);
  98540. protected abstract _buildUniformLayout(): void;
  98541. /**
  98542. * Sets the passed Effect "effect" with the Light information.
  98543. * @param effect The effect to update
  98544. * @param lightIndex The index of the light in the effect to update
  98545. * @returns The light
  98546. */
  98547. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  98548. /**
  98549. * Sets the passed Effect "effect" with the Light textures.
  98550. * @param effect The effect to update
  98551. * @param lightIndex The index of the light in the effect to update
  98552. * @returns The light
  98553. */
  98554. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  98555. /**
  98556. * Binds the lights information from the scene to the effect for the given mesh.
  98557. * @param lightIndex Light index
  98558. * @param scene The scene where the light belongs to
  98559. * @param effect The effect we are binding the data to
  98560. * @param useSpecular Defines if specular is supported
  98561. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  98562. */
  98563. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  98564. /**
  98565. * Sets the passed Effect "effect" with the Light information.
  98566. * @param effect The effect to update
  98567. * @param lightDataUniformName The uniform used to store light data (position or direction)
  98568. * @returns The light
  98569. */
  98570. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  98571. /**
  98572. * Returns the string "Light".
  98573. * @returns the class name
  98574. */
  98575. getClassName(): string;
  98576. /** @hidden */
  98577. readonly _isLight: boolean;
  98578. /**
  98579. * Converts the light information to a readable string for debug purpose.
  98580. * @param fullDetails Supports for multiple levels of logging within scene loading
  98581. * @returns the human readable light info
  98582. */
  98583. toString(fullDetails?: boolean): string;
  98584. /** @hidden */
  98585. protected _syncParentEnabledState(): void;
  98586. /**
  98587. * Set the enabled state of this node.
  98588. * @param value - the new enabled state
  98589. */
  98590. setEnabled(value: boolean): void;
  98591. /**
  98592. * Returns the Light associated shadow generator if any.
  98593. * @return the associated shadow generator.
  98594. */
  98595. getShadowGenerator(): Nullable<IShadowGenerator>;
  98596. /**
  98597. * Returns a Vector3, the absolute light position in the World.
  98598. * @returns the world space position of the light
  98599. */
  98600. getAbsolutePosition(): Vector3;
  98601. /**
  98602. * Specifies if the light will affect the passed mesh.
  98603. * @param mesh The mesh to test against the light
  98604. * @return true the mesh is affected otherwise, false.
  98605. */
  98606. canAffectMesh(mesh: AbstractMesh): boolean;
  98607. /**
  98608. * Sort function to order lights for rendering.
  98609. * @param a First Light object to compare to second.
  98610. * @param b Second Light object to compare first.
  98611. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  98612. */
  98613. static CompareLightsPriority(a: Light, b: Light): number;
  98614. /**
  98615. * Releases resources associated with this node.
  98616. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  98617. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  98618. */
  98619. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  98620. /**
  98621. * Returns the light type ID (integer).
  98622. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  98623. */
  98624. getTypeID(): number;
  98625. /**
  98626. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  98627. * @returns the scaled intensity in intensity mode unit
  98628. */
  98629. getScaledIntensity(): number;
  98630. /**
  98631. * Returns a new Light object, named "name", from the current one.
  98632. * @param name The name of the cloned light
  98633. * @param newParent The parent of this light, if it has one
  98634. * @returns the new created light
  98635. */
  98636. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  98637. /**
  98638. * Serializes the current light into a Serialization object.
  98639. * @returns the serialized object.
  98640. */
  98641. serialize(): any;
  98642. /**
  98643. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  98644. * This new light is named "name" and added to the passed scene.
  98645. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  98646. * @param name The friendly name of the light
  98647. * @param scene The scene the new light will belong to
  98648. * @returns the constructor function
  98649. */
  98650. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  98651. /**
  98652. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  98653. * @param parsedLight The JSON representation of the light
  98654. * @param scene The scene to create the parsed light in
  98655. * @returns the created light after parsing
  98656. */
  98657. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  98658. private _hookArrayForExcluded;
  98659. private _hookArrayForIncludedOnly;
  98660. private _resyncMeshes;
  98661. /**
  98662. * Forces the meshes to update their light related information in their rendering used effects
  98663. * @hidden Internal Use Only
  98664. */
  98665. _markMeshesAsLightDirty(): void;
  98666. /**
  98667. * Recomputes the cached photometric scale if needed.
  98668. */
  98669. private _computePhotometricScale;
  98670. /**
  98671. * Returns the Photometric Scale according to the light type and intensity mode.
  98672. */
  98673. private _getPhotometricScale;
  98674. /**
  98675. * Reorder the light in the scene according to their defined priority.
  98676. * @hidden Internal Use Only
  98677. */
  98678. _reorderLightsInScene(): void;
  98679. /**
  98680. * Prepares the list of defines specific to the light type.
  98681. * @param defines the list of defines
  98682. * @param lightIndex defines the index of the light for the effect
  98683. */
  98684. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98685. }
  98686. }
  98687. declare module BABYLON {
  98688. /**
  98689. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  98690. * This is the base of the follow, arc rotate cameras and Free camera
  98691. * @see https://doc.babylonjs.com/features/cameras
  98692. */
  98693. export class TargetCamera extends Camera {
  98694. private static _RigCamTransformMatrix;
  98695. private static _TargetTransformMatrix;
  98696. private static _TargetFocalPoint;
  98697. private _tmpUpVector;
  98698. private _tmpTargetVector;
  98699. /**
  98700. * Define the current direction the camera is moving to
  98701. */
  98702. cameraDirection: Vector3;
  98703. /**
  98704. * Define the current rotation the camera is rotating to
  98705. */
  98706. cameraRotation: Vector2;
  98707. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98708. ignoreParentScaling: boolean;
  98709. /**
  98710. * When set, the up vector of the camera will be updated by the rotation of the camera
  98711. */
  98712. updateUpVectorFromRotation: boolean;
  98713. private _tmpQuaternion;
  98714. /**
  98715. * Define the current rotation of the camera
  98716. */
  98717. rotation: Vector3;
  98718. /**
  98719. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98720. */
  98721. rotationQuaternion: Quaternion;
  98722. /**
  98723. * Define the current speed of the camera
  98724. */
  98725. speed: number;
  98726. /**
  98727. * Add constraint to the camera to prevent it to move freely in all directions and
  98728. * around all axis.
  98729. */
  98730. noRotationConstraint: boolean;
  98731. /**
  98732. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98733. * panning
  98734. */
  98735. invertRotation: boolean;
  98736. /**
  98737. * Speed multiplier for inverse camera panning
  98738. */
  98739. inverseRotationSpeed: number;
  98740. /**
  98741. * Define the current target of the camera as an object or a position.
  98742. */
  98743. lockedTarget: any;
  98744. /** @hidden */
  98745. _currentTarget: Vector3;
  98746. /** @hidden */
  98747. _initialFocalDistance: number;
  98748. /** @hidden */
  98749. _viewMatrix: Matrix;
  98750. /** @hidden */
  98751. _camMatrix: Matrix;
  98752. /** @hidden */
  98753. _cameraTransformMatrix: Matrix;
  98754. /** @hidden */
  98755. _cameraRotationMatrix: Matrix;
  98756. /** @hidden */
  98757. _referencePoint: Vector3;
  98758. /** @hidden */
  98759. _transformedReferencePoint: Vector3;
  98760. /** @hidden */
  98761. _reset: () => void;
  98762. private _defaultUp;
  98763. /**
  98764. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98765. * This is the base of the follow, arc rotate cameras and Free camera
  98766. * @see https://doc.babylonjs.com/features/cameras
  98767. * @param name Defines the name of the camera in the scene
  98768. * @param position Defines the start position of the camera in the scene
  98769. * @param scene Defines the scene the camera belongs to
  98770. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98771. */
  98772. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98773. /**
  98774. * Gets the position in front of the camera at a given distance.
  98775. * @param distance The distance from the camera we want the position to be
  98776. * @returns the position
  98777. */
  98778. getFrontPosition(distance: number): Vector3;
  98779. /** @hidden */
  98780. _getLockedTargetPosition(): Nullable<Vector3>;
  98781. private _storedPosition;
  98782. private _storedRotation;
  98783. private _storedRotationQuaternion;
  98784. /**
  98785. * Store current camera state of the camera (fov, position, rotation, etc..)
  98786. * @returns the camera
  98787. */
  98788. storeState(): Camera;
  98789. /**
  98790. * Restored camera state. You must call storeState() first
  98791. * @returns whether it was successful or not
  98792. * @hidden
  98793. */
  98794. _restoreStateValues(): boolean;
  98795. /** @hidden */
  98796. _initCache(): void;
  98797. /** @hidden */
  98798. _updateCache(ignoreParentClass?: boolean): void;
  98799. /** @hidden */
  98800. _isSynchronizedViewMatrix(): boolean;
  98801. /** @hidden */
  98802. _computeLocalCameraSpeed(): number;
  98803. /**
  98804. * Defines the target the camera should look at.
  98805. * @param target Defines the new target as a Vector or a mesh
  98806. */
  98807. setTarget(target: Vector3): void;
  98808. /**
  98809. * Defines the target point of the camera.
  98810. * The camera looks towards it form the radius distance.
  98811. */
  98812. get target(): Vector3;
  98813. set target(value: Vector3);
  98814. /**
  98815. * Return the current target position of the camera. This value is expressed in local space.
  98816. * @returns the target position
  98817. */
  98818. getTarget(): Vector3;
  98819. /** @hidden */
  98820. _decideIfNeedsToMove(): boolean;
  98821. /** @hidden */
  98822. _updatePosition(): void;
  98823. /** @hidden */
  98824. _checkInputs(): void;
  98825. protected _updateCameraRotationMatrix(): void;
  98826. /**
  98827. * 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)
  98828. * @returns the current camera
  98829. */
  98830. private _rotateUpVectorWithCameraRotationMatrix;
  98831. private _cachedRotationZ;
  98832. private _cachedQuaternionRotationZ;
  98833. /** @hidden */
  98834. _getViewMatrix(): Matrix;
  98835. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98836. /**
  98837. * @hidden
  98838. */
  98839. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98840. /**
  98841. * @hidden
  98842. */
  98843. _updateRigCameras(): void;
  98844. private _getRigCamPositionAndTarget;
  98845. /**
  98846. * Gets the current object class name.
  98847. * @return the class name
  98848. */
  98849. getClassName(): string;
  98850. }
  98851. }
  98852. declare module BABYLON {
  98853. /**
  98854. * Gather the list of keyboard event types as constants.
  98855. */
  98856. export class KeyboardEventTypes {
  98857. /**
  98858. * The keydown event is fired when a key becomes active (pressed).
  98859. */
  98860. static readonly KEYDOWN: number;
  98861. /**
  98862. * The keyup event is fired when a key has been released.
  98863. */
  98864. static readonly KEYUP: number;
  98865. }
  98866. /**
  98867. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98868. */
  98869. export class KeyboardInfo {
  98870. /**
  98871. * Defines the type of event (KeyboardEventTypes)
  98872. */
  98873. type: number;
  98874. /**
  98875. * Defines the related dom event
  98876. */
  98877. event: KeyboardEvent;
  98878. /**
  98879. * Instantiates a new keyboard info.
  98880. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98881. * @param type Defines the type of event (KeyboardEventTypes)
  98882. * @param event Defines the related dom event
  98883. */
  98884. constructor(
  98885. /**
  98886. * Defines the type of event (KeyboardEventTypes)
  98887. */
  98888. type: number,
  98889. /**
  98890. * Defines the related dom event
  98891. */
  98892. event: KeyboardEvent);
  98893. }
  98894. /**
  98895. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98896. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98897. */
  98898. export class KeyboardInfoPre extends KeyboardInfo {
  98899. /**
  98900. * Defines the type of event (KeyboardEventTypes)
  98901. */
  98902. type: number;
  98903. /**
  98904. * Defines the related dom event
  98905. */
  98906. event: KeyboardEvent;
  98907. /**
  98908. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98909. */
  98910. skipOnPointerObservable: boolean;
  98911. /**
  98912. * Instantiates a new keyboard pre info.
  98913. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98914. * @param type Defines the type of event (KeyboardEventTypes)
  98915. * @param event Defines the related dom event
  98916. */
  98917. constructor(
  98918. /**
  98919. * Defines the type of event (KeyboardEventTypes)
  98920. */
  98921. type: number,
  98922. /**
  98923. * Defines the related dom event
  98924. */
  98925. event: KeyboardEvent);
  98926. }
  98927. }
  98928. declare module BABYLON {
  98929. /**
  98930. * Manage the keyboard inputs to control the movement of a free camera.
  98931. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98932. */
  98933. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98934. /**
  98935. * Defines the camera the input is attached to.
  98936. */
  98937. camera: FreeCamera;
  98938. /**
  98939. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98940. */
  98941. keysUp: number[];
  98942. /**
  98943. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98944. */
  98945. keysUpward: number[];
  98946. /**
  98947. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98948. */
  98949. keysDown: number[];
  98950. /**
  98951. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98952. */
  98953. keysDownward: number[];
  98954. /**
  98955. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98956. */
  98957. keysLeft: number[];
  98958. /**
  98959. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98960. */
  98961. keysRight: number[];
  98962. private _keys;
  98963. private _onCanvasBlurObserver;
  98964. private _onKeyboardObserver;
  98965. private _engine;
  98966. private _scene;
  98967. /**
  98968. * Attach the input controls to a specific dom element to get the input from.
  98969. * @param element Defines the element the controls should be listened from
  98970. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98971. */
  98972. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98973. /**
  98974. * Detach the current controls from the specified dom element.
  98975. * @param element Defines the element to stop listening the inputs from
  98976. */
  98977. detachControl(element: Nullable<HTMLElement>): void;
  98978. /**
  98979. * Update the current camera state depending on the inputs that have been used this frame.
  98980. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98981. */
  98982. checkInputs(): void;
  98983. /**
  98984. * Gets the class name of the current intput.
  98985. * @returns the class name
  98986. */
  98987. getClassName(): string;
  98988. /** @hidden */
  98989. _onLostFocus(): void;
  98990. /**
  98991. * Get the friendly name associated with the input class.
  98992. * @returns the input friendly name
  98993. */
  98994. getSimpleName(): string;
  98995. }
  98996. }
  98997. declare module BABYLON {
  98998. /**
  98999. * Gather the list of pointer event types as constants.
  99000. */
  99001. export class PointerEventTypes {
  99002. /**
  99003. * 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.
  99004. */
  99005. static readonly POINTERDOWN: number;
  99006. /**
  99007. * The pointerup event is fired when a pointer is no longer active.
  99008. */
  99009. static readonly POINTERUP: number;
  99010. /**
  99011. * The pointermove event is fired when a pointer changes coordinates.
  99012. */
  99013. static readonly POINTERMOVE: number;
  99014. /**
  99015. * The pointerwheel event is fired when a mouse wheel has been rotated.
  99016. */
  99017. static readonly POINTERWHEEL: number;
  99018. /**
  99019. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  99020. */
  99021. static readonly POINTERPICK: number;
  99022. /**
  99023. * The pointertap event is fired when a the object has been touched and released without drag.
  99024. */
  99025. static readonly POINTERTAP: number;
  99026. /**
  99027. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  99028. */
  99029. static readonly POINTERDOUBLETAP: number;
  99030. }
  99031. /**
  99032. * Base class of pointer info types.
  99033. */
  99034. export class PointerInfoBase {
  99035. /**
  99036. * Defines the type of event (PointerEventTypes)
  99037. */
  99038. type: number;
  99039. /**
  99040. * Defines the related dom event
  99041. */
  99042. event: PointerEvent | MouseWheelEvent;
  99043. /**
  99044. * Instantiates the base class of pointers info.
  99045. * @param type Defines the type of event (PointerEventTypes)
  99046. * @param event Defines the related dom event
  99047. */
  99048. constructor(
  99049. /**
  99050. * Defines the type of event (PointerEventTypes)
  99051. */
  99052. type: number,
  99053. /**
  99054. * Defines the related dom event
  99055. */
  99056. event: PointerEvent | MouseWheelEvent);
  99057. }
  99058. /**
  99059. * This class is used to store pointer related info for the onPrePointerObservable event.
  99060. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  99061. */
  99062. export class PointerInfoPre extends PointerInfoBase {
  99063. /**
  99064. * Ray from a pointer if availible (eg. 6dof controller)
  99065. */
  99066. ray: Nullable<Ray>;
  99067. /**
  99068. * Defines the local position of the pointer on the canvas.
  99069. */
  99070. localPosition: Vector2;
  99071. /**
  99072. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  99073. */
  99074. skipOnPointerObservable: boolean;
  99075. /**
  99076. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  99077. * @param type Defines the type of event (PointerEventTypes)
  99078. * @param event Defines the related dom event
  99079. * @param localX Defines the local x coordinates of the pointer when the event occured
  99080. * @param localY Defines the local y coordinates of the pointer when the event occured
  99081. */
  99082. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  99083. }
  99084. /**
  99085. * This type contains all the data related to a pointer event in Babylon.js.
  99086. * 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.
  99087. */
  99088. export class PointerInfo extends PointerInfoBase {
  99089. /**
  99090. * Defines the picking info associated to the info (if any)\
  99091. */
  99092. pickInfo: Nullable<PickingInfo>;
  99093. /**
  99094. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  99095. * @param type Defines the type of event (PointerEventTypes)
  99096. * @param event Defines the related dom event
  99097. * @param pickInfo Defines the picking info associated to the info (if any)\
  99098. */
  99099. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  99100. /**
  99101. * Defines the picking info associated to the info (if any)\
  99102. */
  99103. pickInfo: Nullable<PickingInfo>);
  99104. }
  99105. /**
  99106. * Data relating to a touch event on the screen.
  99107. */
  99108. export interface PointerTouch {
  99109. /**
  99110. * X coordinate of touch.
  99111. */
  99112. x: number;
  99113. /**
  99114. * Y coordinate of touch.
  99115. */
  99116. y: number;
  99117. /**
  99118. * Id of touch. Unique for each finger.
  99119. */
  99120. pointerId: number;
  99121. /**
  99122. * Event type passed from DOM.
  99123. */
  99124. type: any;
  99125. }
  99126. }
  99127. declare module BABYLON {
  99128. /**
  99129. * Manage the mouse inputs to control the movement of a free camera.
  99130. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99131. */
  99132. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  99133. /**
  99134. * Define if touch is enabled in the mouse input
  99135. */
  99136. touchEnabled: boolean;
  99137. /**
  99138. * Defines the camera the input is attached to.
  99139. */
  99140. camera: FreeCamera;
  99141. /**
  99142. * Defines the buttons associated with the input to handle camera move.
  99143. */
  99144. buttons: number[];
  99145. /**
  99146. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  99147. */
  99148. angularSensibility: number;
  99149. private _pointerInput;
  99150. private _onMouseMove;
  99151. private _observer;
  99152. private previousPosition;
  99153. /**
  99154. * Observable for when a pointer move event occurs containing the move offset
  99155. */
  99156. onPointerMovedObservable: Observable<{
  99157. offsetX: number;
  99158. offsetY: number;
  99159. }>;
  99160. /**
  99161. * @hidden
  99162. * If the camera should be rotated automatically based on pointer movement
  99163. */
  99164. _allowCameraRotation: boolean;
  99165. /**
  99166. * Manage the mouse inputs to control the movement of a free camera.
  99167. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99168. * @param touchEnabled Defines if touch is enabled or not
  99169. */
  99170. constructor(
  99171. /**
  99172. * Define if touch is enabled in the mouse input
  99173. */
  99174. touchEnabled?: boolean);
  99175. /**
  99176. * Attach the input controls to a specific dom element to get the input from.
  99177. * @param element Defines the element the controls should be listened from
  99178. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99179. */
  99180. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99181. /**
  99182. * Called on JS contextmenu event.
  99183. * Override this method to provide functionality.
  99184. */
  99185. protected onContextMenu(evt: PointerEvent): void;
  99186. /**
  99187. * Detach the current controls from the specified dom element.
  99188. * @param element Defines the element to stop listening the inputs from
  99189. */
  99190. detachControl(element: Nullable<HTMLElement>): void;
  99191. /**
  99192. * Gets the class name of the current intput.
  99193. * @returns the class name
  99194. */
  99195. getClassName(): string;
  99196. /**
  99197. * Get the friendly name associated with the input class.
  99198. * @returns the input friendly name
  99199. */
  99200. getSimpleName(): string;
  99201. }
  99202. }
  99203. declare module BABYLON {
  99204. /**
  99205. * Manage the touch inputs to control the movement of a free camera.
  99206. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99207. */
  99208. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  99209. /**
  99210. * Define if mouse events can be treated as touch events
  99211. */
  99212. allowMouse: boolean;
  99213. /**
  99214. * Defines the camera the input is attached to.
  99215. */
  99216. camera: FreeCamera;
  99217. /**
  99218. * Defines the touch sensibility for rotation.
  99219. * The higher the faster.
  99220. */
  99221. touchAngularSensibility: number;
  99222. /**
  99223. * Defines the touch sensibility for move.
  99224. * The higher the faster.
  99225. */
  99226. touchMoveSensibility: number;
  99227. private _offsetX;
  99228. private _offsetY;
  99229. private _pointerPressed;
  99230. private _pointerInput;
  99231. private _observer;
  99232. private _onLostFocus;
  99233. /**
  99234. * Manage the touch inputs to control the movement of a free camera.
  99235. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99236. * @param allowMouse Defines if mouse events can be treated as touch events
  99237. */
  99238. constructor(
  99239. /**
  99240. * Define if mouse events can be treated as touch events
  99241. */
  99242. allowMouse?: boolean);
  99243. /**
  99244. * Attach the input controls to a specific dom element to get the input from.
  99245. * @param element Defines the element the controls should be listened from
  99246. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99247. */
  99248. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99249. /**
  99250. * Detach the current controls from the specified dom element.
  99251. * @param element Defines the element to stop listening the inputs from
  99252. */
  99253. detachControl(element: Nullable<HTMLElement>): void;
  99254. /**
  99255. * Update the current camera state depending on the inputs that have been used this frame.
  99256. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  99257. */
  99258. checkInputs(): void;
  99259. /**
  99260. * Gets the class name of the current intput.
  99261. * @returns the class name
  99262. */
  99263. getClassName(): string;
  99264. /**
  99265. * Get the friendly name associated with the input class.
  99266. * @returns the input friendly name
  99267. */
  99268. getSimpleName(): string;
  99269. }
  99270. }
  99271. declare module BABYLON {
  99272. /**
  99273. * Default Inputs manager for the FreeCamera.
  99274. * It groups all the default supported inputs for ease of use.
  99275. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99276. */
  99277. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  99278. /**
  99279. * @hidden
  99280. */
  99281. _mouseInput: Nullable<FreeCameraMouseInput>;
  99282. /**
  99283. * Instantiates a new FreeCameraInputsManager.
  99284. * @param camera Defines the camera the inputs belong to
  99285. */
  99286. constructor(camera: FreeCamera);
  99287. /**
  99288. * Add keyboard input support to the input manager.
  99289. * @returns the current input manager
  99290. */
  99291. addKeyboard(): FreeCameraInputsManager;
  99292. /**
  99293. * Add mouse input support to the input manager.
  99294. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  99295. * @returns the current input manager
  99296. */
  99297. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  99298. /**
  99299. * Removes the mouse input support from the manager
  99300. * @returns the current input manager
  99301. */
  99302. removeMouse(): FreeCameraInputsManager;
  99303. /**
  99304. * Add touch input support to the input manager.
  99305. * @returns the current input manager
  99306. */
  99307. addTouch(): FreeCameraInputsManager;
  99308. /**
  99309. * Remove all attached input methods from a camera
  99310. */
  99311. clear(): void;
  99312. }
  99313. }
  99314. declare module BABYLON {
  99315. /**
  99316. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  99317. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  99318. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  99319. */
  99320. export class FreeCamera extends TargetCamera {
  99321. /**
  99322. * Define the collision ellipsoid of the camera.
  99323. * This is helpful to simulate a camera body like the player body around the camera
  99324. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  99325. */
  99326. ellipsoid: Vector3;
  99327. /**
  99328. * Define an offset for the position of the ellipsoid around the camera.
  99329. * This can be helpful to determine the center of the body near the gravity center of the body
  99330. * instead of its head.
  99331. */
  99332. ellipsoidOffset: Vector3;
  99333. /**
  99334. * Enable or disable collisions of the camera with the rest of the scene objects.
  99335. */
  99336. checkCollisions: boolean;
  99337. /**
  99338. * Enable or disable gravity on the camera.
  99339. */
  99340. applyGravity: boolean;
  99341. /**
  99342. * Define the input manager associated to the camera.
  99343. */
  99344. inputs: FreeCameraInputsManager;
  99345. /**
  99346. * Gets the input sensibility for a mouse input. (default is 2000.0)
  99347. * Higher values reduce sensitivity.
  99348. */
  99349. get angularSensibility(): number;
  99350. /**
  99351. * Sets the input sensibility for a mouse input. (default is 2000.0)
  99352. * Higher values reduce sensitivity.
  99353. */
  99354. set angularSensibility(value: number);
  99355. /**
  99356. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  99357. */
  99358. get keysUp(): number[];
  99359. set keysUp(value: number[]);
  99360. /**
  99361. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  99362. */
  99363. get keysUpward(): number[];
  99364. set keysUpward(value: number[]);
  99365. /**
  99366. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  99367. */
  99368. get keysDown(): number[];
  99369. set keysDown(value: number[]);
  99370. /**
  99371. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  99372. */
  99373. get keysDownward(): number[];
  99374. set keysDownward(value: number[]);
  99375. /**
  99376. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  99377. */
  99378. get keysLeft(): number[];
  99379. set keysLeft(value: number[]);
  99380. /**
  99381. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  99382. */
  99383. get keysRight(): number[];
  99384. set keysRight(value: number[]);
  99385. /**
  99386. * Event raised when the camera collide with a mesh in the scene.
  99387. */
  99388. onCollide: (collidedMesh: AbstractMesh) => void;
  99389. private _collider;
  99390. private _needMoveForGravity;
  99391. private _oldPosition;
  99392. private _diffPosition;
  99393. private _newPosition;
  99394. /** @hidden */
  99395. _localDirection: Vector3;
  99396. /** @hidden */
  99397. _transformedDirection: Vector3;
  99398. /**
  99399. * Instantiates a Free Camera.
  99400. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  99401. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  99402. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  99403. * @param name Define the name of the camera in the scene
  99404. * @param position Define the start position of the camera in the scene
  99405. * @param scene Define the scene the camera belongs to
  99406. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  99407. */
  99408. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  99409. /**
  99410. * Attached controls to the current camera.
  99411. * @param element Defines the element the controls should be listened from
  99412. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99413. */
  99414. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99415. /**
  99416. * Detach the current controls from the camera.
  99417. * The camera will stop reacting to inputs.
  99418. * @param element Defines the element to stop listening the inputs from
  99419. */
  99420. detachControl(element: HTMLElement): void;
  99421. private _collisionMask;
  99422. /**
  99423. * Define a collision mask to limit the list of object the camera can collide with
  99424. */
  99425. get collisionMask(): number;
  99426. set collisionMask(mask: number);
  99427. /** @hidden */
  99428. _collideWithWorld(displacement: Vector3): void;
  99429. private _onCollisionPositionChange;
  99430. /** @hidden */
  99431. _checkInputs(): void;
  99432. /** @hidden */
  99433. _decideIfNeedsToMove(): boolean;
  99434. /** @hidden */
  99435. _updatePosition(): void;
  99436. /**
  99437. * Destroy the camera and release the current resources hold by it.
  99438. */
  99439. dispose(): void;
  99440. /**
  99441. * Gets the current object class name.
  99442. * @return the class name
  99443. */
  99444. getClassName(): string;
  99445. }
  99446. }
  99447. declare module BABYLON {
  99448. /**
  99449. * Represents a gamepad control stick position
  99450. */
  99451. export class StickValues {
  99452. /**
  99453. * The x component of the control stick
  99454. */
  99455. x: number;
  99456. /**
  99457. * The y component of the control stick
  99458. */
  99459. y: number;
  99460. /**
  99461. * Initializes the gamepad x and y control stick values
  99462. * @param x The x component of the gamepad control stick value
  99463. * @param y The y component of the gamepad control stick value
  99464. */
  99465. constructor(
  99466. /**
  99467. * The x component of the control stick
  99468. */
  99469. x: number,
  99470. /**
  99471. * The y component of the control stick
  99472. */
  99473. y: number);
  99474. }
  99475. /**
  99476. * An interface which manages callbacks for gamepad button changes
  99477. */
  99478. export interface GamepadButtonChanges {
  99479. /**
  99480. * Called when a gamepad has been changed
  99481. */
  99482. changed: boolean;
  99483. /**
  99484. * Called when a gamepad press event has been triggered
  99485. */
  99486. pressChanged: boolean;
  99487. /**
  99488. * Called when a touch event has been triggered
  99489. */
  99490. touchChanged: boolean;
  99491. /**
  99492. * Called when a value has changed
  99493. */
  99494. valueChanged: boolean;
  99495. }
  99496. /**
  99497. * Represents a gamepad
  99498. */
  99499. export class Gamepad {
  99500. /**
  99501. * The id of the gamepad
  99502. */
  99503. id: string;
  99504. /**
  99505. * The index of the gamepad
  99506. */
  99507. index: number;
  99508. /**
  99509. * The browser gamepad
  99510. */
  99511. browserGamepad: any;
  99512. /**
  99513. * Specifies what type of gamepad this represents
  99514. */
  99515. type: number;
  99516. private _leftStick;
  99517. private _rightStick;
  99518. /** @hidden */
  99519. _isConnected: boolean;
  99520. private _leftStickAxisX;
  99521. private _leftStickAxisY;
  99522. private _rightStickAxisX;
  99523. private _rightStickAxisY;
  99524. /**
  99525. * Triggered when the left control stick has been changed
  99526. */
  99527. private _onleftstickchanged;
  99528. /**
  99529. * Triggered when the right control stick has been changed
  99530. */
  99531. private _onrightstickchanged;
  99532. /**
  99533. * Represents a gamepad controller
  99534. */
  99535. static GAMEPAD: number;
  99536. /**
  99537. * Represents a generic controller
  99538. */
  99539. static GENERIC: number;
  99540. /**
  99541. * Represents an XBox controller
  99542. */
  99543. static XBOX: number;
  99544. /**
  99545. * Represents a pose-enabled controller
  99546. */
  99547. static POSE_ENABLED: number;
  99548. /**
  99549. * Represents an Dual Shock controller
  99550. */
  99551. static DUALSHOCK: number;
  99552. /**
  99553. * Specifies whether the left control stick should be Y-inverted
  99554. */
  99555. protected _invertLeftStickY: boolean;
  99556. /**
  99557. * Specifies if the gamepad has been connected
  99558. */
  99559. get isConnected(): boolean;
  99560. /**
  99561. * Initializes the gamepad
  99562. * @param id The id of the gamepad
  99563. * @param index The index of the gamepad
  99564. * @param browserGamepad The browser gamepad
  99565. * @param leftStickX The x component of the left joystick
  99566. * @param leftStickY The y component of the left joystick
  99567. * @param rightStickX The x component of the right joystick
  99568. * @param rightStickY The y component of the right joystick
  99569. */
  99570. constructor(
  99571. /**
  99572. * The id of the gamepad
  99573. */
  99574. id: string,
  99575. /**
  99576. * The index of the gamepad
  99577. */
  99578. index: number,
  99579. /**
  99580. * The browser gamepad
  99581. */
  99582. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  99583. /**
  99584. * Callback triggered when the left joystick has changed
  99585. * @param callback
  99586. */
  99587. onleftstickchanged(callback: (values: StickValues) => void): void;
  99588. /**
  99589. * Callback triggered when the right joystick has changed
  99590. * @param callback
  99591. */
  99592. onrightstickchanged(callback: (values: StickValues) => void): void;
  99593. /**
  99594. * Gets the left joystick
  99595. */
  99596. get leftStick(): StickValues;
  99597. /**
  99598. * Sets the left joystick values
  99599. */
  99600. set leftStick(newValues: StickValues);
  99601. /**
  99602. * Gets the right joystick
  99603. */
  99604. get rightStick(): StickValues;
  99605. /**
  99606. * Sets the right joystick value
  99607. */
  99608. set rightStick(newValues: StickValues);
  99609. /**
  99610. * Updates the gamepad joystick positions
  99611. */
  99612. update(): void;
  99613. /**
  99614. * Disposes the gamepad
  99615. */
  99616. dispose(): void;
  99617. }
  99618. /**
  99619. * Represents a generic gamepad
  99620. */
  99621. export class GenericPad extends Gamepad {
  99622. private _buttons;
  99623. private _onbuttondown;
  99624. private _onbuttonup;
  99625. /**
  99626. * Observable triggered when a button has been pressed
  99627. */
  99628. onButtonDownObservable: Observable<number>;
  99629. /**
  99630. * Observable triggered when a button has been released
  99631. */
  99632. onButtonUpObservable: Observable<number>;
  99633. /**
  99634. * Callback triggered when a button has been pressed
  99635. * @param callback Called when a button has been pressed
  99636. */
  99637. onbuttondown(callback: (buttonPressed: number) => void): void;
  99638. /**
  99639. * Callback triggered when a button has been released
  99640. * @param callback Called when a button has been released
  99641. */
  99642. onbuttonup(callback: (buttonReleased: number) => void): void;
  99643. /**
  99644. * Initializes the generic gamepad
  99645. * @param id The id of the generic gamepad
  99646. * @param index The index of the generic gamepad
  99647. * @param browserGamepad The browser gamepad
  99648. */
  99649. constructor(id: string, index: number, browserGamepad: any);
  99650. private _setButtonValue;
  99651. /**
  99652. * Updates the generic gamepad
  99653. */
  99654. update(): void;
  99655. /**
  99656. * Disposes the generic gamepad
  99657. */
  99658. dispose(): void;
  99659. }
  99660. }
  99661. declare module BABYLON {
  99662. /**
  99663. * Defines the types of pose enabled controllers that are supported
  99664. */
  99665. export enum PoseEnabledControllerType {
  99666. /**
  99667. * HTC Vive
  99668. */
  99669. VIVE = 0,
  99670. /**
  99671. * Oculus Rift
  99672. */
  99673. OCULUS = 1,
  99674. /**
  99675. * Windows mixed reality
  99676. */
  99677. WINDOWS = 2,
  99678. /**
  99679. * Samsung gear VR
  99680. */
  99681. GEAR_VR = 3,
  99682. /**
  99683. * Google Daydream
  99684. */
  99685. DAYDREAM = 4,
  99686. /**
  99687. * Generic
  99688. */
  99689. GENERIC = 5
  99690. }
  99691. /**
  99692. * Defines the MutableGamepadButton interface for the state of a gamepad button
  99693. */
  99694. export interface MutableGamepadButton {
  99695. /**
  99696. * Value of the button/trigger
  99697. */
  99698. value: number;
  99699. /**
  99700. * If the button/trigger is currently touched
  99701. */
  99702. touched: boolean;
  99703. /**
  99704. * If the button/trigger is currently pressed
  99705. */
  99706. pressed: boolean;
  99707. }
  99708. /**
  99709. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99710. * @hidden
  99711. */
  99712. export interface ExtendedGamepadButton extends GamepadButton {
  99713. /**
  99714. * If the button/trigger is currently pressed
  99715. */
  99716. readonly pressed: boolean;
  99717. /**
  99718. * If the button/trigger is currently touched
  99719. */
  99720. readonly touched: boolean;
  99721. /**
  99722. * Value of the button/trigger
  99723. */
  99724. readonly value: number;
  99725. }
  99726. /** @hidden */
  99727. export interface _GamePadFactory {
  99728. /**
  99729. * Returns whether or not the current gamepad can be created for this type of controller.
  99730. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99731. * @returns true if it can be created, otherwise false
  99732. */
  99733. canCreate(gamepadInfo: any): boolean;
  99734. /**
  99735. * Creates a new instance of the Gamepad.
  99736. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99737. * @returns the new gamepad instance
  99738. */
  99739. create(gamepadInfo: any): Gamepad;
  99740. }
  99741. /**
  99742. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99743. */
  99744. export class PoseEnabledControllerHelper {
  99745. /** @hidden */
  99746. static _ControllerFactories: _GamePadFactory[];
  99747. /** @hidden */
  99748. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99749. /**
  99750. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99751. * @param vrGamepad the gamepad to initialized
  99752. * @returns a vr controller of the type the gamepad identified as
  99753. */
  99754. static InitiateController(vrGamepad: any): Gamepad;
  99755. }
  99756. /**
  99757. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99758. */
  99759. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99760. /**
  99761. * If the controller is used in a webXR session
  99762. */
  99763. isXR: boolean;
  99764. private _deviceRoomPosition;
  99765. private _deviceRoomRotationQuaternion;
  99766. /**
  99767. * The device position in babylon space
  99768. */
  99769. devicePosition: Vector3;
  99770. /**
  99771. * The device rotation in babylon space
  99772. */
  99773. deviceRotationQuaternion: Quaternion;
  99774. /**
  99775. * The scale factor of the device in babylon space
  99776. */
  99777. deviceScaleFactor: number;
  99778. /**
  99779. * (Likely devicePosition should be used instead) The device position in its room space
  99780. */
  99781. position: Vector3;
  99782. /**
  99783. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99784. */
  99785. rotationQuaternion: Quaternion;
  99786. /**
  99787. * The type of controller (Eg. Windows mixed reality)
  99788. */
  99789. controllerType: PoseEnabledControllerType;
  99790. protected _calculatedPosition: Vector3;
  99791. private _calculatedRotation;
  99792. /**
  99793. * The raw pose from the device
  99794. */
  99795. rawPose: DevicePose;
  99796. private _trackPosition;
  99797. private _maxRotationDistFromHeadset;
  99798. private _draggedRoomRotation;
  99799. /**
  99800. * @hidden
  99801. */
  99802. _disableTrackPosition(fixedPosition: Vector3): void;
  99803. /**
  99804. * Internal, the mesh attached to the controller
  99805. * @hidden
  99806. */
  99807. _mesh: Nullable<AbstractMesh>;
  99808. private _poseControlledCamera;
  99809. private _leftHandSystemQuaternion;
  99810. /**
  99811. * Internal, matrix used to convert room space to babylon space
  99812. * @hidden
  99813. */
  99814. _deviceToWorld: Matrix;
  99815. /**
  99816. * Node to be used when casting a ray from the controller
  99817. * @hidden
  99818. */
  99819. _pointingPoseNode: Nullable<TransformNode>;
  99820. /**
  99821. * Name of the child mesh that can be used to cast a ray from the controller
  99822. */
  99823. static readonly POINTING_POSE: string;
  99824. /**
  99825. * Creates a new PoseEnabledController from a gamepad
  99826. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99827. */
  99828. constructor(browserGamepad: any);
  99829. private _workingMatrix;
  99830. /**
  99831. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99832. */
  99833. update(): void;
  99834. /**
  99835. * Updates only the pose device and mesh without doing any button event checking
  99836. */
  99837. protected _updatePoseAndMesh(): void;
  99838. /**
  99839. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99840. * @param poseData raw pose fromthe device
  99841. */
  99842. updateFromDevice(poseData: DevicePose): void;
  99843. /**
  99844. * @hidden
  99845. */
  99846. _meshAttachedObservable: Observable<AbstractMesh>;
  99847. /**
  99848. * Attaches a mesh to the controller
  99849. * @param mesh the mesh to be attached
  99850. */
  99851. attachToMesh(mesh: AbstractMesh): void;
  99852. /**
  99853. * Attaches the controllers mesh to a camera
  99854. * @param camera the camera the mesh should be attached to
  99855. */
  99856. attachToPoseControlledCamera(camera: TargetCamera): void;
  99857. /**
  99858. * Disposes of the controller
  99859. */
  99860. dispose(): void;
  99861. /**
  99862. * The mesh that is attached to the controller
  99863. */
  99864. get mesh(): Nullable<AbstractMesh>;
  99865. /**
  99866. * Gets the ray of the controller in the direction the controller is pointing
  99867. * @param length the length the resulting ray should be
  99868. * @returns a ray in the direction the controller is pointing
  99869. */
  99870. getForwardRay(length?: number): Ray;
  99871. }
  99872. }
  99873. declare module BABYLON {
  99874. /**
  99875. * Defines the WebVRController object that represents controllers tracked in 3D space
  99876. */
  99877. export abstract class WebVRController extends PoseEnabledController {
  99878. /**
  99879. * Internal, the default controller model for the controller
  99880. */
  99881. protected _defaultModel: Nullable<AbstractMesh>;
  99882. /**
  99883. * Fired when the trigger state has changed
  99884. */
  99885. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99886. /**
  99887. * Fired when the main button state has changed
  99888. */
  99889. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99890. /**
  99891. * Fired when the secondary button state has changed
  99892. */
  99893. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99894. /**
  99895. * Fired when the pad state has changed
  99896. */
  99897. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99898. /**
  99899. * Fired when controllers stick values have changed
  99900. */
  99901. onPadValuesChangedObservable: Observable<StickValues>;
  99902. /**
  99903. * Array of button availible on the controller
  99904. */
  99905. protected _buttons: Array<MutableGamepadButton>;
  99906. private _onButtonStateChange;
  99907. /**
  99908. * Fired when a controller button's state has changed
  99909. * @param callback the callback containing the button that was modified
  99910. */
  99911. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99912. /**
  99913. * X and Y axis corresponding to the controllers joystick
  99914. */
  99915. pad: StickValues;
  99916. /**
  99917. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99918. */
  99919. hand: string;
  99920. /**
  99921. * The default controller model for the controller
  99922. */
  99923. get defaultModel(): Nullable<AbstractMesh>;
  99924. /**
  99925. * Creates a new WebVRController from a gamepad
  99926. * @param vrGamepad the gamepad that the WebVRController should be created from
  99927. */
  99928. constructor(vrGamepad: any);
  99929. /**
  99930. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99931. */
  99932. update(): void;
  99933. /**
  99934. * Function to be called when a button is modified
  99935. */
  99936. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99937. /**
  99938. * Loads a mesh and attaches it to the controller
  99939. * @param scene the scene the mesh should be added to
  99940. * @param meshLoaded callback for when the mesh has been loaded
  99941. */
  99942. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99943. private _setButtonValue;
  99944. private _changes;
  99945. private _checkChanges;
  99946. /**
  99947. * Disposes of th webVRCOntroller
  99948. */
  99949. dispose(): void;
  99950. }
  99951. }
  99952. declare module BABYLON {
  99953. /**
  99954. * The HemisphericLight simulates the ambient environment light,
  99955. * so the passed direction is the light reflection direction, not the incoming direction.
  99956. */
  99957. export class HemisphericLight extends Light {
  99958. /**
  99959. * The groundColor is the light in the opposite direction to the one specified during creation.
  99960. * 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.
  99961. */
  99962. groundColor: Color3;
  99963. /**
  99964. * The light reflection direction, not the incoming direction.
  99965. */
  99966. direction: Vector3;
  99967. /**
  99968. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99969. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99970. * The HemisphericLight can't cast shadows.
  99971. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99972. * @param name The friendly name of the light
  99973. * @param direction The direction of the light reflection
  99974. * @param scene The scene the light belongs to
  99975. */
  99976. constructor(name: string, direction: Vector3, scene: Scene);
  99977. protected _buildUniformLayout(): void;
  99978. /**
  99979. * Returns the string "HemisphericLight".
  99980. * @return The class name
  99981. */
  99982. getClassName(): string;
  99983. /**
  99984. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99985. * Returns the updated direction.
  99986. * @param target The target the direction should point to
  99987. * @return The computed direction
  99988. */
  99989. setDirectionToTarget(target: Vector3): Vector3;
  99990. /**
  99991. * Returns the shadow generator associated to the light.
  99992. * @returns Always null for hemispheric lights because it does not support shadows.
  99993. */
  99994. getShadowGenerator(): Nullable<IShadowGenerator>;
  99995. /**
  99996. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99997. * @param effect The effect to update
  99998. * @param lightIndex The index of the light in the effect to update
  99999. * @returns The hemispheric light
  100000. */
  100001. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  100002. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  100003. /**
  100004. * Computes the world matrix of the node
  100005. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  100006. * @param useWasUpdatedFlag defines a reserved property
  100007. * @returns the world matrix
  100008. */
  100009. computeWorldMatrix(): Matrix;
  100010. /**
  100011. * Returns the integer 3.
  100012. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  100013. */
  100014. getTypeID(): number;
  100015. /**
  100016. * Prepares the list of defines specific to the light type.
  100017. * @param defines the list of defines
  100018. * @param lightIndex defines the index of the light for the effect
  100019. */
  100020. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  100021. }
  100022. }
  100023. declare module BABYLON {
  100024. /** @hidden */
  100025. export var vrMultiviewToSingleviewPixelShader: {
  100026. name: string;
  100027. shader: string;
  100028. };
  100029. }
  100030. declare module BABYLON {
  100031. /**
  100032. * Renders to multiple views with a single draw call
  100033. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  100034. */
  100035. export class MultiviewRenderTarget extends RenderTargetTexture {
  100036. /**
  100037. * Creates a multiview render target
  100038. * @param scene scene used with the render target
  100039. * @param size the size of the render target (used for each view)
  100040. */
  100041. constructor(scene: Scene, size?: number | {
  100042. width: number;
  100043. height: number;
  100044. } | {
  100045. ratio: number;
  100046. });
  100047. /**
  100048. * @hidden
  100049. * @param faceIndex the face index, if its a cube texture
  100050. */
  100051. _bindFrameBuffer(faceIndex?: number): void;
  100052. /**
  100053. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  100054. * @returns the view count
  100055. */
  100056. getViewCount(): number;
  100057. }
  100058. }
  100059. declare module BABYLON {
  100060. interface Engine {
  100061. /**
  100062. * Creates a new multiview render target
  100063. * @param width defines the width of the texture
  100064. * @param height defines the height of the texture
  100065. * @returns the created multiview texture
  100066. */
  100067. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  100068. /**
  100069. * Binds a multiview framebuffer to be drawn to
  100070. * @param multiviewTexture texture to bind
  100071. */
  100072. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  100073. }
  100074. interface Camera {
  100075. /**
  100076. * @hidden
  100077. * 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)
  100078. */
  100079. _useMultiviewToSingleView: boolean;
  100080. /**
  100081. * @hidden
  100082. * 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)
  100083. */
  100084. _multiviewTexture: Nullable<RenderTargetTexture>;
  100085. /**
  100086. * @hidden
  100087. * ensures the multiview texture of the camera exists and has the specified width/height
  100088. * @param width height to set on the multiview texture
  100089. * @param height width to set on the multiview texture
  100090. */
  100091. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  100092. }
  100093. interface Scene {
  100094. /** @hidden */
  100095. _transformMatrixR: Matrix;
  100096. /** @hidden */
  100097. _multiviewSceneUbo: Nullable<UniformBuffer>;
  100098. /** @hidden */
  100099. _createMultiviewUbo(): void;
  100100. /** @hidden */
  100101. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  100102. /** @hidden */
  100103. _renderMultiviewToSingleView(camera: Camera): void;
  100104. }
  100105. }
  100106. declare module BABYLON {
  100107. /**
  100108. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  100109. * This will not be used for webXR as it supports displaying texture arrays directly
  100110. */
  100111. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  100112. /**
  100113. * Gets a string identifying the name of the class
  100114. * @returns "VRMultiviewToSingleviewPostProcess" string
  100115. */
  100116. getClassName(): string;
  100117. /**
  100118. * Initializes a VRMultiviewToSingleview
  100119. * @param name name of the post process
  100120. * @param camera camera to be applied to
  100121. * @param scaleFactor scaling factor to the size of the output texture
  100122. */
  100123. constructor(name: string, camera: Camera, scaleFactor: number);
  100124. }
  100125. }
  100126. declare module BABYLON {
  100127. /**
  100128. * Interface used to define additional presentation attributes
  100129. */
  100130. export interface IVRPresentationAttributes {
  100131. /**
  100132. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  100133. */
  100134. highRefreshRate: boolean;
  100135. /**
  100136. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  100137. */
  100138. foveationLevel: number;
  100139. }
  100140. interface Engine {
  100141. /** @hidden */
  100142. _vrDisplay: any;
  100143. /** @hidden */
  100144. _vrSupported: boolean;
  100145. /** @hidden */
  100146. _oldSize: Size;
  100147. /** @hidden */
  100148. _oldHardwareScaleFactor: number;
  100149. /** @hidden */
  100150. _vrExclusivePointerMode: boolean;
  100151. /** @hidden */
  100152. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  100153. /** @hidden */
  100154. _onVRDisplayPointerRestricted: () => void;
  100155. /** @hidden */
  100156. _onVRDisplayPointerUnrestricted: () => void;
  100157. /** @hidden */
  100158. _onVrDisplayConnect: Nullable<(display: any) => void>;
  100159. /** @hidden */
  100160. _onVrDisplayDisconnect: Nullable<() => void>;
  100161. /** @hidden */
  100162. _onVrDisplayPresentChange: Nullable<() => void>;
  100163. /**
  100164. * Observable signaled when VR display mode changes
  100165. */
  100166. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  100167. /**
  100168. * Observable signaled when VR request present is complete
  100169. */
  100170. onVRRequestPresentComplete: Observable<boolean>;
  100171. /**
  100172. * Observable signaled when VR request present starts
  100173. */
  100174. onVRRequestPresentStart: Observable<Engine>;
  100175. /**
  100176. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  100177. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  100178. */
  100179. isInVRExclusivePointerMode: boolean;
  100180. /**
  100181. * Gets a boolean indicating if a webVR device was detected
  100182. * @returns true if a webVR device was detected
  100183. */
  100184. isVRDevicePresent(): boolean;
  100185. /**
  100186. * Gets the current webVR device
  100187. * @returns the current webVR device (or null)
  100188. */
  100189. getVRDevice(): any;
  100190. /**
  100191. * Initializes a webVR display and starts listening to display change events
  100192. * The onVRDisplayChangedObservable will be notified upon these changes
  100193. * @returns A promise containing a VRDisplay and if vr is supported
  100194. */
  100195. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  100196. /** @hidden */
  100197. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  100198. /**
  100199. * Gets or sets the presentation attributes used to configure VR rendering
  100200. */
  100201. vrPresentationAttributes?: IVRPresentationAttributes;
  100202. /**
  100203. * Call this function to switch to webVR mode
  100204. * Will do nothing if webVR is not supported or if there is no webVR device
  100205. * @param options the webvr options provided to the camera. mainly used for multiview
  100206. * @see https://doc.babylonjs.com/how_to/webvr_camera
  100207. */
  100208. enableVR(options: WebVROptions): void;
  100209. /** @hidden */
  100210. _onVRFullScreenTriggered(): void;
  100211. }
  100212. }
  100213. declare module BABYLON {
  100214. /**
  100215. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  100216. * IMPORTANT!! The data is right-hand data.
  100217. * @export
  100218. * @interface DevicePose
  100219. */
  100220. export interface DevicePose {
  100221. /**
  100222. * The position of the device, values in array are [x,y,z].
  100223. */
  100224. readonly position: Nullable<Float32Array>;
  100225. /**
  100226. * The linearVelocity of the device, values in array are [x,y,z].
  100227. */
  100228. readonly linearVelocity: Nullable<Float32Array>;
  100229. /**
  100230. * The linearAcceleration of the device, values in array are [x,y,z].
  100231. */
  100232. readonly linearAcceleration: Nullable<Float32Array>;
  100233. /**
  100234. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  100235. */
  100236. readonly orientation: Nullable<Float32Array>;
  100237. /**
  100238. * The angularVelocity of the device, values in array are [x,y,z].
  100239. */
  100240. readonly angularVelocity: Nullable<Float32Array>;
  100241. /**
  100242. * The angularAcceleration of the device, values in array are [x,y,z].
  100243. */
  100244. readonly angularAcceleration: Nullable<Float32Array>;
  100245. }
  100246. /**
  100247. * Interface representing a pose controlled object in Babylon.
  100248. * A pose controlled object has both regular pose values as well as pose values
  100249. * from an external device such as a VR head mounted display
  100250. */
  100251. export interface PoseControlled {
  100252. /**
  100253. * The position of the object in babylon space.
  100254. */
  100255. position: Vector3;
  100256. /**
  100257. * The rotation quaternion of the object in babylon space.
  100258. */
  100259. rotationQuaternion: Quaternion;
  100260. /**
  100261. * The position of the device in babylon space.
  100262. */
  100263. devicePosition?: Vector3;
  100264. /**
  100265. * The rotation quaternion of the device in babylon space.
  100266. */
  100267. deviceRotationQuaternion: Quaternion;
  100268. /**
  100269. * The raw pose coming from the device.
  100270. */
  100271. rawPose: Nullable<DevicePose>;
  100272. /**
  100273. * The scale of the device to be used when translating from device space to babylon space.
  100274. */
  100275. deviceScaleFactor: number;
  100276. /**
  100277. * Updates the poseControlled values based on the input device pose.
  100278. * @param poseData the pose data to update the object with
  100279. */
  100280. updateFromDevice(poseData: DevicePose): void;
  100281. }
  100282. /**
  100283. * Set of options to customize the webVRCamera
  100284. */
  100285. export interface WebVROptions {
  100286. /**
  100287. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  100288. */
  100289. trackPosition?: boolean;
  100290. /**
  100291. * Sets the scale of the vrDevice in babylon space. (default: 1)
  100292. */
  100293. positionScale?: number;
  100294. /**
  100295. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  100296. */
  100297. displayName?: string;
  100298. /**
  100299. * Should the native controller meshes be initialized. (default: true)
  100300. */
  100301. controllerMeshes?: boolean;
  100302. /**
  100303. * Creating a default HemiLight only on controllers. (default: true)
  100304. */
  100305. defaultLightingOnControllers?: boolean;
  100306. /**
  100307. * If you don't want to use the default VR button of the helper. (default: false)
  100308. */
  100309. useCustomVRButton?: boolean;
  100310. /**
  100311. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  100312. */
  100313. customVRButton?: HTMLButtonElement;
  100314. /**
  100315. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  100316. */
  100317. rayLength?: number;
  100318. /**
  100319. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  100320. */
  100321. defaultHeight?: number;
  100322. /**
  100323. * If multiview should be used if availible (default: false)
  100324. */
  100325. useMultiview?: boolean;
  100326. }
  100327. /**
  100328. * This represents a WebVR camera.
  100329. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  100330. * @example https://doc.babylonjs.com/how_to/webvr_camera
  100331. */
  100332. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  100333. private webVROptions;
  100334. /**
  100335. * @hidden
  100336. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  100337. */
  100338. _vrDevice: any;
  100339. /**
  100340. * The rawPose of the vrDevice.
  100341. */
  100342. rawPose: Nullable<DevicePose>;
  100343. private _onVREnabled;
  100344. private _specsVersion;
  100345. private _attached;
  100346. private _frameData;
  100347. protected _descendants: Array<Node>;
  100348. private _deviceRoomPosition;
  100349. /** @hidden */
  100350. _deviceRoomRotationQuaternion: Quaternion;
  100351. private _standingMatrix;
  100352. /**
  100353. * Represents device position in babylon space.
  100354. */
  100355. devicePosition: Vector3;
  100356. /**
  100357. * Represents device rotation in babylon space.
  100358. */
  100359. deviceRotationQuaternion: Quaternion;
  100360. /**
  100361. * The scale of the device to be used when translating from device space to babylon space.
  100362. */
  100363. deviceScaleFactor: number;
  100364. private _deviceToWorld;
  100365. private _worldToDevice;
  100366. /**
  100367. * References to the webVR controllers for the vrDevice.
  100368. */
  100369. controllers: Array<WebVRController>;
  100370. /**
  100371. * Emits an event when a controller is attached.
  100372. */
  100373. onControllersAttachedObservable: Observable<WebVRController[]>;
  100374. /**
  100375. * Emits an event when a controller's mesh has been loaded;
  100376. */
  100377. onControllerMeshLoadedObservable: Observable<WebVRController>;
  100378. /**
  100379. * Emits an event when the HMD's pose has been updated.
  100380. */
  100381. onPoseUpdatedFromDeviceObservable: Observable<any>;
  100382. private _poseSet;
  100383. /**
  100384. * If the rig cameras be used as parent instead of this camera.
  100385. */
  100386. rigParenting: boolean;
  100387. private _lightOnControllers;
  100388. private _defaultHeight?;
  100389. /**
  100390. * Instantiates a WebVRFreeCamera.
  100391. * @param name The name of the WebVRFreeCamera
  100392. * @param position The starting anchor position for the camera
  100393. * @param scene The scene the camera belongs to
  100394. * @param webVROptions a set of customizable options for the webVRCamera
  100395. */
  100396. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  100397. /**
  100398. * Gets the device distance from the ground in meters.
  100399. * @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.
  100400. */
  100401. deviceDistanceToRoomGround(): number;
  100402. /**
  100403. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  100404. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  100405. */
  100406. useStandingMatrix(callback?: (bool: boolean) => void): void;
  100407. /**
  100408. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  100409. * @returns A promise with a boolean set to if the standing matrix is supported.
  100410. */
  100411. useStandingMatrixAsync(): Promise<boolean>;
  100412. /**
  100413. * Disposes the camera
  100414. */
  100415. dispose(): void;
  100416. /**
  100417. * Gets a vrController by name.
  100418. * @param name The name of the controller to retreive
  100419. * @returns the controller matching the name specified or null if not found
  100420. */
  100421. getControllerByName(name: string): Nullable<WebVRController>;
  100422. private _leftController;
  100423. /**
  100424. * The controller corresponding to the users left hand.
  100425. */
  100426. get leftController(): Nullable<WebVRController>;
  100427. private _rightController;
  100428. /**
  100429. * The controller corresponding to the users right hand.
  100430. */
  100431. get rightController(): Nullable<WebVRController>;
  100432. /**
  100433. * Casts a ray forward from the vrCamera's gaze.
  100434. * @param length Length of the ray (default: 100)
  100435. * @returns the ray corresponding to the gaze
  100436. */
  100437. getForwardRay(length?: number): Ray;
  100438. /**
  100439. * @hidden
  100440. * Updates the camera based on device's frame data
  100441. */
  100442. _checkInputs(): void;
  100443. /**
  100444. * Updates the poseControlled values based on the input device pose.
  100445. * @param poseData Pose coming from the device
  100446. */
  100447. updateFromDevice(poseData: DevicePose): void;
  100448. private _htmlElementAttached;
  100449. private _detachIfAttached;
  100450. /**
  100451. * WebVR's attach control will start broadcasting frames to the device.
  100452. * Note that in certain browsers (chrome for example) this function must be called
  100453. * within a user-interaction callback. Example:
  100454. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  100455. *
  100456. * @param element html element to attach the vrDevice to
  100457. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  100458. */
  100459. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  100460. /**
  100461. * Detaches the camera from the html element and disables VR
  100462. *
  100463. * @param element html element to detach from
  100464. */
  100465. detachControl(element: HTMLElement): void;
  100466. /**
  100467. * @returns the name of this class
  100468. */
  100469. getClassName(): string;
  100470. /**
  100471. * Calls resetPose on the vrDisplay
  100472. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  100473. */
  100474. resetToCurrentRotation(): void;
  100475. /**
  100476. * @hidden
  100477. * Updates the rig cameras (left and right eye)
  100478. */
  100479. _updateRigCameras(): void;
  100480. private _workingVector;
  100481. private _oneVector;
  100482. private _workingMatrix;
  100483. private updateCacheCalled;
  100484. private _correctPositionIfNotTrackPosition;
  100485. /**
  100486. * @hidden
  100487. * Updates the cached values of the camera
  100488. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  100489. */
  100490. _updateCache(ignoreParentClass?: boolean): void;
  100491. /**
  100492. * @hidden
  100493. * Get current device position in babylon world
  100494. */
  100495. _computeDevicePosition(): void;
  100496. /**
  100497. * Updates the current device position and rotation in the babylon world
  100498. */
  100499. update(): void;
  100500. /**
  100501. * @hidden
  100502. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  100503. * @returns an identity matrix
  100504. */
  100505. _getViewMatrix(): Matrix;
  100506. private _tmpMatrix;
  100507. /**
  100508. * This function is called by the two RIG cameras.
  100509. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  100510. * @hidden
  100511. */
  100512. _getWebVRViewMatrix(): Matrix;
  100513. /** @hidden */
  100514. _getWebVRProjectionMatrix(): Matrix;
  100515. private _onGamepadConnectedObserver;
  100516. private _onGamepadDisconnectedObserver;
  100517. private _updateCacheWhenTrackingDisabledObserver;
  100518. /**
  100519. * Initializes the controllers and their meshes
  100520. */
  100521. initControllers(): void;
  100522. }
  100523. }
  100524. declare module BABYLON {
  100525. /**
  100526. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  100527. *
  100528. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  100529. *
  100530. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  100531. */
  100532. export class MaterialHelper {
  100533. /**
  100534. * Bind the current view position to an effect.
  100535. * @param effect The effect to be bound
  100536. * @param scene The scene the eyes position is used from
  100537. * @param variableName name of the shader variable that will hold the eye position
  100538. */
  100539. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  100540. /**
  100541. * Helps preparing the defines values about the UVs in used in the effect.
  100542. * UVs are shared as much as we can accross channels in the shaders.
  100543. * @param texture The texture we are preparing the UVs for
  100544. * @param defines The defines to update
  100545. * @param key The channel key "diffuse", "specular"... used in the shader
  100546. */
  100547. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  100548. /**
  100549. * Binds a texture matrix value to its corrsponding uniform
  100550. * @param texture The texture to bind the matrix for
  100551. * @param uniformBuffer The uniform buffer receivin the data
  100552. * @param key The channel key "diffuse", "specular"... used in the shader
  100553. */
  100554. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  100555. /**
  100556. * Gets the current status of the fog (should it be enabled?)
  100557. * @param mesh defines the mesh to evaluate for fog support
  100558. * @param scene defines the hosting scene
  100559. * @returns true if fog must be enabled
  100560. */
  100561. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  100562. /**
  100563. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  100564. * @param mesh defines the current mesh
  100565. * @param scene defines the current scene
  100566. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  100567. * @param pointsCloud defines if point cloud rendering has to be turned on
  100568. * @param fogEnabled defines if fog has to be turned on
  100569. * @param alphaTest defines if alpha testing has to be turned on
  100570. * @param defines defines the current list of defines
  100571. */
  100572. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  100573. /**
  100574. * Helper used to prepare the list of defines associated with frame values for shader compilation
  100575. * @param scene defines the current scene
  100576. * @param engine defines the current engine
  100577. * @param defines specifies the list of active defines
  100578. * @param useInstances defines if instances have to be turned on
  100579. * @param useClipPlane defines if clip plane have to be turned on
  100580. * @param useInstances defines if instances have to be turned on
  100581. * @param useThinInstances defines if thin instances have to be turned on
  100582. */
  100583. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  100584. /**
  100585. * Prepares the defines for bones
  100586. * @param mesh The mesh containing the geometry data we will draw
  100587. * @param defines The defines to update
  100588. */
  100589. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  100590. /**
  100591. * Prepares the defines for morph targets
  100592. * @param mesh The mesh containing the geometry data we will draw
  100593. * @param defines The defines to update
  100594. */
  100595. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  100596. /**
  100597. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  100598. * @param mesh The mesh containing the geometry data we will draw
  100599. * @param defines The defines to update
  100600. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  100601. * @param useBones Precise whether bones should be used or not (override mesh info)
  100602. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  100603. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  100604. * @returns false if defines are considered not dirty and have not been checked
  100605. */
  100606. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  100607. /**
  100608. * Prepares the defines related to multiview
  100609. * @param scene The scene we are intending to draw
  100610. * @param defines The defines to update
  100611. */
  100612. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  100613. /**
  100614. * Prepares the defines related to the prepass
  100615. * @param scene The scene we are intending to draw
  100616. * @param defines The defines to update
  100617. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  100618. */
  100619. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  100620. /**
  100621. * Prepares the defines related to the light information passed in parameter
  100622. * @param scene The scene we are intending to draw
  100623. * @param mesh The mesh the effect is compiling for
  100624. * @param light The light the effect is compiling for
  100625. * @param lightIndex The index of the light
  100626. * @param defines The defines to update
  100627. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100628. * @param state Defines the current state regarding what is needed (normals, etc...)
  100629. */
  100630. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  100631. needNormals: boolean;
  100632. needRebuild: boolean;
  100633. shadowEnabled: boolean;
  100634. specularEnabled: boolean;
  100635. lightmapMode: boolean;
  100636. }): void;
  100637. /**
  100638. * Prepares the defines related to the light information passed in parameter
  100639. * @param scene The scene we are intending to draw
  100640. * @param mesh The mesh the effect is compiling for
  100641. * @param defines The defines to update
  100642. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100643. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  100644. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  100645. * @returns true if normals will be required for the rest of the effect
  100646. */
  100647. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  100648. /**
  100649. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  100650. * @param lightIndex defines the light index
  100651. * @param uniformsList The uniform list
  100652. * @param samplersList The sampler list
  100653. * @param projectedLightTexture defines if projected texture must be used
  100654. * @param uniformBuffersList defines an optional list of uniform buffers
  100655. */
  100656. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  100657. /**
  100658. * Prepares the uniforms and samplers list to be used in the effect
  100659. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  100660. * @param samplersList The sampler list
  100661. * @param defines The defines helping in the list generation
  100662. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  100663. */
  100664. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  100665. /**
  100666. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  100667. * @param defines The defines to update while falling back
  100668. * @param fallbacks The authorized effect fallbacks
  100669. * @param maxSimultaneousLights The maximum number of lights allowed
  100670. * @param rank the current rank of the Effect
  100671. * @returns The newly affected rank
  100672. */
  100673. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  100674. private static _TmpMorphInfluencers;
  100675. /**
  100676. * Prepares the list of attributes required for morph targets according to the effect defines.
  100677. * @param attribs The current list of supported attribs
  100678. * @param mesh The mesh to prepare the morph targets attributes for
  100679. * @param influencers The number of influencers
  100680. */
  100681. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  100682. /**
  100683. * Prepares the list of attributes required for morph targets according to the effect defines.
  100684. * @param attribs The current list of supported attribs
  100685. * @param mesh The mesh to prepare the morph targets attributes for
  100686. * @param defines The current Defines of the effect
  100687. */
  100688. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  100689. /**
  100690. * Prepares the list of attributes required for bones according to the effect defines.
  100691. * @param attribs The current list of supported attribs
  100692. * @param mesh The mesh to prepare the bones attributes for
  100693. * @param defines The current Defines of the effect
  100694. * @param fallbacks The current efffect fallback strategy
  100695. */
  100696. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100697. /**
  100698. * Check and prepare the list of attributes required for instances according to the effect defines.
  100699. * @param attribs The current list of supported attribs
  100700. * @param defines The current MaterialDefines of the effect
  100701. */
  100702. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100703. /**
  100704. * Add the list of attributes required for instances to the attribs array.
  100705. * @param attribs The current list of supported attribs
  100706. */
  100707. static PushAttributesForInstances(attribs: string[]): void;
  100708. /**
  100709. * Binds the light information to the effect.
  100710. * @param light The light containing the generator
  100711. * @param effect The effect we are binding the data to
  100712. * @param lightIndex The light index in the effect used to render
  100713. */
  100714. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100715. /**
  100716. * Binds the lights information from the scene to the effect for the given mesh.
  100717. * @param light Light to bind
  100718. * @param lightIndex Light index
  100719. * @param scene The scene where the light belongs to
  100720. * @param effect The effect we are binding the data to
  100721. * @param useSpecular Defines if specular is supported
  100722. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100723. */
  100724. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100725. /**
  100726. * Binds the lights information from the scene to the effect for the given mesh.
  100727. * @param scene The scene the lights belongs to
  100728. * @param mesh The mesh we are binding the information to render
  100729. * @param effect The effect we are binding the data to
  100730. * @param defines The generated defines for the effect
  100731. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100732. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100733. */
  100734. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100735. private static _tempFogColor;
  100736. /**
  100737. * Binds the fog information from the scene to the effect for the given mesh.
  100738. * @param scene The scene the lights belongs to
  100739. * @param mesh The mesh we are binding the information to render
  100740. * @param effect The effect we are binding the data to
  100741. * @param linearSpace Defines if the fog effect is applied in linear space
  100742. */
  100743. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100744. /**
  100745. * Binds the bones information from the mesh to the effect.
  100746. * @param mesh The mesh we are binding the information to render
  100747. * @param effect The effect we are binding the data to
  100748. */
  100749. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100750. /**
  100751. * Binds the morph targets information from the mesh to the effect.
  100752. * @param abstractMesh The mesh we are binding the information to render
  100753. * @param effect The effect we are binding the data to
  100754. */
  100755. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100756. /**
  100757. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100758. * @param defines The generated defines used in the effect
  100759. * @param effect The effect we are binding the data to
  100760. * @param scene The scene we are willing to render with logarithmic scale for
  100761. */
  100762. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100763. /**
  100764. * Binds the clip plane information from the scene to the effect.
  100765. * @param scene The scene the clip plane information are extracted from
  100766. * @param effect The effect we are binding the data to
  100767. */
  100768. static BindClipPlane(effect: Effect, scene: Scene): void;
  100769. }
  100770. }
  100771. declare module BABYLON {
  100772. /**
  100773. * Block used to expose an input value
  100774. */
  100775. export class InputBlock extends NodeMaterialBlock {
  100776. private _mode;
  100777. private _associatedVariableName;
  100778. private _storedValue;
  100779. private _valueCallback;
  100780. private _type;
  100781. private _animationType;
  100782. /** Gets or set a value used to limit the range of float values */
  100783. min: number;
  100784. /** Gets or set a value used to limit the range of float values */
  100785. max: number;
  100786. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100787. isBoolean: boolean;
  100788. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100789. matrixMode: number;
  100790. /** @hidden */
  100791. _systemValue: Nullable<NodeMaterialSystemValues>;
  100792. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100793. isConstant: boolean;
  100794. /** Gets or sets the group to use to display this block in the Inspector */
  100795. groupInInspector: string;
  100796. /** Gets an observable raised when the value is changed */
  100797. onValueChangedObservable: Observable<InputBlock>;
  100798. /**
  100799. * Gets or sets the connection point type (default is float)
  100800. */
  100801. get type(): NodeMaterialBlockConnectionPointTypes;
  100802. /**
  100803. * Creates a new InputBlock
  100804. * @param name defines the block name
  100805. * @param target defines the target of that block (Vertex by default)
  100806. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100807. */
  100808. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100809. /**
  100810. * Validates if a name is a reserve word.
  100811. * @param newName the new name to be given to the node.
  100812. * @returns false if the name is a reserve word, else true.
  100813. */
  100814. validateBlockName(newName: string): boolean;
  100815. /**
  100816. * Gets the output component
  100817. */
  100818. get output(): NodeMaterialConnectionPoint;
  100819. /**
  100820. * Set the source of this connection point to a vertex attribute
  100821. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100822. * @returns the current connection point
  100823. */
  100824. setAsAttribute(attributeName?: string): InputBlock;
  100825. /**
  100826. * Set the source of this connection point to a system value
  100827. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100828. * @returns the current connection point
  100829. */
  100830. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100831. /**
  100832. * Gets or sets the value of that point.
  100833. * Please note that this value will be ignored if valueCallback is defined
  100834. */
  100835. get value(): any;
  100836. set value(value: any);
  100837. /**
  100838. * Gets or sets a callback used to get the value of that point.
  100839. * Please note that setting this value will force the connection point to ignore the value property
  100840. */
  100841. get valueCallback(): () => any;
  100842. set valueCallback(value: () => any);
  100843. /**
  100844. * Gets or sets the associated variable name in the shader
  100845. */
  100846. get associatedVariableName(): string;
  100847. set associatedVariableName(value: string);
  100848. /** Gets or sets the type of animation applied to the input */
  100849. get animationType(): AnimatedInputBlockTypes;
  100850. set animationType(value: AnimatedInputBlockTypes);
  100851. /**
  100852. * Gets a boolean indicating that this connection point not defined yet
  100853. */
  100854. get isUndefined(): boolean;
  100855. /**
  100856. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100857. * In this case the connection point name must be the name of the uniform to use.
  100858. * Can only be set on inputs
  100859. */
  100860. get isUniform(): boolean;
  100861. set isUniform(value: boolean);
  100862. /**
  100863. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100864. * In this case the connection point name must be the name of the attribute to use
  100865. * Can only be set on inputs
  100866. */
  100867. get isAttribute(): boolean;
  100868. set isAttribute(value: boolean);
  100869. /**
  100870. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100871. * Can only be set on exit points
  100872. */
  100873. get isVarying(): boolean;
  100874. set isVarying(value: boolean);
  100875. /**
  100876. * Gets a boolean indicating that the current connection point is a system value
  100877. */
  100878. get isSystemValue(): boolean;
  100879. /**
  100880. * Gets or sets the current well known value or null if not defined as a system value
  100881. */
  100882. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100883. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100884. /**
  100885. * Gets the current class name
  100886. * @returns the class name
  100887. */
  100888. getClassName(): string;
  100889. /**
  100890. * Animate the input if animationType !== None
  100891. * @param scene defines the rendering scene
  100892. */
  100893. animate(scene: Scene): void;
  100894. private _emitDefine;
  100895. initialize(state: NodeMaterialBuildState): void;
  100896. /**
  100897. * Set the input block to its default value (based on its type)
  100898. */
  100899. setDefaultValue(): void;
  100900. private _emitConstant;
  100901. /** @hidden */
  100902. get _noContextSwitch(): boolean;
  100903. private _emit;
  100904. /** @hidden */
  100905. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100906. /** @hidden */
  100907. _transmit(effect: Effect, scene: Scene): void;
  100908. protected _buildBlock(state: NodeMaterialBuildState): void;
  100909. protected _dumpPropertiesCode(): string;
  100910. dispose(): void;
  100911. serialize(): any;
  100912. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100913. }
  100914. }
  100915. declare module BABYLON {
  100916. /**
  100917. * Enum used to define the compatibility state between two connection points
  100918. */
  100919. export enum NodeMaterialConnectionPointCompatibilityStates {
  100920. /** Points are compatibles */
  100921. Compatible = 0,
  100922. /** Points are incompatible because of their types */
  100923. TypeIncompatible = 1,
  100924. /** Points are incompatible because of their targets (vertex vs fragment) */
  100925. TargetIncompatible = 2
  100926. }
  100927. /**
  100928. * Defines the direction of a connection point
  100929. */
  100930. export enum NodeMaterialConnectionPointDirection {
  100931. /** Input */
  100932. Input = 0,
  100933. /** Output */
  100934. Output = 1
  100935. }
  100936. /**
  100937. * Defines a connection point for a block
  100938. */
  100939. export class NodeMaterialConnectionPoint {
  100940. /** @hidden */
  100941. _ownerBlock: NodeMaterialBlock;
  100942. /** @hidden */
  100943. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100944. private _endpoints;
  100945. private _associatedVariableName;
  100946. private _direction;
  100947. /** @hidden */
  100948. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100949. /** @hidden */
  100950. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100951. private _type;
  100952. /** @hidden */
  100953. _enforceAssociatedVariableName: boolean;
  100954. /** Gets the direction of the point */
  100955. get direction(): NodeMaterialConnectionPointDirection;
  100956. /** Indicates that this connection point needs dual validation before being connected to another point */
  100957. needDualDirectionValidation: boolean;
  100958. /**
  100959. * Gets or sets the additional types supported by this connection point
  100960. */
  100961. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100962. /**
  100963. * Gets or sets the additional types excluded by this connection point
  100964. */
  100965. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100966. /**
  100967. * Observable triggered when this point is connected
  100968. */
  100969. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100970. /**
  100971. * Gets or sets the associated variable name in the shader
  100972. */
  100973. get associatedVariableName(): string;
  100974. set associatedVariableName(value: string);
  100975. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100976. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100977. /**
  100978. * Gets or sets the connection point type (default is float)
  100979. */
  100980. get type(): NodeMaterialBlockConnectionPointTypes;
  100981. set type(value: NodeMaterialBlockConnectionPointTypes);
  100982. /**
  100983. * Gets or sets the connection point name
  100984. */
  100985. name: string;
  100986. /**
  100987. * Gets or sets the connection point name
  100988. */
  100989. displayName: string;
  100990. /**
  100991. * Gets or sets a boolean indicating that this connection point can be omitted
  100992. */
  100993. isOptional: boolean;
  100994. /**
  100995. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100996. */
  100997. isExposedOnFrame: boolean;
  100998. /**
  100999. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  101000. */
  101001. define: string;
  101002. /** @hidden */
  101003. _prioritizeVertex: boolean;
  101004. private _target;
  101005. /** Gets or sets the target of that connection point */
  101006. get target(): NodeMaterialBlockTargets;
  101007. set target(value: NodeMaterialBlockTargets);
  101008. /**
  101009. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  101010. */
  101011. get isConnected(): boolean;
  101012. /**
  101013. * Gets a boolean indicating that the current point is connected to an input block
  101014. */
  101015. get isConnectedToInputBlock(): boolean;
  101016. /**
  101017. * Gets a the connected input block (if any)
  101018. */
  101019. get connectInputBlock(): Nullable<InputBlock>;
  101020. /** Get the other side of the connection (if any) */
  101021. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  101022. /** Get the block that owns this connection point */
  101023. get ownerBlock(): NodeMaterialBlock;
  101024. /** Get the block connected on the other side of this connection (if any) */
  101025. get sourceBlock(): Nullable<NodeMaterialBlock>;
  101026. /** Get the block connected on the endpoints of this connection (if any) */
  101027. get connectedBlocks(): Array<NodeMaterialBlock>;
  101028. /** Gets the list of connected endpoints */
  101029. get endpoints(): NodeMaterialConnectionPoint[];
  101030. /** Gets a boolean indicating if that output point is connected to at least one input */
  101031. get hasEndpoints(): boolean;
  101032. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  101033. get isConnectedInVertexShader(): boolean;
  101034. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  101035. get isConnectedInFragmentShader(): boolean;
  101036. /**
  101037. * Creates a block suitable to be used as an input for this input point.
  101038. * If null is returned, a block based on the point type will be created.
  101039. * @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
  101040. */
  101041. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  101042. /**
  101043. * Creates a new connection point
  101044. * @param name defines the connection point name
  101045. * @param ownerBlock defines the block hosting this connection point
  101046. * @param direction defines the direction of the connection point
  101047. */
  101048. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  101049. /**
  101050. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  101051. * @returns the class name
  101052. */
  101053. getClassName(): string;
  101054. /**
  101055. * Gets a boolean indicating if the current point can be connected to another point
  101056. * @param connectionPoint defines the other connection point
  101057. * @returns a boolean
  101058. */
  101059. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  101060. /**
  101061. * Gets a number indicating if the current point can be connected to another point
  101062. * @param connectionPoint defines the other connection point
  101063. * @returns a number defining the compatibility state
  101064. */
  101065. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  101066. /**
  101067. * Connect this point to another connection point
  101068. * @param connectionPoint defines the other connection point
  101069. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  101070. * @returns the current connection point
  101071. */
  101072. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  101073. /**
  101074. * Disconnect this point from one of his endpoint
  101075. * @param endpoint defines the other connection point
  101076. * @returns the current connection point
  101077. */
  101078. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  101079. /**
  101080. * Serializes this point in a JSON representation
  101081. * @param isInput defines if the connection point is an input (default is true)
  101082. * @returns the serialized point object
  101083. */
  101084. serialize(isInput?: boolean): any;
  101085. /**
  101086. * Release resources
  101087. */
  101088. dispose(): void;
  101089. }
  101090. }
  101091. declare module BABYLON {
  101092. /**
  101093. * Enum used to define the material modes
  101094. */
  101095. export enum NodeMaterialModes {
  101096. /** Regular material */
  101097. Material = 0,
  101098. /** For post process */
  101099. PostProcess = 1,
  101100. /** For particle system */
  101101. Particle = 2,
  101102. /** For procedural texture */
  101103. ProceduralTexture = 3
  101104. }
  101105. }
  101106. declare module BABYLON {
  101107. /**
  101108. * Block used to read a texture from a sampler
  101109. */
  101110. export class TextureBlock extends NodeMaterialBlock {
  101111. private _defineName;
  101112. private _linearDefineName;
  101113. private _gammaDefineName;
  101114. private _tempTextureRead;
  101115. private _samplerName;
  101116. private _transformedUVName;
  101117. private _textureTransformName;
  101118. private _textureInfoName;
  101119. private _mainUVName;
  101120. private _mainUVDefineName;
  101121. private _fragmentOnly;
  101122. /**
  101123. * Gets or sets the texture associated with the node
  101124. */
  101125. texture: Nullable<Texture>;
  101126. /**
  101127. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101128. */
  101129. convertToGammaSpace: boolean;
  101130. /**
  101131. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101132. */
  101133. convertToLinearSpace: boolean;
  101134. /**
  101135. * Create a new TextureBlock
  101136. * @param name defines the block name
  101137. */
  101138. constructor(name: string, fragmentOnly?: boolean);
  101139. /**
  101140. * Gets the current class name
  101141. * @returns the class name
  101142. */
  101143. getClassName(): string;
  101144. /**
  101145. * Gets the uv input component
  101146. */
  101147. get uv(): NodeMaterialConnectionPoint;
  101148. /**
  101149. * Gets the rgba output component
  101150. */
  101151. get rgba(): NodeMaterialConnectionPoint;
  101152. /**
  101153. * Gets the rgb output component
  101154. */
  101155. get rgb(): NodeMaterialConnectionPoint;
  101156. /**
  101157. * Gets the r output component
  101158. */
  101159. get r(): NodeMaterialConnectionPoint;
  101160. /**
  101161. * Gets the g output component
  101162. */
  101163. get g(): NodeMaterialConnectionPoint;
  101164. /**
  101165. * Gets the b output component
  101166. */
  101167. get b(): NodeMaterialConnectionPoint;
  101168. /**
  101169. * Gets the a output component
  101170. */
  101171. get a(): NodeMaterialConnectionPoint;
  101172. get target(): NodeMaterialBlockTargets;
  101173. autoConfigure(material: NodeMaterial): void;
  101174. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101175. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101176. isReady(): boolean;
  101177. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  101178. private get _isMixed();
  101179. private _injectVertexCode;
  101180. private _writeTextureRead;
  101181. private _writeOutput;
  101182. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101183. protected _dumpPropertiesCode(): string;
  101184. serialize(): any;
  101185. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101186. }
  101187. }
  101188. declare module BABYLON {
  101189. /** @hidden */
  101190. export var reflectionFunction: {
  101191. name: string;
  101192. shader: string;
  101193. };
  101194. }
  101195. declare module BABYLON {
  101196. /**
  101197. * Base block used to read a reflection texture from a sampler
  101198. */
  101199. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  101200. /** @hidden */
  101201. _define3DName: string;
  101202. /** @hidden */
  101203. _defineCubicName: string;
  101204. /** @hidden */
  101205. _defineExplicitName: string;
  101206. /** @hidden */
  101207. _defineProjectionName: string;
  101208. /** @hidden */
  101209. _defineLocalCubicName: string;
  101210. /** @hidden */
  101211. _defineSphericalName: string;
  101212. /** @hidden */
  101213. _definePlanarName: string;
  101214. /** @hidden */
  101215. _defineEquirectangularName: string;
  101216. /** @hidden */
  101217. _defineMirroredEquirectangularFixedName: string;
  101218. /** @hidden */
  101219. _defineEquirectangularFixedName: string;
  101220. /** @hidden */
  101221. _defineSkyboxName: string;
  101222. /** @hidden */
  101223. _defineOppositeZ: string;
  101224. /** @hidden */
  101225. _cubeSamplerName: string;
  101226. /** @hidden */
  101227. _2DSamplerName: string;
  101228. protected _positionUVWName: string;
  101229. protected _directionWName: string;
  101230. protected _reflectionVectorName: string;
  101231. /** @hidden */
  101232. _reflectionCoordsName: string;
  101233. /** @hidden */
  101234. _reflectionMatrixName: string;
  101235. protected _reflectionColorName: string;
  101236. /**
  101237. * Gets or sets the texture associated with the node
  101238. */
  101239. texture: Nullable<BaseTexture>;
  101240. /**
  101241. * Create a new ReflectionTextureBaseBlock
  101242. * @param name defines the block name
  101243. */
  101244. constructor(name: string);
  101245. /**
  101246. * Gets the current class name
  101247. * @returns the class name
  101248. */
  101249. getClassName(): string;
  101250. /**
  101251. * Gets the world position input component
  101252. */
  101253. abstract get position(): NodeMaterialConnectionPoint;
  101254. /**
  101255. * Gets the world position input component
  101256. */
  101257. abstract get worldPosition(): NodeMaterialConnectionPoint;
  101258. /**
  101259. * Gets the world normal input component
  101260. */
  101261. abstract get worldNormal(): NodeMaterialConnectionPoint;
  101262. /**
  101263. * Gets the world input component
  101264. */
  101265. abstract get world(): NodeMaterialConnectionPoint;
  101266. /**
  101267. * Gets the camera (or eye) position component
  101268. */
  101269. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  101270. /**
  101271. * Gets the view input component
  101272. */
  101273. abstract get view(): NodeMaterialConnectionPoint;
  101274. protected _getTexture(): Nullable<BaseTexture>;
  101275. autoConfigure(material: NodeMaterial): void;
  101276. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101277. isReady(): boolean;
  101278. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  101279. /**
  101280. * Gets the code to inject in the vertex shader
  101281. * @param state current state of the node material building
  101282. * @returns the shader code
  101283. */
  101284. handleVertexSide(state: NodeMaterialBuildState): string;
  101285. /**
  101286. * Handles the inits for the fragment code path
  101287. * @param state node material build state
  101288. */
  101289. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  101290. /**
  101291. * Generates the reflection coords code for the fragment code path
  101292. * @param worldNormalVarName name of the world normal variable
  101293. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  101294. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  101295. * @returns the shader code
  101296. */
  101297. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  101298. /**
  101299. * Generates the reflection color code for the fragment code path
  101300. * @param lodVarName name of the lod variable
  101301. * @param swizzleLookupTexture swizzle to use for the final color variable
  101302. * @returns the shader code
  101303. */
  101304. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  101305. /**
  101306. * Generates the code corresponding to the connected output points
  101307. * @param state node material build state
  101308. * @param varName name of the variable to output
  101309. * @returns the shader code
  101310. */
  101311. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  101312. protected _buildBlock(state: NodeMaterialBuildState): this;
  101313. protected _dumpPropertiesCode(): string;
  101314. serialize(): any;
  101315. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101316. }
  101317. }
  101318. declare module BABYLON {
  101319. /**
  101320. * Defines a connection point to be used for points with a custom object type
  101321. */
  101322. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  101323. private _blockType;
  101324. private _blockName;
  101325. private _nameForCheking?;
  101326. /**
  101327. * Creates a new connection point
  101328. * @param name defines the connection point name
  101329. * @param ownerBlock defines the block hosting this connection point
  101330. * @param direction defines the direction of the connection point
  101331. */
  101332. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  101333. /**
  101334. * Gets a number indicating if the current point can be connected to another point
  101335. * @param connectionPoint defines the other connection point
  101336. * @returns a number defining the compatibility state
  101337. */
  101338. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  101339. /**
  101340. * Creates a block suitable to be used as an input for this input point.
  101341. * If null is returned, a block based on the point type will be created.
  101342. * @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
  101343. */
  101344. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  101345. }
  101346. }
  101347. declare module BABYLON {
  101348. /**
  101349. * Enum defining the type of properties that can be edited in the property pages in the NME
  101350. */
  101351. export enum PropertyTypeForEdition {
  101352. /** property is a boolean */
  101353. Boolean = 0,
  101354. /** property is a float */
  101355. Float = 1,
  101356. /** property is a Vector2 */
  101357. Vector2 = 2,
  101358. /** property is a list of values */
  101359. List = 3
  101360. }
  101361. /**
  101362. * Interface that defines an option in a variable of type list
  101363. */
  101364. export interface IEditablePropertyListOption {
  101365. /** label of the option */
  101366. "label": string;
  101367. /** value of the option */
  101368. "value": number;
  101369. }
  101370. /**
  101371. * Interface that defines the options available for an editable property
  101372. */
  101373. export interface IEditablePropertyOption {
  101374. /** min value */
  101375. "min"?: number;
  101376. /** max value */
  101377. "max"?: number;
  101378. /** notifiers: indicates which actions to take when the property is changed */
  101379. "notifiers"?: {
  101380. /** the material should be rebuilt */
  101381. "rebuild"?: boolean;
  101382. /** the preview should be updated */
  101383. "update"?: boolean;
  101384. };
  101385. /** list of the options for a variable of type list */
  101386. "options"?: IEditablePropertyListOption[];
  101387. }
  101388. /**
  101389. * Interface that describes an editable property
  101390. */
  101391. export interface IPropertyDescriptionForEdition {
  101392. /** name of the property */
  101393. "propertyName": string;
  101394. /** display name of the property */
  101395. "displayName": string;
  101396. /** type of the property */
  101397. "type": PropertyTypeForEdition;
  101398. /** group of the property - all properties with the same group value will be displayed in a specific section */
  101399. "groupName": string;
  101400. /** options for the property */
  101401. "options": IEditablePropertyOption;
  101402. }
  101403. /**
  101404. * Decorator that flags a property in a node material block as being editable
  101405. */
  101406. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  101407. }
  101408. declare module BABYLON {
  101409. /**
  101410. * Block used to implement the refraction part of the sub surface module of the PBR material
  101411. */
  101412. export class RefractionBlock extends NodeMaterialBlock {
  101413. /** @hidden */
  101414. _define3DName: string;
  101415. /** @hidden */
  101416. _refractionMatrixName: string;
  101417. /** @hidden */
  101418. _defineLODRefractionAlpha: string;
  101419. /** @hidden */
  101420. _defineLinearSpecularRefraction: string;
  101421. /** @hidden */
  101422. _defineOppositeZ: string;
  101423. /** @hidden */
  101424. _cubeSamplerName: string;
  101425. /** @hidden */
  101426. _2DSamplerName: string;
  101427. /** @hidden */
  101428. _vRefractionMicrosurfaceInfosName: string;
  101429. /** @hidden */
  101430. _vRefractionInfosName: string;
  101431. private _scene;
  101432. /**
  101433. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  101434. * Materials half opaque for instance using refraction could benefit from this control.
  101435. */
  101436. linkRefractionWithTransparency: boolean;
  101437. /**
  101438. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  101439. */
  101440. invertRefractionY: boolean;
  101441. /**
  101442. * Gets or sets the texture associated with the node
  101443. */
  101444. texture: Nullable<BaseTexture>;
  101445. /**
  101446. * Create a new RefractionBlock
  101447. * @param name defines the block name
  101448. */
  101449. constructor(name: string);
  101450. /**
  101451. * Gets the current class name
  101452. * @returns the class name
  101453. */
  101454. getClassName(): string;
  101455. /**
  101456. * Gets the intensity input component
  101457. */
  101458. get intensity(): NodeMaterialConnectionPoint;
  101459. /**
  101460. * Gets the index of refraction input component
  101461. */
  101462. get indexOfRefraction(): NodeMaterialConnectionPoint;
  101463. /**
  101464. * Gets the tint at distance input component
  101465. */
  101466. get tintAtDistance(): NodeMaterialConnectionPoint;
  101467. /**
  101468. * Gets the view input component
  101469. */
  101470. get view(): NodeMaterialConnectionPoint;
  101471. /**
  101472. * Gets the refraction object output component
  101473. */
  101474. get refraction(): NodeMaterialConnectionPoint;
  101475. /**
  101476. * Returns true if the block has a texture
  101477. */
  101478. get hasTexture(): boolean;
  101479. protected _getTexture(): Nullable<BaseTexture>;
  101480. autoConfigure(material: NodeMaterial): void;
  101481. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101482. isReady(): boolean;
  101483. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101484. /**
  101485. * Gets the main code of the block (fragment side)
  101486. * @param state current state of the node material building
  101487. * @returns the shader code
  101488. */
  101489. getCode(state: NodeMaterialBuildState): string;
  101490. protected _buildBlock(state: NodeMaterialBuildState): this;
  101491. protected _dumpPropertiesCode(): string;
  101492. serialize(): any;
  101493. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101494. }
  101495. }
  101496. declare module BABYLON {
  101497. /**
  101498. * Base block used as input for post process
  101499. */
  101500. export class CurrentScreenBlock extends NodeMaterialBlock {
  101501. private _samplerName;
  101502. private _linearDefineName;
  101503. private _gammaDefineName;
  101504. private _mainUVName;
  101505. private _tempTextureRead;
  101506. /**
  101507. * Gets or sets the texture associated with the node
  101508. */
  101509. texture: Nullable<BaseTexture>;
  101510. /**
  101511. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101512. */
  101513. convertToGammaSpace: boolean;
  101514. /**
  101515. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101516. */
  101517. convertToLinearSpace: boolean;
  101518. /**
  101519. * Create a new CurrentScreenBlock
  101520. * @param name defines the block name
  101521. */
  101522. constructor(name: string);
  101523. /**
  101524. * Gets the current class name
  101525. * @returns the class name
  101526. */
  101527. getClassName(): string;
  101528. /**
  101529. * Gets the uv input component
  101530. */
  101531. get uv(): NodeMaterialConnectionPoint;
  101532. /**
  101533. * Gets the rgba output component
  101534. */
  101535. get rgba(): NodeMaterialConnectionPoint;
  101536. /**
  101537. * Gets the rgb output component
  101538. */
  101539. get rgb(): NodeMaterialConnectionPoint;
  101540. /**
  101541. * Gets the r output component
  101542. */
  101543. get r(): NodeMaterialConnectionPoint;
  101544. /**
  101545. * Gets the g output component
  101546. */
  101547. get g(): NodeMaterialConnectionPoint;
  101548. /**
  101549. * Gets the b output component
  101550. */
  101551. get b(): NodeMaterialConnectionPoint;
  101552. /**
  101553. * Gets the a output component
  101554. */
  101555. get a(): NodeMaterialConnectionPoint;
  101556. /**
  101557. * Initialize the block and prepare the context for build
  101558. * @param state defines the state that will be used for the build
  101559. */
  101560. initialize(state: NodeMaterialBuildState): void;
  101561. get target(): NodeMaterialBlockTargets;
  101562. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101563. isReady(): boolean;
  101564. private _injectVertexCode;
  101565. private _writeTextureRead;
  101566. private _writeOutput;
  101567. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101568. serialize(): any;
  101569. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101570. }
  101571. }
  101572. declare module BABYLON {
  101573. /**
  101574. * Base block used for the particle texture
  101575. */
  101576. export class ParticleTextureBlock extends NodeMaterialBlock {
  101577. private _samplerName;
  101578. private _linearDefineName;
  101579. private _gammaDefineName;
  101580. private _tempTextureRead;
  101581. /**
  101582. * Gets or sets the texture associated with the node
  101583. */
  101584. texture: Nullable<BaseTexture>;
  101585. /**
  101586. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101587. */
  101588. convertToGammaSpace: boolean;
  101589. /**
  101590. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101591. */
  101592. convertToLinearSpace: boolean;
  101593. /**
  101594. * Create a new ParticleTextureBlock
  101595. * @param name defines the block name
  101596. */
  101597. constructor(name: string);
  101598. /**
  101599. * Gets the current class name
  101600. * @returns the class name
  101601. */
  101602. getClassName(): string;
  101603. /**
  101604. * Gets the uv input component
  101605. */
  101606. get uv(): NodeMaterialConnectionPoint;
  101607. /**
  101608. * Gets the rgba output component
  101609. */
  101610. get rgba(): NodeMaterialConnectionPoint;
  101611. /**
  101612. * Gets the rgb output component
  101613. */
  101614. get rgb(): NodeMaterialConnectionPoint;
  101615. /**
  101616. * Gets the r output component
  101617. */
  101618. get r(): NodeMaterialConnectionPoint;
  101619. /**
  101620. * Gets the g output component
  101621. */
  101622. get g(): NodeMaterialConnectionPoint;
  101623. /**
  101624. * Gets the b output component
  101625. */
  101626. get b(): NodeMaterialConnectionPoint;
  101627. /**
  101628. * Gets the a output component
  101629. */
  101630. get a(): NodeMaterialConnectionPoint;
  101631. /**
  101632. * Initialize the block and prepare the context for build
  101633. * @param state defines the state that will be used for the build
  101634. */
  101635. initialize(state: NodeMaterialBuildState): void;
  101636. autoConfigure(material: NodeMaterial): void;
  101637. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101638. isReady(): boolean;
  101639. private _writeOutput;
  101640. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101641. serialize(): any;
  101642. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101643. }
  101644. }
  101645. declare module BABYLON {
  101646. /**
  101647. * Class used to store shared data between 2 NodeMaterialBuildState
  101648. */
  101649. export class NodeMaterialBuildStateSharedData {
  101650. /**
  101651. * Gets the list of emitted varyings
  101652. */
  101653. temps: string[];
  101654. /**
  101655. * Gets the list of emitted varyings
  101656. */
  101657. varyings: string[];
  101658. /**
  101659. * Gets the varying declaration string
  101660. */
  101661. varyingDeclaration: string;
  101662. /**
  101663. * Input blocks
  101664. */
  101665. inputBlocks: InputBlock[];
  101666. /**
  101667. * Input blocks
  101668. */
  101669. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101670. /**
  101671. * Bindable blocks (Blocks that need to set data to the effect)
  101672. */
  101673. bindableBlocks: NodeMaterialBlock[];
  101674. /**
  101675. * List of blocks that can provide a compilation fallback
  101676. */
  101677. blocksWithFallbacks: NodeMaterialBlock[];
  101678. /**
  101679. * List of blocks that can provide a define update
  101680. */
  101681. blocksWithDefines: NodeMaterialBlock[];
  101682. /**
  101683. * List of blocks that can provide a repeatable content
  101684. */
  101685. repeatableContentBlocks: NodeMaterialBlock[];
  101686. /**
  101687. * List of blocks that can provide a dynamic list of uniforms
  101688. */
  101689. dynamicUniformBlocks: NodeMaterialBlock[];
  101690. /**
  101691. * List of blocks that can block the isReady function for the material
  101692. */
  101693. blockingBlocks: NodeMaterialBlock[];
  101694. /**
  101695. * Gets the list of animated inputs
  101696. */
  101697. animatedInputs: InputBlock[];
  101698. /**
  101699. * Build Id used to avoid multiple recompilations
  101700. */
  101701. buildId: number;
  101702. /** List of emitted variables */
  101703. variableNames: {
  101704. [key: string]: number;
  101705. };
  101706. /** List of emitted defines */
  101707. defineNames: {
  101708. [key: string]: number;
  101709. };
  101710. /** Should emit comments? */
  101711. emitComments: boolean;
  101712. /** Emit build activity */
  101713. verbose: boolean;
  101714. /** Gets or sets the hosting scene */
  101715. scene: Scene;
  101716. /**
  101717. * Gets the compilation hints emitted at compilation time
  101718. */
  101719. hints: {
  101720. needWorldViewMatrix: boolean;
  101721. needWorldViewProjectionMatrix: boolean;
  101722. needAlphaBlending: boolean;
  101723. needAlphaTesting: boolean;
  101724. };
  101725. /**
  101726. * List of compilation checks
  101727. */
  101728. checks: {
  101729. emitVertex: boolean;
  101730. emitFragment: boolean;
  101731. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101732. };
  101733. /**
  101734. * Is vertex program allowed to be empty?
  101735. */
  101736. allowEmptyVertexProgram: boolean;
  101737. /** Creates a new shared data */
  101738. constructor();
  101739. /**
  101740. * Emits console errors and exceptions if there is a failing check
  101741. */
  101742. emitErrors(): void;
  101743. }
  101744. }
  101745. declare module BABYLON {
  101746. /**
  101747. * Class used to store node based material build state
  101748. */
  101749. export class NodeMaterialBuildState {
  101750. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101751. supportUniformBuffers: boolean;
  101752. /**
  101753. * Gets the list of emitted attributes
  101754. */
  101755. attributes: string[];
  101756. /**
  101757. * Gets the list of emitted uniforms
  101758. */
  101759. uniforms: string[];
  101760. /**
  101761. * Gets the list of emitted constants
  101762. */
  101763. constants: string[];
  101764. /**
  101765. * Gets the list of emitted samplers
  101766. */
  101767. samplers: string[];
  101768. /**
  101769. * Gets the list of emitted functions
  101770. */
  101771. functions: {
  101772. [key: string]: string;
  101773. };
  101774. /**
  101775. * Gets the list of emitted extensions
  101776. */
  101777. extensions: {
  101778. [key: string]: string;
  101779. };
  101780. /**
  101781. * Gets the target of the compilation state
  101782. */
  101783. target: NodeMaterialBlockTargets;
  101784. /**
  101785. * Gets the list of emitted counters
  101786. */
  101787. counters: {
  101788. [key: string]: number;
  101789. };
  101790. /**
  101791. * Shared data between multiple NodeMaterialBuildState instances
  101792. */
  101793. sharedData: NodeMaterialBuildStateSharedData;
  101794. /** @hidden */
  101795. _vertexState: NodeMaterialBuildState;
  101796. /** @hidden */
  101797. _attributeDeclaration: string;
  101798. /** @hidden */
  101799. _uniformDeclaration: string;
  101800. /** @hidden */
  101801. _constantDeclaration: string;
  101802. /** @hidden */
  101803. _samplerDeclaration: string;
  101804. /** @hidden */
  101805. _varyingTransfer: string;
  101806. /** @hidden */
  101807. _injectAtEnd: string;
  101808. private _repeatableContentAnchorIndex;
  101809. /** @hidden */
  101810. _builtCompilationString: string;
  101811. /**
  101812. * Gets the emitted compilation strings
  101813. */
  101814. compilationString: string;
  101815. /**
  101816. * Finalize the compilation strings
  101817. * @param state defines the current compilation state
  101818. */
  101819. finalize(state: NodeMaterialBuildState): void;
  101820. /** @hidden */
  101821. get _repeatableContentAnchor(): string;
  101822. /** @hidden */
  101823. _getFreeVariableName(prefix: string): string;
  101824. /** @hidden */
  101825. _getFreeDefineName(prefix: string): string;
  101826. /** @hidden */
  101827. _excludeVariableName(name: string): void;
  101828. /** @hidden */
  101829. _emit2DSampler(name: string): void;
  101830. /** @hidden */
  101831. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101832. /** @hidden */
  101833. _emitExtension(name: string, extension: string, define?: string): void;
  101834. /** @hidden */
  101835. _emitFunction(name: string, code: string, comments: string): void;
  101836. /** @hidden */
  101837. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101838. replaceStrings?: {
  101839. search: RegExp;
  101840. replace: string;
  101841. }[];
  101842. repeatKey?: string;
  101843. }): string;
  101844. /** @hidden */
  101845. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101846. repeatKey?: string;
  101847. removeAttributes?: boolean;
  101848. removeUniforms?: boolean;
  101849. removeVaryings?: boolean;
  101850. removeIfDef?: boolean;
  101851. replaceStrings?: {
  101852. search: RegExp;
  101853. replace: string;
  101854. }[];
  101855. }, storeKey?: string): void;
  101856. /** @hidden */
  101857. _registerTempVariable(name: string): boolean;
  101858. /** @hidden */
  101859. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101860. /** @hidden */
  101861. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101862. /** @hidden */
  101863. _emitFloat(value: number): string;
  101864. }
  101865. }
  101866. declare module BABYLON {
  101867. /**
  101868. * Helper class used to generate session unique ID
  101869. */
  101870. export class UniqueIdGenerator {
  101871. private static _UniqueIdCounter;
  101872. /**
  101873. * Gets an unique (relatively to the current scene) Id
  101874. */
  101875. static get UniqueId(): number;
  101876. }
  101877. }
  101878. declare module BABYLON {
  101879. /**
  101880. * Defines a block that can be used inside a node based material
  101881. */
  101882. export class NodeMaterialBlock {
  101883. private _buildId;
  101884. private _buildTarget;
  101885. private _target;
  101886. private _isFinalMerger;
  101887. private _isInput;
  101888. private _name;
  101889. protected _isUnique: boolean;
  101890. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101891. inputsAreExclusive: boolean;
  101892. /** @hidden */
  101893. _codeVariableName: string;
  101894. /** @hidden */
  101895. _inputs: NodeMaterialConnectionPoint[];
  101896. /** @hidden */
  101897. _outputs: NodeMaterialConnectionPoint[];
  101898. /** @hidden */
  101899. _preparationId: number;
  101900. /**
  101901. * Gets the name of the block
  101902. */
  101903. get name(): string;
  101904. /**
  101905. * Sets the name of the block. Will check if the name is valid.
  101906. */
  101907. set name(newName: string);
  101908. /**
  101909. * Gets or sets the unique id of the node
  101910. */
  101911. uniqueId: number;
  101912. /**
  101913. * Gets or sets the comments associated with this block
  101914. */
  101915. comments: string;
  101916. /**
  101917. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101918. */
  101919. get isUnique(): boolean;
  101920. /**
  101921. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101922. */
  101923. get isFinalMerger(): boolean;
  101924. /**
  101925. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101926. */
  101927. get isInput(): boolean;
  101928. /**
  101929. * Gets or sets the build Id
  101930. */
  101931. get buildId(): number;
  101932. set buildId(value: number);
  101933. /**
  101934. * Gets or sets the target of the block
  101935. */
  101936. get target(): NodeMaterialBlockTargets;
  101937. set target(value: NodeMaterialBlockTargets);
  101938. /**
  101939. * Gets the list of input points
  101940. */
  101941. get inputs(): NodeMaterialConnectionPoint[];
  101942. /** Gets the list of output points */
  101943. get outputs(): NodeMaterialConnectionPoint[];
  101944. /**
  101945. * Find an input by its name
  101946. * @param name defines the name of the input to look for
  101947. * @returns the input or null if not found
  101948. */
  101949. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101950. /**
  101951. * Find an output by its name
  101952. * @param name defines the name of the outputto look for
  101953. * @returns the output or null if not found
  101954. */
  101955. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101956. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  101957. visibleInInspector: boolean;
  101958. /**
  101959. * Creates a new NodeMaterialBlock
  101960. * @param name defines the block name
  101961. * @param target defines the target of that block (Vertex by default)
  101962. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101963. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101964. */
  101965. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101966. /**
  101967. * Initialize the block and prepare the context for build
  101968. * @param state defines the state that will be used for the build
  101969. */
  101970. initialize(state: NodeMaterialBuildState): void;
  101971. /**
  101972. * Bind data to effect. Will only be called for blocks with isBindable === true
  101973. * @param effect defines the effect to bind data to
  101974. * @param nodeMaterial defines the hosting NodeMaterial
  101975. * @param mesh defines the mesh that will be rendered
  101976. * @param subMesh defines the submesh that will be rendered
  101977. */
  101978. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101979. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101980. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101981. protected _writeFloat(value: number): string;
  101982. /**
  101983. * Gets the current class name e.g. "NodeMaterialBlock"
  101984. * @returns the class name
  101985. */
  101986. getClassName(): string;
  101987. /**
  101988. * Register a new input. Must be called inside a block constructor
  101989. * @param name defines the connection point name
  101990. * @param type defines the connection point type
  101991. * @param isOptional defines a boolean indicating that this input can be omitted
  101992. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101993. * @param point an already created connection point. If not provided, create a new one
  101994. * @returns the current block
  101995. */
  101996. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101997. /**
  101998. * Register a new output. Must be called inside a block constructor
  101999. * @param name defines the connection point name
  102000. * @param type defines the connection point type
  102001. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  102002. * @param point an already created connection point. If not provided, create a new one
  102003. * @returns the current block
  102004. */
  102005. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  102006. /**
  102007. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  102008. * @param forOutput defines an optional connection point to check compatibility with
  102009. * @returns the first available input or null
  102010. */
  102011. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  102012. /**
  102013. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  102014. * @param forBlock defines an optional block to check compatibility with
  102015. * @returns the first available input or null
  102016. */
  102017. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  102018. /**
  102019. * Gets the sibling of the given output
  102020. * @param current defines the current output
  102021. * @returns the next output in the list or null
  102022. */
  102023. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  102024. /**
  102025. * Connect current block with another block
  102026. * @param other defines the block to connect with
  102027. * @param options define the various options to help pick the right connections
  102028. * @returns the current block
  102029. */
  102030. connectTo(other: NodeMaterialBlock, options?: {
  102031. input?: string;
  102032. output?: string;
  102033. outputSwizzle?: string;
  102034. }): this | undefined;
  102035. protected _buildBlock(state: NodeMaterialBuildState): void;
  102036. /**
  102037. * Add uniforms, samplers and uniform buffers at compilation time
  102038. * @param state defines the state to update
  102039. * @param nodeMaterial defines the node material requesting the update
  102040. * @param defines defines the material defines to update
  102041. * @param uniformBuffers defines the list of uniform buffer names
  102042. */
  102043. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  102044. /**
  102045. * Add potential fallbacks if shader compilation fails
  102046. * @param mesh defines the mesh to be rendered
  102047. * @param fallbacks defines the current prioritized list of fallbacks
  102048. */
  102049. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  102050. /**
  102051. * Initialize defines for shader compilation
  102052. * @param mesh defines the mesh to be rendered
  102053. * @param nodeMaterial defines the node material requesting the update
  102054. * @param defines defines the material defines to update
  102055. * @param useInstances specifies that instances should be used
  102056. */
  102057. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  102058. /**
  102059. * Update defines for shader compilation
  102060. * @param mesh defines the mesh to be rendered
  102061. * @param nodeMaterial defines the node material requesting the update
  102062. * @param defines defines the material defines to update
  102063. * @param useInstances specifies that instances should be used
  102064. * @param subMesh defines which submesh to render
  102065. */
  102066. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  102067. /**
  102068. * Lets the block try to connect some inputs automatically
  102069. * @param material defines the hosting NodeMaterial
  102070. */
  102071. autoConfigure(material: NodeMaterial): void;
  102072. /**
  102073. * Function called when a block is declared as repeatable content generator
  102074. * @param vertexShaderState defines the current compilation state for the vertex shader
  102075. * @param fragmentShaderState defines the current compilation state for the fragment shader
  102076. * @param mesh defines the mesh to be rendered
  102077. * @param defines defines the material defines to update
  102078. */
  102079. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  102080. /**
  102081. * Checks if the block is ready
  102082. * @param mesh defines the mesh to be rendered
  102083. * @param nodeMaterial defines the node material requesting the update
  102084. * @param defines defines the material defines to update
  102085. * @param useInstances specifies that instances should be used
  102086. * @returns true if the block is ready
  102087. */
  102088. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  102089. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  102090. private _processBuild;
  102091. /**
  102092. * Validates the new name for the block node.
  102093. * @param newName the new name to be given to the node.
  102094. * @returns false if the name is a reserve word, else true.
  102095. */
  102096. validateBlockName(newName: string): boolean;
  102097. /**
  102098. * Compile the current node and generate the shader code
  102099. * @param state defines the current compilation state (uniforms, samplers, current string)
  102100. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  102101. * @returns true if already built
  102102. */
  102103. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  102104. protected _inputRename(name: string): string;
  102105. protected _outputRename(name: string): string;
  102106. protected _dumpPropertiesCode(): string;
  102107. /** @hidden */
  102108. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  102109. /** @hidden */
  102110. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  102111. /**
  102112. * Clone the current block to a new identical block
  102113. * @param scene defines the hosting scene
  102114. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102115. * @returns a copy of the current block
  102116. */
  102117. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  102118. /**
  102119. * Serializes this block in a JSON representation
  102120. * @returns the serialized block object
  102121. */
  102122. serialize(): any;
  102123. /** @hidden */
  102124. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102125. private _deserializePortDisplayNamesAndExposedOnFrame;
  102126. /**
  102127. * Release resources
  102128. */
  102129. dispose(): void;
  102130. }
  102131. }
  102132. declare module BABYLON {
  102133. /**
  102134. * Base class of materials working in push mode in babylon JS
  102135. * @hidden
  102136. */
  102137. export class PushMaterial extends Material {
  102138. protected _activeEffect: Effect;
  102139. protected _normalMatrix: Matrix;
  102140. constructor(name: string, scene: Scene);
  102141. getEffect(): Effect;
  102142. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  102143. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  102144. /**
  102145. * Binds the given world matrix to the active effect
  102146. *
  102147. * @param world the matrix to bind
  102148. */
  102149. bindOnlyWorldMatrix(world: Matrix): void;
  102150. /**
  102151. * Binds the given normal matrix to the active effect
  102152. *
  102153. * @param normalMatrix the matrix to bind
  102154. */
  102155. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  102156. bind(world: Matrix, mesh?: Mesh): void;
  102157. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  102158. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  102159. }
  102160. }
  102161. declare module BABYLON {
  102162. /**
  102163. * Root class for all node material optimizers
  102164. */
  102165. export class NodeMaterialOptimizer {
  102166. /**
  102167. * Function used to optimize a NodeMaterial graph
  102168. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  102169. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  102170. */
  102171. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  102172. }
  102173. }
  102174. declare module BABYLON {
  102175. /**
  102176. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  102177. */
  102178. export class TransformBlock extends NodeMaterialBlock {
  102179. /**
  102180. * Defines the value to use to complement W value to transform it to a Vector4
  102181. */
  102182. complementW: number;
  102183. /**
  102184. * Defines the value to use to complement z value to transform it to a Vector4
  102185. */
  102186. complementZ: number;
  102187. /**
  102188. * Creates a new TransformBlock
  102189. * @param name defines the block name
  102190. */
  102191. constructor(name: string);
  102192. /**
  102193. * Gets the current class name
  102194. * @returns the class name
  102195. */
  102196. getClassName(): string;
  102197. /**
  102198. * Gets the vector input
  102199. */
  102200. get vector(): NodeMaterialConnectionPoint;
  102201. /**
  102202. * Gets the output component
  102203. */
  102204. get output(): NodeMaterialConnectionPoint;
  102205. /**
  102206. * Gets the xyz output component
  102207. */
  102208. get xyz(): NodeMaterialConnectionPoint;
  102209. /**
  102210. * Gets the matrix transform input
  102211. */
  102212. get transform(): NodeMaterialConnectionPoint;
  102213. protected _buildBlock(state: NodeMaterialBuildState): this;
  102214. /**
  102215. * Update defines for shader compilation
  102216. * @param mesh defines the mesh to be rendered
  102217. * @param nodeMaterial defines the node material requesting the update
  102218. * @param defines defines the material defines to update
  102219. * @param useInstances specifies that instances should be used
  102220. * @param subMesh defines which submesh to render
  102221. */
  102222. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  102223. serialize(): any;
  102224. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102225. protected _dumpPropertiesCode(): string;
  102226. }
  102227. }
  102228. declare module BABYLON {
  102229. /**
  102230. * Block used to output the vertex position
  102231. */
  102232. export class VertexOutputBlock extends NodeMaterialBlock {
  102233. /**
  102234. * Creates a new VertexOutputBlock
  102235. * @param name defines the block name
  102236. */
  102237. constructor(name: string);
  102238. /**
  102239. * Gets the current class name
  102240. * @returns the class name
  102241. */
  102242. getClassName(): string;
  102243. /**
  102244. * Gets the vector input component
  102245. */
  102246. get vector(): NodeMaterialConnectionPoint;
  102247. protected _buildBlock(state: NodeMaterialBuildState): this;
  102248. }
  102249. }
  102250. declare module BABYLON {
  102251. /**
  102252. * Block used to output the final color
  102253. */
  102254. export class FragmentOutputBlock extends NodeMaterialBlock {
  102255. /**
  102256. * Create a new FragmentOutputBlock
  102257. * @param name defines the block name
  102258. */
  102259. constructor(name: string);
  102260. /**
  102261. * Gets the current class name
  102262. * @returns the class name
  102263. */
  102264. getClassName(): string;
  102265. /**
  102266. * Gets the rgba input component
  102267. */
  102268. get rgba(): NodeMaterialConnectionPoint;
  102269. /**
  102270. * Gets the rgb input component
  102271. */
  102272. get rgb(): NodeMaterialConnectionPoint;
  102273. /**
  102274. * Gets the a input component
  102275. */
  102276. get a(): NodeMaterialConnectionPoint;
  102277. protected _buildBlock(state: NodeMaterialBuildState): this;
  102278. }
  102279. }
  102280. declare module BABYLON {
  102281. /**
  102282. * Block used for the particle ramp gradient section
  102283. */
  102284. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  102285. /**
  102286. * Create a new ParticleRampGradientBlock
  102287. * @param name defines the block name
  102288. */
  102289. constructor(name: string);
  102290. /**
  102291. * Gets the current class name
  102292. * @returns the class name
  102293. */
  102294. getClassName(): string;
  102295. /**
  102296. * Gets the color input component
  102297. */
  102298. get color(): NodeMaterialConnectionPoint;
  102299. /**
  102300. * Gets the rampColor output component
  102301. */
  102302. get rampColor(): NodeMaterialConnectionPoint;
  102303. /**
  102304. * Initialize the block and prepare the context for build
  102305. * @param state defines the state that will be used for the build
  102306. */
  102307. initialize(state: NodeMaterialBuildState): void;
  102308. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102309. }
  102310. }
  102311. declare module BABYLON {
  102312. /**
  102313. * Block used for the particle blend multiply section
  102314. */
  102315. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  102316. /**
  102317. * Create a new ParticleBlendMultiplyBlock
  102318. * @param name defines the block name
  102319. */
  102320. constructor(name: string);
  102321. /**
  102322. * Gets the current class name
  102323. * @returns the class name
  102324. */
  102325. getClassName(): string;
  102326. /**
  102327. * Gets the color input component
  102328. */
  102329. get color(): NodeMaterialConnectionPoint;
  102330. /**
  102331. * Gets the alphaTexture input component
  102332. */
  102333. get alphaTexture(): NodeMaterialConnectionPoint;
  102334. /**
  102335. * Gets the alphaColor input component
  102336. */
  102337. get alphaColor(): NodeMaterialConnectionPoint;
  102338. /**
  102339. * Gets the blendColor output component
  102340. */
  102341. get blendColor(): NodeMaterialConnectionPoint;
  102342. /**
  102343. * Initialize the block and prepare the context for build
  102344. * @param state defines the state that will be used for the build
  102345. */
  102346. initialize(state: NodeMaterialBuildState): void;
  102347. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102348. }
  102349. }
  102350. declare module BABYLON {
  102351. /**
  102352. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  102353. */
  102354. export class VectorMergerBlock extends NodeMaterialBlock {
  102355. /**
  102356. * Create a new VectorMergerBlock
  102357. * @param name defines the block name
  102358. */
  102359. constructor(name: string);
  102360. /**
  102361. * Gets the current class name
  102362. * @returns the class name
  102363. */
  102364. getClassName(): string;
  102365. /**
  102366. * Gets the xyz component (input)
  102367. */
  102368. get xyzIn(): NodeMaterialConnectionPoint;
  102369. /**
  102370. * Gets the xy component (input)
  102371. */
  102372. get xyIn(): NodeMaterialConnectionPoint;
  102373. /**
  102374. * Gets the x component (input)
  102375. */
  102376. get x(): NodeMaterialConnectionPoint;
  102377. /**
  102378. * Gets the y component (input)
  102379. */
  102380. get y(): NodeMaterialConnectionPoint;
  102381. /**
  102382. * Gets the z component (input)
  102383. */
  102384. get z(): NodeMaterialConnectionPoint;
  102385. /**
  102386. * Gets the w component (input)
  102387. */
  102388. get w(): NodeMaterialConnectionPoint;
  102389. /**
  102390. * Gets the xyzw component (output)
  102391. */
  102392. get xyzw(): NodeMaterialConnectionPoint;
  102393. /**
  102394. * Gets the xyz component (output)
  102395. */
  102396. get xyzOut(): NodeMaterialConnectionPoint;
  102397. /**
  102398. * Gets the xy component (output)
  102399. */
  102400. get xyOut(): NodeMaterialConnectionPoint;
  102401. /**
  102402. * Gets the xy component (output)
  102403. * @deprecated Please use xyOut instead.
  102404. */
  102405. get xy(): NodeMaterialConnectionPoint;
  102406. /**
  102407. * Gets the xyz component (output)
  102408. * @deprecated Please use xyzOut instead.
  102409. */
  102410. get xyz(): NodeMaterialConnectionPoint;
  102411. protected _buildBlock(state: NodeMaterialBuildState): this;
  102412. }
  102413. }
  102414. declare module BABYLON {
  102415. /**
  102416. * Block used to remap a float from a range to a new one
  102417. */
  102418. export class RemapBlock extends NodeMaterialBlock {
  102419. /**
  102420. * Gets or sets the source range
  102421. */
  102422. sourceRange: Vector2;
  102423. /**
  102424. * Gets or sets the target range
  102425. */
  102426. targetRange: Vector2;
  102427. /**
  102428. * Creates a new RemapBlock
  102429. * @param name defines the block name
  102430. */
  102431. constructor(name: string);
  102432. /**
  102433. * Gets the current class name
  102434. * @returns the class name
  102435. */
  102436. getClassName(): string;
  102437. /**
  102438. * Gets the input component
  102439. */
  102440. get input(): NodeMaterialConnectionPoint;
  102441. /**
  102442. * Gets the source min input component
  102443. */
  102444. get sourceMin(): NodeMaterialConnectionPoint;
  102445. /**
  102446. * Gets the source max input component
  102447. */
  102448. get sourceMax(): NodeMaterialConnectionPoint;
  102449. /**
  102450. * Gets the target min input component
  102451. */
  102452. get targetMin(): NodeMaterialConnectionPoint;
  102453. /**
  102454. * Gets the target max input component
  102455. */
  102456. get targetMax(): NodeMaterialConnectionPoint;
  102457. /**
  102458. * Gets the output component
  102459. */
  102460. get output(): NodeMaterialConnectionPoint;
  102461. protected _buildBlock(state: NodeMaterialBuildState): this;
  102462. protected _dumpPropertiesCode(): string;
  102463. serialize(): any;
  102464. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102465. }
  102466. }
  102467. declare module BABYLON {
  102468. /**
  102469. * Block used to multiply 2 values
  102470. */
  102471. export class MultiplyBlock extends NodeMaterialBlock {
  102472. /**
  102473. * Creates a new MultiplyBlock
  102474. * @param name defines the block name
  102475. */
  102476. constructor(name: string);
  102477. /**
  102478. * Gets the current class name
  102479. * @returns the class name
  102480. */
  102481. getClassName(): string;
  102482. /**
  102483. * Gets the left operand input component
  102484. */
  102485. get left(): NodeMaterialConnectionPoint;
  102486. /**
  102487. * Gets the right operand input component
  102488. */
  102489. get right(): NodeMaterialConnectionPoint;
  102490. /**
  102491. * Gets the output component
  102492. */
  102493. get output(): NodeMaterialConnectionPoint;
  102494. protected _buildBlock(state: NodeMaterialBuildState): this;
  102495. }
  102496. }
  102497. declare module BABYLON {
  102498. /**
  102499. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  102500. */
  102501. export class ColorSplitterBlock extends NodeMaterialBlock {
  102502. /**
  102503. * Create a new ColorSplitterBlock
  102504. * @param name defines the block name
  102505. */
  102506. constructor(name: string);
  102507. /**
  102508. * Gets the current class name
  102509. * @returns the class name
  102510. */
  102511. getClassName(): string;
  102512. /**
  102513. * Gets the rgba component (input)
  102514. */
  102515. get rgba(): NodeMaterialConnectionPoint;
  102516. /**
  102517. * Gets the rgb component (input)
  102518. */
  102519. get rgbIn(): NodeMaterialConnectionPoint;
  102520. /**
  102521. * Gets the rgb component (output)
  102522. */
  102523. get rgbOut(): NodeMaterialConnectionPoint;
  102524. /**
  102525. * Gets the r component (output)
  102526. */
  102527. get r(): NodeMaterialConnectionPoint;
  102528. /**
  102529. * Gets the g component (output)
  102530. */
  102531. get g(): NodeMaterialConnectionPoint;
  102532. /**
  102533. * Gets the b component (output)
  102534. */
  102535. get b(): NodeMaterialConnectionPoint;
  102536. /**
  102537. * Gets the a component (output)
  102538. */
  102539. get a(): NodeMaterialConnectionPoint;
  102540. protected _inputRename(name: string): string;
  102541. protected _outputRename(name: string): string;
  102542. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102543. }
  102544. }
  102545. declare module BABYLON {
  102546. /**
  102547. * Operations supported by the Trigonometry block
  102548. */
  102549. export enum TrigonometryBlockOperations {
  102550. /** Cos */
  102551. Cos = 0,
  102552. /** Sin */
  102553. Sin = 1,
  102554. /** Abs */
  102555. Abs = 2,
  102556. /** Exp */
  102557. Exp = 3,
  102558. /** Exp2 */
  102559. Exp2 = 4,
  102560. /** Round */
  102561. Round = 5,
  102562. /** Floor */
  102563. Floor = 6,
  102564. /** Ceiling */
  102565. Ceiling = 7,
  102566. /** Square root */
  102567. Sqrt = 8,
  102568. /** Log */
  102569. Log = 9,
  102570. /** Tangent */
  102571. Tan = 10,
  102572. /** Arc tangent */
  102573. ArcTan = 11,
  102574. /** Arc cosinus */
  102575. ArcCos = 12,
  102576. /** Arc sinus */
  102577. ArcSin = 13,
  102578. /** Fraction */
  102579. Fract = 14,
  102580. /** Sign */
  102581. Sign = 15,
  102582. /** To radians (from degrees) */
  102583. Radians = 16,
  102584. /** To degrees (from radians) */
  102585. Degrees = 17
  102586. }
  102587. /**
  102588. * Block used to apply trigonometry operation to floats
  102589. */
  102590. export class TrigonometryBlock extends NodeMaterialBlock {
  102591. /**
  102592. * Gets or sets the operation applied by the block
  102593. */
  102594. operation: TrigonometryBlockOperations;
  102595. /**
  102596. * Creates a new TrigonometryBlock
  102597. * @param name defines the block name
  102598. */
  102599. constructor(name: string);
  102600. /**
  102601. * Gets the current class name
  102602. * @returns the class name
  102603. */
  102604. getClassName(): string;
  102605. /**
  102606. * Gets the input component
  102607. */
  102608. get input(): NodeMaterialConnectionPoint;
  102609. /**
  102610. * Gets the output component
  102611. */
  102612. get output(): NodeMaterialConnectionPoint;
  102613. protected _buildBlock(state: NodeMaterialBuildState): this;
  102614. serialize(): any;
  102615. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102616. protected _dumpPropertiesCode(): string;
  102617. }
  102618. }
  102619. declare module BABYLON {
  102620. /**
  102621. * Interface used to configure the node material editor
  102622. */
  102623. export interface INodeMaterialEditorOptions {
  102624. /** Define the URl to load node editor script */
  102625. editorURL?: string;
  102626. }
  102627. /** @hidden */
  102628. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  102629. NORMAL: boolean;
  102630. TANGENT: boolean;
  102631. UV1: boolean;
  102632. /** BONES */
  102633. NUM_BONE_INFLUENCERS: number;
  102634. BonesPerMesh: number;
  102635. BONETEXTURE: boolean;
  102636. /** MORPH TARGETS */
  102637. MORPHTARGETS: boolean;
  102638. MORPHTARGETS_NORMAL: boolean;
  102639. MORPHTARGETS_TANGENT: boolean;
  102640. MORPHTARGETS_UV: boolean;
  102641. NUM_MORPH_INFLUENCERS: number;
  102642. /** IMAGE PROCESSING */
  102643. IMAGEPROCESSING: boolean;
  102644. VIGNETTE: boolean;
  102645. VIGNETTEBLENDMODEMULTIPLY: boolean;
  102646. VIGNETTEBLENDMODEOPAQUE: boolean;
  102647. TONEMAPPING: boolean;
  102648. TONEMAPPING_ACES: boolean;
  102649. CONTRAST: boolean;
  102650. EXPOSURE: boolean;
  102651. COLORCURVES: boolean;
  102652. COLORGRADING: boolean;
  102653. COLORGRADING3D: boolean;
  102654. SAMPLER3DGREENDEPTH: boolean;
  102655. SAMPLER3DBGRMAP: boolean;
  102656. IMAGEPROCESSINGPOSTPROCESS: boolean;
  102657. /** MISC. */
  102658. BUMPDIRECTUV: number;
  102659. constructor();
  102660. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  102661. }
  102662. /**
  102663. * Class used to configure NodeMaterial
  102664. */
  102665. export interface INodeMaterialOptions {
  102666. /**
  102667. * Defines if blocks should emit comments
  102668. */
  102669. emitComments: boolean;
  102670. }
  102671. /**
  102672. * Class used to create a node based material built by assembling shader blocks
  102673. */
  102674. export class NodeMaterial extends PushMaterial {
  102675. private static _BuildIdGenerator;
  102676. private _options;
  102677. private _vertexCompilationState;
  102678. private _fragmentCompilationState;
  102679. private _sharedData;
  102680. private _buildId;
  102681. private _buildWasSuccessful;
  102682. private _cachedWorldViewMatrix;
  102683. private _cachedWorldViewProjectionMatrix;
  102684. private _optimizers;
  102685. private _animationFrame;
  102686. /** Define the Url to load node editor script */
  102687. static EditorURL: string;
  102688. /** Define the Url to load snippets */
  102689. static SnippetUrl: string;
  102690. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  102691. static IgnoreTexturesAtLoadTime: boolean;
  102692. private BJSNODEMATERIALEDITOR;
  102693. /** Get the inspector from bundle or global */
  102694. private _getGlobalNodeMaterialEditor;
  102695. /**
  102696. * Snippet ID if the material was created from the snippet server
  102697. */
  102698. snippetId: string;
  102699. /**
  102700. * Gets or sets data used by visual editor
  102701. * @see https://nme.babylonjs.com
  102702. */
  102703. editorData: any;
  102704. /**
  102705. * 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)
  102706. */
  102707. ignoreAlpha: boolean;
  102708. /**
  102709. * Defines the maximum number of lights that can be used in the material
  102710. */
  102711. maxSimultaneousLights: number;
  102712. /**
  102713. * Observable raised when the material is built
  102714. */
  102715. onBuildObservable: Observable<NodeMaterial>;
  102716. /**
  102717. * Gets or sets the root nodes of the material vertex shader
  102718. */
  102719. _vertexOutputNodes: NodeMaterialBlock[];
  102720. /**
  102721. * Gets or sets the root nodes of the material fragment (pixel) shader
  102722. */
  102723. _fragmentOutputNodes: NodeMaterialBlock[];
  102724. /** Gets or sets options to control the node material overall behavior */
  102725. get options(): INodeMaterialOptions;
  102726. set options(options: INodeMaterialOptions);
  102727. /**
  102728. * Default configuration related to image processing available in the standard Material.
  102729. */
  102730. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  102731. /**
  102732. * Gets the image processing configuration used either in this material.
  102733. */
  102734. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  102735. /**
  102736. * Sets the Default image processing configuration used either in the this material.
  102737. *
  102738. * If sets to null, the scene one is in use.
  102739. */
  102740. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  102741. /**
  102742. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  102743. */
  102744. attachedBlocks: NodeMaterialBlock[];
  102745. /**
  102746. * Specifies the mode of the node material
  102747. * @hidden
  102748. */
  102749. _mode: NodeMaterialModes;
  102750. /**
  102751. * Gets the mode property
  102752. */
  102753. get mode(): NodeMaterialModes;
  102754. /**
  102755. * Create a new node based material
  102756. * @param name defines the material name
  102757. * @param scene defines the hosting scene
  102758. * @param options defines creation option
  102759. */
  102760. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  102761. /**
  102762. * Gets the current class name of the material e.g. "NodeMaterial"
  102763. * @returns the class name
  102764. */
  102765. getClassName(): string;
  102766. /**
  102767. * Keep track of the image processing observer to allow dispose and replace.
  102768. */
  102769. private _imageProcessingObserver;
  102770. /**
  102771. * Attaches a new image processing configuration to the Standard Material.
  102772. * @param configuration
  102773. */
  102774. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102775. /**
  102776. * Get a block by its name
  102777. * @param name defines the name of the block to retrieve
  102778. * @returns the required block or null if not found
  102779. */
  102780. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102781. /**
  102782. * Get a block by its name
  102783. * @param predicate defines the predicate used to find the good candidate
  102784. * @returns the required block or null if not found
  102785. */
  102786. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102787. /**
  102788. * Get an input block by its name
  102789. * @param predicate defines the predicate used to find the good candidate
  102790. * @returns the required input block or null if not found
  102791. */
  102792. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102793. /**
  102794. * Gets the list of input blocks attached to this material
  102795. * @returns an array of InputBlocks
  102796. */
  102797. getInputBlocks(): InputBlock[];
  102798. /**
  102799. * Adds a new optimizer to the list of optimizers
  102800. * @param optimizer defines the optimizers to add
  102801. * @returns the current material
  102802. */
  102803. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102804. /**
  102805. * Remove an optimizer from the list of optimizers
  102806. * @param optimizer defines the optimizers to remove
  102807. * @returns the current material
  102808. */
  102809. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102810. /**
  102811. * Add a new block to the list of output nodes
  102812. * @param node defines the node to add
  102813. * @returns the current material
  102814. */
  102815. addOutputNode(node: NodeMaterialBlock): this;
  102816. /**
  102817. * Remove a block from the list of root nodes
  102818. * @param node defines the node to remove
  102819. * @returns the current material
  102820. */
  102821. removeOutputNode(node: NodeMaterialBlock): this;
  102822. private _addVertexOutputNode;
  102823. private _removeVertexOutputNode;
  102824. private _addFragmentOutputNode;
  102825. private _removeFragmentOutputNode;
  102826. /**
  102827. * Specifies if the material will require alpha blending
  102828. * @returns a boolean specifying if alpha blending is needed
  102829. */
  102830. needAlphaBlending(): boolean;
  102831. /**
  102832. * Specifies if this material should be rendered in alpha test mode
  102833. * @returns a boolean specifying if an alpha test is needed.
  102834. */
  102835. needAlphaTesting(): boolean;
  102836. private _initializeBlock;
  102837. private _resetDualBlocks;
  102838. /**
  102839. * Remove a block from the current node material
  102840. * @param block defines the block to remove
  102841. */
  102842. removeBlock(block: NodeMaterialBlock): void;
  102843. /**
  102844. * Build the material and generates the inner effect
  102845. * @param verbose defines if the build should log activity
  102846. */
  102847. build(verbose?: boolean): void;
  102848. /**
  102849. * Runs an otpimization phase to try to improve the shader code
  102850. */
  102851. optimize(): void;
  102852. private _prepareDefinesForAttributes;
  102853. /**
  102854. * Create a post process from the material
  102855. * @param camera The camera to apply the render pass to.
  102856. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102857. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102858. * @param engine The engine which the post process will be applied. (default: current engine)
  102859. * @param reusable If the post process can be reused on the same frame. (default: false)
  102860. * @param textureType Type of textures used when performing the post process. (default: 0)
  102861. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102862. * @returns the post process created
  102863. */
  102864. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  102865. /**
  102866. * Create the post process effect from the material
  102867. * @param postProcess The post process to create the effect for
  102868. */
  102869. createEffectForPostProcess(postProcess: PostProcess): void;
  102870. private _createEffectForPostProcess;
  102871. /**
  102872. * Create a new procedural texture based on this node material
  102873. * @param size defines the size of the texture
  102874. * @param scene defines the hosting scene
  102875. * @returns the new procedural texture attached to this node material
  102876. */
  102877. createProceduralTexture(size: number | {
  102878. width: number;
  102879. height: number;
  102880. layers?: number;
  102881. }, scene: Scene): Nullable<ProceduralTexture>;
  102882. private _createEffectForParticles;
  102883. private _checkInternals;
  102884. /**
  102885. * Create the effect to be used as the custom effect for a particle system
  102886. * @param particleSystem Particle system to create the effect for
  102887. * @param onCompiled defines a function to call when the effect creation is successful
  102888. * @param onError defines a function to call when the effect creation has failed
  102889. */
  102890. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102891. private _processDefines;
  102892. /**
  102893. * Get if the submesh is ready to be used and all its information available.
  102894. * Child classes can use it to update shaders
  102895. * @param mesh defines the mesh to check
  102896. * @param subMesh defines which submesh to check
  102897. * @param useInstances specifies that instances should be used
  102898. * @returns a boolean indicating that the submesh is ready or not
  102899. */
  102900. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102901. /**
  102902. * Get a string representing the shaders built by the current node graph
  102903. */
  102904. get compiledShaders(): string;
  102905. /**
  102906. * Binds the world matrix to the material
  102907. * @param world defines the world transformation matrix
  102908. */
  102909. bindOnlyWorldMatrix(world: Matrix): void;
  102910. /**
  102911. * Binds the submesh to this material by preparing the effect and shader to draw
  102912. * @param world defines the world transformation matrix
  102913. * @param mesh defines the mesh containing the submesh
  102914. * @param subMesh defines the submesh to bind the material to
  102915. */
  102916. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102917. /**
  102918. * Gets the active textures from the material
  102919. * @returns an array of textures
  102920. */
  102921. getActiveTextures(): BaseTexture[];
  102922. /**
  102923. * Gets the list of texture blocks
  102924. * @returns an array of texture blocks
  102925. */
  102926. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102927. /**
  102928. * Specifies if the material uses a texture
  102929. * @param texture defines the texture to check against the material
  102930. * @returns a boolean specifying if the material uses the texture
  102931. */
  102932. hasTexture(texture: BaseTexture): boolean;
  102933. /**
  102934. * Disposes the material
  102935. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102936. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102937. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102938. */
  102939. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102940. /** Creates the node editor window. */
  102941. private _createNodeEditor;
  102942. /**
  102943. * Launch the node material editor
  102944. * @param config Define the configuration of the editor
  102945. * @return a promise fulfilled when the node editor is visible
  102946. */
  102947. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102948. /**
  102949. * Clear the current material
  102950. */
  102951. clear(): void;
  102952. /**
  102953. * Clear the current material and set it to a default state
  102954. */
  102955. setToDefault(): void;
  102956. /**
  102957. * Clear the current material and set it to a default state for post process
  102958. */
  102959. setToDefaultPostProcess(): void;
  102960. /**
  102961. * Clear the current material and set it to a default state for procedural texture
  102962. */
  102963. setToDefaultProceduralTexture(): void;
  102964. /**
  102965. * Clear the current material and set it to a default state for particle
  102966. */
  102967. setToDefaultParticle(): void;
  102968. /**
  102969. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102970. * @param url defines the url to load from
  102971. * @returns a promise that will fullfil when the material is fully loaded
  102972. */
  102973. loadAsync(url: string): Promise<void>;
  102974. private _gatherBlocks;
  102975. /**
  102976. * Generate a string containing the code declaration required to create an equivalent of this material
  102977. * @returns a string
  102978. */
  102979. generateCode(): string;
  102980. /**
  102981. * Serializes this material in a JSON representation
  102982. * @returns the serialized material object
  102983. */
  102984. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102985. private _restoreConnections;
  102986. /**
  102987. * Clear the current graph and load a new one from a serialization object
  102988. * @param source defines the JSON representation of the material
  102989. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102990. * @param merge defines whether or not the source must be merged or replace the current content
  102991. */
  102992. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102993. /**
  102994. * Makes a duplicate of the current material.
  102995. * @param name - name to use for the new material.
  102996. */
  102997. clone(name: string): NodeMaterial;
  102998. /**
  102999. * Creates a node material from parsed material data
  103000. * @param source defines the JSON representation of the material
  103001. * @param scene defines the hosting scene
  103002. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103003. * @returns a new node material
  103004. */
  103005. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  103006. /**
  103007. * Creates a node material from a snippet saved in a remote file
  103008. * @param name defines the name of the material to create
  103009. * @param url defines the url to load from
  103010. * @param scene defines the hosting scene
  103011. * @returns a promise that will resolve to the new node material
  103012. */
  103013. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  103014. /**
  103015. * Creates a node material from a snippet saved by the node material editor
  103016. * @param snippetId defines the snippet to load
  103017. * @param scene defines the hosting scene
  103018. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103019. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  103020. * @returns a promise that will resolve to the new node material
  103021. */
  103022. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  103023. /**
  103024. * Creates a new node material set to default basic configuration
  103025. * @param name defines the name of the material
  103026. * @param scene defines the hosting scene
  103027. * @returns a new NodeMaterial
  103028. */
  103029. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  103030. }
  103031. }
  103032. declare module BABYLON {
  103033. /**
  103034. * Size options for a post process
  103035. */
  103036. export type PostProcessOptions = {
  103037. width: number;
  103038. height: number;
  103039. };
  103040. /**
  103041. * PostProcess can be used to apply a shader to a texture after it has been rendered
  103042. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103043. */
  103044. export class PostProcess {
  103045. /**
  103046. * Gets or sets the unique id of the post process
  103047. */
  103048. uniqueId: number;
  103049. /** Name of the PostProcess. */
  103050. name: string;
  103051. /**
  103052. * Width of the texture to apply the post process on
  103053. */
  103054. width: number;
  103055. /**
  103056. * Height of the texture to apply the post process on
  103057. */
  103058. height: number;
  103059. /**
  103060. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  103061. */
  103062. nodeMaterialSource: Nullable<NodeMaterial>;
  103063. /**
  103064. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  103065. * @hidden
  103066. */
  103067. _outputTexture: Nullable<InternalTexture>;
  103068. /**
  103069. * Sampling mode used by the shader
  103070. * See https://doc.babylonjs.com/classes/3.1/texture
  103071. */
  103072. renderTargetSamplingMode: number;
  103073. /**
  103074. * Clear color to use when screen clearing
  103075. */
  103076. clearColor: Color4;
  103077. /**
  103078. * If the buffer needs to be cleared before applying the post process. (default: true)
  103079. * Should be set to false if shader will overwrite all previous pixels.
  103080. */
  103081. autoClear: boolean;
  103082. /**
  103083. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  103084. */
  103085. alphaMode: number;
  103086. /**
  103087. * Sets the setAlphaBlendConstants of the babylon engine
  103088. */
  103089. alphaConstants: Color4;
  103090. /**
  103091. * Animations to be used for the post processing
  103092. */
  103093. animations: Animation[];
  103094. /**
  103095. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  103096. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  103097. */
  103098. enablePixelPerfectMode: boolean;
  103099. /**
  103100. * Force the postprocess to be applied without taking in account viewport
  103101. */
  103102. forceFullscreenViewport: boolean;
  103103. /**
  103104. * List of inspectable custom properties (used by the Inspector)
  103105. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103106. */
  103107. inspectableCustomProperties: IInspectable[];
  103108. /**
  103109. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  103110. *
  103111. * | Value | Type | Description |
  103112. * | ----- | ----------------------------------- | ----------- |
  103113. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  103114. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  103115. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  103116. *
  103117. */
  103118. scaleMode: number;
  103119. /**
  103120. * Force textures to be a power of two (default: false)
  103121. */
  103122. alwaysForcePOT: boolean;
  103123. private _samples;
  103124. /**
  103125. * Number of sample textures (default: 1)
  103126. */
  103127. get samples(): number;
  103128. set samples(n: number);
  103129. /**
  103130. * Modify the scale of the post process to be the same as the viewport (default: false)
  103131. */
  103132. adaptScaleToCurrentViewport: boolean;
  103133. private _camera;
  103134. protected _scene: Scene;
  103135. private _engine;
  103136. private _options;
  103137. private _reusable;
  103138. private _textureType;
  103139. private _textureFormat;
  103140. /**
  103141. * Smart array of input and output textures for the post process.
  103142. * @hidden
  103143. */
  103144. _textures: SmartArray<InternalTexture>;
  103145. /**
  103146. * The index in _textures that corresponds to the output texture.
  103147. * @hidden
  103148. */
  103149. _currentRenderTextureInd: number;
  103150. private _effect;
  103151. private _samplers;
  103152. private _fragmentUrl;
  103153. private _vertexUrl;
  103154. private _parameters;
  103155. private _scaleRatio;
  103156. protected _indexParameters: any;
  103157. private _shareOutputWithPostProcess;
  103158. private _texelSize;
  103159. private _forcedOutputTexture;
  103160. /**
  103161. * Returns the fragment url or shader name used in the post process.
  103162. * @returns the fragment url or name in the shader store.
  103163. */
  103164. getEffectName(): string;
  103165. /**
  103166. * An event triggered when the postprocess is activated.
  103167. */
  103168. onActivateObservable: Observable<Camera>;
  103169. private _onActivateObserver;
  103170. /**
  103171. * A function that is added to the onActivateObservable
  103172. */
  103173. set onActivate(callback: Nullable<(camera: Camera) => void>);
  103174. /**
  103175. * An event triggered when the postprocess changes its size.
  103176. */
  103177. onSizeChangedObservable: Observable<PostProcess>;
  103178. private _onSizeChangedObserver;
  103179. /**
  103180. * A function that is added to the onSizeChangedObservable
  103181. */
  103182. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  103183. /**
  103184. * An event triggered when the postprocess applies its effect.
  103185. */
  103186. onApplyObservable: Observable<Effect>;
  103187. private _onApplyObserver;
  103188. /**
  103189. * A function that is added to the onApplyObservable
  103190. */
  103191. set onApply(callback: (effect: Effect) => void);
  103192. /**
  103193. * An event triggered before rendering the postprocess
  103194. */
  103195. onBeforeRenderObservable: Observable<Effect>;
  103196. private _onBeforeRenderObserver;
  103197. /**
  103198. * A function that is added to the onBeforeRenderObservable
  103199. */
  103200. set onBeforeRender(callback: (effect: Effect) => void);
  103201. /**
  103202. * An event triggered after rendering the postprocess
  103203. */
  103204. onAfterRenderObservable: Observable<Effect>;
  103205. private _onAfterRenderObserver;
  103206. /**
  103207. * A function that is added to the onAfterRenderObservable
  103208. */
  103209. set onAfterRender(callback: (efect: Effect) => void);
  103210. /**
  103211. * 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
  103212. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  103213. */
  103214. get inputTexture(): InternalTexture;
  103215. set inputTexture(value: InternalTexture);
  103216. /**
  103217. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  103218. * the only way to unset it is to use this function to restore its internal state
  103219. */
  103220. restoreDefaultInputTexture(): void;
  103221. /**
  103222. * Gets the camera which post process is applied to.
  103223. * @returns The camera the post process is applied to.
  103224. */
  103225. getCamera(): Camera;
  103226. /**
  103227. * Gets the texel size of the postprocess.
  103228. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  103229. */
  103230. get texelSize(): Vector2;
  103231. /**
  103232. * Creates a new instance PostProcess
  103233. * @param name The name of the PostProcess.
  103234. * @param fragmentUrl The url of the fragment shader to be used.
  103235. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  103236. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  103237. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  103238. * @param camera The camera to apply the render pass to.
  103239. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103240. * @param engine The engine which the post process will be applied. (default: current engine)
  103241. * @param reusable If the post process can be reused on the same frame. (default: false)
  103242. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  103243. * @param textureType Type of textures used when performing the post process. (default: 0)
  103244. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  103245. * @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
  103246. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  103247. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  103248. */
  103249. 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);
  103250. /**
  103251. * Gets a string identifying the name of the class
  103252. * @returns "PostProcess" string
  103253. */
  103254. getClassName(): string;
  103255. /**
  103256. * Gets the engine which this post process belongs to.
  103257. * @returns The engine the post process was enabled with.
  103258. */
  103259. getEngine(): Engine;
  103260. /**
  103261. * The effect that is created when initializing the post process.
  103262. * @returns The created effect corresponding the the postprocess.
  103263. */
  103264. getEffect(): Effect;
  103265. /**
  103266. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  103267. * @param postProcess The post process to share the output with.
  103268. * @returns This post process.
  103269. */
  103270. shareOutputWith(postProcess: PostProcess): PostProcess;
  103271. /**
  103272. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  103273. * This should be called if the post process that shares output with this post process is disabled/disposed.
  103274. */
  103275. useOwnOutput(): void;
  103276. /**
  103277. * Updates the effect with the current post process compile time values and recompiles the shader.
  103278. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  103279. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  103280. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  103281. * @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
  103282. * @param onCompiled Called when the shader has been compiled.
  103283. * @param onError Called if there is an error when compiling a shader.
  103284. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  103285. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  103286. */
  103287. 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;
  103288. /**
  103289. * The post process is reusable if it can be used multiple times within one frame.
  103290. * @returns If the post process is reusable
  103291. */
  103292. isReusable(): boolean;
  103293. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  103294. markTextureDirty(): void;
  103295. /**
  103296. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  103297. * 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.
  103298. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  103299. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  103300. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  103301. * @returns The target texture that was bound to be written to.
  103302. */
  103303. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  103304. /**
  103305. * If the post process is supported.
  103306. */
  103307. get isSupported(): boolean;
  103308. /**
  103309. * The aspect ratio of the output texture.
  103310. */
  103311. get aspectRatio(): number;
  103312. /**
  103313. * Get a value indicating if the post-process is ready to be used
  103314. * @returns true if the post-process is ready (shader is compiled)
  103315. */
  103316. isReady(): boolean;
  103317. /**
  103318. * Binds all textures and uniforms to the shader, this will be run on every pass.
  103319. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  103320. */
  103321. apply(): Nullable<Effect>;
  103322. private _disposeTextures;
  103323. /**
  103324. * Disposes the post process.
  103325. * @param camera The camera to dispose the post process on.
  103326. */
  103327. dispose(camera?: Camera): void;
  103328. /**
  103329. * Serializes the particle system to a JSON object
  103330. * @returns the JSON object
  103331. */
  103332. serialize(): any;
  103333. /**
  103334. * Creates a material from parsed material data
  103335. * @param parsedPostProcess defines parsed post process data
  103336. * @param scene defines the hosting scene
  103337. * @param rootUrl defines the root URL to use to load textures
  103338. * @returns a new post process
  103339. */
  103340. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  103341. }
  103342. }
  103343. declare module BABYLON {
  103344. /** @hidden */
  103345. export var kernelBlurVaryingDeclaration: {
  103346. name: string;
  103347. shader: string;
  103348. };
  103349. }
  103350. declare module BABYLON {
  103351. /** @hidden */
  103352. export var kernelBlurFragment: {
  103353. name: string;
  103354. shader: string;
  103355. };
  103356. }
  103357. declare module BABYLON {
  103358. /** @hidden */
  103359. export var kernelBlurFragment2: {
  103360. name: string;
  103361. shader: string;
  103362. };
  103363. }
  103364. declare module BABYLON {
  103365. /** @hidden */
  103366. export var kernelBlurPixelShader: {
  103367. name: string;
  103368. shader: string;
  103369. };
  103370. }
  103371. declare module BABYLON {
  103372. /** @hidden */
  103373. export var kernelBlurVertex: {
  103374. name: string;
  103375. shader: string;
  103376. };
  103377. }
  103378. declare module BABYLON {
  103379. /** @hidden */
  103380. export var kernelBlurVertexShader: {
  103381. name: string;
  103382. shader: string;
  103383. };
  103384. }
  103385. declare module BABYLON {
  103386. /**
  103387. * The Blur Post Process which blurs an image based on a kernel and direction.
  103388. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  103389. */
  103390. export class BlurPostProcess extends PostProcess {
  103391. private blockCompilation;
  103392. protected _kernel: number;
  103393. protected _idealKernel: number;
  103394. protected _packedFloat: boolean;
  103395. private _staticDefines;
  103396. /** The direction in which to blur the image. */
  103397. direction: Vector2;
  103398. /**
  103399. * Sets the length in pixels of the blur sample region
  103400. */
  103401. set kernel(v: number);
  103402. /**
  103403. * Gets the length in pixels of the blur sample region
  103404. */
  103405. get kernel(): number;
  103406. /**
  103407. * Sets wether or not the blur needs to unpack/repack floats
  103408. */
  103409. set packedFloat(v: boolean);
  103410. /**
  103411. * Gets wether or not the blur is unpacking/repacking floats
  103412. */
  103413. get packedFloat(): boolean;
  103414. /**
  103415. * Gets a string identifying the name of the class
  103416. * @returns "BlurPostProcess" string
  103417. */
  103418. getClassName(): string;
  103419. /**
  103420. * Creates a new instance BlurPostProcess
  103421. * @param name The name of the effect.
  103422. * @param direction The direction in which to blur the image.
  103423. * @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.
  103424. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  103425. * @param camera The camera to apply the render pass to.
  103426. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103427. * @param engine The engine which the post process will be applied. (default: current engine)
  103428. * @param reusable If the post process can be reused on the same frame. (default: false)
  103429. * @param textureType Type of textures used when performing the post process. (default: 0)
  103430. * @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)
  103431. */
  103432. 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);
  103433. /**
  103434. * Updates the effect with the current post process compile time values and recompiles the shader.
  103435. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  103436. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  103437. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  103438. * @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
  103439. * @param onCompiled Called when the shader has been compiled.
  103440. * @param onError Called if there is an error when compiling a shader.
  103441. */
  103442. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  103443. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  103444. /**
  103445. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  103446. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  103447. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  103448. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  103449. * The gaps between physical kernels are compensated for in the weighting of the samples
  103450. * @param idealKernel Ideal blur kernel.
  103451. * @return Nearest best kernel.
  103452. */
  103453. protected _nearestBestKernel(idealKernel: number): number;
  103454. /**
  103455. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  103456. * @param x The point on the Gaussian distribution to sample.
  103457. * @return the value of the Gaussian function at x.
  103458. */
  103459. protected _gaussianWeight(x: number): number;
  103460. /**
  103461. * Generates a string that can be used as a floating point number in GLSL.
  103462. * @param x Value to print.
  103463. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  103464. * @return GLSL float string.
  103465. */
  103466. protected _glslFloat(x: number, decimalFigures?: number): string;
  103467. /** @hidden */
  103468. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  103469. }
  103470. }
  103471. declare module BABYLON {
  103472. /**
  103473. * Mirror texture can be used to simulate the view from a mirror in a scene.
  103474. * It will dynamically be rendered every frame to adapt to the camera point of view.
  103475. * You can then easily use it as a reflectionTexture on a flat surface.
  103476. * In case the surface is not a plane, please consider relying on reflection probes.
  103477. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  103478. */
  103479. export class MirrorTexture extends RenderTargetTexture {
  103480. private scene;
  103481. /**
  103482. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  103483. * 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.
  103484. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  103485. */
  103486. mirrorPlane: Plane;
  103487. /**
  103488. * Define the blur ratio used to blur the reflection if needed.
  103489. */
  103490. set blurRatio(value: number);
  103491. get blurRatio(): number;
  103492. /**
  103493. * Define the adaptive blur kernel used to blur the reflection if needed.
  103494. * This will autocompute the closest best match for the `blurKernel`
  103495. */
  103496. set adaptiveBlurKernel(value: number);
  103497. /**
  103498. * Define the blur kernel used to blur the reflection if needed.
  103499. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  103500. */
  103501. set blurKernel(value: number);
  103502. /**
  103503. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  103504. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  103505. */
  103506. set blurKernelX(value: number);
  103507. get blurKernelX(): number;
  103508. /**
  103509. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  103510. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  103511. */
  103512. set blurKernelY(value: number);
  103513. get blurKernelY(): number;
  103514. private _autoComputeBlurKernel;
  103515. protected _onRatioRescale(): void;
  103516. private _updateGammaSpace;
  103517. private _imageProcessingConfigChangeObserver;
  103518. private _transformMatrix;
  103519. private _mirrorMatrix;
  103520. private _savedViewMatrix;
  103521. private _blurX;
  103522. private _blurY;
  103523. private _adaptiveBlurKernel;
  103524. private _blurKernelX;
  103525. private _blurKernelY;
  103526. private _blurRatio;
  103527. /**
  103528. * Instantiates a Mirror Texture.
  103529. * Mirror texture can be used to simulate the view from a mirror in a scene.
  103530. * It will dynamically be rendered every frame to adapt to the camera point of view.
  103531. * You can then easily use it as a reflectionTexture on a flat surface.
  103532. * In case the surface is not a plane, please consider relying on reflection probes.
  103533. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  103534. * @param name
  103535. * @param size
  103536. * @param scene
  103537. * @param generateMipMaps
  103538. * @param type
  103539. * @param samplingMode
  103540. * @param generateDepthBuffer
  103541. */
  103542. constructor(name: string, size: number | {
  103543. width: number;
  103544. height: number;
  103545. } | {
  103546. ratio: number;
  103547. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  103548. private _preparePostProcesses;
  103549. /**
  103550. * Clone the mirror texture.
  103551. * @returns the cloned texture
  103552. */
  103553. clone(): MirrorTexture;
  103554. /**
  103555. * Serialize the texture to a JSON representation you could use in Parse later on
  103556. * @returns the serialized JSON representation
  103557. */
  103558. serialize(): any;
  103559. /**
  103560. * Dispose the texture and release its associated resources.
  103561. */
  103562. dispose(): void;
  103563. }
  103564. }
  103565. declare module BABYLON {
  103566. /**
  103567. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  103568. * @see https://doc.babylonjs.com/babylon101/materials#texture
  103569. */
  103570. export class Texture extends BaseTexture {
  103571. /**
  103572. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  103573. */
  103574. static SerializeBuffers: boolean;
  103575. /** @hidden */
  103576. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  103577. /** @hidden */
  103578. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  103579. /** @hidden */
  103580. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  103581. /** nearest is mag = nearest and min = nearest and mip = linear */
  103582. static readonly NEAREST_SAMPLINGMODE: number;
  103583. /** nearest is mag = nearest and min = nearest and mip = linear */
  103584. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  103585. /** Bilinear is mag = linear and min = linear and mip = nearest */
  103586. static readonly BILINEAR_SAMPLINGMODE: number;
  103587. /** Bilinear is mag = linear and min = linear and mip = nearest */
  103588. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  103589. /** Trilinear is mag = linear and min = linear and mip = linear */
  103590. static readonly TRILINEAR_SAMPLINGMODE: number;
  103591. /** Trilinear is mag = linear and min = linear and mip = linear */
  103592. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  103593. /** mag = nearest and min = nearest and mip = nearest */
  103594. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  103595. /** mag = nearest and min = linear and mip = nearest */
  103596. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  103597. /** mag = nearest and min = linear and mip = linear */
  103598. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  103599. /** mag = nearest and min = linear and mip = none */
  103600. static readonly NEAREST_LINEAR: number;
  103601. /** mag = nearest and min = nearest and mip = none */
  103602. static readonly NEAREST_NEAREST: number;
  103603. /** mag = linear and min = nearest and mip = nearest */
  103604. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  103605. /** mag = linear and min = nearest and mip = linear */
  103606. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  103607. /** mag = linear and min = linear and mip = none */
  103608. static readonly LINEAR_LINEAR: number;
  103609. /** mag = linear and min = nearest and mip = none */
  103610. static readonly LINEAR_NEAREST: number;
  103611. /** Explicit coordinates mode */
  103612. static readonly EXPLICIT_MODE: number;
  103613. /** Spherical coordinates mode */
  103614. static readonly SPHERICAL_MODE: number;
  103615. /** Planar coordinates mode */
  103616. static readonly PLANAR_MODE: number;
  103617. /** Cubic coordinates mode */
  103618. static readonly CUBIC_MODE: number;
  103619. /** Projection coordinates mode */
  103620. static readonly PROJECTION_MODE: number;
  103621. /** Inverse Cubic coordinates mode */
  103622. static readonly SKYBOX_MODE: number;
  103623. /** Inverse Cubic coordinates mode */
  103624. static readonly INVCUBIC_MODE: number;
  103625. /** Equirectangular coordinates mode */
  103626. static readonly EQUIRECTANGULAR_MODE: number;
  103627. /** Equirectangular Fixed coordinates mode */
  103628. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  103629. /** Equirectangular Fixed Mirrored coordinates mode */
  103630. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  103631. /** Texture is not repeating outside of 0..1 UVs */
  103632. static readonly CLAMP_ADDRESSMODE: number;
  103633. /** Texture is repeating outside of 0..1 UVs */
  103634. static readonly WRAP_ADDRESSMODE: number;
  103635. /** Texture is repeating and mirrored */
  103636. static readonly MIRROR_ADDRESSMODE: number;
  103637. /**
  103638. * 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
  103639. */
  103640. static UseSerializedUrlIfAny: boolean;
  103641. /**
  103642. * Define the url of the texture.
  103643. */
  103644. url: Nullable<string>;
  103645. /**
  103646. * Define an offset on the texture to offset the u coordinates of the UVs
  103647. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  103648. */
  103649. uOffset: number;
  103650. /**
  103651. * Define an offset on the texture to offset the v coordinates of the UVs
  103652. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  103653. */
  103654. vOffset: number;
  103655. /**
  103656. * Define an offset on the texture to scale the u coordinates of the UVs
  103657. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  103658. */
  103659. uScale: number;
  103660. /**
  103661. * Define an offset on the texture to scale the v coordinates of the UVs
  103662. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  103663. */
  103664. vScale: number;
  103665. /**
  103666. * Define an offset on the texture to rotate around the u coordinates of the UVs
  103667. * @see https://doc.babylonjs.com/how_to/more_materials
  103668. */
  103669. uAng: number;
  103670. /**
  103671. * Define an offset on the texture to rotate around the v coordinates of the UVs
  103672. * @see https://doc.babylonjs.com/how_to/more_materials
  103673. */
  103674. vAng: number;
  103675. /**
  103676. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  103677. * @see https://doc.babylonjs.com/how_to/more_materials
  103678. */
  103679. wAng: number;
  103680. /**
  103681. * Defines the center of rotation (U)
  103682. */
  103683. uRotationCenter: number;
  103684. /**
  103685. * Defines the center of rotation (V)
  103686. */
  103687. vRotationCenter: number;
  103688. /**
  103689. * Defines the center of rotation (W)
  103690. */
  103691. wRotationCenter: number;
  103692. /**
  103693. * Are mip maps generated for this texture or not.
  103694. */
  103695. get noMipmap(): boolean;
  103696. /**
  103697. * List of inspectable custom properties (used by the Inspector)
  103698. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103699. */
  103700. inspectableCustomProperties: Nullable<IInspectable[]>;
  103701. private _noMipmap;
  103702. /** @hidden */
  103703. _invertY: boolean;
  103704. private _rowGenerationMatrix;
  103705. private _cachedTextureMatrix;
  103706. private _projectionModeMatrix;
  103707. private _t0;
  103708. private _t1;
  103709. private _t2;
  103710. private _cachedUOffset;
  103711. private _cachedVOffset;
  103712. private _cachedUScale;
  103713. private _cachedVScale;
  103714. private _cachedUAng;
  103715. private _cachedVAng;
  103716. private _cachedWAng;
  103717. private _cachedProjectionMatrixId;
  103718. private _cachedCoordinatesMode;
  103719. /** @hidden */
  103720. protected _initialSamplingMode: number;
  103721. /** @hidden */
  103722. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  103723. private _deleteBuffer;
  103724. protected _format: Nullable<number>;
  103725. private _delayedOnLoad;
  103726. private _delayedOnError;
  103727. private _mimeType?;
  103728. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  103729. get mimeType(): string | undefined;
  103730. /**
  103731. * Observable triggered once the texture has been loaded.
  103732. */
  103733. onLoadObservable: Observable<Texture>;
  103734. protected _isBlocking: boolean;
  103735. /**
  103736. * Is the texture preventing material to render while loading.
  103737. * If false, a default texture will be used instead of the loading one during the preparation step.
  103738. */
  103739. set isBlocking(value: boolean);
  103740. get isBlocking(): boolean;
  103741. /**
  103742. * Get the current sampling mode associated with the texture.
  103743. */
  103744. get samplingMode(): number;
  103745. /**
  103746. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  103747. */
  103748. get invertY(): boolean;
  103749. /**
  103750. * Instantiates a new texture.
  103751. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  103752. * @see https://doc.babylonjs.com/babylon101/materials#texture
  103753. * @param url defines the url of the picture to load as a texture
  103754. * @param sceneOrEngine defines the scene or engine the texture will belong to
  103755. * @param noMipmap defines if the texture will require mip maps or not
  103756. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  103757. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103758. * @param onLoad defines a callback triggered when the texture has been loaded
  103759. * @param onError defines a callback triggered when an error occurred during the loading session
  103760. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  103761. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  103762. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103763. * @param mimeType defines an optional mime type information
  103764. */
  103765. 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);
  103766. /**
  103767. * Update the url (and optional buffer) of this texture if url was null during construction.
  103768. * @param url the url of the texture
  103769. * @param buffer the buffer of the texture (defaults to null)
  103770. * @param onLoad callback called when the texture is loaded (defaults to null)
  103771. */
  103772. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  103773. /**
  103774. * Finish the loading sequence of a texture flagged as delayed load.
  103775. * @hidden
  103776. */
  103777. delayLoad(): void;
  103778. private _prepareRowForTextureGeneration;
  103779. /**
  103780. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  103781. * @returns the transform matrix of the texture.
  103782. */
  103783. getTextureMatrix(uBase?: number): Matrix;
  103784. /**
  103785. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  103786. * @returns The reflection texture transform
  103787. */
  103788. getReflectionTextureMatrix(): Matrix;
  103789. /**
  103790. * Clones the texture.
  103791. * @returns the cloned texture
  103792. */
  103793. clone(): Texture;
  103794. /**
  103795. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103796. * @returns The JSON representation of the texture
  103797. */
  103798. serialize(): any;
  103799. /**
  103800. * Get the current class name of the texture useful for serialization or dynamic coding.
  103801. * @returns "Texture"
  103802. */
  103803. getClassName(): string;
  103804. /**
  103805. * Dispose the texture and release its associated resources.
  103806. */
  103807. dispose(): void;
  103808. /**
  103809. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103810. * @param parsedTexture Define the JSON representation of the texture
  103811. * @param scene Define the scene the parsed texture should be instantiated in
  103812. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103813. * @returns The parsed texture if successful
  103814. */
  103815. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103816. /**
  103817. * Creates a texture from its base 64 representation.
  103818. * @param data Define the base64 payload without the data: prefix
  103819. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103820. * @param scene Define the scene the texture should belong to
  103821. * @param noMipmap Forces the texture to not create mip map information if true
  103822. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103823. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103824. * @param onLoad define a callback triggered when the texture has been loaded
  103825. * @param onError define a callback triggered when an error occurred during the loading session
  103826. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103827. * @returns the created texture
  103828. */
  103829. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103830. /**
  103831. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103832. * @param data Define the base64 payload without the data: prefix
  103833. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103834. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103835. * @param scene Define the scene the texture should belong to
  103836. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103837. * @param noMipmap Forces the texture to not create mip map information if true
  103838. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103839. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103840. * @param onLoad define a callback triggered when the texture has been loaded
  103841. * @param onError define a callback triggered when an error occurred during the loading session
  103842. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103843. * @returns the created texture
  103844. */
  103845. 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;
  103846. }
  103847. }
  103848. declare module BABYLON {
  103849. /**
  103850. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103851. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103852. */
  103853. export class PostProcessManager {
  103854. private _scene;
  103855. private _indexBuffer;
  103856. private _vertexBuffers;
  103857. /**
  103858. * Creates a new instance PostProcess
  103859. * @param scene The scene that the post process is associated with.
  103860. */
  103861. constructor(scene: Scene);
  103862. private _prepareBuffers;
  103863. private _buildIndexBuffer;
  103864. /**
  103865. * Rebuilds the vertex buffers of the manager.
  103866. * @hidden
  103867. */
  103868. _rebuild(): void;
  103869. /**
  103870. * Prepares a frame to be run through a post process.
  103871. * @param sourceTexture The input texture to the post procesess. (default: null)
  103872. * @param postProcesses An array of post processes to be run. (default: null)
  103873. * @returns True if the post processes were able to be run.
  103874. * @hidden
  103875. */
  103876. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103877. /**
  103878. * Manually render a set of post processes to a texture.
  103879. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103880. * @param postProcesses An array of post processes to be run.
  103881. * @param targetTexture The target texture to render to.
  103882. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103883. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103884. * @param lodLevel defines which lod of the texture to render to
  103885. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103886. */
  103887. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103888. /**
  103889. * Finalize the result of the output of the postprocesses.
  103890. * @param doNotPresent If true the result will not be displayed to the screen.
  103891. * @param targetTexture The target texture to render to.
  103892. * @param faceIndex The index of the face to bind the target texture to.
  103893. * @param postProcesses The array of post processes to render.
  103894. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103895. * @hidden
  103896. */
  103897. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103898. /**
  103899. * Disposes of the post process manager.
  103900. */
  103901. dispose(): void;
  103902. }
  103903. }
  103904. declare module BABYLON {
  103905. /**
  103906. * This Helps creating a texture that will be created from a camera in your scene.
  103907. * It is basically a dynamic texture that could be used to create special effects for instance.
  103908. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103909. */
  103910. export class RenderTargetTexture extends Texture {
  103911. /**
  103912. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103913. */
  103914. static readonly REFRESHRATE_RENDER_ONCE: number;
  103915. /**
  103916. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103917. */
  103918. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103919. /**
  103920. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103921. * the central point of your effect and can save a lot of performances.
  103922. */
  103923. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103924. /**
  103925. * Use this predicate to dynamically define the list of mesh you want to render.
  103926. * If set, the renderList property will be overwritten.
  103927. */
  103928. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103929. private _renderList;
  103930. /**
  103931. * Use this list to define the list of mesh you want to render.
  103932. */
  103933. get renderList(): Nullable<Array<AbstractMesh>>;
  103934. set renderList(value: Nullable<Array<AbstractMesh>>);
  103935. /**
  103936. * Use this function to overload the renderList array at rendering time.
  103937. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103938. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103939. * the cube (if the RTT is a cube, else layerOrFace=0).
  103940. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103941. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103942. * hold dummy elements!
  103943. */
  103944. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103945. private _hookArray;
  103946. /**
  103947. * Define if particles should be rendered in your texture.
  103948. */
  103949. renderParticles: boolean;
  103950. /**
  103951. * Define if sprites should be rendered in your texture.
  103952. */
  103953. renderSprites: boolean;
  103954. /**
  103955. * Define the camera used to render the texture.
  103956. */
  103957. activeCamera: Nullable<Camera>;
  103958. /**
  103959. * Override the mesh isReady function with your own one.
  103960. */
  103961. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103962. /**
  103963. * Override the render function of the texture with your own one.
  103964. */
  103965. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103966. /**
  103967. * Define if camera post processes should be use while rendering the texture.
  103968. */
  103969. useCameraPostProcesses: boolean;
  103970. /**
  103971. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103972. */
  103973. ignoreCameraViewport: boolean;
  103974. private _postProcessManager;
  103975. private _postProcesses;
  103976. private _resizeObserver;
  103977. /**
  103978. * An event triggered when the texture is unbind.
  103979. */
  103980. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103981. /**
  103982. * An event triggered when the texture is unbind.
  103983. */
  103984. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103985. private _onAfterUnbindObserver;
  103986. /**
  103987. * Set a after unbind callback in the texture.
  103988. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103989. */
  103990. set onAfterUnbind(callback: () => void);
  103991. /**
  103992. * An event triggered before rendering the texture
  103993. */
  103994. onBeforeRenderObservable: Observable<number>;
  103995. private _onBeforeRenderObserver;
  103996. /**
  103997. * Set a before render callback in the texture.
  103998. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103999. */
  104000. set onBeforeRender(callback: (faceIndex: number) => void);
  104001. /**
  104002. * An event triggered after rendering the texture
  104003. */
  104004. onAfterRenderObservable: Observable<number>;
  104005. private _onAfterRenderObserver;
  104006. /**
  104007. * Set a after render callback in the texture.
  104008. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  104009. */
  104010. set onAfterRender(callback: (faceIndex: number) => void);
  104011. /**
  104012. * An event triggered after the texture clear
  104013. */
  104014. onClearObservable: Observable<Engine>;
  104015. private _onClearObserver;
  104016. /**
  104017. * Set a clear callback in the texture.
  104018. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  104019. */
  104020. set onClear(callback: (Engine: Engine) => void);
  104021. /**
  104022. * An event triggered when the texture is resized.
  104023. */
  104024. onResizeObservable: Observable<RenderTargetTexture>;
  104025. /**
  104026. * Define the clear color of the Render Target if it should be different from the scene.
  104027. */
  104028. clearColor: Color4;
  104029. protected _size: number | {
  104030. width: number;
  104031. height: number;
  104032. layers?: number;
  104033. };
  104034. protected _initialSizeParameter: number | {
  104035. width: number;
  104036. height: number;
  104037. } | {
  104038. ratio: number;
  104039. };
  104040. protected _sizeRatio: Nullable<number>;
  104041. /** @hidden */
  104042. _generateMipMaps: boolean;
  104043. protected _renderingManager: RenderingManager;
  104044. /** @hidden */
  104045. _waitingRenderList?: string[];
  104046. protected _doNotChangeAspectRatio: boolean;
  104047. protected _currentRefreshId: number;
  104048. protected _refreshRate: number;
  104049. protected _textureMatrix: Matrix;
  104050. protected _samples: number;
  104051. protected _renderTargetOptions: RenderTargetCreationOptions;
  104052. /**
  104053. * Gets render target creation options that were used.
  104054. */
  104055. get renderTargetOptions(): RenderTargetCreationOptions;
  104056. protected _onRatioRescale(): void;
  104057. /**
  104058. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  104059. * It must define where the camera used to render the texture is set
  104060. */
  104061. boundingBoxPosition: Vector3;
  104062. private _boundingBoxSize;
  104063. /**
  104064. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  104065. * When defined, the cubemap will switch to local mode
  104066. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  104067. * @example https://www.babylonjs-playground.com/#RNASML
  104068. */
  104069. set boundingBoxSize(value: Vector3);
  104070. get boundingBoxSize(): Vector3;
  104071. /**
  104072. * In case the RTT has been created with a depth texture, get the associated
  104073. * depth texture.
  104074. * Otherwise, return null.
  104075. */
  104076. get depthStencilTexture(): Nullable<InternalTexture>;
  104077. /**
  104078. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  104079. * or used a shadow, depth texture...
  104080. * @param name The friendly name of the texture
  104081. * @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)
  104082. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  104083. * @param generateMipMaps True if mip maps need to be generated after render.
  104084. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  104085. * @param type The type of the buffer in the RTT (int, half float, float...)
  104086. * @param isCube True if a cube texture needs to be created
  104087. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  104088. * @param generateDepthBuffer True to generate a depth buffer
  104089. * @param generateStencilBuffer True to generate a stencil buffer
  104090. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  104091. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  104092. * @param delayAllocation if the texture allocation should be delayed (default: false)
  104093. */
  104094. constructor(name: string, size: number | {
  104095. width: number;
  104096. height: number;
  104097. layers?: number;
  104098. } | {
  104099. ratio: number;
  104100. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  104101. /**
  104102. * Creates a depth stencil texture.
  104103. * This is only available in WebGL 2 or with the depth texture extension available.
  104104. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  104105. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  104106. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  104107. */
  104108. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  104109. private _processSizeParameter;
  104110. /**
  104111. * Define the number of samples to use in case of MSAA.
  104112. * It defaults to one meaning no MSAA has been enabled.
  104113. */
  104114. get samples(): number;
  104115. set samples(value: number);
  104116. /**
  104117. * Resets the refresh counter of the texture and start bak from scratch.
  104118. * Could be useful to regenerate the texture if it is setup to render only once.
  104119. */
  104120. resetRefreshCounter(): void;
  104121. /**
  104122. * Define the refresh rate of the texture or the rendering frequency.
  104123. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  104124. */
  104125. get refreshRate(): number;
  104126. set refreshRate(value: number);
  104127. /**
  104128. * Adds a post process to the render target rendering passes.
  104129. * @param postProcess define the post process to add
  104130. */
  104131. addPostProcess(postProcess: PostProcess): void;
  104132. /**
  104133. * Clear all the post processes attached to the render target
  104134. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  104135. */
  104136. clearPostProcesses(dispose?: boolean): void;
  104137. /**
  104138. * Remove one of the post process from the list of attached post processes to the texture
  104139. * @param postProcess define the post process to remove from the list
  104140. */
  104141. removePostProcess(postProcess: PostProcess): void;
  104142. /** @hidden */
  104143. _shouldRender(): boolean;
  104144. /**
  104145. * Gets the actual render size of the texture.
  104146. * @returns the width of the render size
  104147. */
  104148. getRenderSize(): number;
  104149. /**
  104150. * Gets the actual render width of the texture.
  104151. * @returns the width of the render size
  104152. */
  104153. getRenderWidth(): number;
  104154. /**
  104155. * Gets the actual render height of the texture.
  104156. * @returns the height of the render size
  104157. */
  104158. getRenderHeight(): number;
  104159. /**
  104160. * Gets the actual number of layers of the texture.
  104161. * @returns the number of layers
  104162. */
  104163. getRenderLayers(): number;
  104164. /**
  104165. * Get if the texture can be rescaled or not.
  104166. */
  104167. get canRescale(): boolean;
  104168. /**
  104169. * Resize the texture using a ratio.
  104170. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  104171. */
  104172. scale(ratio: number): void;
  104173. /**
  104174. * Get the texture reflection matrix used to rotate/transform the reflection.
  104175. * @returns the reflection matrix
  104176. */
  104177. getReflectionTextureMatrix(): Matrix;
  104178. /**
  104179. * Resize the texture to a new desired size.
  104180. * Be carrefull as it will recreate all the data in the new texture.
  104181. * @param size Define the new size. It can be:
  104182. * - a number for squared texture,
  104183. * - an object containing { width: number, height: number }
  104184. * - or an object containing a ratio { ratio: number }
  104185. */
  104186. resize(size: number | {
  104187. width: number;
  104188. height: number;
  104189. } | {
  104190. ratio: number;
  104191. }): void;
  104192. private _defaultRenderListPrepared;
  104193. /**
  104194. * Renders all the objects from the render list into the texture.
  104195. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  104196. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  104197. */
  104198. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  104199. private _bestReflectionRenderTargetDimension;
  104200. private _prepareRenderingManager;
  104201. /**
  104202. * @hidden
  104203. * @param faceIndex face index to bind to if this is a cubetexture
  104204. * @param layer defines the index of the texture to bind in the array
  104205. */
  104206. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  104207. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  104208. private renderToTarget;
  104209. /**
  104210. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  104211. * This allowed control for front to back rendering or reversly depending of the special needs.
  104212. *
  104213. * @param renderingGroupId The rendering group id corresponding to its index
  104214. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  104215. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  104216. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  104217. */
  104218. 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;
  104219. /**
  104220. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  104221. *
  104222. * @param renderingGroupId The rendering group id corresponding to its index
  104223. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  104224. */
  104225. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  104226. /**
  104227. * Clones the texture.
  104228. * @returns the cloned texture
  104229. */
  104230. clone(): RenderTargetTexture;
  104231. /**
  104232. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  104233. * @returns The JSON representation of the texture
  104234. */
  104235. serialize(): any;
  104236. /**
  104237. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  104238. */
  104239. disposeFramebufferObjects(): void;
  104240. /**
  104241. * Dispose the texture and release its associated resources.
  104242. */
  104243. dispose(): void;
  104244. /** @hidden */
  104245. _rebuild(): void;
  104246. /**
  104247. * Clear the info related to rendering groups preventing retention point in material dispose.
  104248. */
  104249. freeRenderingGroups(): void;
  104250. /**
  104251. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  104252. * @returns the view count
  104253. */
  104254. getViewCount(): number;
  104255. }
  104256. }
  104257. declare module BABYLON {
  104258. /**
  104259. * Class used to manipulate GUIDs
  104260. */
  104261. export class GUID {
  104262. /**
  104263. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  104264. * Be aware Math.random() could cause collisions, but:
  104265. * "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"
  104266. * @returns a pseudo random id
  104267. */
  104268. static RandomId(): string;
  104269. }
  104270. }
  104271. declare module BABYLON {
  104272. /**
  104273. * Options to be used when creating a shadow depth material
  104274. */
  104275. export interface IIOptionShadowDepthMaterial {
  104276. /** Variables in the vertex shader code that need to have their names remapped.
  104277. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  104278. * "var_name" should be either: worldPos or vNormalW
  104279. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  104280. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  104281. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  104282. */
  104283. remappedVariables?: string[];
  104284. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  104285. standalone?: boolean;
  104286. }
  104287. /**
  104288. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  104289. */
  104290. export class ShadowDepthWrapper {
  104291. private _scene;
  104292. private _options?;
  104293. private _baseMaterial;
  104294. private _onEffectCreatedObserver;
  104295. private _subMeshToEffect;
  104296. private _subMeshToDepthEffect;
  104297. private _meshes;
  104298. /** @hidden */
  104299. _matriceNames: any;
  104300. /** Gets the standalone status of the wrapper */
  104301. get standalone(): boolean;
  104302. /** Gets the base material the wrapper is built upon */
  104303. get baseMaterial(): Material;
  104304. /**
  104305. * Instantiate a new shadow depth wrapper.
  104306. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  104307. * generate the shadow depth map. For more information, please refer to the documentation:
  104308. * https://doc.babylonjs.com/babylon101/shadows
  104309. * @param baseMaterial Material to wrap
  104310. * @param scene Define the scene the material belongs to
  104311. * @param options Options used to create the wrapper
  104312. */
  104313. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  104314. /**
  104315. * Gets the effect to use to generate the depth map
  104316. * @param subMesh subMesh to get the effect for
  104317. * @param shadowGenerator shadow generator to get the effect for
  104318. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  104319. */
  104320. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  104321. /**
  104322. * Specifies that the submesh is ready to be used for depth rendering
  104323. * @param subMesh submesh to check
  104324. * @param defines the list of defines to take into account when checking the effect
  104325. * @param shadowGenerator combined with subMesh, it defines the effect to check
  104326. * @param useInstances specifies that instances should be used
  104327. * @returns a boolean indicating that the submesh is ready or not
  104328. */
  104329. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  104330. /**
  104331. * Disposes the resources
  104332. */
  104333. dispose(): void;
  104334. private _makeEffect;
  104335. }
  104336. }
  104337. declare module BABYLON {
  104338. interface ThinEngine {
  104339. /**
  104340. * Unbind a list of render target textures from the webGL context
  104341. * This is used only when drawBuffer extension or webGL2 are active
  104342. * @param textures defines the render target textures to unbind
  104343. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  104344. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  104345. */
  104346. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  104347. /**
  104348. * Create a multi render target texture
  104349. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  104350. * @param size defines the size of the texture
  104351. * @param options defines the creation options
  104352. * @returns the cube texture as an InternalTexture
  104353. */
  104354. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  104355. /**
  104356. * Update the sample count for a given multiple render target texture
  104357. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  104358. * @param textures defines the textures to update
  104359. * @param samples defines the sample count to set
  104360. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  104361. */
  104362. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  104363. /**
  104364. * Select a subsets of attachments to draw to.
  104365. * @param attachments gl attachments
  104366. */
  104367. bindAttachments(attachments: number[]): void;
  104368. }
  104369. }
  104370. declare module BABYLON {
  104371. /**
  104372. * Creation options of the multi render target texture.
  104373. */
  104374. export interface IMultiRenderTargetOptions {
  104375. /**
  104376. * Define if the texture needs to create mip maps after render.
  104377. */
  104378. generateMipMaps?: boolean;
  104379. /**
  104380. * Define the types of all the draw buffers we want to create
  104381. */
  104382. types?: number[];
  104383. /**
  104384. * Define the sampling modes of all the draw buffers we want to create
  104385. */
  104386. samplingModes?: number[];
  104387. /**
  104388. * Define if a depth buffer is required
  104389. */
  104390. generateDepthBuffer?: boolean;
  104391. /**
  104392. * Define if a stencil buffer is required
  104393. */
  104394. generateStencilBuffer?: boolean;
  104395. /**
  104396. * Define if a depth texture is required instead of a depth buffer
  104397. */
  104398. generateDepthTexture?: boolean;
  104399. /**
  104400. * Define the number of desired draw buffers
  104401. */
  104402. textureCount?: number;
  104403. /**
  104404. * Define if aspect ratio should be adapted to the texture or stay the scene one
  104405. */
  104406. doNotChangeAspectRatio?: boolean;
  104407. /**
  104408. * Define the default type of the buffers we are creating
  104409. */
  104410. defaultType?: number;
  104411. }
  104412. /**
  104413. * A multi render target, like a render target provides the ability to render to a texture.
  104414. * Unlike the render target, it can render to several draw buffers in one draw.
  104415. * This is specially interesting in deferred rendering or for any effects requiring more than
  104416. * just one color from a single pass.
  104417. */
  104418. export class MultiRenderTarget extends RenderTargetTexture {
  104419. private _internalTextures;
  104420. private _textures;
  104421. private _multiRenderTargetOptions;
  104422. private _count;
  104423. /**
  104424. * Get if draw buffers are currently supported by the used hardware and browser.
  104425. */
  104426. get isSupported(): boolean;
  104427. /**
  104428. * Get the list of textures generated by the multi render target.
  104429. */
  104430. get textures(): Texture[];
  104431. /**
  104432. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  104433. */
  104434. get count(): number;
  104435. /**
  104436. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  104437. */
  104438. get depthTexture(): Texture;
  104439. /**
  104440. * Set the wrapping mode on U of all the textures we are rendering to.
  104441. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  104442. */
  104443. set wrapU(wrap: number);
  104444. /**
  104445. * Set the wrapping mode on V of all the textures we are rendering to.
  104446. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  104447. */
  104448. set wrapV(wrap: number);
  104449. /**
  104450. * Instantiate a new multi render target texture.
  104451. * A multi render target, like a render target provides the ability to render to a texture.
  104452. * Unlike the render target, it can render to several draw buffers in one draw.
  104453. * This is specially interesting in deferred rendering or for any effects requiring more than
  104454. * just one color from a single pass.
  104455. * @param name Define the name of the texture
  104456. * @param size Define the size of the buffers to render to
  104457. * @param count Define the number of target we are rendering into
  104458. * @param scene Define the scene the texture belongs to
  104459. * @param options Define the options used to create the multi render target
  104460. */
  104461. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  104462. private _initTypes;
  104463. /** @hidden */
  104464. _rebuild(forceFullRebuild?: boolean): void;
  104465. private _createInternalTextures;
  104466. private _createTextures;
  104467. /**
  104468. * Define the number of samples used if MSAA is enabled.
  104469. */
  104470. get samples(): number;
  104471. set samples(value: number);
  104472. /**
  104473. * Resize all the textures in the multi render target.
  104474. * Be careful as it will recreate all the data in the new texture.
  104475. * @param size Define the new size
  104476. */
  104477. resize(size: any): void;
  104478. /**
  104479. * Changes the number of render targets in this MRT
  104480. * Be careful as it will recreate all the data in the new texture.
  104481. * @param count new texture count
  104482. * @param options Specifies texture types and sampling modes for new textures
  104483. */
  104484. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  104485. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  104486. /**
  104487. * Dispose the render targets and their associated resources
  104488. */
  104489. dispose(): void;
  104490. /**
  104491. * Release all the underlying texture used as draw buffers.
  104492. */
  104493. releaseInternalTextures(): void;
  104494. }
  104495. }
  104496. declare module BABYLON {
  104497. /** @hidden */
  104498. export var imageProcessingPixelShader: {
  104499. name: string;
  104500. shader: string;
  104501. };
  104502. }
  104503. declare module BABYLON {
  104504. /**
  104505. * ImageProcessingPostProcess
  104506. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  104507. */
  104508. export class ImageProcessingPostProcess extends PostProcess {
  104509. /**
  104510. * Default configuration related to image processing available in the PBR Material.
  104511. */
  104512. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  104513. /**
  104514. * Gets the image processing configuration used either in this material.
  104515. */
  104516. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  104517. /**
  104518. * Sets the Default image processing configuration used either in the this material.
  104519. *
  104520. * If sets to null, the scene one is in use.
  104521. */
  104522. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  104523. /**
  104524. * Keep track of the image processing observer to allow dispose and replace.
  104525. */
  104526. private _imageProcessingObserver;
  104527. /**
  104528. * Attaches a new image processing configuration to the PBR Material.
  104529. * @param configuration
  104530. */
  104531. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  104532. /**
  104533. * If the post process is supported.
  104534. */
  104535. get isSupported(): boolean;
  104536. /**
  104537. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  104538. */
  104539. get colorCurves(): Nullable<ColorCurves>;
  104540. /**
  104541. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  104542. */
  104543. set colorCurves(value: Nullable<ColorCurves>);
  104544. /**
  104545. * Gets wether the color curves effect is enabled.
  104546. */
  104547. get colorCurvesEnabled(): boolean;
  104548. /**
  104549. * Sets wether the color curves effect is enabled.
  104550. */
  104551. set colorCurvesEnabled(value: boolean);
  104552. /**
  104553. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  104554. */
  104555. get colorGradingTexture(): Nullable<BaseTexture>;
  104556. /**
  104557. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  104558. */
  104559. set colorGradingTexture(value: Nullable<BaseTexture>);
  104560. /**
  104561. * Gets wether the color grading effect is enabled.
  104562. */
  104563. get colorGradingEnabled(): boolean;
  104564. /**
  104565. * Gets wether the color grading effect is enabled.
  104566. */
  104567. set colorGradingEnabled(value: boolean);
  104568. /**
  104569. * Gets exposure used in the effect.
  104570. */
  104571. get exposure(): number;
  104572. /**
  104573. * Sets exposure used in the effect.
  104574. */
  104575. set exposure(value: number);
  104576. /**
  104577. * Gets wether tonemapping is enabled or not.
  104578. */
  104579. get toneMappingEnabled(): boolean;
  104580. /**
  104581. * Sets wether tonemapping is enabled or not
  104582. */
  104583. set toneMappingEnabled(value: boolean);
  104584. /**
  104585. * Gets the type of tone mapping effect.
  104586. */
  104587. get toneMappingType(): number;
  104588. /**
  104589. * Sets the type of tone mapping effect.
  104590. */
  104591. set toneMappingType(value: number);
  104592. /**
  104593. * Gets contrast used in the effect.
  104594. */
  104595. get contrast(): number;
  104596. /**
  104597. * Sets contrast used in the effect.
  104598. */
  104599. set contrast(value: number);
  104600. /**
  104601. * Gets Vignette stretch size.
  104602. */
  104603. get vignetteStretch(): number;
  104604. /**
  104605. * Sets Vignette stretch size.
  104606. */
  104607. set vignetteStretch(value: number);
  104608. /**
  104609. * Gets Vignette centre X Offset.
  104610. */
  104611. get vignetteCentreX(): number;
  104612. /**
  104613. * Sets Vignette centre X Offset.
  104614. */
  104615. set vignetteCentreX(value: number);
  104616. /**
  104617. * Gets Vignette centre Y Offset.
  104618. */
  104619. get vignetteCentreY(): number;
  104620. /**
  104621. * Sets Vignette centre Y Offset.
  104622. */
  104623. set vignetteCentreY(value: number);
  104624. /**
  104625. * Gets Vignette weight or intensity of the vignette effect.
  104626. */
  104627. get vignetteWeight(): number;
  104628. /**
  104629. * Sets Vignette weight or intensity of the vignette effect.
  104630. */
  104631. set vignetteWeight(value: number);
  104632. /**
  104633. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  104634. * if vignetteEnabled is set to true.
  104635. */
  104636. get vignetteColor(): Color4;
  104637. /**
  104638. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  104639. * if vignetteEnabled is set to true.
  104640. */
  104641. set vignetteColor(value: Color4);
  104642. /**
  104643. * Gets Camera field of view used by the Vignette effect.
  104644. */
  104645. get vignetteCameraFov(): number;
  104646. /**
  104647. * Sets Camera field of view used by the Vignette effect.
  104648. */
  104649. set vignetteCameraFov(value: number);
  104650. /**
  104651. * Gets the vignette blend mode allowing different kind of effect.
  104652. */
  104653. get vignetteBlendMode(): number;
  104654. /**
  104655. * Sets the vignette blend mode allowing different kind of effect.
  104656. */
  104657. set vignetteBlendMode(value: number);
  104658. /**
  104659. * Gets wether the vignette effect is enabled.
  104660. */
  104661. get vignetteEnabled(): boolean;
  104662. /**
  104663. * Sets wether the vignette effect is enabled.
  104664. */
  104665. set vignetteEnabled(value: boolean);
  104666. private _fromLinearSpace;
  104667. /**
  104668. * Gets wether the input of the processing is in Gamma or Linear Space.
  104669. */
  104670. get fromLinearSpace(): boolean;
  104671. /**
  104672. * Sets wether the input of the processing is in Gamma or Linear Space.
  104673. */
  104674. set fromLinearSpace(value: boolean);
  104675. /**
  104676. * Defines cache preventing GC.
  104677. */
  104678. private _defines;
  104679. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  104680. /**
  104681. * "ImageProcessingPostProcess"
  104682. * @returns "ImageProcessingPostProcess"
  104683. */
  104684. getClassName(): string;
  104685. /**
  104686. * @hidden
  104687. */
  104688. _updateParameters(): void;
  104689. dispose(camera?: Camera): void;
  104690. }
  104691. }
  104692. declare module BABYLON {
  104693. /**
  104694. * Interface for defining prepass effects in the prepass post-process pipeline
  104695. */
  104696. export interface PrePassEffectConfiguration {
  104697. /**
  104698. * Name of the effect
  104699. */
  104700. name: string;
  104701. /**
  104702. * Post process to attach for this effect
  104703. */
  104704. postProcess?: PostProcess;
  104705. /**
  104706. * Textures required in the MRT
  104707. */
  104708. texturesRequired: number[];
  104709. /**
  104710. * Is the effect enabled
  104711. */
  104712. enabled: boolean;
  104713. /**
  104714. * Disposes the effect configuration
  104715. */
  104716. dispose(): void;
  104717. /**
  104718. * Creates the associated post process
  104719. */
  104720. createPostProcess?: () => PostProcess;
  104721. }
  104722. }
  104723. declare module BABYLON {
  104724. /**
  104725. * Renders a pre pass of the scene
  104726. * This means every mesh in the scene will be rendered to a render target texture
  104727. * And then this texture will be composited to the rendering canvas with post processes
  104728. * It is necessary for effects like subsurface scattering or deferred shading
  104729. */
  104730. export class PrePassRenderer {
  104731. /** @hidden */
  104732. static _SceneComponentInitialization: (scene: Scene) => void;
  104733. private _textureFormats;
  104734. private _textureIndices;
  104735. private _scene;
  104736. private _engine;
  104737. private _isDirty;
  104738. /**
  104739. * Number of textures in the multi render target texture where the scene is directly rendered
  104740. */
  104741. mrtCount: number;
  104742. /**
  104743. * The render target where the scene is directly rendered
  104744. */
  104745. prePassRT: MultiRenderTarget;
  104746. private _multiRenderAttachments;
  104747. private _defaultAttachments;
  104748. private _clearAttachments;
  104749. private _postProcesses;
  104750. private readonly _clearColor;
  104751. /**
  104752. * Image processing post process for composition
  104753. */
  104754. imageProcessingPostProcess: ImageProcessingPostProcess;
  104755. /**
  104756. * Configuration for prepass effects
  104757. */
  104758. private _effectConfigurations;
  104759. /**
  104760. * Should materials render their geometry on the MRT
  104761. */
  104762. materialsShouldRenderGeometry: boolean;
  104763. /**
  104764. * Should materials render the irradiance information on the MRT
  104765. */
  104766. materialsShouldRenderIrradiance: boolean;
  104767. private _mrtFormats;
  104768. private _mrtLayout;
  104769. private _enabled;
  104770. /**
  104771. * Indicates if the prepass is enabled
  104772. */
  104773. get enabled(): boolean;
  104774. /**
  104775. * How many samples are used for MSAA of the scene render target
  104776. */
  104777. get samples(): number;
  104778. set samples(n: number);
  104779. /**
  104780. * Instanciates a prepass renderer
  104781. * @param scene The scene
  104782. */
  104783. constructor(scene: Scene);
  104784. private _initializeAttachments;
  104785. private _createCompositionEffect;
  104786. /**
  104787. * Indicates if rendering a prepass is supported
  104788. */
  104789. get isSupported(): boolean;
  104790. /**
  104791. * Sets the proper output textures to draw in the engine.
  104792. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104793. */
  104794. bindAttachmentsForEffect(effect: Effect): void;
  104795. /**
  104796. * @hidden
  104797. */
  104798. _beforeCameraDraw(): void;
  104799. /**
  104800. * @hidden
  104801. */
  104802. _afterCameraDraw(): void;
  104803. private _checkRTSize;
  104804. private _bindFrameBuffer;
  104805. /**
  104806. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104807. */
  104808. clear(): void;
  104809. private _setState;
  104810. private _checkTextureType;
  104811. /**
  104812. * Adds an effect configuration to the prepass.
  104813. * If an effect has already been added, it won't add it twice and will return the configuration
  104814. * already present.
  104815. * @param cfg the effect configuration
  104816. * @return the effect configuration now used by the prepass
  104817. */
  104818. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  104819. /**
  104820. * Returns the index of a texture in the multi render target texture array.
  104821. * @param type Texture type
  104822. * @return The index
  104823. */
  104824. getIndex(type: number): number;
  104825. private _enable;
  104826. private _disable;
  104827. private _resetLayout;
  104828. private _resetPostProcessChain;
  104829. private _bindPostProcessChain;
  104830. /**
  104831. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104832. */
  104833. markAsDirty(): void;
  104834. /**
  104835. * Enables a texture on the MultiRenderTarget for prepass
  104836. */
  104837. private _enableTextures;
  104838. private _update;
  104839. /**
  104840. * Disposes the prepass renderer.
  104841. */
  104842. dispose(): void;
  104843. }
  104844. }
  104845. declare module BABYLON {
  104846. /**
  104847. * Options for compiling materials.
  104848. */
  104849. export interface IMaterialCompilationOptions {
  104850. /**
  104851. * Defines whether clip planes are enabled.
  104852. */
  104853. clipPlane: boolean;
  104854. /**
  104855. * Defines whether instances are enabled.
  104856. */
  104857. useInstances: boolean;
  104858. }
  104859. /**
  104860. * Options passed when calling customShaderNameResolve
  104861. */
  104862. export interface ICustomShaderNameResolveOptions {
  104863. /**
  104864. * 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
  104865. */
  104866. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104867. }
  104868. /**
  104869. * Base class for the main features of a material in Babylon.js
  104870. */
  104871. export class Material implements IAnimatable {
  104872. /**
  104873. * Returns the triangle fill mode
  104874. */
  104875. static readonly TriangleFillMode: number;
  104876. /**
  104877. * Returns the wireframe mode
  104878. */
  104879. static readonly WireFrameFillMode: number;
  104880. /**
  104881. * Returns the point fill mode
  104882. */
  104883. static readonly PointFillMode: number;
  104884. /**
  104885. * Returns the point list draw mode
  104886. */
  104887. static readonly PointListDrawMode: number;
  104888. /**
  104889. * Returns the line list draw mode
  104890. */
  104891. static readonly LineListDrawMode: number;
  104892. /**
  104893. * Returns the line loop draw mode
  104894. */
  104895. static readonly LineLoopDrawMode: number;
  104896. /**
  104897. * Returns the line strip draw mode
  104898. */
  104899. static readonly LineStripDrawMode: number;
  104900. /**
  104901. * Returns the triangle strip draw mode
  104902. */
  104903. static readonly TriangleStripDrawMode: number;
  104904. /**
  104905. * Returns the triangle fan draw mode
  104906. */
  104907. static readonly TriangleFanDrawMode: number;
  104908. /**
  104909. * Stores the clock-wise side orientation
  104910. */
  104911. static readonly ClockWiseSideOrientation: number;
  104912. /**
  104913. * Stores the counter clock-wise side orientation
  104914. */
  104915. static readonly CounterClockWiseSideOrientation: number;
  104916. /**
  104917. * The dirty texture flag value
  104918. */
  104919. static readonly TextureDirtyFlag: number;
  104920. /**
  104921. * The dirty light flag value
  104922. */
  104923. static readonly LightDirtyFlag: number;
  104924. /**
  104925. * The dirty fresnel flag value
  104926. */
  104927. static readonly FresnelDirtyFlag: number;
  104928. /**
  104929. * The dirty attribute flag value
  104930. */
  104931. static readonly AttributesDirtyFlag: number;
  104932. /**
  104933. * The dirty misc flag value
  104934. */
  104935. static readonly MiscDirtyFlag: number;
  104936. /**
  104937. * The all dirty flag value
  104938. */
  104939. static readonly AllDirtyFlag: number;
  104940. /**
  104941. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104942. */
  104943. static readonly MATERIAL_OPAQUE: number;
  104944. /**
  104945. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104946. */
  104947. static readonly MATERIAL_ALPHATEST: number;
  104948. /**
  104949. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104950. */
  104951. static readonly MATERIAL_ALPHABLEND: number;
  104952. /**
  104953. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104954. * They are also discarded below the alpha cutoff threshold to improve performances.
  104955. */
  104956. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104957. /**
  104958. * The Whiteout method is used to blend normals.
  104959. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104960. */
  104961. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104962. /**
  104963. * The Reoriented Normal Mapping method is used to blend normals.
  104964. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104965. */
  104966. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104967. /**
  104968. * Custom callback helping to override the default shader used in the material.
  104969. */
  104970. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104971. /**
  104972. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104973. */
  104974. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104975. /**
  104976. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104977. * This means that the material can keep using a previous shader while a new one is being compiled.
  104978. * This is mostly used when shader parallel compilation is supported (true by default)
  104979. */
  104980. allowShaderHotSwapping: boolean;
  104981. /**
  104982. * The ID of the material
  104983. */
  104984. id: string;
  104985. /**
  104986. * Gets or sets the unique id of the material
  104987. */
  104988. uniqueId: number;
  104989. /**
  104990. * The name of the material
  104991. */
  104992. name: string;
  104993. /**
  104994. * Gets or sets user defined metadata
  104995. */
  104996. metadata: any;
  104997. /**
  104998. * For internal use only. Please do not use.
  104999. */
  105000. reservedDataStore: any;
  105001. /**
  105002. * Specifies if the ready state should be checked on each call
  105003. */
  105004. checkReadyOnEveryCall: boolean;
  105005. /**
  105006. * Specifies if the ready state should be checked once
  105007. */
  105008. checkReadyOnlyOnce: boolean;
  105009. /**
  105010. * The state of the material
  105011. */
  105012. state: string;
  105013. /**
  105014. * If the material can be rendered to several textures with MRT extension
  105015. */
  105016. get canRenderToMRT(): boolean;
  105017. /**
  105018. * The alpha value of the material
  105019. */
  105020. protected _alpha: number;
  105021. /**
  105022. * List of inspectable custom properties (used by the Inspector)
  105023. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  105024. */
  105025. inspectableCustomProperties: IInspectable[];
  105026. /**
  105027. * Sets the alpha value of the material
  105028. */
  105029. set alpha(value: number);
  105030. /**
  105031. * Gets the alpha value of the material
  105032. */
  105033. get alpha(): number;
  105034. /**
  105035. * Specifies if back face culling is enabled
  105036. */
  105037. protected _backFaceCulling: boolean;
  105038. /**
  105039. * Sets the back-face culling state
  105040. */
  105041. set backFaceCulling(value: boolean);
  105042. /**
  105043. * Gets the back-face culling state
  105044. */
  105045. get backFaceCulling(): boolean;
  105046. /**
  105047. * Stores the value for side orientation
  105048. */
  105049. sideOrientation: number;
  105050. /**
  105051. * Callback triggered when the material is compiled
  105052. */
  105053. onCompiled: Nullable<(effect: Effect) => void>;
  105054. /**
  105055. * Callback triggered when an error occurs
  105056. */
  105057. onError: Nullable<(effect: Effect, errors: string) => void>;
  105058. /**
  105059. * Callback triggered to get the render target textures
  105060. */
  105061. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  105062. /**
  105063. * Gets a boolean indicating that current material needs to register RTT
  105064. */
  105065. get hasRenderTargetTextures(): boolean;
  105066. /**
  105067. * Specifies if the material should be serialized
  105068. */
  105069. doNotSerialize: boolean;
  105070. /**
  105071. * @hidden
  105072. */
  105073. _storeEffectOnSubMeshes: boolean;
  105074. /**
  105075. * Stores the animations for the material
  105076. */
  105077. animations: Nullable<Array<Animation>>;
  105078. /**
  105079. * An event triggered when the material is disposed
  105080. */
  105081. onDisposeObservable: Observable<Material>;
  105082. /**
  105083. * An observer which watches for dispose events
  105084. */
  105085. private _onDisposeObserver;
  105086. private _onUnBindObservable;
  105087. /**
  105088. * Called during a dispose event
  105089. */
  105090. set onDispose(callback: () => void);
  105091. private _onBindObservable;
  105092. /**
  105093. * An event triggered when the material is bound
  105094. */
  105095. get onBindObservable(): Observable<AbstractMesh>;
  105096. /**
  105097. * An observer which watches for bind events
  105098. */
  105099. private _onBindObserver;
  105100. /**
  105101. * Called during a bind event
  105102. */
  105103. set onBind(callback: (Mesh: AbstractMesh) => void);
  105104. /**
  105105. * An event triggered when the material is unbound
  105106. */
  105107. get onUnBindObservable(): Observable<Material>;
  105108. protected _onEffectCreatedObservable: Nullable<Observable<{
  105109. effect: Effect;
  105110. subMesh: Nullable<SubMesh>;
  105111. }>>;
  105112. /**
  105113. * An event triggered when the effect is (re)created
  105114. */
  105115. get onEffectCreatedObservable(): Observable<{
  105116. effect: Effect;
  105117. subMesh: Nullable<SubMesh>;
  105118. }>;
  105119. /**
  105120. * Stores the value of the alpha mode
  105121. */
  105122. private _alphaMode;
  105123. /**
  105124. * Sets the value of the alpha mode.
  105125. *
  105126. * | Value | Type | Description |
  105127. * | --- | --- | --- |
  105128. * | 0 | ALPHA_DISABLE | |
  105129. * | 1 | ALPHA_ADD | |
  105130. * | 2 | ALPHA_COMBINE | |
  105131. * | 3 | ALPHA_SUBTRACT | |
  105132. * | 4 | ALPHA_MULTIPLY | |
  105133. * | 5 | ALPHA_MAXIMIZED | |
  105134. * | 6 | ALPHA_ONEONE | |
  105135. * | 7 | ALPHA_PREMULTIPLIED | |
  105136. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  105137. * | 9 | ALPHA_INTERPOLATE | |
  105138. * | 10 | ALPHA_SCREENMODE | |
  105139. *
  105140. */
  105141. set alphaMode(value: number);
  105142. /**
  105143. * Gets the value of the alpha mode
  105144. */
  105145. get alphaMode(): number;
  105146. /**
  105147. * Stores the state of the need depth pre-pass value
  105148. */
  105149. private _needDepthPrePass;
  105150. /**
  105151. * Sets the need depth pre-pass value
  105152. */
  105153. set needDepthPrePass(value: boolean);
  105154. /**
  105155. * Gets the depth pre-pass value
  105156. */
  105157. get needDepthPrePass(): boolean;
  105158. /**
  105159. * Specifies if depth writing should be disabled
  105160. */
  105161. disableDepthWrite: boolean;
  105162. /**
  105163. * Specifies if color writing should be disabled
  105164. */
  105165. disableColorWrite: boolean;
  105166. /**
  105167. * Specifies if depth writing should be forced
  105168. */
  105169. forceDepthWrite: boolean;
  105170. /**
  105171. * Specifies the depth function that should be used. 0 means the default engine function
  105172. */
  105173. depthFunction: number;
  105174. /**
  105175. * Specifies if there should be a separate pass for culling
  105176. */
  105177. separateCullingPass: boolean;
  105178. /**
  105179. * Stores the state specifing if fog should be enabled
  105180. */
  105181. private _fogEnabled;
  105182. /**
  105183. * Sets the state for enabling fog
  105184. */
  105185. set fogEnabled(value: boolean);
  105186. /**
  105187. * Gets the value of the fog enabled state
  105188. */
  105189. get fogEnabled(): boolean;
  105190. /**
  105191. * Stores the size of points
  105192. */
  105193. pointSize: number;
  105194. /**
  105195. * Stores the z offset value
  105196. */
  105197. zOffset: number;
  105198. get wireframe(): boolean;
  105199. /**
  105200. * Sets the state of wireframe mode
  105201. */
  105202. set wireframe(value: boolean);
  105203. /**
  105204. * Gets the value specifying if point clouds are enabled
  105205. */
  105206. get pointsCloud(): boolean;
  105207. /**
  105208. * Sets the state of point cloud mode
  105209. */
  105210. set pointsCloud(value: boolean);
  105211. /**
  105212. * Gets the material fill mode
  105213. */
  105214. get fillMode(): number;
  105215. /**
  105216. * Sets the material fill mode
  105217. */
  105218. set fillMode(value: number);
  105219. /**
  105220. * @hidden
  105221. * Stores the effects for the material
  105222. */
  105223. _effect: Nullable<Effect>;
  105224. /**
  105225. * Specifies if uniform buffers should be used
  105226. */
  105227. private _useUBO;
  105228. /**
  105229. * Stores a reference to the scene
  105230. */
  105231. private _scene;
  105232. /**
  105233. * Stores the fill mode state
  105234. */
  105235. private _fillMode;
  105236. /**
  105237. * Specifies if the depth write state should be cached
  105238. */
  105239. private _cachedDepthWriteState;
  105240. /**
  105241. * Specifies if the color write state should be cached
  105242. */
  105243. private _cachedColorWriteState;
  105244. /**
  105245. * Specifies if the depth function state should be cached
  105246. */
  105247. private _cachedDepthFunctionState;
  105248. /**
  105249. * Stores the uniform buffer
  105250. */
  105251. protected _uniformBuffer: UniformBuffer;
  105252. /** @hidden */
  105253. _indexInSceneMaterialArray: number;
  105254. /** @hidden */
  105255. meshMap: Nullable<{
  105256. [id: string]: AbstractMesh | undefined;
  105257. }>;
  105258. /**
  105259. * Creates a material instance
  105260. * @param name defines the name of the material
  105261. * @param scene defines the scene to reference
  105262. * @param doNotAdd specifies if the material should be added to the scene
  105263. */
  105264. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  105265. /**
  105266. * Returns a string representation of the current material
  105267. * @param fullDetails defines a boolean indicating which levels of logging is desired
  105268. * @returns a string with material information
  105269. */
  105270. toString(fullDetails?: boolean): string;
  105271. /**
  105272. * Gets the class name of the material
  105273. * @returns a string with the class name of the material
  105274. */
  105275. getClassName(): string;
  105276. /**
  105277. * Specifies if updates for the material been locked
  105278. */
  105279. get isFrozen(): boolean;
  105280. /**
  105281. * Locks updates for the material
  105282. */
  105283. freeze(): void;
  105284. /**
  105285. * Unlocks updates for the material
  105286. */
  105287. unfreeze(): void;
  105288. /**
  105289. * Specifies if the material is ready to be used
  105290. * @param mesh defines the mesh to check
  105291. * @param useInstances specifies if instances should be used
  105292. * @returns a boolean indicating if the material is ready to be used
  105293. */
  105294. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  105295. /**
  105296. * Specifies that the submesh is ready to be used
  105297. * @param mesh defines the mesh to check
  105298. * @param subMesh defines which submesh to check
  105299. * @param useInstances specifies that instances should be used
  105300. * @returns a boolean indicating that the submesh is ready or not
  105301. */
  105302. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105303. /**
  105304. * Returns the material effect
  105305. * @returns the effect associated with the material
  105306. */
  105307. getEffect(): Nullable<Effect>;
  105308. /**
  105309. * Returns the current scene
  105310. * @returns a Scene
  105311. */
  105312. getScene(): Scene;
  105313. /**
  105314. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  105315. */
  105316. protected _forceAlphaTest: boolean;
  105317. /**
  105318. * The transparency mode of the material.
  105319. */
  105320. protected _transparencyMode: Nullable<number>;
  105321. /**
  105322. * Gets the current transparency mode.
  105323. */
  105324. get transparencyMode(): Nullable<number>;
  105325. /**
  105326. * Sets the transparency mode of the material.
  105327. *
  105328. * | Value | Type | Description |
  105329. * | ----- | ----------------------------------- | ----------- |
  105330. * | 0 | OPAQUE | |
  105331. * | 1 | ALPHATEST | |
  105332. * | 2 | ALPHABLEND | |
  105333. * | 3 | ALPHATESTANDBLEND | |
  105334. *
  105335. */
  105336. set transparencyMode(value: Nullable<number>);
  105337. /**
  105338. * Returns true if alpha blending should be disabled.
  105339. */
  105340. protected get _disableAlphaBlending(): boolean;
  105341. /**
  105342. * Specifies whether or not this material should be rendered in alpha blend mode.
  105343. * @returns a boolean specifying if alpha blending is needed
  105344. */
  105345. needAlphaBlending(): boolean;
  105346. /**
  105347. * Specifies if the mesh will require alpha blending
  105348. * @param mesh defines the mesh to check
  105349. * @returns a boolean specifying if alpha blending is needed for the mesh
  105350. */
  105351. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  105352. /**
  105353. * Specifies whether or not this material should be rendered in alpha test mode.
  105354. * @returns a boolean specifying if an alpha test is needed.
  105355. */
  105356. needAlphaTesting(): boolean;
  105357. /**
  105358. * Specifies if material alpha testing should be turned on for the mesh
  105359. * @param mesh defines the mesh to check
  105360. */
  105361. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  105362. /**
  105363. * Gets the texture used for the alpha test
  105364. * @returns the texture to use for alpha testing
  105365. */
  105366. getAlphaTestTexture(): Nullable<BaseTexture>;
  105367. /**
  105368. * Marks the material to indicate that it needs to be re-calculated
  105369. */
  105370. markDirty(): void;
  105371. /** @hidden */
  105372. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  105373. /**
  105374. * Binds the material to the mesh
  105375. * @param world defines the world transformation matrix
  105376. * @param mesh defines the mesh to bind the material to
  105377. */
  105378. bind(world: Matrix, mesh?: Mesh): void;
  105379. /**
  105380. * Binds the submesh to the material
  105381. * @param world defines the world transformation matrix
  105382. * @param mesh defines the mesh containing the submesh
  105383. * @param subMesh defines the submesh to bind the material to
  105384. */
  105385. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  105386. /**
  105387. * Binds the world matrix to the material
  105388. * @param world defines the world transformation matrix
  105389. */
  105390. bindOnlyWorldMatrix(world: Matrix): void;
  105391. /**
  105392. * Binds the scene's uniform buffer to the effect.
  105393. * @param effect defines the effect to bind to the scene uniform buffer
  105394. * @param sceneUbo defines the uniform buffer storing scene data
  105395. */
  105396. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  105397. /**
  105398. * Binds the view matrix to the effect
  105399. * @param effect defines the effect to bind the view matrix to
  105400. */
  105401. bindView(effect: Effect): void;
  105402. /**
  105403. * Binds the view projection matrix to the effect
  105404. * @param effect defines the effect to bind the view projection matrix to
  105405. */
  105406. bindViewProjection(effect: Effect): void;
  105407. /**
  105408. * Processes to execute after binding the material to a mesh
  105409. * @param mesh defines the rendered mesh
  105410. */
  105411. protected _afterBind(mesh?: Mesh): void;
  105412. /**
  105413. * Unbinds the material from the mesh
  105414. */
  105415. unbind(): void;
  105416. /**
  105417. * Gets the active textures from the material
  105418. * @returns an array of textures
  105419. */
  105420. getActiveTextures(): BaseTexture[];
  105421. /**
  105422. * Specifies if the material uses a texture
  105423. * @param texture defines the texture to check against the material
  105424. * @returns a boolean specifying if the material uses the texture
  105425. */
  105426. hasTexture(texture: BaseTexture): boolean;
  105427. /**
  105428. * Makes a duplicate of the material, and gives it a new name
  105429. * @param name defines the new name for the duplicated material
  105430. * @returns the cloned material
  105431. */
  105432. clone(name: string): Nullable<Material>;
  105433. /**
  105434. * Gets the meshes bound to the material
  105435. * @returns an array of meshes bound to the material
  105436. */
  105437. getBindedMeshes(): AbstractMesh[];
  105438. /**
  105439. * Force shader compilation
  105440. * @param mesh defines the mesh associated with this material
  105441. * @param onCompiled defines a function to execute once the material is compiled
  105442. * @param options defines the options to configure the compilation
  105443. * @param onError defines a function to execute if the material fails compiling
  105444. */
  105445. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  105446. /**
  105447. * Force shader compilation
  105448. * @param mesh defines the mesh that will use this material
  105449. * @param options defines additional options for compiling the shaders
  105450. * @returns a promise that resolves when the compilation completes
  105451. */
  105452. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  105453. private static readonly _AllDirtyCallBack;
  105454. private static readonly _ImageProcessingDirtyCallBack;
  105455. private static readonly _TextureDirtyCallBack;
  105456. private static readonly _FresnelDirtyCallBack;
  105457. private static readonly _MiscDirtyCallBack;
  105458. private static readonly _LightsDirtyCallBack;
  105459. private static readonly _AttributeDirtyCallBack;
  105460. private static _FresnelAndMiscDirtyCallBack;
  105461. private static _TextureAndMiscDirtyCallBack;
  105462. private static readonly _DirtyCallbackArray;
  105463. private static readonly _RunDirtyCallBacks;
  105464. /**
  105465. * Marks a define in the material to indicate that it needs to be re-computed
  105466. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  105467. */
  105468. markAsDirty(flag: number): void;
  105469. /**
  105470. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  105471. * @param func defines a function which checks material defines against the submeshes
  105472. */
  105473. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  105474. /**
  105475. * Indicates that the scene should check if the rendering now needs a prepass
  105476. */
  105477. protected _markScenePrePassDirty(): void;
  105478. /**
  105479. * Indicates that we need to re-calculated for all submeshes
  105480. */
  105481. protected _markAllSubMeshesAsAllDirty(): void;
  105482. /**
  105483. * Indicates that image processing needs to be re-calculated for all submeshes
  105484. */
  105485. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  105486. /**
  105487. * Indicates that textures need to be re-calculated for all submeshes
  105488. */
  105489. protected _markAllSubMeshesAsTexturesDirty(): void;
  105490. /**
  105491. * Indicates that fresnel needs to be re-calculated for all submeshes
  105492. */
  105493. protected _markAllSubMeshesAsFresnelDirty(): void;
  105494. /**
  105495. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  105496. */
  105497. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  105498. /**
  105499. * Indicates that lights need to be re-calculated for all submeshes
  105500. */
  105501. protected _markAllSubMeshesAsLightsDirty(): void;
  105502. /**
  105503. * Indicates that attributes need to be re-calculated for all submeshes
  105504. */
  105505. protected _markAllSubMeshesAsAttributesDirty(): void;
  105506. /**
  105507. * Indicates that misc needs to be re-calculated for all submeshes
  105508. */
  105509. protected _markAllSubMeshesAsMiscDirty(): void;
  105510. /**
  105511. * Indicates that textures and misc need to be re-calculated for all submeshes
  105512. */
  105513. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  105514. /**
  105515. * Sets the required values to the prepass renderer.
  105516. * @param prePassRenderer defines the prepass renderer to setup.
  105517. * @returns true if the pre pass is needed.
  105518. */
  105519. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  105520. /**
  105521. * Disposes the material
  105522. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  105523. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  105524. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  105525. */
  105526. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  105527. /** @hidden */
  105528. private releaseVertexArrayObject;
  105529. /**
  105530. * Serializes this material
  105531. * @returns the serialized material object
  105532. */
  105533. serialize(): any;
  105534. /**
  105535. * Creates a material from parsed material data
  105536. * @param parsedMaterial defines parsed material data
  105537. * @param scene defines the hosting scene
  105538. * @param rootUrl defines the root URL to use to load textures
  105539. * @returns a new material
  105540. */
  105541. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  105542. }
  105543. }
  105544. declare module BABYLON {
  105545. /**
  105546. * A multi-material is used to apply different materials to different parts of the same object without the need of
  105547. * separate meshes. This can be use to improve performances.
  105548. * @see https://doc.babylonjs.com/how_to/multi_materials
  105549. */
  105550. export class MultiMaterial extends Material {
  105551. private _subMaterials;
  105552. /**
  105553. * Gets or Sets the list of Materials used within the multi material.
  105554. * They need to be ordered according to the submeshes order in the associated mesh
  105555. */
  105556. get subMaterials(): Nullable<Material>[];
  105557. set subMaterials(value: Nullable<Material>[]);
  105558. /**
  105559. * Function used to align with Node.getChildren()
  105560. * @returns the list of Materials used within the multi material
  105561. */
  105562. getChildren(): Nullable<Material>[];
  105563. /**
  105564. * Instantiates a new Multi Material
  105565. * A multi-material is used to apply different materials to different parts of the same object without the need of
  105566. * separate meshes. This can be use to improve performances.
  105567. * @see https://doc.babylonjs.com/how_to/multi_materials
  105568. * @param name Define the name in the scene
  105569. * @param scene Define the scene the material belongs to
  105570. */
  105571. constructor(name: string, scene: Scene);
  105572. private _hookArray;
  105573. /**
  105574. * Get one of the submaterial by its index in the submaterials array
  105575. * @param index The index to look the sub material at
  105576. * @returns The Material if the index has been defined
  105577. */
  105578. getSubMaterial(index: number): Nullable<Material>;
  105579. /**
  105580. * Get the list of active textures for the whole sub materials list.
  105581. * @returns All the textures that will be used during the rendering
  105582. */
  105583. getActiveTextures(): BaseTexture[];
  105584. /**
  105585. * Gets the current class name of the material e.g. "MultiMaterial"
  105586. * Mainly use in serialization.
  105587. * @returns the class name
  105588. */
  105589. getClassName(): string;
  105590. /**
  105591. * Checks if the material is ready to render the requested sub mesh
  105592. * @param mesh Define the mesh the submesh belongs to
  105593. * @param subMesh Define the sub mesh to look readyness for
  105594. * @param useInstances Define whether or not the material is used with instances
  105595. * @returns true if ready, otherwise false
  105596. */
  105597. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105598. /**
  105599. * Clones the current material and its related sub materials
  105600. * @param name Define the name of the newly cloned material
  105601. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  105602. * @returns the cloned material
  105603. */
  105604. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  105605. /**
  105606. * Serializes the materials into a JSON representation.
  105607. * @returns the JSON representation
  105608. */
  105609. serialize(): any;
  105610. /**
  105611. * Dispose the material and release its associated resources
  105612. * @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)
  105613. * @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)
  105614. * @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)
  105615. */
  105616. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  105617. /**
  105618. * Creates a MultiMaterial from parsed MultiMaterial data.
  105619. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  105620. * @param scene defines the hosting scene
  105621. * @returns a new MultiMaterial
  105622. */
  105623. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  105624. }
  105625. }
  105626. declare module BABYLON {
  105627. /**
  105628. * Defines a subdivision inside a mesh
  105629. */
  105630. export class SubMesh implements ICullable {
  105631. /** the material index to use */
  105632. materialIndex: number;
  105633. /** vertex index start */
  105634. verticesStart: number;
  105635. /** vertices count */
  105636. verticesCount: number;
  105637. /** index start */
  105638. indexStart: number;
  105639. /** indices count */
  105640. indexCount: number;
  105641. /** @hidden */
  105642. _materialDefines: Nullable<MaterialDefines>;
  105643. /** @hidden */
  105644. _materialEffect: Nullable<Effect>;
  105645. /** @hidden */
  105646. _effectOverride: Nullable<Effect>;
  105647. /**
  105648. * Gets material defines used by the effect associated to the sub mesh
  105649. */
  105650. get materialDefines(): Nullable<MaterialDefines>;
  105651. /**
  105652. * Sets material defines used by the effect associated to the sub mesh
  105653. */
  105654. set materialDefines(defines: Nullable<MaterialDefines>);
  105655. /**
  105656. * Gets associated effect
  105657. */
  105658. get effect(): Nullable<Effect>;
  105659. /**
  105660. * Sets associated effect (effect used to render this submesh)
  105661. * @param effect defines the effect to associate with
  105662. * @param defines defines the set of defines used to compile this effect
  105663. */
  105664. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  105665. /** @hidden */
  105666. _linesIndexCount: number;
  105667. private _mesh;
  105668. private _renderingMesh;
  105669. private _boundingInfo;
  105670. private _linesIndexBuffer;
  105671. /** @hidden */
  105672. _lastColliderWorldVertices: Nullable<Vector3[]>;
  105673. /** @hidden */
  105674. _trianglePlanes: Plane[];
  105675. /** @hidden */
  105676. _lastColliderTransformMatrix: Nullable<Matrix>;
  105677. /** @hidden */
  105678. _renderId: number;
  105679. /** @hidden */
  105680. _alphaIndex: number;
  105681. /** @hidden */
  105682. _distanceToCamera: number;
  105683. /** @hidden */
  105684. _id: number;
  105685. private _currentMaterial;
  105686. /**
  105687. * Add a new submesh to a mesh
  105688. * @param materialIndex defines the material index to use
  105689. * @param verticesStart defines vertex index start
  105690. * @param verticesCount defines vertices count
  105691. * @param indexStart defines index start
  105692. * @param indexCount defines indices count
  105693. * @param mesh defines the parent mesh
  105694. * @param renderingMesh defines an optional rendering mesh
  105695. * @param createBoundingBox defines if bounding box should be created for this submesh
  105696. * @returns the new submesh
  105697. */
  105698. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105699. /**
  105700. * Creates a new submesh
  105701. * @param materialIndex defines the material index to use
  105702. * @param verticesStart defines vertex index start
  105703. * @param verticesCount defines vertices count
  105704. * @param indexStart defines index start
  105705. * @param indexCount defines indices count
  105706. * @param mesh defines the parent mesh
  105707. * @param renderingMesh defines an optional rendering mesh
  105708. * @param createBoundingBox defines if bounding box should be created for this submesh
  105709. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105710. */
  105711. constructor(
  105712. /** the material index to use */
  105713. materialIndex: number,
  105714. /** vertex index start */
  105715. verticesStart: number,
  105716. /** vertices count */
  105717. verticesCount: number,
  105718. /** index start */
  105719. indexStart: number,
  105720. /** indices count */
  105721. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105722. /**
  105723. * Returns true if this submesh covers the entire parent mesh
  105724. * @ignorenaming
  105725. */
  105726. get IsGlobal(): boolean;
  105727. /**
  105728. * Returns the submesh BoudingInfo object
  105729. * @returns current bounding info (or mesh's one if the submesh is global)
  105730. */
  105731. getBoundingInfo(): BoundingInfo;
  105732. /**
  105733. * Sets the submesh BoundingInfo
  105734. * @param boundingInfo defines the new bounding info to use
  105735. * @returns the SubMesh
  105736. */
  105737. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105738. /**
  105739. * Returns the mesh of the current submesh
  105740. * @return the parent mesh
  105741. */
  105742. getMesh(): AbstractMesh;
  105743. /**
  105744. * Returns the rendering mesh of the submesh
  105745. * @returns the rendering mesh (could be different from parent mesh)
  105746. */
  105747. getRenderingMesh(): Mesh;
  105748. /**
  105749. * Returns the replacement mesh of the submesh
  105750. * @returns the replacement mesh (could be different from parent mesh)
  105751. */
  105752. getReplacementMesh(): Nullable<AbstractMesh>;
  105753. /**
  105754. * Returns the effective mesh of the submesh
  105755. * @returns the effective mesh (could be different from parent mesh)
  105756. */
  105757. getEffectiveMesh(): AbstractMesh;
  105758. /**
  105759. * Returns the submesh material
  105760. * @returns null or the current material
  105761. */
  105762. getMaterial(): Nullable<Material>;
  105763. private _IsMultiMaterial;
  105764. /**
  105765. * Sets a new updated BoundingInfo object to the submesh
  105766. * @param data defines an optional position array to use to determine the bounding info
  105767. * @returns the SubMesh
  105768. */
  105769. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105770. /** @hidden */
  105771. _checkCollision(collider: Collider): boolean;
  105772. /**
  105773. * Updates the submesh BoundingInfo
  105774. * @param world defines the world matrix to use to update the bounding info
  105775. * @returns the submesh
  105776. */
  105777. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105778. /**
  105779. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105780. * @param frustumPlanes defines the frustum planes
  105781. * @returns true if the submesh is intersecting with the frustum
  105782. */
  105783. isInFrustum(frustumPlanes: Plane[]): boolean;
  105784. /**
  105785. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105786. * @param frustumPlanes defines the frustum planes
  105787. * @returns true if the submesh is inside the frustum
  105788. */
  105789. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105790. /**
  105791. * Renders the submesh
  105792. * @param enableAlphaMode defines if alpha needs to be used
  105793. * @returns the submesh
  105794. */
  105795. render(enableAlphaMode: boolean): SubMesh;
  105796. /**
  105797. * @hidden
  105798. */
  105799. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105800. /**
  105801. * Checks if the submesh intersects with a ray
  105802. * @param ray defines the ray to test
  105803. * @returns true is the passed ray intersects the submesh bounding box
  105804. */
  105805. canIntersects(ray: Ray): boolean;
  105806. /**
  105807. * Intersects current submesh with a ray
  105808. * @param ray defines the ray to test
  105809. * @param positions defines mesh's positions array
  105810. * @param indices defines mesh's indices array
  105811. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105812. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105813. * @returns intersection info or null if no intersection
  105814. */
  105815. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105816. /** @hidden */
  105817. private _intersectLines;
  105818. /** @hidden */
  105819. private _intersectUnIndexedLines;
  105820. /** @hidden */
  105821. private _intersectTriangles;
  105822. /** @hidden */
  105823. private _intersectUnIndexedTriangles;
  105824. /** @hidden */
  105825. _rebuild(): void;
  105826. /**
  105827. * Creates a new submesh from the passed mesh
  105828. * @param newMesh defines the new hosting mesh
  105829. * @param newRenderingMesh defines an optional rendering mesh
  105830. * @returns the new submesh
  105831. */
  105832. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105833. /**
  105834. * Release associated resources
  105835. */
  105836. dispose(): void;
  105837. /**
  105838. * Gets the class name
  105839. * @returns the string "SubMesh".
  105840. */
  105841. getClassName(): string;
  105842. /**
  105843. * Creates a new submesh from indices data
  105844. * @param materialIndex the index of the main mesh material
  105845. * @param startIndex the index where to start the copy in the mesh indices array
  105846. * @param indexCount the number of indices to copy then from the startIndex
  105847. * @param mesh the main mesh to create the submesh from
  105848. * @param renderingMesh the optional rendering mesh
  105849. * @returns a new submesh
  105850. */
  105851. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105852. }
  105853. }
  105854. declare module BABYLON {
  105855. /**
  105856. * Class used to represent data loading progression
  105857. */
  105858. export class SceneLoaderFlags {
  105859. private static _ForceFullSceneLoadingForIncremental;
  105860. private static _ShowLoadingScreen;
  105861. private static _CleanBoneMatrixWeights;
  105862. private static _loggingLevel;
  105863. /**
  105864. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105865. */
  105866. static get ForceFullSceneLoadingForIncremental(): boolean;
  105867. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105868. /**
  105869. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105870. */
  105871. static get ShowLoadingScreen(): boolean;
  105872. static set ShowLoadingScreen(value: boolean);
  105873. /**
  105874. * Defines the current logging level (while loading the scene)
  105875. * @ignorenaming
  105876. */
  105877. static get loggingLevel(): number;
  105878. static set loggingLevel(value: number);
  105879. /**
  105880. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105881. */
  105882. static get CleanBoneMatrixWeights(): boolean;
  105883. static set CleanBoneMatrixWeights(value: boolean);
  105884. }
  105885. }
  105886. declare module BABYLON {
  105887. /**
  105888. * Class used to store geometry data (vertex buffers + index buffer)
  105889. */
  105890. export class Geometry implements IGetSetVerticesData {
  105891. /**
  105892. * Gets or sets the ID of the geometry
  105893. */
  105894. id: string;
  105895. /**
  105896. * Gets or sets the unique ID of the geometry
  105897. */
  105898. uniqueId: number;
  105899. /**
  105900. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105901. */
  105902. delayLoadState: number;
  105903. /**
  105904. * Gets the file containing the data to load when running in delay load state
  105905. */
  105906. delayLoadingFile: Nullable<string>;
  105907. /**
  105908. * Callback called when the geometry is updated
  105909. */
  105910. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105911. private _scene;
  105912. private _engine;
  105913. private _meshes;
  105914. private _totalVertices;
  105915. /** @hidden */
  105916. _indices: IndicesArray;
  105917. /** @hidden */
  105918. _vertexBuffers: {
  105919. [key: string]: VertexBuffer;
  105920. };
  105921. private _isDisposed;
  105922. private _extend;
  105923. private _boundingBias;
  105924. /** @hidden */
  105925. _delayInfo: Array<string>;
  105926. private _indexBuffer;
  105927. private _indexBufferIsUpdatable;
  105928. /** @hidden */
  105929. _boundingInfo: Nullable<BoundingInfo>;
  105930. /** @hidden */
  105931. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105932. /** @hidden */
  105933. _softwareSkinningFrameId: number;
  105934. private _vertexArrayObjects;
  105935. private _updatable;
  105936. /** @hidden */
  105937. _positions: Nullable<Vector3[]>;
  105938. /**
  105939. * 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
  105940. */
  105941. get boundingBias(): Vector2;
  105942. /**
  105943. * 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
  105944. */
  105945. set boundingBias(value: Vector2);
  105946. /**
  105947. * Static function used to attach a new empty geometry to a mesh
  105948. * @param mesh defines the mesh to attach the geometry to
  105949. * @returns the new Geometry
  105950. */
  105951. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105952. /** Get the list of meshes using this geometry */
  105953. get meshes(): Mesh[];
  105954. /**
  105955. * 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
  105956. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105957. */
  105958. useBoundingInfoFromGeometry: boolean;
  105959. /**
  105960. * Creates a new geometry
  105961. * @param id defines the unique ID
  105962. * @param scene defines the hosting scene
  105963. * @param vertexData defines the VertexData used to get geometry data
  105964. * @param updatable defines if geometry must be updatable (false by default)
  105965. * @param mesh defines the mesh that will be associated with the geometry
  105966. */
  105967. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105968. /**
  105969. * Gets the current extend of the geometry
  105970. */
  105971. get extend(): {
  105972. minimum: Vector3;
  105973. maximum: Vector3;
  105974. };
  105975. /**
  105976. * Gets the hosting scene
  105977. * @returns the hosting Scene
  105978. */
  105979. getScene(): Scene;
  105980. /**
  105981. * Gets the hosting engine
  105982. * @returns the hosting Engine
  105983. */
  105984. getEngine(): Engine;
  105985. /**
  105986. * Defines if the geometry is ready to use
  105987. * @returns true if the geometry is ready to be used
  105988. */
  105989. isReady(): boolean;
  105990. /**
  105991. * Gets a value indicating that the geometry should not be serialized
  105992. */
  105993. get doNotSerialize(): boolean;
  105994. /** @hidden */
  105995. _rebuild(): void;
  105996. /**
  105997. * Affects all geometry data in one call
  105998. * @param vertexData defines the geometry data
  105999. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  106000. */
  106001. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  106002. /**
  106003. * Set specific vertex data
  106004. * @param kind defines the data kind (Position, normal, etc...)
  106005. * @param data defines the vertex data to use
  106006. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  106007. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  106008. */
  106009. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  106010. /**
  106011. * Removes a specific vertex data
  106012. * @param kind defines the data kind (Position, normal, etc...)
  106013. */
  106014. removeVerticesData(kind: string): void;
  106015. /**
  106016. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  106017. * @param buffer defines the vertex buffer to use
  106018. * @param totalVertices defines the total number of vertices for position kind (could be null)
  106019. */
  106020. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  106021. /**
  106022. * Update a specific vertex buffer
  106023. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  106024. * It will do nothing if the buffer is not updatable
  106025. * @param kind defines the data kind (Position, normal, etc...)
  106026. * @param data defines the data to use
  106027. * @param offset defines the offset in the target buffer where to store the data
  106028. * @param useBytes set to true if the offset is in bytes
  106029. */
  106030. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  106031. /**
  106032. * Update a specific vertex buffer
  106033. * This function will create a new buffer if the current one is not updatable
  106034. * @param kind defines the data kind (Position, normal, etc...)
  106035. * @param data defines the data to use
  106036. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  106037. */
  106038. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  106039. private _updateBoundingInfo;
  106040. /** @hidden */
  106041. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  106042. /**
  106043. * Gets total number of vertices
  106044. * @returns the total number of vertices
  106045. */
  106046. getTotalVertices(): number;
  106047. /**
  106048. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  106049. * @param kind defines the data kind (Position, normal, etc...)
  106050. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  106051. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106052. * @returns a float array containing vertex data
  106053. */
  106054. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  106055. /**
  106056. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  106057. * @param kind defines the data kind (Position, normal, etc...)
  106058. * @returns true if the vertex buffer with the specified kind is updatable
  106059. */
  106060. isVertexBufferUpdatable(kind: string): boolean;
  106061. /**
  106062. * Gets a specific vertex buffer
  106063. * @param kind defines the data kind (Position, normal, etc...)
  106064. * @returns a VertexBuffer
  106065. */
  106066. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  106067. /**
  106068. * Returns all vertex buffers
  106069. * @return an object holding all vertex buffers indexed by kind
  106070. */
  106071. getVertexBuffers(): Nullable<{
  106072. [key: string]: VertexBuffer;
  106073. }>;
  106074. /**
  106075. * Gets a boolean indicating if specific vertex buffer is present
  106076. * @param kind defines the data kind (Position, normal, etc...)
  106077. * @returns true if data is present
  106078. */
  106079. isVerticesDataPresent(kind: string): boolean;
  106080. /**
  106081. * Gets a list of all attached data kinds (Position, normal, etc...)
  106082. * @returns a list of string containing all kinds
  106083. */
  106084. getVerticesDataKinds(): string[];
  106085. /**
  106086. * Update index buffer
  106087. * @param indices defines the indices to store in the index buffer
  106088. * @param offset defines the offset in the target buffer where to store the data
  106089. * @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)
  106090. */
  106091. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  106092. /**
  106093. * Creates a new index buffer
  106094. * @param indices defines the indices to store in the index buffer
  106095. * @param totalVertices defines the total number of vertices (could be null)
  106096. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  106097. */
  106098. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  106099. /**
  106100. * Return the total number of indices
  106101. * @returns the total number of indices
  106102. */
  106103. getTotalIndices(): number;
  106104. /**
  106105. * Gets the index buffer array
  106106. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  106107. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106108. * @returns the index buffer array
  106109. */
  106110. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  106111. /**
  106112. * Gets the index buffer
  106113. * @return the index buffer
  106114. */
  106115. getIndexBuffer(): Nullable<DataBuffer>;
  106116. /** @hidden */
  106117. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  106118. /**
  106119. * Release the associated resources for a specific mesh
  106120. * @param mesh defines the source mesh
  106121. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  106122. */
  106123. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  106124. /**
  106125. * Apply current geometry to a given mesh
  106126. * @param mesh defines the mesh to apply geometry to
  106127. */
  106128. applyToMesh(mesh: Mesh): void;
  106129. private _updateExtend;
  106130. private _applyToMesh;
  106131. private notifyUpdate;
  106132. /**
  106133. * Load the geometry if it was flagged as delay loaded
  106134. * @param scene defines the hosting scene
  106135. * @param onLoaded defines a callback called when the geometry is loaded
  106136. */
  106137. load(scene: Scene, onLoaded?: () => void): void;
  106138. private _queueLoad;
  106139. /**
  106140. * Invert the geometry to move from a right handed system to a left handed one.
  106141. */
  106142. toLeftHanded(): void;
  106143. /** @hidden */
  106144. _resetPointsArrayCache(): void;
  106145. /** @hidden */
  106146. _generatePointsArray(): boolean;
  106147. /**
  106148. * Gets a value indicating if the geometry is disposed
  106149. * @returns true if the geometry was disposed
  106150. */
  106151. isDisposed(): boolean;
  106152. private _disposeVertexArrayObjects;
  106153. /**
  106154. * Free all associated resources
  106155. */
  106156. dispose(): void;
  106157. /**
  106158. * Clone the current geometry into a new geometry
  106159. * @param id defines the unique ID of the new geometry
  106160. * @returns a new geometry object
  106161. */
  106162. copy(id: string): Geometry;
  106163. /**
  106164. * Serialize the current geometry info (and not the vertices data) into a JSON object
  106165. * @return a JSON representation of the current geometry data (without the vertices data)
  106166. */
  106167. serialize(): any;
  106168. private toNumberArray;
  106169. /**
  106170. * Serialize all vertices data into a JSON oject
  106171. * @returns a JSON representation of the current geometry data
  106172. */
  106173. serializeVerticeData(): any;
  106174. /**
  106175. * Extracts a clone of a mesh geometry
  106176. * @param mesh defines the source mesh
  106177. * @param id defines the unique ID of the new geometry object
  106178. * @returns the new geometry object
  106179. */
  106180. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  106181. /**
  106182. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  106183. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  106184. * Be aware Math.random() could cause collisions, but:
  106185. * "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"
  106186. * @returns a string containing a new GUID
  106187. */
  106188. static RandomId(): string;
  106189. /** @hidden */
  106190. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  106191. private static _CleanMatricesWeights;
  106192. /**
  106193. * Create a new geometry from persisted data (Using .babylon file format)
  106194. * @param parsedVertexData defines the persisted data
  106195. * @param scene defines the hosting scene
  106196. * @param rootUrl defines the root url to use to load assets (like delayed data)
  106197. * @returns the new geometry object
  106198. */
  106199. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  106200. }
  106201. }
  106202. declare module BABYLON {
  106203. /**
  106204. * Define an interface for all classes that will get and set the data on vertices
  106205. */
  106206. export interface IGetSetVerticesData {
  106207. /**
  106208. * Gets a boolean indicating if specific vertex data is present
  106209. * @param kind defines the vertex data kind to use
  106210. * @returns true is data kind is present
  106211. */
  106212. isVerticesDataPresent(kind: string): boolean;
  106213. /**
  106214. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  106215. * @param kind defines the data kind (Position, normal, etc...)
  106216. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  106217. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106218. * @returns a float array containing vertex data
  106219. */
  106220. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  106221. /**
  106222. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  106223. * @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.
  106224. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106225. * @returns the indices array or an empty array if the mesh has no geometry
  106226. */
  106227. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  106228. /**
  106229. * Set specific vertex data
  106230. * @param kind defines the data kind (Position, normal, etc...)
  106231. * @param data defines the vertex data to use
  106232. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  106233. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  106234. */
  106235. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  106236. /**
  106237. * Update a specific associated vertex buffer
  106238. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  106239. * - VertexBuffer.PositionKind
  106240. * - VertexBuffer.UVKind
  106241. * - VertexBuffer.UV2Kind
  106242. * - VertexBuffer.UV3Kind
  106243. * - VertexBuffer.UV4Kind
  106244. * - VertexBuffer.UV5Kind
  106245. * - VertexBuffer.UV6Kind
  106246. * - VertexBuffer.ColorKind
  106247. * - VertexBuffer.MatricesIndicesKind
  106248. * - VertexBuffer.MatricesIndicesExtraKind
  106249. * - VertexBuffer.MatricesWeightsKind
  106250. * - VertexBuffer.MatricesWeightsExtraKind
  106251. * @param data defines the data source
  106252. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  106253. * @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)
  106254. */
  106255. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  106256. /**
  106257. * Creates a new index buffer
  106258. * @param indices defines the indices to store in the index buffer
  106259. * @param totalVertices defines the total number of vertices (could be null)
  106260. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  106261. */
  106262. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  106263. }
  106264. /**
  106265. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  106266. */
  106267. export class VertexData {
  106268. /**
  106269. * Mesh side orientation : usually the external or front surface
  106270. */
  106271. static readonly FRONTSIDE: number;
  106272. /**
  106273. * Mesh side orientation : usually the internal or back surface
  106274. */
  106275. static readonly BACKSIDE: number;
  106276. /**
  106277. * Mesh side orientation : both internal and external or front and back surfaces
  106278. */
  106279. static readonly DOUBLESIDE: number;
  106280. /**
  106281. * Mesh side orientation : by default, `FRONTSIDE`
  106282. */
  106283. static readonly DEFAULTSIDE: number;
  106284. /**
  106285. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  106286. */
  106287. positions: Nullable<FloatArray>;
  106288. /**
  106289. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  106290. */
  106291. normals: Nullable<FloatArray>;
  106292. /**
  106293. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  106294. */
  106295. tangents: Nullable<FloatArray>;
  106296. /**
  106297. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106298. */
  106299. uvs: Nullable<FloatArray>;
  106300. /**
  106301. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106302. */
  106303. uvs2: Nullable<FloatArray>;
  106304. /**
  106305. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106306. */
  106307. uvs3: Nullable<FloatArray>;
  106308. /**
  106309. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106310. */
  106311. uvs4: Nullable<FloatArray>;
  106312. /**
  106313. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106314. */
  106315. uvs5: Nullable<FloatArray>;
  106316. /**
  106317. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106318. */
  106319. uvs6: Nullable<FloatArray>;
  106320. /**
  106321. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  106322. */
  106323. colors: Nullable<FloatArray>;
  106324. /**
  106325. * 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).
  106326. */
  106327. matricesIndices: Nullable<FloatArray>;
  106328. /**
  106329. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  106330. */
  106331. matricesWeights: Nullable<FloatArray>;
  106332. /**
  106333. * An array extending the number of possible indices
  106334. */
  106335. matricesIndicesExtra: Nullable<FloatArray>;
  106336. /**
  106337. * An array extending the number of possible weights when the number of indices is extended
  106338. */
  106339. matricesWeightsExtra: Nullable<FloatArray>;
  106340. /**
  106341. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  106342. */
  106343. indices: Nullable<IndicesArray>;
  106344. /**
  106345. * Uses the passed data array to set the set the values for the specified kind of data
  106346. * @param data a linear array of floating numbers
  106347. * @param kind the type of data that is being set, eg positions, colors etc
  106348. */
  106349. set(data: FloatArray, kind: string): void;
  106350. /**
  106351. * Associates the vertexData to the passed Mesh.
  106352. * Sets it as updatable or not (default `false`)
  106353. * @param mesh the mesh the vertexData is applied to
  106354. * @param updatable when used and having the value true allows new data to update the vertexData
  106355. * @returns the VertexData
  106356. */
  106357. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  106358. /**
  106359. * Associates the vertexData to the passed Geometry.
  106360. * Sets it as updatable or not (default `false`)
  106361. * @param geometry the geometry the vertexData is applied to
  106362. * @param updatable when used and having the value true allows new data to update the vertexData
  106363. * @returns VertexData
  106364. */
  106365. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  106366. /**
  106367. * Updates the associated mesh
  106368. * @param mesh the mesh to be updated
  106369. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  106370. * @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
  106371. * @returns VertexData
  106372. */
  106373. updateMesh(mesh: Mesh): VertexData;
  106374. /**
  106375. * Updates the associated geometry
  106376. * @param geometry the geometry to be updated
  106377. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  106378. * @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
  106379. * @returns VertexData.
  106380. */
  106381. updateGeometry(geometry: Geometry): VertexData;
  106382. private _applyTo;
  106383. private _update;
  106384. /**
  106385. * Transforms each position and each normal of the vertexData according to the passed Matrix
  106386. * @param matrix the transforming matrix
  106387. * @returns the VertexData
  106388. */
  106389. transform(matrix: Matrix): VertexData;
  106390. /**
  106391. * Merges the passed VertexData into the current one
  106392. * @param other the VertexData to be merged into the current one
  106393. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  106394. * @returns the modified VertexData
  106395. */
  106396. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  106397. private _mergeElement;
  106398. private _validate;
  106399. /**
  106400. * Serializes the VertexData
  106401. * @returns a serialized object
  106402. */
  106403. serialize(): any;
  106404. /**
  106405. * Extracts the vertexData from a mesh
  106406. * @param mesh the mesh from which to extract the VertexData
  106407. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  106408. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  106409. * @returns the object VertexData associated to the passed mesh
  106410. */
  106411. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  106412. /**
  106413. * Extracts the vertexData from the geometry
  106414. * @param geometry the geometry from which to extract the VertexData
  106415. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  106416. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  106417. * @returns the object VertexData associated to the passed mesh
  106418. */
  106419. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  106420. private static _ExtractFrom;
  106421. /**
  106422. * Creates the VertexData for a Ribbon
  106423. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  106424. * * pathArray array of paths, each of which an array of successive Vector3
  106425. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  106426. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  106427. * * 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
  106428. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106429. * * 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)
  106430. * * 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)
  106431. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  106432. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  106433. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  106434. * @returns the VertexData of the ribbon
  106435. */
  106436. static CreateRibbon(options: {
  106437. pathArray: Vector3[][];
  106438. closeArray?: boolean;
  106439. closePath?: boolean;
  106440. offset?: number;
  106441. sideOrientation?: number;
  106442. frontUVs?: Vector4;
  106443. backUVs?: Vector4;
  106444. invertUV?: boolean;
  106445. uvs?: Vector2[];
  106446. colors?: Color4[];
  106447. }): VertexData;
  106448. /**
  106449. * Creates the VertexData for a box
  106450. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106451. * * size sets the width, height and depth of the box to the value of size, optional default 1
  106452. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  106453. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  106454. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  106455. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  106456. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  106457. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106458. * * 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)
  106459. * * 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)
  106460. * @returns the VertexData of the box
  106461. */
  106462. static CreateBox(options: {
  106463. size?: number;
  106464. width?: number;
  106465. height?: number;
  106466. depth?: number;
  106467. faceUV?: Vector4[];
  106468. faceColors?: Color4[];
  106469. sideOrientation?: number;
  106470. frontUVs?: Vector4;
  106471. backUVs?: Vector4;
  106472. }): VertexData;
  106473. /**
  106474. * Creates the VertexData for a tiled box
  106475. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106476. * * faceTiles sets the pattern, tile size and number of tiles for a face
  106477. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  106478. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  106479. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106480. * @returns the VertexData of the box
  106481. */
  106482. static CreateTiledBox(options: {
  106483. pattern?: number;
  106484. width?: number;
  106485. height?: number;
  106486. depth?: number;
  106487. tileSize?: number;
  106488. tileWidth?: number;
  106489. tileHeight?: number;
  106490. alignHorizontal?: number;
  106491. alignVertical?: number;
  106492. faceUV?: Vector4[];
  106493. faceColors?: Color4[];
  106494. sideOrientation?: number;
  106495. }): VertexData;
  106496. /**
  106497. * Creates the VertexData for a tiled plane
  106498. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106499. * * pattern a limited pattern arrangement depending on the number
  106500. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  106501. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  106502. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  106503. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106504. * * 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)
  106505. * * 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)
  106506. * @returns the VertexData of the tiled plane
  106507. */
  106508. static CreateTiledPlane(options: {
  106509. pattern?: number;
  106510. tileSize?: number;
  106511. tileWidth?: number;
  106512. tileHeight?: number;
  106513. size?: number;
  106514. width?: number;
  106515. height?: number;
  106516. alignHorizontal?: number;
  106517. alignVertical?: number;
  106518. sideOrientation?: number;
  106519. frontUVs?: Vector4;
  106520. backUVs?: Vector4;
  106521. }): VertexData;
  106522. /**
  106523. * Creates the VertexData for an ellipsoid, defaults to a sphere
  106524. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106525. * * segments sets the number of horizontal strips optional, default 32
  106526. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  106527. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  106528. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  106529. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  106530. * * 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
  106531. * * 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
  106532. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106533. * * 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)
  106534. * * 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)
  106535. * @returns the VertexData of the ellipsoid
  106536. */
  106537. static CreateSphere(options: {
  106538. segments?: number;
  106539. diameter?: number;
  106540. diameterX?: number;
  106541. diameterY?: number;
  106542. diameterZ?: number;
  106543. arc?: number;
  106544. slice?: number;
  106545. sideOrientation?: number;
  106546. frontUVs?: Vector4;
  106547. backUVs?: Vector4;
  106548. }): VertexData;
  106549. /**
  106550. * Creates the VertexData for a cylinder, cone or prism
  106551. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106552. * * height sets the height (y direction) of the cylinder, optional, default 2
  106553. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  106554. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  106555. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  106556. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  106557. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  106558. * * 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
  106559. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106560. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106561. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  106562. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  106563. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106564. * * 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)
  106565. * * 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)
  106566. * @returns the VertexData of the cylinder, cone or prism
  106567. */
  106568. static CreateCylinder(options: {
  106569. height?: number;
  106570. diameterTop?: number;
  106571. diameterBottom?: number;
  106572. diameter?: number;
  106573. tessellation?: number;
  106574. subdivisions?: number;
  106575. arc?: number;
  106576. faceColors?: Color4[];
  106577. faceUV?: Vector4[];
  106578. hasRings?: boolean;
  106579. enclose?: boolean;
  106580. sideOrientation?: number;
  106581. frontUVs?: Vector4;
  106582. backUVs?: Vector4;
  106583. }): VertexData;
  106584. /**
  106585. * Creates the VertexData for a torus
  106586. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106587. * * diameter the diameter of the torus, optional default 1
  106588. * * thickness the diameter of the tube forming the torus, optional default 0.5
  106589. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  106590. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106591. * * 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)
  106592. * * 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)
  106593. * @returns the VertexData of the torus
  106594. */
  106595. static CreateTorus(options: {
  106596. diameter?: number;
  106597. thickness?: number;
  106598. tessellation?: number;
  106599. sideOrientation?: number;
  106600. frontUVs?: Vector4;
  106601. backUVs?: Vector4;
  106602. }): VertexData;
  106603. /**
  106604. * Creates the VertexData of the LineSystem
  106605. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  106606. * - lines an array of lines, each line being an array of successive Vector3
  106607. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  106608. * @returns the VertexData of the LineSystem
  106609. */
  106610. static CreateLineSystem(options: {
  106611. lines: Vector3[][];
  106612. colors?: Nullable<Color4[][]>;
  106613. }): VertexData;
  106614. /**
  106615. * Create the VertexData for a DashedLines
  106616. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  106617. * - points an array successive Vector3
  106618. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  106619. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  106620. * - dashNb the intended total number of dashes, optional, default 200
  106621. * @returns the VertexData for the DashedLines
  106622. */
  106623. static CreateDashedLines(options: {
  106624. points: Vector3[];
  106625. dashSize?: number;
  106626. gapSize?: number;
  106627. dashNb?: number;
  106628. }): VertexData;
  106629. /**
  106630. * Creates the VertexData for a Ground
  106631. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106632. * - width the width (x direction) of the ground, optional, default 1
  106633. * - height the height (z direction) of the ground, optional, default 1
  106634. * - subdivisions the number of subdivisions per side, optional, default 1
  106635. * @returns the VertexData of the Ground
  106636. */
  106637. static CreateGround(options: {
  106638. width?: number;
  106639. height?: number;
  106640. subdivisions?: number;
  106641. subdivisionsX?: number;
  106642. subdivisionsY?: number;
  106643. }): VertexData;
  106644. /**
  106645. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  106646. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106647. * * xmin the ground minimum X coordinate, optional, default -1
  106648. * * zmin the ground minimum Z coordinate, optional, default -1
  106649. * * xmax the ground maximum X coordinate, optional, default 1
  106650. * * zmax the ground maximum Z coordinate, optional, default 1
  106651. * * 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}
  106652. * * 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}
  106653. * @returns the VertexData of the TiledGround
  106654. */
  106655. static CreateTiledGround(options: {
  106656. xmin: number;
  106657. zmin: number;
  106658. xmax: number;
  106659. zmax: number;
  106660. subdivisions?: {
  106661. w: number;
  106662. h: number;
  106663. };
  106664. precision?: {
  106665. w: number;
  106666. h: number;
  106667. };
  106668. }): VertexData;
  106669. /**
  106670. * Creates the VertexData of the Ground designed from a heightmap
  106671. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  106672. * * width the width (x direction) of the ground
  106673. * * height the height (z direction) of the ground
  106674. * * subdivisions the number of subdivisions per side
  106675. * * minHeight the minimum altitude on the ground, optional, default 0
  106676. * * maxHeight the maximum altitude on the ground, optional default 1
  106677. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  106678. * * buffer the array holding the image color data
  106679. * * bufferWidth the width of image
  106680. * * bufferHeight the height of image
  106681. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  106682. * @returns the VertexData of the Ground designed from a heightmap
  106683. */
  106684. static CreateGroundFromHeightMap(options: {
  106685. width: number;
  106686. height: number;
  106687. subdivisions: number;
  106688. minHeight: number;
  106689. maxHeight: number;
  106690. colorFilter: Color3;
  106691. buffer: Uint8Array;
  106692. bufferWidth: number;
  106693. bufferHeight: number;
  106694. alphaFilter: number;
  106695. }): VertexData;
  106696. /**
  106697. * Creates the VertexData for a Plane
  106698. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106699. * * size sets the width and height of the plane to the value of size, optional default 1
  106700. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106701. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106702. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106703. * * 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)
  106704. * * 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)
  106705. * @returns the VertexData of the box
  106706. */
  106707. static CreatePlane(options: {
  106708. size?: number;
  106709. width?: number;
  106710. height?: number;
  106711. sideOrientation?: number;
  106712. frontUVs?: Vector4;
  106713. backUVs?: Vector4;
  106714. }): VertexData;
  106715. /**
  106716. * Creates the VertexData of the Disc or regular Polygon
  106717. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106718. * * radius the radius of the disc, optional default 0.5
  106719. * * tessellation the number of polygon sides, optional, default 64
  106720. * * 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
  106721. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106722. * * 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)
  106723. * * 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)
  106724. * @returns the VertexData of the box
  106725. */
  106726. static CreateDisc(options: {
  106727. radius?: number;
  106728. tessellation?: number;
  106729. arc?: number;
  106730. sideOrientation?: number;
  106731. frontUVs?: Vector4;
  106732. backUVs?: Vector4;
  106733. }): VertexData;
  106734. /**
  106735. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106736. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106737. * @param polygon a mesh built from polygonTriangulation.build()
  106738. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106739. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106740. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106741. * @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)
  106742. * @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)
  106743. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106744. * @returns the VertexData of the Polygon
  106745. */
  106746. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106747. /**
  106748. * Creates the VertexData of the IcoSphere
  106749. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106750. * * radius the radius of the IcoSphere, optional default 1
  106751. * * radiusX allows stretching in the x direction, optional, default radius
  106752. * * radiusY allows stretching in the y direction, optional, default radius
  106753. * * radiusZ allows stretching in the z direction, optional, default radius
  106754. * * flat when true creates a flat shaded mesh, optional, default true
  106755. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106756. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106757. * * 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)
  106758. * * 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)
  106759. * @returns the VertexData of the IcoSphere
  106760. */
  106761. static CreateIcoSphere(options: {
  106762. radius?: number;
  106763. radiusX?: number;
  106764. radiusY?: number;
  106765. radiusZ?: number;
  106766. flat?: boolean;
  106767. subdivisions?: number;
  106768. sideOrientation?: number;
  106769. frontUVs?: Vector4;
  106770. backUVs?: Vector4;
  106771. }): VertexData;
  106772. /**
  106773. * Creates the VertexData for a Polyhedron
  106774. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106775. * * type provided types are:
  106776. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106777. * * 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)
  106778. * * size the size of the IcoSphere, optional default 1
  106779. * * sizeX allows stretching in the x direction, optional, default size
  106780. * * sizeY allows stretching in the y direction, optional, default size
  106781. * * sizeZ allows stretching in the z direction, optional, default size
  106782. * * 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
  106783. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106784. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106785. * * flat when true creates a flat shaded mesh, optional, default true
  106786. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106787. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106788. * * 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)
  106789. * * 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)
  106790. * @returns the VertexData of the Polyhedron
  106791. */
  106792. static CreatePolyhedron(options: {
  106793. type?: number;
  106794. size?: number;
  106795. sizeX?: number;
  106796. sizeY?: number;
  106797. sizeZ?: number;
  106798. custom?: any;
  106799. faceUV?: Vector4[];
  106800. faceColors?: Color4[];
  106801. flat?: boolean;
  106802. sideOrientation?: number;
  106803. frontUVs?: Vector4;
  106804. backUVs?: Vector4;
  106805. }): VertexData;
  106806. /**
  106807. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  106808. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  106809. * @returns the VertexData of the Capsule
  106810. */
  106811. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  106812. /**
  106813. * Creates the VertexData for a TorusKnot
  106814. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106815. * * radius the radius of the torus knot, optional, default 2
  106816. * * tube the thickness of the tube, optional, default 0.5
  106817. * * radialSegments the number of sides on each tube segments, optional, default 32
  106818. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106819. * * p the number of windings around the z axis, optional, default 2
  106820. * * q the number of windings around the x axis, optional, default 3
  106821. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106822. * * 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)
  106823. * * 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)
  106824. * @returns the VertexData of the Torus Knot
  106825. */
  106826. static CreateTorusKnot(options: {
  106827. radius?: number;
  106828. tube?: number;
  106829. radialSegments?: number;
  106830. tubularSegments?: number;
  106831. p?: number;
  106832. q?: number;
  106833. sideOrientation?: number;
  106834. frontUVs?: Vector4;
  106835. backUVs?: Vector4;
  106836. }): VertexData;
  106837. /**
  106838. * Compute normals for given positions and indices
  106839. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106840. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106841. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106842. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106843. * * facetNormals : optional array of facet normals (vector3)
  106844. * * facetPositions : optional array of facet positions (vector3)
  106845. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106846. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106847. * * bInfo : optional bounding info, required for facetPartitioning computation
  106848. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106849. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106850. * * useRightHandedSystem: optional boolean to for right handed system computation
  106851. * * depthSort : optional boolean to enable the facet depth sort computation
  106852. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106853. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106854. */
  106855. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106856. facetNormals?: any;
  106857. facetPositions?: any;
  106858. facetPartitioning?: any;
  106859. ratio?: number;
  106860. bInfo?: any;
  106861. bbSize?: Vector3;
  106862. subDiv?: any;
  106863. useRightHandedSystem?: boolean;
  106864. depthSort?: boolean;
  106865. distanceTo?: Vector3;
  106866. depthSortedFacets?: any;
  106867. }): void;
  106868. /** @hidden */
  106869. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106870. /**
  106871. * Applies VertexData created from the imported parameters to the geometry
  106872. * @param parsedVertexData the parsed data from an imported file
  106873. * @param geometry the geometry to apply the VertexData to
  106874. */
  106875. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106876. }
  106877. }
  106878. declare module BABYLON {
  106879. /**
  106880. * Defines a target to use with MorphTargetManager
  106881. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106882. */
  106883. export class MorphTarget implements IAnimatable {
  106884. /** defines the name of the target */
  106885. name: string;
  106886. /**
  106887. * Gets or sets the list of animations
  106888. */
  106889. animations: Animation[];
  106890. private _scene;
  106891. private _positions;
  106892. private _normals;
  106893. private _tangents;
  106894. private _uvs;
  106895. private _influence;
  106896. private _uniqueId;
  106897. /**
  106898. * Observable raised when the influence changes
  106899. */
  106900. onInfluenceChanged: Observable<boolean>;
  106901. /** @hidden */
  106902. _onDataLayoutChanged: Observable<void>;
  106903. /**
  106904. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106905. */
  106906. get influence(): number;
  106907. set influence(influence: number);
  106908. /**
  106909. * Gets or sets the id of the morph Target
  106910. */
  106911. id: string;
  106912. private _animationPropertiesOverride;
  106913. /**
  106914. * Gets or sets the animation properties override
  106915. */
  106916. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106917. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106918. /**
  106919. * Creates a new MorphTarget
  106920. * @param name defines the name of the target
  106921. * @param influence defines the influence to use
  106922. * @param scene defines the scene the morphtarget belongs to
  106923. */
  106924. constructor(
  106925. /** defines the name of the target */
  106926. name: string, influence?: number, scene?: Nullable<Scene>);
  106927. /**
  106928. * Gets the unique ID of this manager
  106929. */
  106930. get uniqueId(): number;
  106931. /**
  106932. * Gets a boolean defining if the target contains position data
  106933. */
  106934. get hasPositions(): boolean;
  106935. /**
  106936. * Gets a boolean defining if the target contains normal data
  106937. */
  106938. get hasNormals(): boolean;
  106939. /**
  106940. * Gets a boolean defining if the target contains tangent data
  106941. */
  106942. get hasTangents(): boolean;
  106943. /**
  106944. * Gets a boolean defining if the target contains texture coordinates data
  106945. */
  106946. get hasUVs(): boolean;
  106947. /**
  106948. * Affects position data to this target
  106949. * @param data defines the position data to use
  106950. */
  106951. setPositions(data: Nullable<FloatArray>): void;
  106952. /**
  106953. * Gets the position data stored in this target
  106954. * @returns a FloatArray containing the position data (or null if not present)
  106955. */
  106956. getPositions(): Nullable<FloatArray>;
  106957. /**
  106958. * Affects normal data to this target
  106959. * @param data defines the normal data to use
  106960. */
  106961. setNormals(data: Nullable<FloatArray>): void;
  106962. /**
  106963. * Gets the normal data stored in this target
  106964. * @returns a FloatArray containing the normal data (or null if not present)
  106965. */
  106966. getNormals(): Nullable<FloatArray>;
  106967. /**
  106968. * Affects tangent data to this target
  106969. * @param data defines the tangent data to use
  106970. */
  106971. setTangents(data: Nullable<FloatArray>): void;
  106972. /**
  106973. * Gets the tangent data stored in this target
  106974. * @returns a FloatArray containing the tangent data (or null if not present)
  106975. */
  106976. getTangents(): Nullable<FloatArray>;
  106977. /**
  106978. * Affects texture coordinates data to this target
  106979. * @param data defines the texture coordinates data to use
  106980. */
  106981. setUVs(data: Nullable<FloatArray>): void;
  106982. /**
  106983. * Gets the texture coordinates data stored in this target
  106984. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106985. */
  106986. getUVs(): Nullable<FloatArray>;
  106987. /**
  106988. * Clone the current target
  106989. * @returns a new MorphTarget
  106990. */
  106991. clone(): MorphTarget;
  106992. /**
  106993. * Serializes the current target into a Serialization object
  106994. * @returns the serialized object
  106995. */
  106996. serialize(): any;
  106997. /**
  106998. * Returns the string "MorphTarget"
  106999. * @returns "MorphTarget"
  107000. */
  107001. getClassName(): string;
  107002. /**
  107003. * Creates a new target from serialized data
  107004. * @param serializationObject defines the serialized data to use
  107005. * @returns a new MorphTarget
  107006. */
  107007. static Parse(serializationObject: any): MorphTarget;
  107008. /**
  107009. * Creates a MorphTarget from mesh data
  107010. * @param mesh defines the source mesh
  107011. * @param name defines the name to use for the new target
  107012. * @param influence defines the influence to attach to the target
  107013. * @returns a new MorphTarget
  107014. */
  107015. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  107016. }
  107017. }
  107018. declare module BABYLON {
  107019. /**
  107020. * This class is used to deform meshes using morphing between different targets
  107021. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107022. */
  107023. export class MorphTargetManager {
  107024. private _targets;
  107025. private _targetInfluenceChangedObservers;
  107026. private _targetDataLayoutChangedObservers;
  107027. private _activeTargets;
  107028. private _scene;
  107029. private _influences;
  107030. private _supportsNormals;
  107031. private _supportsTangents;
  107032. private _supportsUVs;
  107033. private _vertexCount;
  107034. private _uniqueId;
  107035. private _tempInfluences;
  107036. /**
  107037. * Gets or sets a boolean indicating if normals must be morphed
  107038. */
  107039. enableNormalMorphing: boolean;
  107040. /**
  107041. * Gets or sets a boolean indicating if tangents must be morphed
  107042. */
  107043. enableTangentMorphing: boolean;
  107044. /**
  107045. * Gets or sets a boolean indicating if UV must be morphed
  107046. */
  107047. enableUVMorphing: boolean;
  107048. /**
  107049. * Creates a new MorphTargetManager
  107050. * @param scene defines the current scene
  107051. */
  107052. constructor(scene?: Nullable<Scene>);
  107053. /**
  107054. * Gets the unique ID of this manager
  107055. */
  107056. get uniqueId(): number;
  107057. /**
  107058. * Gets the number of vertices handled by this manager
  107059. */
  107060. get vertexCount(): number;
  107061. /**
  107062. * Gets a boolean indicating if this manager supports morphing of normals
  107063. */
  107064. get supportsNormals(): boolean;
  107065. /**
  107066. * Gets a boolean indicating if this manager supports morphing of tangents
  107067. */
  107068. get supportsTangents(): boolean;
  107069. /**
  107070. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  107071. */
  107072. get supportsUVs(): boolean;
  107073. /**
  107074. * Gets the number of targets stored in this manager
  107075. */
  107076. get numTargets(): number;
  107077. /**
  107078. * Gets the number of influencers (ie. the number of targets with influences > 0)
  107079. */
  107080. get numInfluencers(): number;
  107081. /**
  107082. * Gets the list of influences (one per target)
  107083. */
  107084. get influences(): Float32Array;
  107085. /**
  107086. * Gets the active target at specified index. An active target is a target with an influence > 0
  107087. * @param index defines the index to check
  107088. * @returns the requested target
  107089. */
  107090. getActiveTarget(index: number): MorphTarget;
  107091. /**
  107092. * Gets the target at specified index
  107093. * @param index defines the index to check
  107094. * @returns the requested target
  107095. */
  107096. getTarget(index: number): MorphTarget;
  107097. /**
  107098. * Add a new target to this manager
  107099. * @param target defines the target to add
  107100. */
  107101. addTarget(target: MorphTarget): void;
  107102. /**
  107103. * Removes a target from the manager
  107104. * @param target defines the target to remove
  107105. */
  107106. removeTarget(target: MorphTarget): void;
  107107. /**
  107108. * Clone the current manager
  107109. * @returns a new MorphTargetManager
  107110. */
  107111. clone(): MorphTargetManager;
  107112. /**
  107113. * Serializes the current manager into a Serialization object
  107114. * @returns the serialized object
  107115. */
  107116. serialize(): any;
  107117. private _syncActiveTargets;
  107118. /**
  107119. * Syncrhonize the targets with all the meshes using this morph target manager
  107120. */
  107121. synchronize(): void;
  107122. /**
  107123. * Creates a new MorphTargetManager from serialized data
  107124. * @param serializationObject defines the serialized data
  107125. * @param scene defines the hosting scene
  107126. * @returns the new MorphTargetManager
  107127. */
  107128. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  107129. }
  107130. }
  107131. declare module BABYLON {
  107132. /**
  107133. * Class used to represent a specific level of detail of a mesh
  107134. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107135. */
  107136. export class MeshLODLevel {
  107137. /** Defines the distance where this level should start being displayed */
  107138. distance: number;
  107139. /** Defines the mesh to use to render this level */
  107140. mesh: Nullable<Mesh>;
  107141. /**
  107142. * Creates a new LOD level
  107143. * @param distance defines the distance where this level should star being displayed
  107144. * @param mesh defines the mesh to use to render this level
  107145. */
  107146. constructor(
  107147. /** Defines the distance where this level should start being displayed */
  107148. distance: number,
  107149. /** Defines the mesh to use to render this level */
  107150. mesh: Nullable<Mesh>);
  107151. }
  107152. }
  107153. declare module BABYLON {
  107154. /**
  107155. * Helper class used to generate a canvas to manipulate images
  107156. */
  107157. export class CanvasGenerator {
  107158. /**
  107159. * Create a new canvas (or offscreen canvas depending on the context)
  107160. * @param width defines the expected width
  107161. * @param height defines the expected height
  107162. * @return a new canvas or offscreen canvas
  107163. */
  107164. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  107165. }
  107166. }
  107167. declare module BABYLON {
  107168. /**
  107169. * Mesh representing the gorund
  107170. */
  107171. export class GroundMesh extends Mesh {
  107172. /** If octree should be generated */
  107173. generateOctree: boolean;
  107174. private _heightQuads;
  107175. /** @hidden */
  107176. _subdivisionsX: number;
  107177. /** @hidden */
  107178. _subdivisionsY: number;
  107179. /** @hidden */
  107180. _width: number;
  107181. /** @hidden */
  107182. _height: number;
  107183. /** @hidden */
  107184. _minX: number;
  107185. /** @hidden */
  107186. _maxX: number;
  107187. /** @hidden */
  107188. _minZ: number;
  107189. /** @hidden */
  107190. _maxZ: number;
  107191. constructor(name: string, scene: Scene);
  107192. /**
  107193. * "GroundMesh"
  107194. * @returns "GroundMesh"
  107195. */
  107196. getClassName(): string;
  107197. /**
  107198. * The minimum of x and y subdivisions
  107199. */
  107200. get subdivisions(): number;
  107201. /**
  107202. * X subdivisions
  107203. */
  107204. get subdivisionsX(): number;
  107205. /**
  107206. * Y subdivisions
  107207. */
  107208. get subdivisionsY(): number;
  107209. /**
  107210. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  107211. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  107212. * @param chunksCount the number of subdivisions for x and y
  107213. * @param octreeBlocksSize (Default: 32)
  107214. */
  107215. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  107216. /**
  107217. * Returns a height (y) value in the Worl system :
  107218. * the ground altitude at the coordinates (x, z) expressed in the World system.
  107219. * @param x x coordinate
  107220. * @param z z coordinate
  107221. * @returns the ground y position if (x, z) are outside the ground surface.
  107222. */
  107223. getHeightAtCoordinates(x: number, z: number): number;
  107224. /**
  107225. * Returns a normalized vector (Vector3) orthogonal to the ground
  107226. * at the ground coordinates (x, z) expressed in the World system.
  107227. * @param x x coordinate
  107228. * @param z z coordinate
  107229. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  107230. */
  107231. getNormalAtCoordinates(x: number, z: number): Vector3;
  107232. /**
  107233. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  107234. * at the ground coordinates (x, z) expressed in the World system.
  107235. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  107236. * @param x x coordinate
  107237. * @param z z coordinate
  107238. * @param ref vector to store the result
  107239. * @returns the GroundMesh.
  107240. */
  107241. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  107242. /**
  107243. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  107244. * if the ground has been updated.
  107245. * This can be used in the render loop.
  107246. * @returns the GroundMesh.
  107247. */
  107248. updateCoordinateHeights(): GroundMesh;
  107249. private _getFacetAt;
  107250. private _initHeightQuads;
  107251. private _computeHeightQuads;
  107252. /**
  107253. * Serializes this ground mesh
  107254. * @param serializationObject object to write serialization to
  107255. */
  107256. serialize(serializationObject: any): void;
  107257. /**
  107258. * Parses a serialized ground mesh
  107259. * @param parsedMesh the serialized mesh
  107260. * @param scene the scene to create the ground mesh in
  107261. * @returns the created ground mesh
  107262. */
  107263. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  107264. }
  107265. }
  107266. declare module BABYLON {
  107267. /**
  107268. * Interface for Physics-Joint data
  107269. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107270. */
  107271. export interface PhysicsJointData {
  107272. /**
  107273. * The main pivot of the joint
  107274. */
  107275. mainPivot?: Vector3;
  107276. /**
  107277. * The connected pivot of the joint
  107278. */
  107279. connectedPivot?: Vector3;
  107280. /**
  107281. * The main axis of the joint
  107282. */
  107283. mainAxis?: Vector3;
  107284. /**
  107285. * The connected axis of the joint
  107286. */
  107287. connectedAxis?: Vector3;
  107288. /**
  107289. * The collision of the joint
  107290. */
  107291. collision?: boolean;
  107292. /**
  107293. * Native Oimo/Cannon/Energy data
  107294. */
  107295. nativeParams?: any;
  107296. }
  107297. /**
  107298. * This is a holder class for the physics joint created by the physics plugin
  107299. * It holds a set of functions to control the underlying joint
  107300. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107301. */
  107302. export class PhysicsJoint {
  107303. /**
  107304. * The type of the physics joint
  107305. */
  107306. type: number;
  107307. /**
  107308. * The data for the physics joint
  107309. */
  107310. jointData: PhysicsJointData;
  107311. private _physicsJoint;
  107312. protected _physicsPlugin: IPhysicsEnginePlugin;
  107313. /**
  107314. * Initializes the physics joint
  107315. * @param type The type of the physics joint
  107316. * @param jointData The data for the physics joint
  107317. */
  107318. constructor(
  107319. /**
  107320. * The type of the physics joint
  107321. */
  107322. type: number,
  107323. /**
  107324. * The data for the physics joint
  107325. */
  107326. jointData: PhysicsJointData);
  107327. /**
  107328. * Gets the physics joint
  107329. */
  107330. get physicsJoint(): any;
  107331. /**
  107332. * Sets the physics joint
  107333. */
  107334. set physicsJoint(newJoint: any);
  107335. /**
  107336. * Sets the physics plugin
  107337. */
  107338. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  107339. /**
  107340. * Execute a function that is physics-plugin specific.
  107341. * @param {Function} func the function that will be executed.
  107342. * It accepts two parameters: the physics world and the physics joint
  107343. */
  107344. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  107345. /**
  107346. * Distance-Joint type
  107347. */
  107348. static DistanceJoint: number;
  107349. /**
  107350. * Hinge-Joint type
  107351. */
  107352. static HingeJoint: number;
  107353. /**
  107354. * Ball-and-Socket joint type
  107355. */
  107356. static BallAndSocketJoint: number;
  107357. /**
  107358. * Wheel-Joint type
  107359. */
  107360. static WheelJoint: number;
  107361. /**
  107362. * Slider-Joint type
  107363. */
  107364. static SliderJoint: number;
  107365. /**
  107366. * Prismatic-Joint type
  107367. */
  107368. static PrismaticJoint: number;
  107369. /**
  107370. * Universal-Joint type
  107371. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  107372. */
  107373. static UniversalJoint: number;
  107374. /**
  107375. * Hinge-Joint 2 type
  107376. */
  107377. static Hinge2Joint: number;
  107378. /**
  107379. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  107380. */
  107381. static PointToPointJoint: number;
  107382. /**
  107383. * Spring-Joint type
  107384. */
  107385. static SpringJoint: number;
  107386. /**
  107387. * Lock-Joint type
  107388. */
  107389. static LockJoint: number;
  107390. }
  107391. /**
  107392. * A class representing a physics distance joint
  107393. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107394. */
  107395. export class DistanceJoint extends PhysicsJoint {
  107396. /**
  107397. *
  107398. * @param jointData The data for the Distance-Joint
  107399. */
  107400. constructor(jointData: DistanceJointData);
  107401. /**
  107402. * Update the predefined distance.
  107403. * @param maxDistance The maximum preferred distance
  107404. * @param minDistance The minimum preferred distance
  107405. */
  107406. updateDistance(maxDistance: number, minDistance?: number): void;
  107407. }
  107408. /**
  107409. * Represents a Motor-Enabled Joint
  107410. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107411. */
  107412. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  107413. /**
  107414. * Initializes the Motor-Enabled Joint
  107415. * @param type The type of the joint
  107416. * @param jointData The physica joint data for the joint
  107417. */
  107418. constructor(type: number, jointData: PhysicsJointData);
  107419. /**
  107420. * Set the motor values.
  107421. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107422. * @param force the force to apply
  107423. * @param maxForce max force for this motor.
  107424. */
  107425. setMotor(force?: number, maxForce?: number): void;
  107426. /**
  107427. * Set the motor's limits.
  107428. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107429. * @param upperLimit The upper limit of the motor
  107430. * @param lowerLimit The lower limit of the motor
  107431. */
  107432. setLimit(upperLimit: number, lowerLimit?: number): void;
  107433. }
  107434. /**
  107435. * This class represents a single physics Hinge-Joint
  107436. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107437. */
  107438. export class HingeJoint extends MotorEnabledJoint {
  107439. /**
  107440. * Initializes the Hinge-Joint
  107441. * @param jointData The joint data for the Hinge-Joint
  107442. */
  107443. constructor(jointData: PhysicsJointData);
  107444. /**
  107445. * Set the motor values.
  107446. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107447. * @param {number} force the force to apply
  107448. * @param {number} maxForce max force for this motor.
  107449. */
  107450. setMotor(force?: number, maxForce?: number): void;
  107451. /**
  107452. * Set the motor's limits.
  107453. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107454. * @param upperLimit The upper limit of the motor
  107455. * @param lowerLimit The lower limit of the motor
  107456. */
  107457. setLimit(upperLimit: number, lowerLimit?: number): void;
  107458. }
  107459. /**
  107460. * This class represents a dual hinge physics joint (same as wheel joint)
  107461. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107462. */
  107463. export class Hinge2Joint extends MotorEnabledJoint {
  107464. /**
  107465. * Initializes the Hinge2-Joint
  107466. * @param jointData The joint data for the Hinge2-Joint
  107467. */
  107468. constructor(jointData: PhysicsJointData);
  107469. /**
  107470. * Set the motor values.
  107471. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107472. * @param {number} targetSpeed the speed the motor is to reach
  107473. * @param {number} maxForce max force for this motor.
  107474. * @param {motorIndex} the motor's index, 0 or 1.
  107475. */
  107476. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  107477. /**
  107478. * Set the motor limits.
  107479. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107480. * @param {number} upperLimit the upper limit
  107481. * @param {number} lowerLimit lower limit
  107482. * @param {motorIndex} the motor's index, 0 or 1.
  107483. */
  107484. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107485. }
  107486. /**
  107487. * Interface for a motor enabled joint
  107488. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107489. */
  107490. export interface IMotorEnabledJoint {
  107491. /**
  107492. * Physics joint
  107493. */
  107494. physicsJoint: any;
  107495. /**
  107496. * Sets the motor of the motor-enabled joint
  107497. * @param force The force of the motor
  107498. * @param maxForce The maximum force of the motor
  107499. * @param motorIndex The index of the motor
  107500. */
  107501. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  107502. /**
  107503. * Sets the limit of the motor
  107504. * @param upperLimit The upper limit of the motor
  107505. * @param lowerLimit The lower limit of the motor
  107506. * @param motorIndex The index of the motor
  107507. */
  107508. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107509. }
  107510. /**
  107511. * Joint data for a Distance-Joint
  107512. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107513. */
  107514. export interface DistanceJointData extends PhysicsJointData {
  107515. /**
  107516. * Max distance the 2 joint objects can be apart
  107517. */
  107518. maxDistance: number;
  107519. }
  107520. /**
  107521. * Joint data from a spring joint
  107522. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107523. */
  107524. export interface SpringJointData extends PhysicsJointData {
  107525. /**
  107526. * Length of the spring
  107527. */
  107528. length: number;
  107529. /**
  107530. * Stiffness of the spring
  107531. */
  107532. stiffness: number;
  107533. /**
  107534. * Damping of the spring
  107535. */
  107536. damping: number;
  107537. /** this callback will be called when applying the force to the impostors. */
  107538. forceApplicationCallback: () => void;
  107539. }
  107540. }
  107541. declare module BABYLON {
  107542. /**
  107543. * Holds the data for the raycast result
  107544. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107545. */
  107546. export class PhysicsRaycastResult {
  107547. private _hasHit;
  107548. private _hitDistance;
  107549. private _hitNormalWorld;
  107550. private _hitPointWorld;
  107551. private _rayFromWorld;
  107552. private _rayToWorld;
  107553. /**
  107554. * Gets if there was a hit
  107555. */
  107556. get hasHit(): boolean;
  107557. /**
  107558. * Gets the distance from the hit
  107559. */
  107560. get hitDistance(): number;
  107561. /**
  107562. * Gets the hit normal/direction in the world
  107563. */
  107564. get hitNormalWorld(): Vector3;
  107565. /**
  107566. * Gets the hit point in the world
  107567. */
  107568. get hitPointWorld(): Vector3;
  107569. /**
  107570. * Gets the ray "start point" of the ray in the world
  107571. */
  107572. get rayFromWorld(): Vector3;
  107573. /**
  107574. * Gets the ray "end point" of the ray in the world
  107575. */
  107576. get rayToWorld(): Vector3;
  107577. /**
  107578. * Sets the hit data (normal & point in world space)
  107579. * @param hitNormalWorld defines the normal in world space
  107580. * @param hitPointWorld defines the point in world space
  107581. */
  107582. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  107583. /**
  107584. * Sets the distance from the start point to the hit point
  107585. * @param distance
  107586. */
  107587. setHitDistance(distance: number): void;
  107588. /**
  107589. * Calculates the distance manually
  107590. */
  107591. calculateHitDistance(): void;
  107592. /**
  107593. * Resets all the values to default
  107594. * @param from The from point on world space
  107595. * @param to The to point on world space
  107596. */
  107597. reset(from?: Vector3, to?: Vector3): void;
  107598. }
  107599. /**
  107600. * Interface for the size containing width and height
  107601. */
  107602. interface IXYZ {
  107603. /**
  107604. * X
  107605. */
  107606. x: number;
  107607. /**
  107608. * Y
  107609. */
  107610. y: number;
  107611. /**
  107612. * Z
  107613. */
  107614. z: number;
  107615. }
  107616. }
  107617. declare module BABYLON {
  107618. /**
  107619. * Interface used to describe a physics joint
  107620. */
  107621. export interface PhysicsImpostorJoint {
  107622. /** Defines the main impostor to which the joint is linked */
  107623. mainImpostor: PhysicsImpostor;
  107624. /** Defines the impostor that is connected to the main impostor using this joint */
  107625. connectedImpostor: PhysicsImpostor;
  107626. /** Defines the joint itself */
  107627. joint: PhysicsJoint;
  107628. }
  107629. /** @hidden */
  107630. export interface IPhysicsEnginePlugin {
  107631. world: any;
  107632. name: string;
  107633. setGravity(gravity: Vector3): void;
  107634. setTimeStep(timeStep: number): void;
  107635. getTimeStep(): number;
  107636. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  107637. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107638. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107639. generatePhysicsBody(impostor: PhysicsImpostor): void;
  107640. removePhysicsBody(impostor: PhysicsImpostor): void;
  107641. generateJoint(joint: PhysicsImpostorJoint): void;
  107642. removeJoint(joint: PhysicsImpostorJoint): void;
  107643. isSupported(): boolean;
  107644. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  107645. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  107646. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107647. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107648. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107649. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107650. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  107651. getBodyMass(impostor: PhysicsImpostor): number;
  107652. getBodyFriction(impostor: PhysicsImpostor): number;
  107653. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  107654. getBodyRestitution(impostor: PhysicsImpostor): number;
  107655. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  107656. getBodyPressure?(impostor: PhysicsImpostor): number;
  107657. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  107658. getBodyStiffness?(impostor: PhysicsImpostor): number;
  107659. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  107660. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  107661. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  107662. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  107663. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  107664. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107665. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107666. sleepBody(impostor: PhysicsImpostor): void;
  107667. wakeUpBody(impostor: PhysicsImpostor): void;
  107668. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107669. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  107670. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  107671. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107672. getRadius(impostor: PhysicsImpostor): number;
  107673. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  107674. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  107675. dispose(): void;
  107676. }
  107677. /**
  107678. * Interface used to define a physics engine
  107679. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107680. */
  107681. export interface IPhysicsEngine {
  107682. /**
  107683. * Gets the gravity vector used by the simulation
  107684. */
  107685. gravity: Vector3;
  107686. /**
  107687. * Sets the gravity vector used by the simulation
  107688. * @param gravity defines the gravity vector to use
  107689. */
  107690. setGravity(gravity: Vector3): void;
  107691. /**
  107692. * Set the time step of the physics engine.
  107693. * Default is 1/60.
  107694. * To slow it down, enter 1/600 for example.
  107695. * To speed it up, 1/30
  107696. * @param newTimeStep the new timestep to apply to this world.
  107697. */
  107698. setTimeStep(newTimeStep: number): void;
  107699. /**
  107700. * Get the time step of the physics engine.
  107701. * @returns the current time step
  107702. */
  107703. getTimeStep(): number;
  107704. /**
  107705. * Set the sub time step of the physics engine.
  107706. * Default is 0 meaning there is no sub steps
  107707. * To increase physics resolution precision, set a small value (like 1 ms)
  107708. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107709. */
  107710. setSubTimeStep(subTimeStep: number): void;
  107711. /**
  107712. * Get the sub time step of the physics engine.
  107713. * @returns the current sub time step
  107714. */
  107715. getSubTimeStep(): number;
  107716. /**
  107717. * Release all resources
  107718. */
  107719. dispose(): void;
  107720. /**
  107721. * Gets the name of the current physics plugin
  107722. * @returns the name of the plugin
  107723. */
  107724. getPhysicsPluginName(): string;
  107725. /**
  107726. * Adding a new impostor for the impostor tracking.
  107727. * This will be done by the impostor itself.
  107728. * @param impostor the impostor to add
  107729. */
  107730. addImpostor(impostor: PhysicsImpostor): void;
  107731. /**
  107732. * Remove an impostor from the engine.
  107733. * This impostor and its mesh will not longer be updated by the physics engine.
  107734. * @param impostor the impostor to remove
  107735. */
  107736. removeImpostor(impostor: PhysicsImpostor): void;
  107737. /**
  107738. * Add a joint to the physics engine
  107739. * @param mainImpostor defines the main impostor to which the joint is added.
  107740. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107741. * @param joint defines the joint that will connect both impostors.
  107742. */
  107743. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107744. /**
  107745. * Removes a joint from the simulation
  107746. * @param mainImpostor defines the impostor used with the joint
  107747. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107748. * @param joint defines the joint to remove
  107749. */
  107750. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107751. /**
  107752. * Gets the current plugin used to run the simulation
  107753. * @returns current plugin
  107754. */
  107755. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107756. /**
  107757. * Gets the list of physic impostors
  107758. * @returns an array of PhysicsImpostor
  107759. */
  107760. getImpostors(): Array<PhysicsImpostor>;
  107761. /**
  107762. * Gets the impostor for a physics enabled object
  107763. * @param object defines the object impersonated by the impostor
  107764. * @returns the PhysicsImpostor or null if not found
  107765. */
  107766. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107767. /**
  107768. * Gets the impostor for a physics body object
  107769. * @param body defines physics body used by the impostor
  107770. * @returns the PhysicsImpostor or null if not found
  107771. */
  107772. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107773. /**
  107774. * Does a raycast in the physics world
  107775. * @param from when should the ray start?
  107776. * @param to when should the ray end?
  107777. * @returns PhysicsRaycastResult
  107778. */
  107779. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107780. /**
  107781. * Called by the scene. No need to call it.
  107782. * @param delta defines the timespam between frames
  107783. */
  107784. _step(delta: number): void;
  107785. }
  107786. }
  107787. declare module BABYLON {
  107788. /**
  107789. * The interface for the physics imposter parameters
  107790. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107791. */
  107792. export interface PhysicsImpostorParameters {
  107793. /**
  107794. * The mass of the physics imposter
  107795. */
  107796. mass: number;
  107797. /**
  107798. * The friction of the physics imposter
  107799. */
  107800. friction?: number;
  107801. /**
  107802. * The coefficient of restitution of the physics imposter
  107803. */
  107804. restitution?: number;
  107805. /**
  107806. * The native options of the physics imposter
  107807. */
  107808. nativeOptions?: any;
  107809. /**
  107810. * Specifies if the parent should be ignored
  107811. */
  107812. ignoreParent?: boolean;
  107813. /**
  107814. * Specifies if bi-directional transformations should be disabled
  107815. */
  107816. disableBidirectionalTransformation?: boolean;
  107817. /**
  107818. * The pressure inside the physics imposter, soft object only
  107819. */
  107820. pressure?: number;
  107821. /**
  107822. * The stiffness the physics imposter, soft object only
  107823. */
  107824. stiffness?: number;
  107825. /**
  107826. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107827. */
  107828. velocityIterations?: number;
  107829. /**
  107830. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107831. */
  107832. positionIterations?: number;
  107833. /**
  107834. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107835. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107836. * Add to fix multiple points
  107837. */
  107838. fixedPoints?: number;
  107839. /**
  107840. * The collision margin around a soft object
  107841. */
  107842. margin?: number;
  107843. /**
  107844. * The collision margin around a soft object
  107845. */
  107846. damping?: number;
  107847. /**
  107848. * The path for a rope based on an extrusion
  107849. */
  107850. path?: any;
  107851. /**
  107852. * The shape of an extrusion used for a rope based on an extrusion
  107853. */
  107854. shape?: any;
  107855. }
  107856. /**
  107857. * Interface for a physics-enabled object
  107858. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107859. */
  107860. export interface IPhysicsEnabledObject {
  107861. /**
  107862. * The position of the physics-enabled object
  107863. */
  107864. position: Vector3;
  107865. /**
  107866. * The rotation of the physics-enabled object
  107867. */
  107868. rotationQuaternion: Nullable<Quaternion>;
  107869. /**
  107870. * The scale of the physics-enabled object
  107871. */
  107872. scaling: Vector3;
  107873. /**
  107874. * The rotation of the physics-enabled object
  107875. */
  107876. rotation?: Vector3;
  107877. /**
  107878. * The parent of the physics-enabled object
  107879. */
  107880. parent?: any;
  107881. /**
  107882. * The bounding info of the physics-enabled object
  107883. * @returns The bounding info of the physics-enabled object
  107884. */
  107885. getBoundingInfo(): BoundingInfo;
  107886. /**
  107887. * Computes the world matrix
  107888. * @param force Specifies if the world matrix should be computed by force
  107889. * @returns A world matrix
  107890. */
  107891. computeWorldMatrix(force: boolean): Matrix;
  107892. /**
  107893. * Gets the world matrix
  107894. * @returns A world matrix
  107895. */
  107896. getWorldMatrix?(): Matrix;
  107897. /**
  107898. * Gets the child meshes
  107899. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107900. * @returns An array of abstract meshes
  107901. */
  107902. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107903. /**
  107904. * Gets the vertex data
  107905. * @param kind The type of vertex data
  107906. * @returns A nullable array of numbers, or a float32 array
  107907. */
  107908. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107909. /**
  107910. * Gets the indices from the mesh
  107911. * @returns A nullable array of index arrays
  107912. */
  107913. getIndices?(): Nullable<IndicesArray>;
  107914. /**
  107915. * Gets the scene from the mesh
  107916. * @returns the indices array or null
  107917. */
  107918. getScene?(): Scene;
  107919. /**
  107920. * Gets the absolute position from the mesh
  107921. * @returns the absolute position
  107922. */
  107923. getAbsolutePosition(): Vector3;
  107924. /**
  107925. * Gets the absolute pivot point from the mesh
  107926. * @returns the absolute pivot point
  107927. */
  107928. getAbsolutePivotPoint(): Vector3;
  107929. /**
  107930. * Rotates the mesh
  107931. * @param axis The axis of rotation
  107932. * @param amount The amount of rotation
  107933. * @param space The space of the rotation
  107934. * @returns The rotation transform node
  107935. */
  107936. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107937. /**
  107938. * Translates the mesh
  107939. * @param axis The axis of translation
  107940. * @param distance The distance of translation
  107941. * @param space The space of the translation
  107942. * @returns The transform node
  107943. */
  107944. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107945. /**
  107946. * Sets the absolute position of the mesh
  107947. * @param absolutePosition The absolute position of the mesh
  107948. * @returns The transform node
  107949. */
  107950. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107951. /**
  107952. * Gets the class name of the mesh
  107953. * @returns The class name
  107954. */
  107955. getClassName(): string;
  107956. }
  107957. /**
  107958. * Represents a physics imposter
  107959. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107960. */
  107961. export class PhysicsImpostor {
  107962. /**
  107963. * The physics-enabled object used as the physics imposter
  107964. */
  107965. object: IPhysicsEnabledObject;
  107966. /**
  107967. * The type of the physics imposter
  107968. */
  107969. type: number;
  107970. private _options;
  107971. private _scene?;
  107972. /**
  107973. * The default object size of the imposter
  107974. */
  107975. static DEFAULT_OBJECT_SIZE: Vector3;
  107976. /**
  107977. * The identity quaternion of the imposter
  107978. */
  107979. static IDENTITY_QUATERNION: Quaternion;
  107980. /** @hidden */
  107981. _pluginData: any;
  107982. private _physicsEngine;
  107983. private _physicsBody;
  107984. private _bodyUpdateRequired;
  107985. private _onBeforePhysicsStepCallbacks;
  107986. private _onAfterPhysicsStepCallbacks;
  107987. /** @hidden */
  107988. _onPhysicsCollideCallbacks: Array<{
  107989. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107990. otherImpostors: Array<PhysicsImpostor>;
  107991. }>;
  107992. private _deltaPosition;
  107993. private _deltaRotation;
  107994. private _deltaRotationConjugated;
  107995. /** @hidden */
  107996. _isFromLine: boolean;
  107997. private _parent;
  107998. private _isDisposed;
  107999. private static _tmpVecs;
  108000. private static _tmpQuat;
  108001. /**
  108002. * Specifies if the physics imposter is disposed
  108003. */
  108004. get isDisposed(): boolean;
  108005. /**
  108006. * Gets the mass of the physics imposter
  108007. */
  108008. get mass(): number;
  108009. set mass(value: number);
  108010. /**
  108011. * Gets the coefficient of friction
  108012. */
  108013. get friction(): number;
  108014. /**
  108015. * Sets the coefficient of friction
  108016. */
  108017. set friction(value: number);
  108018. /**
  108019. * Gets the coefficient of restitution
  108020. */
  108021. get restitution(): number;
  108022. /**
  108023. * Sets the coefficient of restitution
  108024. */
  108025. set restitution(value: number);
  108026. /**
  108027. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  108028. */
  108029. get pressure(): number;
  108030. /**
  108031. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  108032. */
  108033. set pressure(value: number);
  108034. /**
  108035. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  108036. */
  108037. get stiffness(): number;
  108038. /**
  108039. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  108040. */
  108041. set stiffness(value: number);
  108042. /**
  108043. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  108044. */
  108045. get velocityIterations(): number;
  108046. /**
  108047. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  108048. */
  108049. set velocityIterations(value: number);
  108050. /**
  108051. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  108052. */
  108053. get positionIterations(): number;
  108054. /**
  108055. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  108056. */
  108057. set positionIterations(value: number);
  108058. /**
  108059. * The unique id of the physics imposter
  108060. * set by the physics engine when adding this impostor to the array
  108061. */
  108062. uniqueId: number;
  108063. /**
  108064. * @hidden
  108065. */
  108066. soft: boolean;
  108067. /**
  108068. * @hidden
  108069. */
  108070. segments: number;
  108071. private _joints;
  108072. /**
  108073. * Initializes the physics imposter
  108074. * @param object The physics-enabled object used as the physics imposter
  108075. * @param type The type of the physics imposter
  108076. * @param _options The options for the physics imposter
  108077. * @param _scene The Babylon scene
  108078. */
  108079. constructor(
  108080. /**
  108081. * The physics-enabled object used as the physics imposter
  108082. */
  108083. object: IPhysicsEnabledObject,
  108084. /**
  108085. * The type of the physics imposter
  108086. */
  108087. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  108088. /**
  108089. * This function will completly initialize this impostor.
  108090. * It will create a new body - but only if this mesh has no parent.
  108091. * If it has, this impostor will not be used other than to define the impostor
  108092. * of the child mesh.
  108093. * @hidden
  108094. */
  108095. _init(): void;
  108096. private _getPhysicsParent;
  108097. /**
  108098. * Should a new body be generated.
  108099. * @returns boolean specifying if body initialization is required
  108100. */
  108101. isBodyInitRequired(): boolean;
  108102. /**
  108103. * Sets the updated scaling
  108104. * @param updated Specifies if the scaling is updated
  108105. */
  108106. setScalingUpdated(): void;
  108107. /**
  108108. * Force a regeneration of this or the parent's impostor's body.
  108109. * Use under cautious - This will remove all joints already implemented.
  108110. */
  108111. forceUpdate(): void;
  108112. /**
  108113. * Gets the body that holds this impostor. Either its own, or its parent.
  108114. */
  108115. get physicsBody(): any;
  108116. /**
  108117. * Get the parent of the physics imposter
  108118. * @returns Physics imposter or null
  108119. */
  108120. get parent(): Nullable<PhysicsImpostor>;
  108121. /**
  108122. * Sets the parent of the physics imposter
  108123. */
  108124. set parent(value: Nullable<PhysicsImpostor>);
  108125. /**
  108126. * Set the physics body. Used mainly by the physics engine/plugin
  108127. */
  108128. set physicsBody(physicsBody: any);
  108129. /**
  108130. * Resets the update flags
  108131. */
  108132. resetUpdateFlags(): void;
  108133. /**
  108134. * Gets the object extend size
  108135. * @returns the object extend size
  108136. */
  108137. getObjectExtendSize(): Vector3;
  108138. /**
  108139. * Gets the object center
  108140. * @returns The object center
  108141. */
  108142. getObjectCenter(): Vector3;
  108143. /**
  108144. * Get a specific parameter from the options parameters
  108145. * @param paramName The object parameter name
  108146. * @returns The object parameter
  108147. */
  108148. getParam(paramName: string): any;
  108149. /**
  108150. * Sets a specific parameter in the options given to the physics plugin
  108151. * @param paramName The parameter name
  108152. * @param value The value of the parameter
  108153. */
  108154. setParam(paramName: string, value: number): void;
  108155. /**
  108156. * Specifically change the body's mass option. Won't recreate the physics body object
  108157. * @param mass The mass of the physics imposter
  108158. */
  108159. setMass(mass: number): void;
  108160. /**
  108161. * Gets the linear velocity
  108162. * @returns linear velocity or null
  108163. */
  108164. getLinearVelocity(): Nullable<Vector3>;
  108165. /**
  108166. * Sets the linear velocity
  108167. * @param velocity linear velocity or null
  108168. */
  108169. setLinearVelocity(velocity: Nullable<Vector3>): void;
  108170. /**
  108171. * Gets the angular velocity
  108172. * @returns angular velocity or null
  108173. */
  108174. getAngularVelocity(): Nullable<Vector3>;
  108175. /**
  108176. * Sets the angular velocity
  108177. * @param velocity The velocity or null
  108178. */
  108179. setAngularVelocity(velocity: Nullable<Vector3>): void;
  108180. /**
  108181. * Execute a function with the physics plugin native code
  108182. * Provide a function the will have two variables - the world object and the physics body object
  108183. * @param func The function to execute with the physics plugin native code
  108184. */
  108185. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  108186. /**
  108187. * Register a function that will be executed before the physics world is stepping forward
  108188. * @param func The function to execute before the physics world is stepped forward
  108189. */
  108190. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108191. /**
  108192. * Unregister a function that will be executed before the physics world is stepping forward
  108193. * @param func The function to execute before the physics world is stepped forward
  108194. */
  108195. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108196. /**
  108197. * Register a function that will be executed after the physics step
  108198. * @param func The function to execute after physics step
  108199. */
  108200. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108201. /**
  108202. * Unregisters a function that will be executed after the physics step
  108203. * @param func The function to execute after physics step
  108204. */
  108205. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108206. /**
  108207. * register a function that will be executed when this impostor collides against a different body
  108208. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  108209. * @param func Callback that is executed on collision
  108210. */
  108211. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  108212. /**
  108213. * Unregisters the physics imposter on contact
  108214. * @param collideAgainst The physics object to collide against
  108215. * @param func Callback to execute on collision
  108216. */
  108217. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  108218. private _tmpQuat;
  108219. private _tmpQuat2;
  108220. /**
  108221. * Get the parent rotation
  108222. * @returns The parent rotation
  108223. */
  108224. getParentsRotation(): Quaternion;
  108225. /**
  108226. * this function is executed by the physics engine.
  108227. */
  108228. beforeStep: () => void;
  108229. /**
  108230. * this function is executed by the physics engine
  108231. */
  108232. afterStep: () => void;
  108233. /**
  108234. * Legacy collision detection event support
  108235. */
  108236. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  108237. /**
  108238. * event and body object due to cannon's event-based architecture.
  108239. */
  108240. onCollide: (e: {
  108241. body: any;
  108242. }) => void;
  108243. /**
  108244. * Apply a force
  108245. * @param force The force to apply
  108246. * @param contactPoint The contact point for the force
  108247. * @returns The physics imposter
  108248. */
  108249. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  108250. /**
  108251. * Apply an impulse
  108252. * @param force The impulse force
  108253. * @param contactPoint The contact point for the impulse force
  108254. * @returns The physics imposter
  108255. */
  108256. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  108257. /**
  108258. * A help function to create a joint
  108259. * @param otherImpostor A physics imposter used to create a joint
  108260. * @param jointType The type of joint
  108261. * @param jointData The data for the joint
  108262. * @returns The physics imposter
  108263. */
  108264. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  108265. /**
  108266. * Add a joint to this impostor with a different impostor
  108267. * @param otherImpostor A physics imposter used to add a joint
  108268. * @param joint The joint to add
  108269. * @returns The physics imposter
  108270. */
  108271. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  108272. /**
  108273. * Add an anchor to a cloth impostor
  108274. * @param otherImpostor rigid impostor to anchor to
  108275. * @param width ratio across width from 0 to 1
  108276. * @param height ratio up height from 0 to 1
  108277. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  108278. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  108279. * @returns impostor the soft imposter
  108280. */
  108281. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  108282. /**
  108283. * Add a hook to a rope impostor
  108284. * @param otherImpostor rigid impostor to anchor to
  108285. * @param length ratio across rope from 0 to 1
  108286. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  108287. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  108288. * @returns impostor the rope imposter
  108289. */
  108290. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  108291. /**
  108292. * Will keep this body still, in a sleep mode.
  108293. * @returns the physics imposter
  108294. */
  108295. sleep(): PhysicsImpostor;
  108296. /**
  108297. * Wake the body up.
  108298. * @returns The physics imposter
  108299. */
  108300. wakeUp(): PhysicsImpostor;
  108301. /**
  108302. * Clones the physics imposter
  108303. * @param newObject The physics imposter clones to this physics-enabled object
  108304. * @returns A nullable physics imposter
  108305. */
  108306. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  108307. /**
  108308. * Disposes the physics imposter
  108309. */
  108310. dispose(): void;
  108311. /**
  108312. * Sets the delta position
  108313. * @param position The delta position amount
  108314. */
  108315. setDeltaPosition(position: Vector3): void;
  108316. /**
  108317. * Sets the delta rotation
  108318. * @param rotation The delta rotation amount
  108319. */
  108320. setDeltaRotation(rotation: Quaternion): void;
  108321. /**
  108322. * Gets the box size of the physics imposter and stores the result in the input parameter
  108323. * @param result Stores the box size
  108324. * @returns The physics imposter
  108325. */
  108326. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  108327. /**
  108328. * Gets the radius of the physics imposter
  108329. * @returns Radius of the physics imposter
  108330. */
  108331. getRadius(): number;
  108332. /**
  108333. * Sync a bone with this impostor
  108334. * @param bone The bone to sync to the impostor.
  108335. * @param boneMesh The mesh that the bone is influencing.
  108336. * @param jointPivot The pivot of the joint / bone in local space.
  108337. * @param distToJoint Optional distance from the impostor to the joint.
  108338. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  108339. */
  108340. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  108341. /**
  108342. * Sync impostor to a bone
  108343. * @param bone The bone that the impostor will be synced to.
  108344. * @param boneMesh The mesh that the bone is influencing.
  108345. * @param jointPivot The pivot of the joint / bone in local space.
  108346. * @param distToJoint Optional distance from the impostor to the joint.
  108347. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  108348. * @param boneAxis Optional vector3 axis the bone is aligned with
  108349. */
  108350. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  108351. /**
  108352. * No-Imposter type
  108353. */
  108354. static NoImpostor: number;
  108355. /**
  108356. * Sphere-Imposter type
  108357. */
  108358. static SphereImpostor: number;
  108359. /**
  108360. * Box-Imposter type
  108361. */
  108362. static BoxImpostor: number;
  108363. /**
  108364. * Plane-Imposter type
  108365. */
  108366. static PlaneImpostor: number;
  108367. /**
  108368. * Mesh-imposter type
  108369. */
  108370. static MeshImpostor: number;
  108371. /**
  108372. * Capsule-Impostor type (Ammo.js plugin only)
  108373. */
  108374. static CapsuleImpostor: number;
  108375. /**
  108376. * Cylinder-Imposter type
  108377. */
  108378. static CylinderImpostor: number;
  108379. /**
  108380. * Particle-Imposter type
  108381. */
  108382. static ParticleImpostor: number;
  108383. /**
  108384. * Heightmap-Imposter type
  108385. */
  108386. static HeightmapImpostor: number;
  108387. /**
  108388. * ConvexHull-Impostor type (Ammo.js plugin only)
  108389. */
  108390. static ConvexHullImpostor: number;
  108391. /**
  108392. * Custom-Imposter type (Ammo.js plugin only)
  108393. */
  108394. static CustomImpostor: number;
  108395. /**
  108396. * Rope-Imposter type
  108397. */
  108398. static RopeImpostor: number;
  108399. /**
  108400. * Cloth-Imposter type
  108401. */
  108402. static ClothImpostor: number;
  108403. /**
  108404. * Softbody-Imposter type
  108405. */
  108406. static SoftbodyImpostor: number;
  108407. }
  108408. }
  108409. declare module BABYLON {
  108410. /**
  108411. * @hidden
  108412. **/
  108413. export class _CreationDataStorage {
  108414. closePath?: boolean;
  108415. closeArray?: boolean;
  108416. idx: number[];
  108417. dashSize: number;
  108418. gapSize: number;
  108419. path3D: Path3D;
  108420. pathArray: Vector3[][];
  108421. arc: number;
  108422. radius: number;
  108423. cap: number;
  108424. tessellation: number;
  108425. }
  108426. /**
  108427. * @hidden
  108428. **/
  108429. class _InstanceDataStorage {
  108430. visibleInstances: any;
  108431. batchCache: _InstancesBatch;
  108432. instancesBufferSize: number;
  108433. instancesBuffer: Nullable<Buffer>;
  108434. instancesData: Float32Array;
  108435. overridenInstanceCount: number;
  108436. isFrozen: boolean;
  108437. previousBatch: Nullable<_InstancesBatch>;
  108438. hardwareInstancedRendering: boolean;
  108439. sideOrientation: number;
  108440. manualUpdate: boolean;
  108441. previousRenderId: number;
  108442. }
  108443. /**
  108444. * @hidden
  108445. **/
  108446. export class _InstancesBatch {
  108447. mustReturn: boolean;
  108448. visibleInstances: Nullable<InstancedMesh[]>[];
  108449. renderSelf: boolean[];
  108450. hardwareInstancedRendering: boolean[];
  108451. }
  108452. /**
  108453. * @hidden
  108454. **/
  108455. class _ThinInstanceDataStorage {
  108456. instancesCount: number;
  108457. matrixBuffer: Nullable<Buffer>;
  108458. matrixBufferSize: number;
  108459. matrixData: Nullable<Float32Array>;
  108460. boundingVectors: Array<Vector3>;
  108461. worldMatrices: Nullable<Matrix[]>;
  108462. }
  108463. /**
  108464. * Class used to represent renderable models
  108465. */
  108466. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  108467. /**
  108468. * Mesh side orientation : usually the external or front surface
  108469. */
  108470. static readonly FRONTSIDE: number;
  108471. /**
  108472. * Mesh side orientation : usually the internal or back surface
  108473. */
  108474. static readonly BACKSIDE: number;
  108475. /**
  108476. * Mesh side orientation : both internal and external or front and back surfaces
  108477. */
  108478. static readonly DOUBLESIDE: number;
  108479. /**
  108480. * Mesh side orientation : by default, `FRONTSIDE`
  108481. */
  108482. static readonly DEFAULTSIDE: number;
  108483. /**
  108484. * Mesh cap setting : no cap
  108485. */
  108486. static readonly NO_CAP: number;
  108487. /**
  108488. * Mesh cap setting : one cap at the beginning of the mesh
  108489. */
  108490. static readonly CAP_START: number;
  108491. /**
  108492. * Mesh cap setting : one cap at the end of the mesh
  108493. */
  108494. static readonly CAP_END: number;
  108495. /**
  108496. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  108497. */
  108498. static readonly CAP_ALL: number;
  108499. /**
  108500. * Mesh pattern setting : no flip or rotate
  108501. */
  108502. static readonly NO_FLIP: number;
  108503. /**
  108504. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  108505. */
  108506. static readonly FLIP_TILE: number;
  108507. /**
  108508. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  108509. */
  108510. static readonly ROTATE_TILE: number;
  108511. /**
  108512. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  108513. */
  108514. static readonly FLIP_ROW: number;
  108515. /**
  108516. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  108517. */
  108518. static readonly ROTATE_ROW: number;
  108519. /**
  108520. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  108521. */
  108522. static readonly FLIP_N_ROTATE_TILE: number;
  108523. /**
  108524. * Mesh pattern setting : rotate pattern and rotate
  108525. */
  108526. static readonly FLIP_N_ROTATE_ROW: number;
  108527. /**
  108528. * Mesh tile positioning : part tiles same on left/right or top/bottom
  108529. */
  108530. static readonly CENTER: number;
  108531. /**
  108532. * Mesh tile positioning : part tiles on left
  108533. */
  108534. static readonly LEFT: number;
  108535. /**
  108536. * Mesh tile positioning : part tiles on right
  108537. */
  108538. static readonly RIGHT: number;
  108539. /**
  108540. * Mesh tile positioning : part tiles on top
  108541. */
  108542. static readonly TOP: number;
  108543. /**
  108544. * Mesh tile positioning : part tiles on bottom
  108545. */
  108546. static readonly BOTTOM: number;
  108547. /**
  108548. * Gets the default side orientation.
  108549. * @param orientation the orientation to value to attempt to get
  108550. * @returns the default orientation
  108551. * @hidden
  108552. */
  108553. static _GetDefaultSideOrientation(orientation?: number): number;
  108554. private _internalMeshDataInfo;
  108555. get computeBonesUsingShaders(): boolean;
  108556. set computeBonesUsingShaders(value: boolean);
  108557. /**
  108558. * An event triggered before rendering the mesh
  108559. */
  108560. get onBeforeRenderObservable(): Observable<Mesh>;
  108561. /**
  108562. * An event triggered before binding the mesh
  108563. */
  108564. get onBeforeBindObservable(): Observable<Mesh>;
  108565. /**
  108566. * An event triggered after rendering the mesh
  108567. */
  108568. get onAfterRenderObservable(): Observable<Mesh>;
  108569. /**
  108570. * An event triggered before drawing the mesh
  108571. */
  108572. get onBeforeDrawObservable(): Observable<Mesh>;
  108573. private _onBeforeDrawObserver;
  108574. /**
  108575. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  108576. */
  108577. set onBeforeDraw(callback: () => void);
  108578. get hasInstances(): boolean;
  108579. get hasThinInstances(): boolean;
  108580. /**
  108581. * Gets the delay loading state of the mesh (when delay loading is turned on)
  108582. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  108583. */
  108584. delayLoadState: number;
  108585. /**
  108586. * Gets the list of instances created from this mesh
  108587. * it is not supposed to be modified manually.
  108588. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  108589. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108590. */
  108591. instances: InstancedMesh[];
  108592. /**
  108593. * Gets the file containing delay loading data for this mesh
  108594. */
  108595. delayLoadingFile: string;
  108596. /** @hidden */
  108597. _binaryInfo: any;
  108598. /**
  108599. * User defined function used to change how LOD level selection is done
  108600. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108601. */
  108602. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  108603. /**
  108604. * Gets or sets the morph target manager
  108605. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  108606. */
  108607. get morphTargetManager(): Nullable<MorphTargetManager>;
  108608. set morphTargetManager(value: Nullable<MorphTargetManager>);
  108609. /** @hidden */
  108610. _creationDataStorage: Nullable<_CreationDataStorage>;
  108611. /** @hidden */
  108612. _geometry: Nullable<Geometry>;
  108613. /** @hidden */
  108614. _delayInfo: Array<string>;
  108615. /** @hidden */
  108616. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  108617. /** @hidden */
  108618. _instanceDataStorage: _InstanceDataStorage;
  108619. /** @hidden */
  108620. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  108621. private _effectiveMaterial;
  108622. /** @hidden */
  108623. _shouldGenerateFlatShading: boolean;
  108624. /** @hidden */
  108625. _originalBuilderSideOrientation: number;
  108626. /**
  108627. * Use this property to change the original side orientation defined at construction time
  108628. */
  108629. overrideMaterialSideOrientation: Nullable<number>;
  108630. /**
  108631. * Gets the source mesh (the one used to clone this one from)
  108632. */
  108633. get source(): Nullable<Mesh>;
  108634. /**
  108635. * Gets the list of clones of this mesh
  108636. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  108637. * Note that useClonedMeshMap=true is the default setting
  108638. */
  108639. get cloneMeshMap(): Nullable<{
  108640. [id: string]: Mesh | undefined;
  108641. }>;
  108642. /**
  108643. * Gets or sets a boolean indicating that this mesh does not use index buffer
  108644. */
  108645. get isUnIndexed(): boolean;
  108646. set isUnIndexed(value: boolean);
  108647. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  108648. get worldMatrixInstancedBuffer(): Float32Array;
  108649. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  108650. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  108651. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  108652. /**
  108653. * @constructor
  108654. * @param name The value used by scene.getMeshByName() to do a lookup.
  108655. * @param scene The scene to add this mesh to.
  108656. * @param parent The parent of this mesh, if it has one
  108657. * @param source An optional Mesh from which geometry is shared, cloned.
  108658. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  108659. * When false, achieved by calling a clone(), also passing False.
  108660. * This will make creation of children, recursive.
  108661. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  108662. */
  108663. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  108664. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  108665. doNotInstantiate: boolean;
  108666. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  108667. /**
  108668. * Gets the class name
  108669. * @returns the string "Mesh".
  108670. */
  108671. getClassName(): string;
  108672. /** @hidden */
  108673. get _isMesh(): boolean;
  108674. /**
  108675. * Returns a description of this mesh
  108676. * @param fullDetails define if full details about this mesh must be used
  108677. * @returns a descriptive string representing this mesh
  108678. */
  108679. toString(fullDetails?: boolean): string;
  108680. /** @hidden */
  108681. _unBindEffect(): void;
  108682. /**
  108683. * Gets a boolean indicating if this mesh has LOD
  108684. */
  108685. get hasLODLevels(): boolean;
  108686. /**
  108687. * Gets the list of MeshLODLevel associated with the current mesh
  108688. * @returns an array of MeshLODLevel
  108689. */
  108690. getLODLevels(): MeshLODLevel[];
  108691. private _sortLODLevels;
  108692. /**
  108693. * Add a mesh as LOD level triggered at the given distance.
  108694. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108695. * @param distance The distance from the center of the object to show this level
  108696. * @param mesh The mesh to be added as LOD level (can be null)
  108697. * @return This mesh (for chaining)
  108698. */
  108699. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  108700. /**
  108701. * Returns the LOD level mesh at the passed distance or null if not found.
  108702. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108703. * @param distance The distance from the center of the object to show this level
  108704. * @returns a Mesh or `null`
  108705. */
  108706. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108707. /**
  108708. * Remove a mesh from the LOD array
  108709. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108710. * @param mesh defines the mesh to be removed
  108711. * @return This mesh (for chaining)
  108712. */
  108713. removeLODLevel(mesh: Mesh): Mesh;
  108714. /**
  108715. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108716. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108717. * @param camera defines the camera to use to compute distance
  108718. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108719. * @return This mesh (for chaining)
  108720. */
  108721. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108722. /**
  108723. * Gets the mesh internal Geometry object
  108724. */
  108725. get geometry(): Nullable<Geometry>;
  108726. /**
  108727. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108728. * @returns the total number of vertices
  108729. */
  108730. getTotalVertices(): number;
  108731. /**
  108732. * Returns the content of an associated vertex buffer
  108733. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108734. * - VertexBuffer.PositionKind
  108735. * - VertexBuffer.UVKind
  108736. * - VertexBuffer.UV2Kind
  108737. * - VertexBuffer.UV3Kind
  108738. * - VertexBuffer.UV4Kind
  108739. * - VertexBuffer.UV5Kind
  108740. * - VertexBuffer.UV6Kind
  108741. * - VertexBuffer.ColorKind
  108742. * - VertexBuffer.MatricesIndicesKind
  108743. * - VertexBuffer.MatricesIndicesExtraKind
  108744. * - VertexBuffer.MatricesWeightsKind
  108745. * - VertexBuffer.MatricesWeightsExtraKind
  108746. * @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
  108747. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108748. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108749. */
  108750. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108751. /**
  108752. * Returns the mesh VertexBuffer object from the requested `kind`
  108753. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108754. * - VertexBuffer.PositionKind
  108755. * - VertexBuffer.NormalKind
  108756. * - VertexBuffer.UVKind
  108757. * - VertexBuffer.UV2Kind
  108758. * - VertexBuffer.UV3Kind
  108759. * - VertexBuffer.UV4Kind
  108760. * - VertexBuffer.UV5Kind
  108761. * - VertexBuffer.UV6Kind
  108762. * - VertexBuffer.ColorKind
  108763. * - VertexBuffer.MatricesIndicesKind
  108764. * - VertexBuffer.MatricesIndicesExtraKind
  108765. * - VertexBuffer.MatricesWeightsKind
  108766. * - VertexBuffer.MatricesWeightsExtraKind
  108767. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108768. */
  108769. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108770. /**
  108771. * Tests if a specific vertex buffer is associated with this mesh
  108772. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108773. * - VertexBuffer.PositionKind
  108774. * - VertexBuffer.NormalKind
  108775. * - VertexBuffer.UVKind
  108776. * - VertexBuffer.UV2Kind
  108777. * - VertexBuffer.UV3Kind
  108778. * - VertexBuffer.UV4Kind
  108779. * - VertexBuffer.UV5Kind
  108780. * - VertexBuffer.UV6Kind
  108781. * - VertexBuffer.ColorKind
  108782. * - VertexBuffer.MatricesIndicesKind
  108783. * - VertexBuffer.MatricesIndicesExtraKind
  108784. * - VertexBuffer.MatricesWeightsKind
  108785. * - VertexBuffer.MatricesWeightsExtraKind
  108786. * @returns a boolean
  108787. */
  108788. isVerticesDataPresent(kind: string): boolean;
  108789. /**
  108790. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108791. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108792. * - VertexBuffer.PositionKind
  108793. * - VertexBuffer.UVKind
  108794. * - VertexBuffer.UV2Kind
  108795. * - VertexBuffer.UV3Kind
  108796. * - VertexBuffer.UV4Kind
  108797. * - VertexBuffer.UV5Kind
  108798. * - VertexBuffer.UV6Kind
  108799. * - VertexBuffer.ColorKind
  108800. * - VertexBuffer.MatricesIndicesKind
  108801. * - VertexBuffer.MatricesIndicesExtraKind
  108802. * - VertexBuffer.MatricesWeightsKind
  108803. * - VertexBuffer.MatricesWeightsExtraKind
  108804. * @returns a boolean
  108805. */
  108806. isVertexBufferUpdatable(kind: string): boolean;
  108807. /**
  108808. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108809. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108810. * - VertexBuffer.PositionKind
  108811. * - VertexBuffer.NormalKind
  108812. * - VertexBuffer.UVKind
  108813. * - VertexBuffer.UV2Kind
  108814. * - VertexBuffer.UV3Kind
  108815. * - VertexBuffer.UV4Kind
  108816. * - VertexBuffer.UV5Kind
  108817. * - VertexBuffer.UV6Kind
  108818. * - VertexBuffer.ColorKind
  108819. * - VertexBuffer.MatricesIndicesKind
  108820. * - VertexBuffer.MatricesIndicesExtraKind
  108821. * - VertexBuffer.MatricesWeightsKind
  108822. * - VertexBuffer.MatricesWeightsExtraKind
  108823. * @returns an array of strings
  108824. */
  108825. getVerticesDataKinds(): string[];
  108826. /**
  108827. * Returns a positive integer : the total number of indices in this mesh geometry.
  108828. * @returns the numner of indices or zero if the mesh has no geometry.
  108829. */
  108830. getTotalIndices(): number;
  108831. /**
  108832. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108833. * @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.
  108834. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108835. * @returns the indices array or an empty array if the mesh has no geometry
  108836. */
  108837. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108838. get isBlocked(): boolean;
  108839. /**
  108840. * Determine if the current mesh is ready to be rendered
  108841. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108842. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108843. * @returns true if all associated assets are ready (material, textures, shaders)
  108844. */
  108845. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108846. /**
  108847. * 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.
  108848. */
  108849. get areNormalsFrozen(): boolean;
  108850. /**
  108851. * 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.
  108852. * @returns the current mesh
  108853. */
  108854. freezeNormals(): Mesh;
  108855. /**
  108856. * 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
  108857. * @returns the current mesh
  108858. */
  108859. unfreezeNormals(): Mesh;
  108860. /**
  108861. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108862. */
  108863. set overridenInstanceCount(count: number);
  108864. /** @hidden */
  108865. _preActivate(): Mesh;
  108866. /** @hidden */
  108867. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108868. /** @hidden */
  108869. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108870. protected _afterComputeWorldMatrix(): void;
  108871. /** @hidden */
  108872. _postActivate(): void;
  108873. /**
  108874. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108875. * This means the mesh underlying bounding box and sphere are recomputed.
  108876. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108877. * @returns the current mesh
  108878. */
  108879. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108880. /** @hidden */
  108881. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108882. /**
  108883. * This function will subdivide the mesh into multiple submeshes
  108884. * @param count defines the expected number of submeshes
  108885. */
  108886. subdivide(count: number): void;
  108887. /**
  108888. * Copy a FloatArray into a specific associated vertex buffer
  108889. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108890. * - VertexBuffer.PositionKind
  108891. * - VertexBuffer.UVKind
  108892. * - VertexBuffer.UV2Kind
  108893. * - VertexBuffer.UV3Kind
  108894. * - VertexBuffer.UV4Kind
  108895. * - VertexBuffer.UV5Kind
  108896. * - VertexBuffer.UV6Kind
  108897. * - VertexBuffer.ColorKind
  108898. * - VertexBuffer.MatricesIndicesKind
  108899. * - VertexBuffer.MatricesIndicesExtraKind
  108900. * - VertexBuffer.MatricesWeightsKind
  108901. * - VertexBuffer.MatricesWeightsExtraKind
  108902. * @param data defines the data source
  108903. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108904. * @param stride defines the data stride size (can be null)
  108905. * @returns the current mesh
  108906. */
  108907. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108908. /**
  108909. * Delete a vertex buffer associated with this mesh
  108910. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108911. * - VertexBuffer.PositionKind
  108912. * - VertexBuffer.UVKind
  108913. * - VertexBuffer.UV2Kind
  108914. * - VertexBuffer.UV3Kind
  108915. * - VertexBuffer.UV4Kind
  108916. * - VertexBuffer.UV5Kind
  108917. * - VertexBuffer.UV6Kind
  108918. * - VertexBuffer.ColorKind
  108919. * - VertexBuffer.MatricesIndicesKind
  108920. * - VertexBuffer.MatricesIndicesExtraKind
  108921. * - VertexBuffer.MatricesWeightsKind
  108922. * - VertexBuffer.MatricesWeightsExtraKind
  108923. */
  108924. removeVerticesData(kind: string): void;
  108925. /**
  108926. * Flags an associated vertex buffer as updatable
  108927. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108928. * - VertexBuffer.PositionKind
  108929. * - VertexBuffer.UVKind
  108930. * - VertexBuffer.UV2Kind
  108931. * - VertexBuffer.UV3Kind
  108932. * - VertexBuffer.UV4Kind
  108933. * - VertexBuffer.UV5Kind
  108934. * - VertexBuffer.UV6Kind
  108935. * - VertexBuffer.ColorKind
  108936. * - VertexBuffer.MatricesIndicesKind
  108937. * - VertexBuffer.MatricesIndicesExtraKind
  108938. * - VertexBuffer.MatricesWeightsKind
  108939. * - VertexBuffer.MatricesWeightsExtraKind
  108940. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108941. */
  108942. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108943. /**
  108944. * Sets the mesh global Vertex Buffer
  108945. * @param buffer defines the buffer to use
  108946. * @returns the current mesh
  108947. */
  108948. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108949. /**
  108950. * Update a specific associated vertex buffer
  108951. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108952. * - VertexBuffer.PositionKind
  108953. * - VertexBuffer.UVKind
  108954. * - VertexBuffer.UV2Kind
  108955. * - VertexBuffer.UV3Kind
  108956. * - VertexBuffer.UV4Kind
  108957. * - VertexBuffer.UV5Kind
  108958. * - VertexBuffer.UV6Kind
  108959. * - VertexBuffer.ColorKind
  108960. * - VertexBuffer.MatricesIndicesKind
  108961. * - VertexBuffer.MatricesIndicesExtraKind
  108962. * - VertexBuffer.MatricesWeightsKind
  108963. * - VertexBuffer.MatricesWeightsExtraKind
  108964. * @param data defines the data source
  108965. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108966. * @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)
  108967. * @returns the current mesh
  108968. */
  108969. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108970. /**
  108971. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108972. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108973. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108974. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108975. * @returns the current mesh
  108976. */
  108977. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108978. /**
  108979. * Creates a un-shared specific occurence of the geometry for the mesh.
  108980. * @returns the current mesh
  108981. */
  108982. makeGeometryUnique(): Mesh;
  108983. /**
  108984. * Set the index buffer of this mesh
  108985. * @param indices defines the source data
  108986. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108987. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108988. * @returns the current mesh
  108989. */
  108990. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108991. /**
  108992. * Update the current index buffer
  108993. * @param indices defines the source data
  108994. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108995. * @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)
  108996. * @returns the current mesh
  108997. */
  108998. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108999. /**
  109000. * Invert the geometry to move from a right handed system to a left handed one.
  109001. * @returns the current mesh
  109002. */
  109003. toLeftHanded(): Mesh;
  109004. /** @hidden */
  109005. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  109006. /** @hidden */
  109007. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  109008. /**
  109009. * Registers for this mesh a javascript function called just before the rendering process
  109010. * @param func defines the function to call before rendering this mesh
  109011. * @returns the current mesh
  109012. */
  109013. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  109014. /**
  109015. * Disposes a previously registered javascript function called before the rendering
  109016. * @param func defines the function to remove
  109017. * @returns the current mesh
  109018. */
  109019. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  109020. /**
  109021. * Registers for this mesh a javascript function called just after the rendering is complete
  109022. * @param func defines the function to call after rendering this mesh
  109023. * @returns the current mesh
  109024. */
  109025. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  109026. /**
  109027. * Disposes a previously registered javascript function called after the rendering.
  109028. * @param func defines the function to remove
  109029. * @returns the current mesh
  109030. */
  109031. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  109032. /** @hidden */
  109033. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  109034. /** @hidden */
  109035. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  109036. /** @hidden */
  109037. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  109038. /** @hidden */
  109039. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  109040. /** @hidden */
  109041. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  109042. /** @hidden */
  109043. _rebuild(): void;
  109044. /** @hidden */
  109045. _freeze(): void;
  109046. /** @hidden */
  109047. _unFreeze(): void;
  109048. /**
  109049. * 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
  109050. * @param subMesh defines the subMesh to render
  109051. * @param enableAlphaMode defines if alpha mode can be changed
  109052. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  109053. * @returns the current mesh
  109054. */
  109055. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  109056. private _onBeforeDraw;
  109057. /**
  109058. * Renormalize the mesh and patch it up if there are no weights
  109059. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  109060. * However in the case of zero weights then we set just a single influence to 1.
  109061. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  109062. */
  109063. cleanMatrixWeights(): void;
  109064. private normalizeSkinFourWeights;
  109065. private normalizeSkinWeightsAndExtra;
  109066. /**
  109067. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  109068. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  109069. * the user know there was an issue with importing the mesh
  109070. * @returns a validation object with skinned, valid and report string
  109071. */
  109072. validateSkinning(): {
  109073. skinned: boolean;
  109074. valid: boolean;
  109075. report: string;
  109076. };
  109077. /** @hidden */
  109078. _checkDelayState(): Mesh;
  109079. private _queueLoad;
  109080. /**
  109081. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  109082. * A mesh is in the frustum if its bounding box intersects the frustum
  109083. * @param frustumPlanes defines the frustum to test
  109084. * @returns true if the mesh is in the frustum planes
  109085. */
  109086. isInFrustum(frustumPlanes: Plane[]): boolean;
  109087. /**
  109088. * Sets the mesh material by the material or multiMaterial `id` property
  109089. * @param id is a string identifying the material or the multiMaterial
  109090. * @returns the current mesh
  109091. */
  109092. setMaterialByID(id: string): Mesh;
  109093. /**
  109094. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  109095. * @returns an array of IAnimatable
  109096. */
  109097. getAnimatables(): IAnimatable[];
  109098. /**
  109099. * Modifies the mesh geometry according to the passed transformation matrix.
  109100. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  109101. * The mesh normals are modified using the same transformation.
  109102. * Note that, under the hood, this method sets a new VertexBuffer each call.
  109103. * @param transform defines the transform matrix to use
  109104. * @see https://doc.babylonjs.com/resources/baking_transformations
  109105. * @returns the current mesh
  109106. */
  109107. bakeTransformIntoVertices(transform: Matrix): Mesh;
  109108. /**
  109109. * Modifies the mesh geometry according to its own current World Matrix.
  109110. * The mesh World Matrix is then reset.
  109111. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  109112. * Note that, under the hood, this method sets a new VertexBuffer each call.
  109113. * @see https://doc.babylonjs.com/resources/baking_transformations
  109114. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  109115. * @returns the current mesh
  109116. */
  109117. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  109118. /** @hidden */
  109119. get _positions(): Nullable<Vector3[]>;
  109120. /** @hidden */
  109121. _resetPointsArrayCache(): Mesh;
  109122. /** @hidden */
  109123. _generatePointsArray(): boolean;
  109124. /**
  109125. * Returns a new Mesh object generated from the current mesh properties.
  109126. * This method must not get confused with createInstance()
  109127. * @param name is a string, the name given to the new mesh
  109128. * @param newParent can be any Node object (default `null`)
  109129. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  109130. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  109131. * @returns a new mesh
  109132. */
  109133. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  109134. /**
  109135. * Releases resources associated with this mesh.
  109136. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109137. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109138. */
  109139. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109140. /** @hidden */
  109141. _disposeInstanceSpecificData(): void;
  109142. /** @hidden */
  109143. _disposeThinInstanceSpecificData(): void;
  109144. /**
  109145. * Modifies the mesh geometry according to a displacement map.
  109146. * 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.
  109147. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  109148. * @param url is a string, the URL from the image file is to be downloaded.
  109149. * @param minHeight is the lower limit of the displacement.
  109150. * @param maxHeight is the upper limit of the displacement.
  109151. * @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.
  109152. * @param uvOffset is an optional vector2 used to offset UV.
  109153. * @param uvScale is an optional vector2 used to scale UV.
  109154. * @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.
  109155. * @returns the Mesh.
  109156. */
  109157. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  109158. /**
  109159. * Modifies the mesh geometry according to a displacementMap buffer.
  109160. * 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.
  109161. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  109162. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  109163. * @param heightMapWidth is the width of the buffer image.
  109164. * @param heightMapHeight is the height of the buffer image.
  109165. * @param minHeight is the lower limit of the displacement.
  109166. * @param maxHeight is the upper limit of the displacement.
  109167. * @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.
  109168. * @param uvOffset is an optional vector2 used to offset UV.
  109169. * @param uvScale is an optional vector2 used to scale UV.
  109170. * @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.
  109171. * @returns the Mesh.
  109172. */
  109173. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  109174. /**
  109175. * Modify the mesh to get a flat shading rendering.
  109176. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  109177. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  109178. * @returns current mesh
  109179. */
  109180. convertToFlatShadedMesh(): Mesh;
  109181. /**
  109182. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  109183. * In other words, more vertices, no more indices and a single bigger VBO.
  109184. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  109185. * @returns current mesh
  109186. */
  109187. convertToUnIndexedMesh(): Mesh;
  109188. /**
  109189. * Inverses facet orientations.
  109190. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  109191. * @param flipNormals will also inverts the normals
  109192. * @returns current mesh
  109193. */
  109194. flipFaces(flipNormals?: boolean): Mesh;
  109195. /**
  109196. * Increase the number of facets and hence vertices in a mesh
  109197. * Vertex normals are interpolated from existing vertex normals
  109198. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  109199. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  109200. */
  109201. increaseVertices(numberPerEdge: number): void;
  109202. /**
  109203. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  109204. * This will undo any application of covertToFlatShadedMesh
  109205. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  109206. */
  109207. forceSharedVertices(): void;
  109208. /** @hidden */
  109209. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  109210. /** @hidden */
  109211. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  109212. /**
  109213. * Creates a new InstancedMesh object from the mesh model.
  109214. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  109215. * @param name defines the name of the new instance
  109216. * @returns a new InstancedMesh
  109217. */
  109218. createInstance(name: string): InstancedMesh;
  109219. /**
  109220. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  109221. * After this call, all the mesh instances have the same submeshes than the current mesh.
  109222. * @returns the current mesh
  109223. */
  109224. synchronizeInstances(): Mesh;
  109225. /**
  109226. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  109227. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  109228. * This should be used together with the simplification to avoid disappearing triangles.
  109229. * @param successCallback an optional success callback to be called after the optimization finished.
  109230. * @returns the current mesh
  109231. */
  109232. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  109233. /**
  109234. * Serialize current mesh
  109235. * @param serializationObject defines the object which will receive the serialization data
  109236. */
  109237. serialize(serializationObject: any): void;
  109238. /** @hidden */
  109239. _syncGeometryWithMorphTargetManager(): void;
  109240. /** @hidden */
  109241. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  109242. /**
  109243. * Returns a new Mesh object parsed from the source provided.
  109244. * @param parsedMesh is the source
  109245. * @param scene defines the hosting scene
  109246. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  109247. * @returns a new Mesh
  109248. */
  109249. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  109250. /**
  109251. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  109252. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  109253. * @param name defines the name of the mesh to create
  109254. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  109255. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  109256. * @param closePath creates a seam between the first and the last points of each path of the path array
  109257. * @param offset is taken in account only if the `pathArray` is containing a single path
  109258. * @param scene defines the hosting scene
  109259. * @param updatable defines if the mesh must be flagged as updatable
  109260. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109261. * @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)
  109262. * @returns a new Mesh
  109263. */
  109264. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  109265. /**
  109266. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  109267. * @param name defines the name of the mesh to create
  109268. * @param radius sets the radius size (float) of the polygon (default 0.5)
  109269. * @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
  109270. * @param scene defines the hosting scene
  109271. * @param updatable defines if the mesh must be flagged as updatable
  109272. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109273. * @returns a new Mesh
  109274. */
  109275. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  109276. /**
  109277. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  109278. * @param name defines the name of the mesh to create
  109279. * @param size sets the size (float) of each box side (default 1)
  109280. * @param scene defines the hosting scene
  109281. * @param updatable defines if the mesh must be flagged as updatable
  109282. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109283. * @returns a new Mesh
  109284. */
  109285. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  109286. /**
  109287. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  109288. * @param name defines the name of the mesh to create
  109289. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  109290. * @param diameter sets the diameter size (float) of the sphere (default 1)
  109291. * @param scene defines the hosting scene
  109292. * @param updatable defines if the mesh must be flagged as updatable
  109293. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109294. * @returns a new Mesh
  109295. */
  109296. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109297. /**
  109298. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  109299. * @param name defines the name of the mesh to create
  109300. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  109301. * @param diameter sets the diameter size (float) of the sphere (default 1)
  109302. * @param scene defines the hosting scene
  109303. * @returns a new Mesh
  109304. */
  109305. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  109306. /**
  109307. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  109308. * @param name defines the name of the mesh to create
  109309. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  109310. * @param diameterTop set the top cap diameter (floats, default 1)
  109311. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  109312. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  109313. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  109314. * @param scene defines the hosting scene
  109315. * @param updatable defines if the mesh must be flagged as updatable
  109316. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109317. * @returns a new Mesh
  109318. */
  109319. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  109320. /**
  109321. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  109322. * @param name defines the name of the mesh to create
  109323. * @param diameter sets the diameter size (float) of the torus (default 1)
  109324. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  109325. * @param tessellation sets the number of torus sides (postive integer, default 16)
  109326. * @param scene defines the hosting scene
  109327. * @param updatable defines if the mesh must be flagged as updatable
  109328. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109329. * @returns a new Mesh
  109330. */
  109331. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109332. /**
  109333. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  109334. * @param name defines the name of the mesh to create
  109335. * @param radius sets the global radius size (float) of the torus knot (default 2)
  109336. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  109337. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  109338. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  109339. * @param p the number of windings on X axis (positive integers, default 2)
  109340. * @param q the number of windings on Y axis (positive integers, default 3)
  109341. * @param scene defines the hosting scene
  109342. * @param updatable defines if the mesh must be flagged as updatable
  109343. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109344. * @returns a new Mesh
  109345. */
  109346. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109347. /**
  109348. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  109349. * @param name defines the name of the mesh to create
  109350. * @param points is an array successive Vector3
  109351. * @param scene defines the hosting scene
  109352. * @param updatable defines if the mesh must be flagged as updatable
  109353. * @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).
  109354. * @returns a new Mesh
  109355. */
  109356. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  109357. /**
  109358. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  109359. * @param name defines the name of the mesh to create
  109360. * @param points is an array successive Vector3
  109361. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  109362. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  109363. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  109364. * @param scene defines the hosting scene
  109365. * @param updatable defines if the mesh must be flagged as updatable
  109366. * @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)
  109367. * @returns a new Mesh
  109368. */
  109369. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  109370. /**
  109371. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  109372. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  109373. * 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.
  109374. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  109375. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109376. * Remember you can only change the shape positions, not their number when updating a polygon.
  109377. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  109378. * @param name defines the name of the mesh to create
  109379. * @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
  109380. * @param scene defines the hosting scene
  109381. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  109382. * @param updatable defines if the mesh must be flagged as updatable
  109383. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109384. * @param earcutInjection can be used to inject your own earcut reference
  109385. * @returns a new Mesh
  109386. */
  109387. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  109388. /**
  109389. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  109390. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  109391. * @param name defines the name of the mesh to create
  109392. * @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
  109393. * @param depth defines the height of extrusion
  109394. * @param scene defines the hosting scene
  109395. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  109396. * @param updatable defines if the mesh must be flagged as updatable
  109397. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109398. * @param earcutInjection can be used to inject your own earcut reference
  109399. * @returns a new Mesh
  109400. */
  109401. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  109402. /**
  109403. * Creates an extruded shape mesh.
  109404. * 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
  109405. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  109406. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  109407. * @param name defines the name of the mesh to create
  109408. * @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
  109409. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  109410. * @param scale is the value to scale the shape
  109411. * @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
  109412. * @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
  109413. * @param scene defines the hosting scene
  109414. * @param updatable defines if the mesh must be flagged as updatable
  109415. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109416. * @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)
  109417. * @returns a new Mesh
  109418. */
  109419. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  109420. /**
  109421. * Creates an custom extruded shape mesh.
  109422. * The custom extrusion is a parametric shape.
  109423. * It has no predefined shape. Its final shape will depend on the input parameters.
  109424. * Please consider using the same method from the MeshBuilder class instead
  109425. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  109426. * @param name defines the name of the mesh to create
  109427. * @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
  109428. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  109429. * @param scaleFunction is a custom Javascript function called on each path point
  109430. * @param rotationFunction is a custom Javascript function called on each path point
  109431. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  109432. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  109433. * @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
  109434. * @param scene defines the hosting scene
  109435. * @param updatable defines if the mesh must be flagged as updatable
  109436. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109437. * @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)
  109438. * @returns a new Mesh
  109439. */
  109440. 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;
  109441. /**
  109442. * Creates lathe mesh.
  109443. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  109444. * Please consider using the same method from the MeshBuilder class instead
  109445. * @param name defines the name of the mesh to create
  109446. * @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
  109447. * @param radius is the radius value of the lathe
  109448. * @param tessellation is the side number of the lathe.
  109449. * @param scene defines the hosting scene
  109450. * @param updatable defines if the mesh must be flagged as updatable
  109451. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109452. * @returns a new Mesh
  109453. */
  109454. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109455. /**
  109456. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  109457. * @param name defines the name of the mesh to create
  109458. * @param size sets the size (float) of both sides of the plane at once (default 1)
  109459. * @param scene defines the hosting scene
  109460. * @param updatable defines if the mesh must be flagged as updatable
  109461. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109462. * @returns a new Mesh
  109463. */
  109464. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109465. /**
  109466. * Creates a ground mesh.
  109467. * Please consider using the same method from the MeshBuilder class instead
  109468. * @param name defines the name of the mesh to create
  109469. * @param width set the width of the ground
  109470. * @param height set the height of the ground
  109471. * @param subdivisions sets the number of subdivisions per side
  109472. * @param scene defines the hosting scene
  109473. * @param updatable defines if the mesh must be flagged as updatable
  109474. * @returns a new Mesh
  109475. */
  109476. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  109477. /**
  109478. * Creates a tiled ground mesh.
  109479. * Please consider using the same method from the MeshBuilder class instead
  109480. * @param name defines the name of the mesh to create
  109481. * @param xmin set the ground minimum X coordinate
  109482. * @param zmin set the ground minimum Y coordinate
  109483. * @param xmax set the ground maximum X coordinate
  109484. * @param zmax set the ground maximum Z coordinate
  109485. * @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
  109486. * @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
  109487. * @param scene defines the hosting scene
  109488. * @param updatable defines if the mesh must be flagged as updatable
  109489. * @returns a new Mesh
  109490. */
  109491. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  109492. w: number;
  109493. h: number;
  109494. }, precision: {
  109495. w: number;
  109496. h: number;
  109497. }, scene: Scene, updatable?: boolean): Mesh;
  109498. /**
  109499. * Creates a ground mesh from a height map.
  109500. * Please consider using the same method from the MeshBuilder class instead
  109501. * @see https://doc.babylonjs.com/babylon101/height_map
  109502. * @param name defines the name of the mesh to create
  109503. * @param url sets the URL of the height map image resource
  109504. * @param width set the ground width size
  109505. * @param height set the ground height size
  109506. * @param subdivisions sets the number of subdivision per side
  109507. * @param minHeight is the minimum altitude on the ground
  109508. * @param maxHeight is the maximum altitude on the ground
  109509. * @param scene defines the hosting scene
  109510. * @param updatable defines if the mesh must be flagged as updatable
  109511. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  109512. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  109513. * @returns a new Mesh
  109514. */
  109515. 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;
  109516. /**
  109517. * Creates a tube mesh.
  109518. * The tube is a parametric shape.
  109519. * It has no predefined shape. Its final shape will depend on the input parameters.
  109520. * Please consider using the same method from the MeshBuilder class instead
  109521. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  109522. * @param name defines the name of the mesh to create
  109523. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  109524. * @param radius sets the tube radius size
  109525. * @param tessellation is the number of sides on the tubular surface
  109526. * @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
  109527. * @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
  109528. * @param scene defines the hosting scene
  109529. * @param updatable defines if the mesh must be flagged as updatable
  109530. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109531. * @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)
  109532. * @returns a new Mesh
  109533. */
  109534. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  109535. (i: number, distance: number): number;
  109536. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  109537. /**
  109538. * Creates a polyhedron mesh.
  109539. * Please consider using the same method from the MeshBuilder class instead.
  109540. * * 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
  109541. * * The parameter `size` (positive float, default 1) sets the polygon size
  109542. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  109543. * * 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`
  109544. * * 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
  109545. * * 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)`)
  109546. * * 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
  109547. * * 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
  109548. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  109549. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109550. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109551. * @param name defines the name of the mesh to create
  109552. * @param options defines the options used to create the mesh
  109553. * @param scene defines the hosting scene
  109554. * @returns a new Mesh
  109555. */
  109556. static CreatePolyhedron(name: string, options: {
  109557. type?: number;
  109558. size?: number;
  109559. sizeX?: number;
  109560. sizeY?: number;
  109561. sizeZ?: number;
  109562. custom?: any;
  109563. faceUV?: Vector4[];
  109564. faceColors?: Color4[];
  109565. updatable?: boolean;
  109566. sideOrientation?: number;
  109567. }, scene: Scene): Mesh;
  109568. /**
  109569. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  109570. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  109571. * * 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`)
  109572. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  109573. * * 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
  109574. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  109575. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109576. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109577. * @param name defines the name of the mesh
  109578. * @param options defines the options used to create the mesh
  109579. * @param scene defines the hosting scene
  109580. * @returns a new Mesh
  109581. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  109582. */
  109583. static CreateIcoSphere(name: string, options: {
  109584. radius?: number;
  109585. flat?: boolean;
  109586. subdivisions?: number;
  109587. sideOrientation?: number;
  109588. updatable?: boolean;
  109589. }, scene: Scene): Mesh;
  109590. /**
  109591. * Creates a decal mesh.
  109592. * Please consider using the same method from the MeshBuilder class instead.
  109593. * A decal is a mesh usually applied as a model onto the surface of another mesh
  109594. * @param name defines the name of the mesh
  109595. * @param sourceMesh defines the mesh receiving the decal
  109596. * @param position sets the position of the decal in world coordinates
  109597. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  109598. * @param size sets the decal scaling
  109599. * @param angle sets the angle to rotate the decal
  109600. * @returns a new Mesh
  109601. */
  109602. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  109603. /** Creates a Capsule Mesh
  109604. * @param name defines the name of the mesh.
  109605. * @param options the constructors options used to shape the mesh.
  109606. * @param scene defines the scene the mesh is scoped to.
  109607. * @returns the capsule mesh
  109608. * @see https://doc.babylonjs.com/how_to/capsule_shape
  109609. */
  109610. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  109611. /**
  109612. * Prepare internal position array for software CPU skinning
  109613. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  109614. */
  109615. setPositionsForCPUSkinning(): Float32Array;
  109616. /**
  109617. * Prepare internal normal array for software CPU skinning
  109618. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  109619. */
  109620. setNormalsForCPUSkinning(): Float32Array;
  109621. /**
  109622. * Updates the vertex buffer by applying transformation from the bones
  109623. * @param skeleton defines the skeleton to apply to current mesh
  109624. * @returns the current mesh
  109625. */
  109626. applySkeleton(skeleton: Skeleton): Mesh;
  109627. /**
  109628. * 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
  109629. * @param meshes defines the list of meshes to scan
  109630. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  109631. */
  109632. static MinMax(meshes: AbstractMesh[]): {
  109633. min: Vector3;
  109634. max: Vector3;
  109635. };
  109636. /**
  109637. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  109638. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  109639. * @returns a vector3
  109640. */
  109641. static Center(meshesOrMinMaxVector: {
  109642. min: Vector3;
  109643. max: Vector3;
  109644. } | AbstractMesh[]): Vector3;
  109645. /**
  109646. * Merge the array of meshes into a single mesh for performance reasons.
  109647. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  109648. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  109649. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  109650. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  109651. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  109652. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  109653. * @returns a new mesh
  109654. */
  109655. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  109656. /** @hidden */
  109657. addInstance(instance: InstancedMesh): void;
  109658. /** @hidden */
  109659. removeInstance(instance: InstancedMesh): void;
  109660. }
  109661. }
  109662. declare module BABYLON {
  109663. /**
  109664. * This is the base class of all the camera used in the application.
  109665. * @see https://doc.babylonjs.com/features/cameras
  109666. */
  109667. export class Camera extends Node {
  109668. /** @hidden */
  109669. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  109670. /**
  109671. * This is the default projection mode used by the cameras.
  109672. * It helps recreating a feeling of perspective and better appreciate depth.
  109673. * This is the best way to simulate real life cameras.
  109674. */
  109675. static readonly PERSPECTIVE_CAMERA: number;
  109676. /**
  109677. * This helps creating camera with an orthographic mode.
  109678. * 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.
  109679. */
  109680. static readonly ORTHOGRAPHIC_CAMERA: number;
  109681. /**
  109682. * This is the default FOV mode for perspective cameras.
  109683. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  109684. */
  109685. static readonly FOVMODE_VERTICAL_FIXED: number;
  109686. /**
  109687. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  109688. */
  109689. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  109690. /**
  109691. * This specifies ther is no need for a camera rig.
  109692. * Basically only one eye is rendered corresponding to the camera.
  109693. */
  109694. static readonly RIG_MODE_NONE: number;
  109695. /**
  109696. * Simulates a camera Rig with one blue eye and one red eye.
  109697. * This can be use with 3d blue and red glasses.
  109698. */
  109699. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  109700. /**
  109701. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  109702. */
  109703. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  109704. /**
  109705. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  109706. */
  109707. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  109708. /**
  109709. * Defines that both eyes of the camera will be rendered over under each other.
  109710. */
  109711. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109712. /**
  109713. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109714. */
  109715. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109716. /**
  109717. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109718. */
  109719. static readonly RIG_MODE_VR: number;
  109720. /**
  109721. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109722. */
  109723. static readonly RIG_MODE_WEBVR: number;
  109724. /**
  109725. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109726. */
  109727. static readonly RIG_MODE_CUSTOM: number;
  109728. /**
  109729. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109730. */
  109731. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109732. /**
  109733. * Define the input manager associated with the camera.
  109734. */
  109735. inputs: CameraInputsManager<Camera>;
  109736. /** @hidden */
  109737. _position: Vector3;
  109738. /**
  109739. * Define the current local position of the camera in the scene
  109740. */
  109741. get position(): Vector3;
  109742. set position(newPosition: Vector3);
  109743. protected _upVector: Vector3;
  109744. /**
  109745. * The vector the camera should consider as up.
  109746. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109747. */
  109748. set upVector(vec: Vector3);
  109749. get upVector(): Vector3;
  109750. /**
  109751. * Define the current limit on the left side for an orthographic camera
  109752. * In scene unit
  109753. */
  109754. orthoLeft: Nullable<number>;
  109755. /**
  109756. * Define the current limit on the right side for an orthographic camera
  109757. * In scene unit
  109758. */
  109759. orthoRight: Nullable<number>;
  109760. /**
  109761. * Define the current limit on the bottom side for an orthographic camera
  109762. * In scene unit
  109763. */
  109764. orthoBottom: Nullable<number>;
  109765. /**
  109766. * Define the current limit on the top side for an orthographic camera
  109767. * In scene unit
  109768. */
  109769. orthoTop: Nullable<number>;
  109770. /**
  109771. * Field Of View is set in Radians. (default is 0.8)
  109772. */
  109773. fov: number;
  109774. /**
  109775. * Define the minimum distance the camera can see from.
  109776. * This is important to note that the depth buffer are not infinite and the closer it starts
  109777. * the more your scene might encounter depth fighting issue.
  109778. */
  109779. minZ: number;
  109780. /**
  109781. * Define the maximum distance the camera can see to.
  109782. * This is important to note that the depth buffer are not infinite and the further it end
  109783. * the more your scene might encounter depth fighting issue.
  109784. */
  109785. maxZ: number;
  109786. /**
  109787. * Define the default inertia of the camera.
  109788. * This helps giving a smooth feeling to the camera movement.
  109789. */
  109790. inertia: number;
  109791. /**
  109792. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109793. */
  109794. mode: number;
  109795. /**
  109796. * Define whether the camera is intermediate.
  109797. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109798. */
  109799. isIntermediate: boolean;
  109800. /**
  109801. * Define the viewport of the camera.
  109802. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109803. */
  109804. viewport: Viewport;
  109805. /**
  109806. * Restricts the camera to viewing objects with the same layerMask.
  109807. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109808. */
  109809. layerMask: number;
  109810. /**
  109811. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109812. */
  109813. fovMode: number;
  109814. /**
  109815. * Rig mode of the camera.
  109816. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109817. * This is normally controlled byt the camera themselves as internal use.
  109818. */
  109819. cameraRigMode: number;
  109820. /**
  109821. * Defines the distance between both "eyes" in case of a RIG
  109822. */
  109823. interaxialDistance: number;
  109824. /**
  109825. * Defines if stereoscopic rendering is done side by side or over under.
  109826. */
  109827. isStereoscopicSideBySide: boolean;
  109828. /**
  109829. * 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
  109830. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109831. * else in the scene. (Eg. security camera)
  109832. *
  109833. * 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)
  109834. */
  109835. customRenderTargets: RenderTargetTexture[];
  109836. /**
  109837. * When set, the camera will render to this render target instead of the default canvas
  109838. *
  109839. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109840. */
  109841. outputRenderTarget: Nullable<RenderTargetTexture>;
  109842. /**
  109843. * Observable triggered when the camera view matrix has changed.
  109844. */
  109845. onViewMatrixChangedObservable: Observable<Camera>;
  109846. /**
  109847. * Observable triggered when the camera Projection matrix has changed.
  109848. */
  109849. onProjectionMatrixChangedObservable: Observable<Camera>;
  109850. /**
  109851. * Observable triggered when the inputs have been processed.
  109852. */
  109853. onAfterCheckInputsObservable: Observable<Camera>;
  109854. /**
  109855. * Observable triggered when reset has been called and applied to the camera.
  109856. */
  109857. onRestoreStateObservable: Observable<Camera>;
  109858. /**
  109859. * Is this camera a part of a rig system?
  109860. */
  109861. isRigCamera: boolean;
  109862. /**
  109863. * If isRigCamera set to true this will be set with the parent camera.
  109864. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109865. */
  109866. rigParent?: Camera;
  109867. /** @hidden */
  109868. _cameraRigParams: any;
  109869. /** @hidden */
  109870. _rigCameras: Camera[];
  109871. /** @hidden */
  109872. _rigPostProcess: Nullable<PostProcess>;
  109873. protected _webvrViewMatrix: Matrix;
  109874. /** @hidden */
  109875. _skipRendering: boolean;
  109876. /** @hidden */
  109877. _projectionMatrix: Matrix;
  109878. /** @hidden */
  109879. _postProcesses: Nullable<PostProcess>[];
  109880. /** @hidden */
  109881. _activeMeshes: SmartArray<AbstractMesh>;
  109882. protected _globalPosition: Vector3;
  109883. /** @hidden */
  109884. _computedViewMatrix: Matrix;
  109885. private _doNotComputeProjectionMatrix;
  109886. private _transformMatrix;
  109887. private _frustumPlanes;
  109888. private _refreshFrustumPlanes;
  109889. private _storedFov;
  109890. private _stateStored;
  109891. /**
  109892. * Instantiates a new camera object.
  109893. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109894. * @see https://doc.babylonjs.com/features/cameras
  109895. * @param name Defines the name of the camera in the scene
  109896. * @param position Defines the position of the camera
  109897. * @param scene Defines the scene the camera belongs too
  109898. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109899. */
  109900. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109901. /**
  109902. * Store current camera state (fov, position, etc..)
  109903. * @returns the camera
  109904. */
  109905. storeState(): Camera;
  109906. /**
  109907. * Restores the camera state values if it has been stored. You must call storeState() first
  109908. */
  109909. protected _restoreStateValues(): boolean;
  109910. /**
  109911. * Restored camera state. You must call storeState() first.
  109912. * @returns true if restored and false otherwise
  109913. */
  109914. restoreState(): boolean;
  109915. /**
  109916. * Gets the class name of the camera.
  109917. * @returns the class name
  109918. */
  109919. getClassName(): string;
  109920. /** @hidden */
  109921. readonly _isCamera: boolean;
  109922. /**
  109923. * Gets a string representation of the camera useful for debug purpose.
  109924. * @param fullDetails Defines that a more verboe level of logging is required
  109925. * @returns the string representation
  109926. */
  109927. toString(fullDetails?: boolean): string;
  109928. /**
  109929. * Gets the current world space position of the camera.
  109930. */
  109931. get globalPosition(): Vector3;
  109932. /**
  109933. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109934. * @returns the active meshe list
  109935. */
  109936. getActiveMeshes(): SmartArray<AbstractMesh>;
  109937. /**
  109938. * Check whether a mesh is part of the current active mesh list of the camera
  109939. * @param mesh Defines the mesh to check
  109940. * @returns true if active, false otherwise
  109941. */
  109942. isActiveMesh(mesh: Mesh): boolean;
  109943. /**
  109944. * Is this camera ready to be used/rendered
  109945. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109946. * @return true if the camera is ready
  109947. */
  109948. isReady(completeCheck?: boolean): boolean;
  109949. /** @hidden */
  109950. _initCache(): void;
  109951. /** @hidden */
  109952. _updateCache(ignoreParentClass?: boolean): void;
  109953. /** @hidden */
  109954. _isSynchronized(): boolean;
  109955. /** @hidden */
  109956. _isSynchronizedViewMatrix(): boolean;
  109957. /** @hidden */
  109958. _isSynchronizedProjectionMatrix(): boolean;
  109959. /**
  109960. * Attach the input controls to a specific dom element to get the input from.
  109961. * @param element Defines the element the controls should be listened from
  109962. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109963. */
  109964. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109965. /**
  109966. * Detach the current controls from the specified dom element.
  109967. * @param element Defines the element to stop listening the inputs from
  109968. */
  109969. detachControl(element: HTMLElement): void;
  109970. /**
  109971. * Update the camera state according to the different inputs gathered during the frame.
  109972. */
  109973. update(): void;
  109974. /** @hidden */
  109975. _checkInputs(): void;
  109976. /** @hidden */
  109977. get rigCameras(): Camera[];
  109978. /**
  109979. * Gets the post process used by the rig cameras
  109980. */
  109981. get rigPostProcess(): Nullable<PostProcess>;
  109982. /**
  109983. * Internal, gets the first post proces.
  109984. * @returns the first post process to be run on this camera.
  109985. */
  109986. _getFirstPostProcess(): Nullable<PostProcess>;
  109987. private _cascadePostProcessesToRigCams;
  109988. /**
  109989. * Attach a post process to the camera.
  109990. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109991. * @param postProcess The post process to attach to the camera
  109992. * @param insertAt The position of the post process in case several of them are in use in the scene
  109993. * @returns the position the post process has been inserted at
  109994. */
  109995. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109996. /**
  109997. * Detach a post process to the camera.
  109998. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109999. * @param postProcess The post process to detach from the camera
  110000. */
  110001. detachPostProcess(postProcess: PostProcess): void;
  110002. /**
  110003. * Gets the current world matrix of the camera
  110004. */
  110005. getWorldMatrix(): Matrix;
  110006. /** @hidden */
  110007. _getViewMatrix(): Matrix;
  110008. /**
  110009. * Gets the current view matrix of the camera.
  110010. * @param force forces the camera to recompute the matrix without looking at the cached state
  110011. * @returns the view matrix
  110012. */
  110013. getViewMatrix(force?: boolean): Matrix;
  110014. /**
  110015. * Freeze the projection matrix.
  110016. * It will prevent the cache check of the camera projection compute and can speed up perf
  110017. * if no parameter of the camera are meant to change
  110018. * @param projection Defines manually a projection if necessary
  110019. */
  110020. freezeProjectionMatrix(projection?: Matrix): void;
  110021. /**
  110022. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  110023. */
  110024. unfreezeProjectionMatrix(): void;
  110025. /**
  110026. * Gets the current projection matrix of the camera.
  110027. * @param force forces the camera to recompute the matrix without looking at the cached state
  110028. * @returns the projection matrix
  110029. */
  110030. getProjectionMatrix(force?: boolean): Matrix;
  110031. /**
  110032. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  110033. * @returns a Matrix
  110034. */
  110035. getTransformationMatrix(): Matrix;
  110036. private _updateFrustumPlanes;
  110037. /**
  110038. * Checks if a cullable object (mesh...) is in the camera frustum
  110039. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  110040. * @param target The object to check
  110041. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  110042. * @returns true if the object is in frustum otherwise false
  110043. */
  110044. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  110045. /**
  110046. * Checks if a cullable object (mesh...) is in the camera frustum
  110047. * Unlike isInFrustum this cheks the full bounding box
  110048. * @param target The object to check
  110049. * @returns true if the object is in frustum otherwise false
  110050. */
  110051. isCompletelyInFrustum(target: ICullable): boolean;
  110052. /**
  110053. * Gets a ray in the forward direction from the camera.
  110054. * @param length Defines the length of the ray to create
  110055. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  110056. * @param origin Defines the start point of the ray which defaults to the camera position
  110057. * @returns the forward ray
  110058. */
  110059. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  110060. /**
  110061. * Gets a ray in the forward direction from the camera.
  110062. * @param refRay the ray to (re)use when setting the values
  110063. * @param length Defines the length of the ray to create
  110064. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  110065. * @param origin Defines the start point of the ray which defaults to the camera position
  110066. * @returns the forward ray
  110067. */
  110068. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  110069. /**
  110070. * Releases resources associated with this node.
  110071. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  110072. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  110073. */
  110074. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  110075. /** @hidden */
  110076. _isLeftCamera: boolean;
  110077. /**
  110078. * Gets the left camera of a rig setup in case of Rigged Camera
  110079. */
  110080. get isLeftCamera(): boolean;
  110081. /** @hidden */
  110082. _isRightCamera: boolean;
  110083. /**
  110084. * Gets the right camera of a rig setup in case of Rigged Camera
  110085. */
  110086. get isRightCamera(): boolean;
  110087. /**
  110088. * Gets the left camera of a rig setup in case of Rigged Camera
  110089. */
  110090. get leftCamera(): Nullable<FreeCamera>;
  110091. /**
  110092. * Gets the right camera of a rig setup in case of Rigged Camera
  110093. */
  110094. get rightCamera(): Nullable<FreeCamera>;
  110095. /**
  110096. * Gets the left camera target of a rig setup in case of Rigged Camera
  110097. * @returns the target position
  110098. */
  110099. getLeftTarget(): Nullable<Vector3>;
  110100. /**
  110101. * Gets the right camera target of a rig setup in case of Rigged Camera
  110102. * @returns the target position
  110103. */
  110104. getRightTarget(): Nullable<Vector3>;
  110105. /**
  110106. * @hidden
  110107. */
  110108. setCameraRigMode(mode: number, rigParams: any): void;
  110109. /** @hidden */
  110110. static _setStereoscopicRigMode(camera: Camera): void;
  110111. /** @hidden */
  110112. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  110113. /** @hidden */
  110114. static _setVRRigMode(camera: Camera, rigParams: any): void;
  110115. /** @hidden */
  110116. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  110117. /** @hidden */
  110118. _getVRProjectionMatrix(): Matrix;
  110119. protected _updateCameraRotationMatrix(): void;
  110120. protected _updateWebVRCameraRotationMatrix(): void;
  110121. /**
  110122. * This function MUST be overwritten by the different WebVR cameras available.
  110123. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  110124. * @hidden
  110125. */
  110126. _getWebVRProjectionMatrix(): Matrix;
  110127. /**
  110128. * This function MUST be overwritten by the different WebVR cameras available.
  110129. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  110130. * @hidden
  110131. */
  110132. _getWebVRViewMatrix(): Matrix;
  110133. /** @hidden */
  110134. setCameraRigParameter(name: string, value: any): void;
  110135. /**
  110136. * needs to be overridden by children so sub has required properties to be copied
  110137. * @hidden
  110138. */
  110139. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  110140. /**
  110141. * May need to be overridden by children
  110142. * @hidden
  110143. */
  110144. _updateRigCameras(): void;
  110145. /** @hidden */
  110146. _setupInputs(): void;
  110147. /**
  110148. * Serialiaze the camera setup to a json represention
  110149. * @returns the JSON representation
  110150. */
  110151. serialize(): any;
  110152. /**
  110153. * Clones the current camera.
  110154. * @param name The cloned camera name
  110155. * @returns the cloned camera
  110156. */
  110157. clone(name: string): Camera;
  110158. /**
  110159. * Gets the direction of the camera relative to a given local axis.
  110160. * @param localAxis Defines the reference axis to provide a relative direction.
  110161. * @return the direction
  110162. */
  110163. getDirection(localAxis: Vector3): Vector3;
  110164. /**
  110165. * Returns the current camera absolute rotation
  110166. */
  110167. get absoluteRotation(): Quaternion;
  110168. /**
  110169. * Gets the direction of the camera relative to a given local axis into a passed vector.
  110170. * @param localAxis Defines the reference axis to provide a relative direction.
  110171. * @param result Defines the vector to store the result in
  110172. */
  110173. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  110174. /**
  110175. * Gets a camera constructor for a given camera type
  110176. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  110177. * @param name The name of the camera the result will be able to instantiate
  110178. * @param scene The scene the result will construct the camera in
  110179. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  110180. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  110181. * @returns a factory method to construc the camera
  110182. */
  110183. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  110184. /**
  110185. * Compute the world matrix of the camera.
  110186. * @returns the camera world matrix
  110187. */
  110188. computeWorldMatrix(): Matrix;
  110189. /**
  110190. * Parse a JSON and creates the camera from the parsed information
  110191. * @param parsedCamera The JSON to parse
  110192. * @param scene The scene to instantiate the camera in
  110193. * @returns the newly constructed camera
  110194. */
  110195. static Parse(parsedCamera: any, scene: Scene): Camera;
  110196. }
  110197. }
  110198. declare module BABYLON {
  110199. /**
  110200. * Class containing static functions to help procedurally build meshes
  110201. */
  110202. export class DiscBuilder {
  110203. /**
  110204. * Creates a plane polygonal mesh. By default, this is a disc
  110205. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  110206. * * 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
  110207. * * 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
  110208. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  110209. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  110210. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  110211. * @param name defines the name of the mesh
  110212. * @param options defines the options used to create the mesh
  110213. * @param scene defines the hosting scene
  110214. * @returns the plane polygonal mesh
  110215. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  110216. */
  110217. static CreateDisc(name: string, options: {
  110218. radius?: number;
  110219. tessellation?: number;
  110220. arc?: number;
  110221. updatable?: boolean;
  110222. sideOrientation?: number;
  110223. frontUVs?: Vector4;
  110224. backUVs?: Vector4;
  110225. }, scene?: Nullable<Scene>): Mesh;
  110226. }
  110227. }
  110228. declare module BABYLON {
  110229. /**
  110230. * Options to be used when creating a FresnelParameters.
  110231. */
  110232. export type IFresnelParametersCreationOptions = {
  110233. /**
  110234. * Define the color used on edges (grazing angle)
  110235. */
  110236. leftColor?: Color3;
  110237. /**
  110238. * Define the color used on center
  110239. */
  110240. rightColor?: Color3;
  110241. /**
  110242. * Define bias applied to computed fresnel term
  110243. */
  110244. bias?: number;
  110245. /**
  110246. * Defined the power exponent applied to fresnel term
  110247. */
  110248. power?: number;
  110249. /**
  110250. * Define if the fresnel effect is enable or not.
  110251. */
  110252. isEnabled?: boolean;
  110253. };
  110254. /**
  110255. * Serialized format for FresnelParameters.
  110256. */
  110257. export type IFresnelParametersSerialized = {
  110258. /**
  110259. * Define the color used on edges (grazing angle) [as an array]
  110260. */
  110261. leftColor: number[];
  110262. /**
  110263. * Define the color used on center [as an array]
  110264. */
  110265. rightColor: number[];
  110266. /**
  110267. * Define bias applied to computed fresnel term
  110268. */
  110269. bias: number;
  110270. /**
  110271. * Defined the power exponent applied to fresnel term
  110272. */
  110273. power?: number;
  110274. /**
  110275. * Define if the fresnel effect is enable or not.
  110276. */
  110277. isEnabled: boolean;
  110278. };
  110279. /**
  110280. * This represents all the required information to add a fresnel effect on a material:
  110281. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110282. */
  110283. export class FresnelParameters {
  110284. private _isEnabled;
  110285. /**
  110286. * Define if the fresnel effect is enable or not.
  110287. */
  110288. get isEnabled(): boolean;
  110289. set isEnabled(value: boolean);
  110290. /**
  110291. * Define the color used on edges (grazing angle)
  110292. */
  110293. leftColor: Color3;
  110294. /**
  110295. * Define the color used on center
  110296. */
  110297. rightColor: Color3;
  110298. /**
  110299. * Define bias applied to computed fresnel term
  110300. */
  110301. bias: number;
  110302. /**
  110303. * Defined the power exponent applied to fresnel term
  110304. */
  110305. power: number;
  110306. /**
  110307. * Creates a new FresnelParameters object.
  110308. *
  110309. * @param options provide your own settings to optionally to override defaults
  110310. */
  110311. constructor(options?: IFresnelParametersCreationOptions);
  110312. /**
  110313. * Clones the current fresnel and its valuues
  110314. * @returns a clone fresnel configuration
  110315. */
  110316. clone(): FresnelParameters;
  110317. /**
  110318. * Determines equality between FresnelParameters objects
  110319. * @param otherFresnelParameters defines the second operand
  110320. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  110321. */
  110322. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  110323. /**
  110324. * Serializes the current fresnel parameters to a JSON representation.
  110325. * @return the JSON serialization
  110326. */
  110327. serialize(): IFresnelParametersSerialized;
  110328. /**
  110329. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  110330. * @param parsedFresnelParameters Define the JSON representation
  110331. * @returns the parsed parameters
  110332. */
  110333. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  110334. }
  110335. }
  110336. declare module BABYLON {
  110337. /**
  110338. * This groups all the flags used to control the materials channel.
  110339. */
  110340. export class MaterialFlags {
  110341. private static _DiffuseTextureEnabled;
  110342. /**
  110343. * Are diffuse textures enabled in the application.
  110344. */
  110345. static get DiffuseTextureEnabled(): boolean;
  110346. static set DiffuseTextureEnabled(value: boolean);
  110347. private static _DetailTextureEnabled;
  110348. /**
  110349. * Are detail textures enabled in the application.
  110350. */
  110351. static get DetailTextureEnabled(): boolean;
  110352. static set DetailTextureEnabled(value: boolean);
  110353. private static _AmbientTextureEnabled;
  110354. /**
  110355. * Are ambient textures enabled in the application.
  110356. */
  110357. static get AmbientTextureEnabled(): boolean;
  110358. static set AmbientTextureEnabled(value: boolean);
  110359. private static _OpacityTextureEnabled;
  110360. /**
  110361. * Are opacity textures enabled in the application.
  110362. */
  110363. static get OpacityTextureEnabled(): boolean;
  110364. static set OpacityTextureEnabled(value: boolean);
  110365. private static _ReflectionTextureEnabled;
  110366. /**
  110367. * Are reflection textures enabled in the application.
  110368. */
  110369. static get ReflectionTextureEnabled(): boolean;
  110370. static set ReflectionTextureEnabled(value: boolean);
  110371. private static _EmissiveTextureEnabled;
  110372. /**
  110373. * Are emissive textures enabled in the application.
  110374. */
  110375. static get EmissiveTextureEnabled(): boolean;
  110376. static set EmissiveTextureEnabled(value: boolean);
  110377. private static _SpecularTextureEnabled;
  110378. /**
  110379. * Are specular textures enabled in the application.
  110380. */
  110381. static get SpecularTextureEnabled(): boolean;
  110382. static set SpecularTextureEnabled(value: boolean);
  110383. private static _BumpTextureEnabled;
  110384. /**
  110385. * Are bump textures enabled in the application.
  110386. */
  110387. static get BumpTextureEnabled(): boolean;
  110388. static set BumpTextureEnabled(value: boolean);
  110389. private static _LightmapTextureEnabled;
  110390. /**
  110391. * Are lightmap textures enabled in the application.
  110392. */
  110393. static get LightmapTextureEnabled(): boolean;
  110394. static set LightmapTextureEnabled(value: boolean);
  110395. private static _RefractionTextureEnabled;
  110396. /**
  110397. * Are refraction textures enabled in the application.
  110398. */
  110399. static get RefractionTextureEnabled(): boolean;
  110400. static set RefractionTextureEnabled(value: boolean);
  110401. private static _ColorGradingTextureEnabled;
  110402. /**
  110403. * Are color grading textures enabled in the application.
  110404. */
  110405. static get ColorGradingTextureEnabled(): boolean;
  110406. static set ColorGradingTextureEnabled(value: boolean);
  110407. private static _FresnelEnabled;
  110408. /**
  110409. * Are fresnels enabled in the application.
  110410. */
  110411. static get FresnelEnabled(): boolean;
  110412. static set FresnelEnabled(value: boolean);
  110413. private static _ClearCoatTextureEnabled;
  110414. /**
  110415. * Are clear coat textures enabled in the application.
  110416. */
  110417. static get ClearCoatTextureEnabled(): boolean;
  110418. static set ClearCoatTextureEnabled(value: boolean);
  110419. private static _ClearCoatBumpTextureEnabled;
  110420. /**
  110421. * Are clear coat bump textures enabled in the application.
  110422. */
  110423. static get ClearCoatBumpTextureEnabled(): boolean;
  110424. static set ClearCoatBumpTextureEnabled(value: boolean);
  110425. private static _ClearCoatTintTextureEnabled;
  110426. /**
  110427. * Are clear coat tint textures enabled in the application.
  110428. */
  110429. static get ClearCoatTintTextureEnabled(): boolean;
  110430. static set ClearCoatTintTextureEnabled(value: boolean);
  110431. private static _SheenTextureEnabled;
  110432. /**
  110433. * Are sheen textures enabled in the application.
  110434. */
  110435. static get SheenTextureEnabled(): boolean;
  110436. static set SheenTextureEnabled(value: boolean);
  110437. private static _AnisotropicTextureEnabled;
  110438. /**
  110439. * Are anisotropic textures enabled in the application.
  110440. */
  110441. static get AnisotropicTextureEnabled(): boolean;
  110442. static set AnisotropicTextureEnabled(value: boolean);
  110443. private static _ThicknessTextureEnabled;
  110444. /**
  110445. * Are thickness textures enabled in the application.
  110446. */
  110447. static get ThicknessTextureEnabled(): boolean;
  110448. static set ThicknessTextureEnabled(value: boolean);
  110449. }
  110450. }
  110451. declare module BABYLON {
  110452. /** @hidden */
  110453. export var defaultFragmentDeclaration: {
  110454. name: string;
  110455. shader: string;
  110456. };
  110457. }
  110458. declare module BABYLON {
  110459. /** @hidden */
  110460. export var defaultUboDeclaration: {
  110461. name: string;
  110462. shader: string;
  110463. };
  110464. }
  110465. declare module BABYLON {
  110466. /** @hidden */
  110467. export var prePassDeclaration: {
  110468. name: string;
  110469. shader: string;
  110470. };
  110471. }
  110472. declare module BABYLON {
  110473. /** @hidden */
  110474. export var lightFragmentDeclaration: {
  110475. name: string;
  110476. shader: string;
  110477. };
  110478. }
  110479. declare module BABYLON {
  110480. /** @hidden */
  110481. export var lightUboDeclaration: {
  110482. name: string;
  110483. shader: string;
  110484. };
  110485. }
  110486. declare module BABYLON {
  110487. /** @hidden */
  110488. export var lightsFragmentFunctions: {
  110489. name: string;
  110490. shader: string;
  110491. };
  110492. }
  110493. declare module BABYLON {
  110494. /** @hidden */
  110495. export var shadowsFragmentFunctions: {
  110496. name: string;
  110497. shader: string;
  110498. };
  110499. }
  110500. declare module BABYLON {
  110501. /** @hidden */
  110502. export var fresnelFunction: {
  110503. name: string;
  110504. shader: string;
  110505. };
  110506. }
  110507. declare module BABYLON {
  110508. /** @hidden */
  110509. export var bumpFragmentMainFunctions: {
  110510. name: string;
  110511. shader: string;
  110512. };
  110513. }
  110514. declare module BABYLON {
  110515. /** @hidden */
  110516. export var bumpFragmentFunctions: {
  110517. name: string;
  110518. shader: string;
  110519. };
  110520. }
  110521. declare module BABYLON {
  110522. /** @hidden */
  110523. export var logDepthDeclaration: {
  110524. name: string;
  110525. shader: string;
  110526. };
  110527. }
  110528. declare module BABYLON {
  110529. /** @hidden */
  110530. export var bumpFragment: {
  110531. name: string;
  110532. shader: string;
  110533. };
  110534. }
  110535. declare module BABYLON {
  110536. /** @hidden */
  110537. export var depthPrePass: {
  110538. name: string;
  110539. shader: string;
  110540. };
  110541. }
  110542. declare module BABYLON {
  110543. /** @hidden */
  110544. export var lightFragment: {
  110545. name: string;
  110546. shader: string;
  110547. };
  110548. }
  110549. declare module BABYLON {
  110550. /** @hidden */
  110551. export var logDepthFragment: {
  110552. name: string;
  110553. shader: string;
  110554. };
  110555. }
  110556. declare module BABYLON {
  110557. /** @hidden */
  110558. export var defaultPixelShader: {
  110559. name: string;
  110560. shader: string;
  110561. };
  110562. }
  110563. declare module BABYLON {
  110564. /** @hidden */
  110565. export var defaultVertexDeclaration: {
  110566. name: string;
  110567. shader: string;
  110568. };
  110569. }
  110570. declare module BABYLON {
  110571. /** @hidden */
  110572. export var bumpVertexDeclaration: {
  110573. name: string;
  110574. shader: string;
  110575. };
  110576. }
  110577. declare module BABYLON {
  110578. /** @hidden */
  110579. export var bumpVertex: {
  110580. name: string;
  110581. shader: string;
  110582. };
  110583. }
  110584. declare module BABYLON {
  110585. /** @hidden */
  110586. export var fogVertex: {
  110587. name: string;
  110588. shader: string;
  110589. };
  110590. }
  110591. declare module BABYLON {
  110592. /** @hidden */
  110593. export var shadowsVertex: {
  110594. name: string;
  110595. shader: string;
  110596. };
  110597. }
  110598. declare module BABYLON {
  110599. /** @hidden */
  110600. export var pointCloudVertex: {
  110601. name: string;
  110602. shader: string;
  110603. };
  110604. }
  110605. declare module BABYLON {
  110606. /** @hidden */
  110607. export var logDepthVertex: {
  110608. name: string;
  110609. shader: string;
  110610. };
  110611. }
  110612. declare module BABYLON {
  110613. /** @hidden */
  110614. export var defaultVertexShader: {
  110615. name: string;
  110616. shader: string;
  110617. };
  110618. }
  110619. declare module BABYLON {
  110620. /**
  110621. * @hidden
  110622. */
  110623. export interface IMaterialDetailMapDefines {
  110624. DETAIL: boolean;
  110625. DETAILDIRECTUV: number;
  110626. DETAIL_NORMALBLENDMETHOD: number;
  110627. /** @hidden */
  110628. _areTexturesDirty: boolean;
  110629. }
  110630. /**
  110631. * Define the code related to the detail map parameters of a material
  110632. *
  110633. * Inspired from:
  110634. * 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
  110635. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  110636. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  110637. */
  110638. export class DetailMapConfiguration {
  110639. private _texture;
  110640. /**
  110641. * The detail texture of the material.
  110642. */
  110643. texture: Nullable<BaseTexture>;
  110644. /**
  110645. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  110646. * Bigger values mean stronger blending
  110647. */
  110648. diffuseBlendLevel: number;
  110649. /**
  110650. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  110651. * Bigger values mean stronger blending. Only used with PBR materials
  110652. */
  110653. roughnessBlendLevel: number;
  110654. /**
  110655. * Defines how strong the bump effect from the detail map is
  110656. * Bigger values mean stronger effect
  110657. */
  110658. bumpLevel: number;
  110659. private _normalBlendMethod;
  110660. /**
  110661. * The method used to blend the bump and detail normals together
  110662. */
  110663. normalBlendMethod: number;
  110664. private _isEnabled;
  110665. /**
  110666. * Enable or disable the detail map on this material
  110667. */
  110668. isEnabled: boolean;
  110669. /** @hidden */
  110670. private _internalMarkAllSubMeshesAsTexturesDirty;
  110671. /** @hidden */
  110672. _markAllSubMeshesAsTexturesDirty(): void;
  110673. /**
  110674. * Instantiate a new detail map
  110675. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  110676. */
  110677. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  110678. /**
  110679. * Gets whether the submesh is ready to be used or not.
  110680. * @param defines the list of "defines" to update.
  110681. * @param scene defines the scene the material belongs to.
  110682. * @returns - boolean indicating that the submesh is ready or not.
  110683. */
  110684. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  110685. /**
  110686. * Update the defines for detail map usage
  110687. * @param defines the list of "defines" to update.
  110688. * @param scene defines the scene the material belongs to.
  110689. */
  110690. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  110691. /**
  110692. * Binds the material data.
  110693. * @param uniformBuffer defines the Uniform buffer to fill in.
  110694. * @param scene defines the scene the material belongs to.
  110695. * @param isFrozen defines whether the material is frozen or not.
  110696. */
  110697. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  110698. /**
  110699. * Checks to see if a texture is used in the material.
  110700. * @param texture - Base texture to use.
  110701. * @returns - Boolean specifying if a texture is used in the material.
  110702. */
  110703. hasTexture(texture: BaseTexture): boolean;
  110704. /**
  110705. * Returns an array of the actively used textures.
  110706. * @param activeTextures Array of BaseTextures
  110707. */
  110708. getActiveTextures(activeTextures: BaseTexture[]): void;
  110709. /**
  110710. * Returns the animatable textures.
  110711. * @param animatables Array of animatable textures.
  110712. */
  110713. getAnimatables(animatables: IAnimatable[]): void;
  110714. /**
  110715. * Disposes the resources of the material.
  110716. * @param forceDisposeTextures - Forces the disposal of all textures.
  110717. */
  110718. dispose(forceDisposeTextures?: boolean): void;
  110719. /**
  110720. * Get the current class name useful for serialization or dynamic coding.
  110721. * @returns "DetailMap"
  110722. */
  110723. getClassName(): string;
  110724. /**
  110725. * Add the required uniforms to the current list.
  110726. * @param uniforms defines the current uniform list.
  110727. */
  110728. static AddUniforms(uniforms: string[]): void;
  110729. /**
  110730. * Add the required samplers to the current list.
  110731. * @param samplers defines the current sampler list.
  110732. */
  110733. static AddSamplers(samplers: string[]): void;
  110734. /**
  110735. * Add the required uniforms to the current buffer.
  110736. * @param uniformBuffer defines the current uniform buffer.
  110737. */
  110738. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110739. /**
  110740. * Makes a duplicate of the current instance into another one.
  110741. * @param detailMap define the instance where to copy the info
  110742. */
  110743. copyTo(detailMap: DetailMapConfiguration): void;
  110744. /**
  110745. * Serializes this detail map instance
  110746. * @returns - An object with the serialized instance.
  110747. */
  110748. serialize(): any;
  110749. /**
  110750. * Parses a detail map setting from a serialized object.
  110751. * @param source - Serialized object.
  110752. * @param scene Defines the scene we are parsing for
  110753. * @param rootUrl Defines the rootUrl to load from
  110754. */
  110755. parse(source: any, scene: Scene, rootUrl: string): void;
  110756. }
  110757. }
  110758. declare module BABYLON {
  110759. /** @hidden */
  110760. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110761. MAINUV1: boolean;
  110762. MAINUV2: boolean;
  110763. DIFFUSE: boolean;
  110764. DIFFUSEDIRECTUV: number;
  110765. DETAIL: boolean;
  110766. DETAILDIRECTUV: number;
  110767. DETAIL_NORMALBLENDMETHOD: number;
  110768. AMBIENT: boolean;
  110769. AMBIENTDIRECTUV: number;
  110770. OPACITY: boolean;
  110771. OPACITYDIRECTUV: number;
  110772. OPACITYRGB: boolean;
  110773. REFLECTION: boolean;
  110774. EMISSIVE: boolean;
  110775. EMISSIVEDIRECTUV: number;
  110776. SPECULAR: boolean;
  110777. SPECULARDIRECTUV: number;
  110778. BUMP: boolean;
  110779. BUMPDIRECTUV: number;
  110780. PARALLAX: boolean;
  110781. PARALLAXOCCLUSION: boolean;
  110782. SPECULAROVERALPHA: boolean;
  110783. CLIPPLANE: boolean;
  110784. CLIPPLANE2: boolean;
  110785. CLIPPLANE3: boolean;
  110786. CLIPPLANE4: boolean;
  110787. CLIPPLANE5: boolean;
  110788. CLIPPLANE6: boolean;
  110789. ALPHATEST: boolean;
  110790. DEPTHPREPASS: boolean;
  110791. ALPHAFROMDIFFUSE: boolean;
  110792. POINTSIZE: boolean;
  110793. FOG: boolean;
  110794. SPECULARTERM: boolean;
  110795. DIFFUSEFRESNEL: boolean;
  110796. OPACITYFRESNEL: boolean;
  110797. REFLECTIONFRESNEL: boolean;
  110798. REFRACTIONFRESNEL: boolean;
  110799. EMISSIVEFRESNEL: boolean;
  110800. FRESNEL: boolean;
  110801. NORMAL: boolean;
  110802. UV1: boolean;
  110803. UV2: boolean;
  110804. VERTEXCOLOR: boolean;
  110805. VERTEXALPHA: boolean;
  110806. NUM_BONE_INFLUENCERS: number;
  110807. BonesPerMesh: number;
  110808. BONETEXTURE: boolean;
  110809. INSTANCES: boolean;
  110810. THIN_INSTANCES: boolean;
  110811. GLOSSINESS: boolean;
  110812. ROUGHNESS: boolean;
  110813. EMISSIVEASILLUMINATION: boolean;
  110814. LINKEMISSIVEWITHDIFFUSE: boolean;
  110815. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110816. LIGHTMAP: boolean;
  110817. LIGHTMAPDIRECTUV: number;
  110818. OBJECTSPACE_NORMALMAP: boolean;
  110819. USELIGHTMAPASSHADOWMAP: boolean;
  110820. REFLECTIONMAP_3D: boolean;
  110821. REFLECTIONMAP_SPHERICAL: boolean;
  110822. REFLECTIONMAP_PLANAR: boolean;
  110823. REFLECTIONMAP_CUBIC: boolean;
  110824. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110825. REFLECTIONMAP_PROJECTION: boolean;
  110826. REFLECTIONMAP_SKYBOX: boolean;
  110827. REFLECTIONMAP_EXPLICIT: boolean;
  110828. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110829. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110830. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110831. INVERTCUBICMAP: boolean;
  110832. LOGARITHMICDEPTH: boolean;
  110833. REFRACTION: boolean;
  110834. REFRACTIONMAP_3D: boolean;
  110835. REFLECTIONOVERALPHA: boolean;
  110836. TWOSIDEDLIGHTING: boolean;
  110837. SHADOWFLOAT: boolean;
  110838. MORPHTARGETS: boolean;
  110839. MORPHTARGETS_NORMAL: boolean;
  110840. MORPHTARGETS_TANGENT: boolean;
  110841. MORPHTARGETS_UV: boolean;
  110842. NUM_MORPH_INFLUENCERS: number;
  110843. NONUNIFORMSCALING: boolean;
  110844. PREMULTIPLYALPHA: boolean;
  110845. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110846. ALPHABLEND: boolean;
  110847. PREPASS: boolean;
  110848. PREPASS_IRRADIANCE: boolean;
  110849. PREPASS_IRRADIANCE_INDEX: number;
  110850. PREPASS_ALBEDO: boolean;
  110851. PREPASS_ALBEDO_INDEX: number;
  110852. PREPASS_DEPTHNORMAL: boolean;
  110853. PREPASS_DEPTHNORMAL_INDEX: number;
  110854. SCENE_MRT_COUNT: number;
  110855. RGBDLIGHTMAP: boolean;
  110856. RGBDREFLECTION: boolean;
  110857. RGBDREFRACTION: boolean;
  110858. IMAGEPROCESSING: boolean;
  110859. VIGNETTE: boolean;
  110860. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110861. VIGNETTEBLENDMODEOPAQUE: boolean;
  110862. TONEMAPPING: boolean;
  110863. TONEMAPPING_ACES: boolean;
  110864. CONTRAST: boolean;
  110865. COLORCURVES: boolean;
  110866. COLORGRADING: boolean;
  110867. COLORGRADING3D: boolean;
  110868. SAMPLER3DGREENDEPTH: boolean;
  110869. SAMPLER3DBGRMAP: boolean;
  110870. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110871. MULTIVIEW: boolean;
  110872. /**
  110873. * If the reflection texture on this material is in linear color space
  110874. * @hidden
  110875. */
  110876. IS_REFLECTION_LINEAR: boolean;
  110877. /**
  110878. * If the refraction texture on this material is in linear color space
  110879. * @hidden
  110880. */
  110881. IS_REFRACTION_LINEAR: boolean;
  110882. EXPOSURE: boolean;
  110883. constructor();
  110884. setReflectionMode(modeToEnable: string): void;
  110885. }
  110886. /**
  110887. * This is the default material used in Babylon. It is the best trade off between quality
  110888. * and performances.
  110889. * @see https://doc.babylonjs.com/babylon101/materials
  110890. */
  110891. export class StandardMaterial extends PushMaterial {
  110892. private _diffuseTexture;
  110893. /**
  110894. * The basic texture of the material as viewed under a light.
  110895. */
  110896. diffuseTexture: Nullable<BaseTexture>;
  110897. private _ambientTexture;
  110898. /**
  110899. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110900. */
  110901. ambientTexture: Nullable<BaseTexture>;
  110902. private _opacityTexture;
  110903. /**
  110904. * Define the transparency of the material from a texture.
  110905. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110906. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110907. */
  110908. opacityTexture: Nullable<BaseTexture>;
  110909. private _reflectionTexture;
  110910. /**
  110911. * Define the texture used to display the reflection.
  110912. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110913. */
  110914. reflectionTexture: Nullable<BaseTexture>;
  110915. private _emissiveTexture;
  110916. /**
  110917. * Define texture of the material as if self lit.
  110918. * This will be mixed in the final result even in the absence of light.
  110919. */
  110920. emissiveTexture: Nullable<BaseTexture>;
  110921. private _specularTexture;
  110922. /**
  110923. * Define how the color and intensity of the highlight given by the light in the material.
  110924. */
  110925. specularTexture: Nullable<BaseTexture>;
  110926. private _bumpTexture;
  110927. /**
  110928. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110929. * 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.
  110930. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110931. */
  110932. bumpTexture: Nullable<BaseTexture>;
  110933. private _lightmapTexture;
  110934. /**
  110935. * Complex lighting can be computationally expensive to compute at runtime.
  110936. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110937. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110938. */
  110939. lightmapTexture: Nullable<BaseTexture>;
  110940. private _refractionTexture;
  110941. /**
  110942. * Define the texture used to display the refraction.
  110943. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110944. */
  110945. refractionTexture: Nullable<BaseTexture>;
  110946. /**
  110947. * The color of the material lit by the environmental background lighting.
  110948. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110949. */
  110950. ambientColor: Color3;
  110951. /**
  110952. * The basic color of the material as viewed under a light.
  110953. */
  110954. diffuseColor: Color3;
  110955. /**
  110956. * Define how the color and intensity of the highlight given by the light in the material.
  110957. */
  110958. specularColor: Color3;
  110959. /**
  110960. * Define the color of the material as if self lit.
  110961. * This will be mixed in the final result even in the absence of light.
  110962. */
  110963. emissiveColor: Color3;
  110964. /**
  110965. * Defines how sharp are the highlights in the material.
  110966. * The bigger the value the sharper giving a more glossy feeling to the result.
  110967. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110968. */
  110969. specularPower: number;
  110970. private _useAlphaFromDiffuseTexture;
  110971. /**
  110972. * Does the transparency come from the diffuse texture alpha channel.
  110973. */
  110974. useAlphaFromDiffuseTexture: boolean;
  110975. private _useEmissiveAsIllumination;
  110976. /**
  110977. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110978. */
  110979. useEmissiveAsIllumination: boolean;
  110980. private _linkEmissiveWithDiffuse;
  110981. /**
  110982. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110983. * the emissive level when the final color is close to one.
  110984. */
  110985. linkEmissiveWithDiffuse: boolean;
  110986. private _useSpecularOverAlpha;
  110987. /**
  110988. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110989. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110990. */
  110991. useSpecularOverAlpha: boolean;
  110992. private _useReflectionOverAlpha;
  110993. /**
  110994. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110995. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110996. */
  110997. useReflectionOverAlpha: boolean;
  110998. private _disableLighting;
  110999. /**
  111000. * Does lights from the scene impacts this material.
  111001. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  111002. */
  111003. disableLighting: boolean;
  111004. private _useObjectSpaceNormalMap;
  111005. /**
  111006. * Allows using an object space normal map (instead of tangent space).
  111007. */
  111008. useObjectSpaceNormalMap: boolean;
  111009. private _useParallax;
  111010. /**
  111011. * Is parallax enabled or not.
  111012. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  111013. */
  111014. useParallax: boolean;
  111015. private _useParallaxOcclusion;
  111016. /**
  111017. * Is parallax occlusion enabled or not.
  111018. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  111019. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  111020. */
  111021. useParallaxOcclusion: boolean;
  111022. /**
  111023. * 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.
  111024. */
  111025. parallaxScaleBias: number;
  111026. private _roughness;
  111027. /**
  111028. * Helps to define how blurry the reflections should appears in the material.
  111029. */
  111030. roughness: number;
  111031. /**
  111032. * In case of refraction, define the value of the index of refraction.
  111033. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  111034. */
  111035. indexOfRefraction: number;
  111036. /**
  111037. * Invert the refraction texture alongside the y axis.
  111038. * It can be useful with procedural textures or probe for instance.
  111039. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  111040. */
  111041. invertRefractionY: boolean;
  111042. /**
  111043. * Defines the alpha limits in alpha test mode.
  111044. */
  111045. alphaCutOff: number;
  111046. private _useLightmapAsShadowmap;
  111047. /**
  111048. * In case of light mapping, define whether the map contains light or shadow informations.
  111049. */
  111050. useLightmapAsShadowmap: boolean;
  111051. private _diffuseFresnelParameters;
  111052. /**
  111053. * Define the diffuse fresnel parameters of the material.
  111054. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111055. */
  111056. diffuseFresnelParameters: FresnelParameters;
  111057. private _opacityFresnelParameters;
  111058. /**
  111059. * Define the opacity fresnel parameters of the material.
  111060. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111061. */
  111062. opacityFresnelParameters: FresnelParameters;
  111063. private _reflectionFresnelParameters;
  111064. /**
  111065. * Define the reflection fresnel parameters of the material.
  111066. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111067. */
  111068. reflectionFresnelParameters: FresnelParameters;
  111069. private _refractionFresnelParameters;
  111070. /**
  111071. * Define the refraction fresnel parameters of the material.
  111072. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111073. */
  111074. refractionFresnelParameters: FresnelParameters;
  111075. private _emissiveFresnelParameters;
  111076. /**
  111077. * Define the emissive fresnel parameters of the material.
  111078. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111079. */
  111080. emissiveFresnelParameters: FresnelParameters;
  111081. private _useReflectionFresnelFromSpecular;
  111082. /**
  111083. * If true automatically deducts the fresnels values from the material specularity.
  111084. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111085. */
  111086. useReflectionFresnelFromSpecular: boolean;
  111087. private _useGlossinessFromSpecularMapAlpha;
  111088. /**
  111089. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  111090. */
  111091. useGlossinessFromSpecularMapAlpha: boolean;
  111092. private _maxSimultaneousLights;
  111093. /**
  111094. * Defines the maximum number of lights that can be used in the material
  111095. */
  111096. maxSimultaneousLights: number;
  111097. private _invertNormalMapX;
  111098. /**
  111099. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  111100. */
  111101. invertNormalMapX: boolean;
  111102. private _invertNormalMapY;
  111103. /**
  111104. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  111105. */
  111106. invertNormalMapY: boolean;
  111107. private _twoSidedLighting;
  111108. /**
  111109. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  111110. */
  111111. twoSidedLighting: boolean;
  111112. /**
  111113. * Default configuration related to image processing available in the standard Material.
  111114. */
  111115. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  111116. /**
  111117. * Gets the image processing configuration used either in this material.
  111118. */
  111119. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  111120. /**
  111121. * Sets the Default image processing configuration used either in the this material.
  111122. *
  111123. * If sets to null, the scene one is in use.
  111124. */
  111125. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  111126. /**
  111127. * Keep track of the image processing observer to allow dispose and replace.
  111128. */
  111129. private _imageProcessingObserver;
  111130. /**
  111131. * Attaches a new image processing configuration to the Standard Material.
  111132. * @param configuration
  111133. */
  111134. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  111135. /**
  111136. * Gets wether the color curves effect is enabled.
  111137. */
  111138. get cameraColorCurvesEnabled(): boolean;
  111139. /**
  111140. * Sets wether the color curves effect is enabled.
  111141. */
  111142. set cameraColorCurvesEnabled(value: boolean);
  111143. /**
  111144. * Gets wether the color grading effect is enabled.
  111145. */
  111146. get cameraColorGradingEnabled(): boolean;
  111147. /**
  111148. * Gets wether the color grading effect is enabled.
  111149. */
  111150. set cameraColorGradingEnabled(value: boolean);
  111151. /**
  111152. * Gets wether tonemapping is enabled or not.
  111153. */
  111154. get cameraToneMappingEnabled(): boolean;
  111155. /**
  111156. * Sets wether tonemapping is enabled or not
  111157. */
  111158. set cameraToneMappingEnabled(value: boolean);
  111159. /**
  111160. * The camera exposure used on this material.
  111161. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  111162. * This corresponds to a photographic exposure.
  111163. */
  111164. get cameraExposure(): number;
  111165. /**
  111166. * The camera exposure used on this material.
  111167. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  111168. * This corresponds to a photographic exposure.
  111169. */
  111170. set cameraExposure(value: number);
  111171. /**
  111172. * Gets The camera contrast used on this material.
  111173. */
  111174. get cameraContrast(): number;
  111175. /**
  111176. * Sets The camera contrast used on this material.
  111177. */
  111178. set cameraContrast(value: number);
  111179. /**
  111180. * Gets the Color Grading 2D Lookup Texture.
  111181. */
  111182. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  111183. /**
  111184. * Sets the Color Grading 2D Lookup Texture.
  111185. */
  111186. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  111187. /**
  111188. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111189. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111190. * 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;
  111191. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111192. */
  111193. get cameraColorCurves(): Nullable<ColorCurves>;
  111194. /**
  111195. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111196. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111197. * 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;
  111198. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111199. */
  111200. set cameraColorCurves(value: Nullable<ColorCurves>);
  111201. /**
  111202. * Can this material render to several textures at once
  111203. */
  111204. get canRenderToMRT(): boolean;
  111205. /**
  111206. * Defines the detail map parameters for the material.
  111207. */
  111208. readonly detailMap: DetailMapConfiguration;
  111209. protected _renderTargets: SmartArray<RenderTargetTexture>;
  111210. protected _worldViewProjectionMatrix: Matrix;
  111211. protected _globalAmbientColor: Color3;
  111212. protected _useLogarithmicDepth: boolean;
  111213. protected _rebuildInParallel: boolean;
  111214. /**
  111215. * Instantiates a new standard material.
  111216. * This is the default material used in Babylon. It is the best trade off between quality
  111217. * and performances.
  111218. * @see https://doc.babylonjs.com/babylon101/materials
  111219. * @param name Define the name of the material in the scene
  111220. * @param scene Define the scene the material belong to
  111221. */
  111222. constructor(name: string, scene: Scene);
  111223. /**
  111224. * Gets a boolean indicating that current material needs to register RTT
  111225. */
  111226. get hasRenderTargetTextures(): boolean;
  111227. /**
  111228. * Gets the current class name of the material e.g. "StandardMaterial"
  111229. * Mainly use in serialization.
  111230. * @returns the class name
  111231. */
  111232. getClassName(): string;
  111233. /**
  111234. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  111235. * You can try switching to logarithmic depth.
  111236. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  111237. */
  111238. get useLogarithmicDepth(): boolean;
  111239. set useLogarithmicDepth(value: boolean);
  111240. /**
  111241. * Specifies if the material will require alpha blending
  111242. * @returns a boolean specifying if alpha blending is needed
  111243. */
  111244. needAlphaBlending(): boolean;
  111245. /**
  111246. * Specifies if this material should be rendered in alpha test mode
  111247. * @returns a boolean specifying if an alpha test is needed.
  111248. */
  111249. needAlphaTesting(): boolean;
  111250. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  111251. /**
  111252. * Get the texture used for alpha test purpose.
  111253. * @returns the diffuse texture in case of the standard material.
  111254. */
  111255. getAlphaTestTexture(): Nullable<BaseTexture>;
  111256. /**
  111257. * Get if the submesh is ready to be used and all its information available.
  111258. * Child classes can use it to update shaders
  111259. * @param mesh defines the mesh to check
  111260. * @param subMesh defines which submesh to check
  111261. * @param useInstances specifies that instances should be used
  111262. * @returns a boolean indicating that the submesh is ready or not
  111263. */
  111264. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  111265. /**
  111266. * Builds the material UBO layouts.
  111267. * Used internally during the effect preparation.
  111268. */
  111269. buildUniformLayout(): void;
  111270. /**
  111271. * Unbinds the material from the mesh
  111272. */
  111273. unbind(): void;
  111274. /**
  111275. * Binds the submesh to this material by preparing the effect and shader to draw
  111276. * @param world defines the world transformation matrix
  111277. * @param mesh defines the mesh containing the submesh
  111278. * @param subMesh defines the submesh to bind the material to
  111279. */
  111280. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  111281. /**
  111282. * Get the list of animatables in the material.
  111283. * @returns the list of animatables object used in the material
  111284. */
  111285. getAnimatables(): IAnimatable[];
  111286. /**
  111287. * Gets the active textures from the material
  111288. * @returns an array of textures
  111289. */
  111290. getActiveTextures(): BaseTexture[];
  111291. /**
  111292. * Specifies if the material uses a texture
  111293. * @param texture defines the texture to check against the material
  111294. * @returns a boolean specifying if the material uses the texture
  111295. */
  111296. hasTexture(texture: BaseTexture): boolean;
  111297. /**
  111298. * Disposes the material
  111299. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  111300. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  111301. */
  111302. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  111303. /**
  111304. * Makes a duplicate of the material, and gives it a new name
  111305. * @param name defines the new name for the duplicated material
  111306. * @returns the cloned material
  111307. */
  111308. clone(name: string): StandardMaterial;
  111309. /**
  111310. * Serializes this material in a JSON representation
  111311. * @returns the serialized material object
  111312. */
  111313. serialize(): any;
  111314. /**
  111315. * Creates a standard material from parsed material data
  111316. * @param source defines the JSON representation of the material
  111317. * @param scene defines the hosting scene
  111318. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  111319. * @returns a new standard material
  111320. */
  111321. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  111322. /**
  111323. * Are diffuse textures enabled in the application.
  111324. */
  111325. static get DiffuseTextureEnabled(): boolean;
  111326. static set DiffuseTextureEnabled(value: boolean);
  111327. /**
  111328. * Are detail textures enabled in the application.
  111329. */
  111330. static get DetailTextureEnabled(): boolean;
  111331. static set DetailTextureEnabled(value: boolean);
  111332. /**
  111333. * Are ambient textures enabled in the application.
  111334. */
  111335. static get AmbientTextureEnabled(): boolean;
  111336. static set AmbientTextureEnabled(value: boolean);
  111337. /**
  111338. * Are opacity textures enabled in the application.
  111339. */
  111340. static get OpacityTextureEnabled(): boolean;
  111341. static set OpacityTextureEnabled(value: boolean);
  111342. /**
  111343. * Are reflection textures enabled in the application.
  111344. */
  111345. static get ReflectionTextureEnabled(): boolean;
  111346. static set ReflectionTextureEnabled(value: boolean);
  111347. /**
  111348. * Are emissive textures enabled in the application.
  111349. */
  111350. static get EmissiveTextureEnabled(): boolean;
  111351. static set EmissiveTextureEnabled(value: boolean);
  111352. /**
  111353. * Are specular textures enabled in the application.
  111354. */
  111355. static get SpecularTextureEnabled(): boolean;
  111356. static set SpecularTextureEnabled(value: boolean);
  111357. /**
  111358. * Are bump textures enabled in the application.
  111359. */
  111360. static get BumpTextureEnabled(): boolean;
  111361. static set BumpTextureEnabled(value: boolean);
  111362. /**
  111363. * Are lightmap textures enabled in the application.
  111364. */
  111365. static get LightmapTextureEnabled(): boolean;
  111366. static set LightmapTextureEnabled(value: boolean);
  111367. /**
  111368. * Are refraction textures enabled in the application.
  111369. */
  111370. static get RefractionTextureEnabled(): boolean;
  111371. static set RefractionTextureEnabled(value: boolean);
  111372. /**
  111373. * Are color grading textures enabled in the application.
  111374. */
  111375. static get ColorGradingTextureEnabled(): boolean;
  111376. static set ColorGradingTextureEnabled(value: boolean);
  111377. /**
  111378. * Are fresnels enabled in the application.
  111379. */
  111380. static get FresnelEnabled(): boolean;
  111381. static set FresnelEnabled(value: boolean);
  111382. }
  111383. }
  111384. declare module BABYLON {
  111385. /**
  111386. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  111387. *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.
  111388. * The SPS is also a particle system. It provides some methods to manage the particles.
  111389. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  111390. *
  111391. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  111392. */
  111393. export class SolidParticleSystem implements IDisposable {
  111394. /**
  111395. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  111396. * Example : var p = SPS.particles[i];
  111397. */
  111398. particles: SolidParticle[];
  111399. /**
  111400. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  111401. */
  111402. nbParticles: number;
  111403. /**
  111404. * If the particles must ever face the camera (default false). Useful for planar particles.
  111405. */
  111406. billboard: boolean;
  111407. /**
  111408. * Recompute normals when adding a shape
  111409. */
  111410. recomputeNormals: boolean;
  111411. /**
  111412. * This a counter ofr your own usage. It's not set by any SPS functions.
  111413. */
  111414. counter: number;
  111415. /**
  111416. * The SPS name. This name is also given to the underlying mesh.
  111417. */
  111418. name: string;
  111419. /**
  111420. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  111421. */
  111422. mesh: Mesh;
  111423. /**
  111424. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  111425. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  111426. */
  111427. vars: any;
  111428. /**
  111429. * This array is populated when the SPS is set as 'pickable'.
  111430. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  111431. * Each element of this array is an object `{idx: int, faceId: int}`.
  111432. * `idx` is the picked particle index in the `SPS.particles` array
  111433. * `faceId` is the picked face index counted within this particle.
  111434. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  111435. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  111436. * Use the method SPS.pickedParticle(pickingInfo) instead.
  111437. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  111438. */
  111439. pickedParticles: {
  111440. idx: number;
  111441. faceId: number;
  111442. }[];
  111443. /**
  111444. * This array is populated when the SPS is set as 'pickable'
  111445. * Each key of this array is a submesh index.
  111446. * Each element of this array is a second array defined like this :
  111447. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  111448. * Each element of this second array is an object `{idx: int, faceId: int}`.
  111449. * `idx` is the picked particle index in the `SPS.particles` array
  111450. * `faceId` is the picked face index counted within this particle.
  111451. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  111452. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  111453. */
  111454. pickedBySubMesh: {
  111455. idx: number;
  111456. faceId: number;
  111457. }[][];
  111458. /**
  111459. * This array is populated when `enableDepthSort` is set to true.
  111460. * Each element of this array is an instance of the class DepthSortedParticle.
  111461. */
  111462. depthSortedParticles: DepthSortedParticle[];
  111463. /**
  111464. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  111465. * @hidden
  111466. */
  111467. _bSphereOnly: boolean;
  111468. /**
  111469. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  111470. * @hidden
  111471. */
  111472. _bSphereRadiusFactor: number;
  111473. private _scene;
  111474. private _positions;
  111475. private _indices;
  111476. private _normals;
  111477. private _colors;
  111478. private _uvs;
  111479. private _indices32;
  111480. private _positions32;
  111481. private _normals32;
  111482. private _fixedNormal32;
  111483. private _colors32;
  111484. private _uvs32;
  111485. private _index;
  111486. private _updatable;
  111487. private _pickable;
  111488. private _isVisibilityBoxLocked;
  111489. private _alwaysVisible;
  111490. private _depthSort;
  111491. private _expandable;
  111492. private _shapeCounter;
  111493. private _copy;
  111494. private _color;
  111495. private _computeParticleColor;
  111496. private _computeParticleTexture;
  111497. private _computeParticleRotation;
  111498. private _computeParticleVertex;
  111499. private _computeBoundingBox;
  111500. private _depthSortParticles;
  111501. private _camera;
  111502. private _mustUnrotateFixedNormals;
  111503. private _particlesIntersect;
  111504. private _needs32Bits;
  111505. private _isNotBuilt;
  111506. private _lastParticleId;
  111507. private _idxOfId;
  111508. private _multimaterialEnabled;
  111509. private _useModelMaterial;
  111510. private _indicesByMaterial;
  111511. private _materialIndexes;
  111512. private _depthSortFunction;
  111513. private _materialSortFunction;
  111514. private _materials;
  111515. private _multimaterial;
  111516. private _materialIndexesById;
  111517. private _defaultMaterial;
  111518. private _autoUpdateSubMeshes;
  111519. private _tmpVertex;
  111520. /**
  111521. * Creates a SPS (Solid Particle System) object.
  111522. * @param name (String) is the SPS name, this will be the underlying mesh name.
  111523. * @param scene (Scene) is the scene in which the SPS is added.
  111524. * @param options defines the options of the sps e.g.
  111525. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  111526. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  111527. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  111528. * * 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.
  111529. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  111530. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  111531. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  111532. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  111533. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  111534. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  111535. */
  111536. constructor(name: string, scene: Scene, options?: {
  111537. updatable?: boolean;
  111538. isPickable?: boolean;
  111539. enableDepthSort?: boolean;
  111540. particleIntersection?: boolean;
  111541. boundingSphereOnly?: boolean;
  111542. bSphereRadiusFactor?: number;
  111543. expandable?: boolean;
  111544. useModelMaterial?: boolean;
  111545. enableMultiMaterial?: boolean;
  111546. });
  111547. /**
  111548. * Builds the SPS underlying mesh. Returns a standard Mesh.
  111549. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  111550. * @returns the created mesh
  111551. */
  111552. buildMesh(): Mesh;
  111553. /**
  111554. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  111555. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  111556. * Thus the particles generated from `digest()` have their property `position` set yet.
  111557. * @param mesh ( Mesh ) is the mesh to be digested
  111558. * @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
  111559. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  111560. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  111561. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  111562. * @returns the current SPS
  111563. */
  111564. digest(mesh: Mesh, options?: {
  111565. facetNb?: number;
  111566. number?: number;
  111567. delta?: number;
  111568. storage?: [];
  111569. }): SolidParticleSystem;
  111570. /**
  111571. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  111572. * @hidden
  111573. */
  111574. private _unrotateFixedNormals;
  111575. /**
  111576. * Resets the temporary working copy particle
  111577. * @hidden
  111578. */
  111579. private _resetCopy;
  111580. /**
  111581. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  111582. * @param p the current index in the positions array to be updated
  111583. * @param ind the current index in the indices array
  111584. * @param shape a Vector3 array, the shape geometry
  111585. * @param positions the positions array to be updated
  111586. * @param meshInd the shape indices array
  111587. * @param indices the indices array to be updated
  111588. * @param meshUV the shape uv array
  111589. * @param uvs the uv array to be updated
  111590. * @param meshCol the shape color array
  111591. * @param colors the color array to be updated
  111592. * @param meshNor the shape normals array
  111593. * @param normals the normals array to be updated
  111594. * @param idx the particle index
  111595. * @param idxInShape the particle index in its shape
  111596. * @param options the addShape() method passed options
  111597. * @model the particle model
  111598. * @hidden
  111599. */
  111600. private _meshBuilder;
  111601. /**
  111602. * Returns a shape Vector3 array from positions float array
  111603. * @param positions float array
  111604. * @returns a vector3 array
  111605. * @hidden
  111606. */
  111607. private _posToShape;
  111608. /**
  111609. * Returns a shapeUV array from a float uvs (array deep copy)
  111610. * @param uvs as a float array
  111611. * @returns a shapeUV array
  111612. * @hidden
  111613. */
  111614. private _uvsToShapeUV;
  111615. /**
  111616. * Adds a new particle object in the particles array
  111617. * @param idx particle index in particles array
  111618. * @param id particle id
  111619. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  111620. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  111621. * @param model particle ModelShape object
  111622. * @param shapeId model shape identifier
  111623. * @param idxInShape index of the particle in the current model
  111624. * @param bInfo model bounding info object
  111625. * @param storage target storage array, if any
  111626. * @hidden
  111627. */
  111628. private _addParticle;
  111629. /**
  111630. * Adds some particles to the SPS from the model shape. Returns the shape id.
  111631. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  111632. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  111633. * @param nb (positive integer) the number of particles to be created from this model
  111634. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  111635. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  111636. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  111637. * @returns the number of shapes in the system
  111638. */
  111639. addShape(mesh: Mesh, nb: number, options?: {
  111640. positionFunction?: any;
  111641. vertexFunction?: any;
  111642. storage?: [];
  111643. }): number;
  111644. /**
  111645. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  111646. * @hidden
  111647. */
  111648. private _rebuildParticle;
  111649. /**
  111650. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  111651. * @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.
  111652. * @returns the SPS.
  111653. */
  111654. rebuildMesh(reset?: boolean): SolidParticleSystem;
  111655. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  111656. * Returns an array with the removed particles.
  111657. * 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.
  111658. * The SPS can't be empty so at least one particle needs to remain in place.
  111659. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  111660. * @param start index of the first particle to remove
  111661. * @param end index of the last particle to remove (included)
  111662. * @returns an array populated with the removed particles
  111663. */
  111664. removeParticles(start: number, end: number): SolidParticle[];
  111665. /**
  111666. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  111667. * @param solidParticleArray an array populated with Solid Particles objects
  111668. * @returns the SPS
  111669. */
  111670. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  111671. /**
  111672. * Creates a new particle and modifies the SPS mesh geometry :
  111673. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  111674. * - calls _addParticle() to populate the particle array
  111675. * factorized code from addShape() and insertParticlesFromArray()
  111676. * @param idx particle index in the particles array
  111677. * @param i particle index in its shape
  111678. * @param modelShape particle ModelShape object
  111679. * @param shape shape vertex array
  111680. * @param meshInd shape indices array
  111681. * @param meshUV shape uv array
  111682. * @param meshCol shape color array
  111683. * @param meshNor shape normals array
  111684. * @param bbInfo shape bounding info
  111685. * @param storage target particle storage
  111686. * @options addShape() passed options
  111687. * @hidden
  111688. */
  111689. private _insertNewParticle;
  111690. /**
  111691. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  111692. * This method calls `updateParticle()` for each particle of the SPS.
  111693. * For an animated SPS, it is usually called within the render loop.
  111694. * 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.
  111695. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  111696. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  111697. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  111698. * @returns the SPS.
  111699. */
  111700. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  111701. /**
  111702. * Disposes the SPS.
  111703. */
  111704. dispose(): void;
  111705. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  111706. * idx is the particle index in the SPS
  111707. * faceId is the picked face index counted within this particle.
  111708. * Returns null if the pickInfo can't identify a picked particle.
  111709. * @param pickingInfo (PickingInfo object)
  111710. * @returns {idx: number, faceId: number} or null
  111711. */
  111712. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  111713. idx: number;
  111714. faceId: number;
  111715. }>;
  111716. /**
  111717. * Returns a SolidParticle object from its identifier : particle.id
  111718. * @param id (integer) the particle Id
  111719. * @returns the searched particle or null if not found in the SPS.
  111720. */
  111721. getParticleById(id: number): Nullable<SolidParticle>;
  111722. /**
  111723. * Returns a new array populated with the particles having the passed shapeId.
  111724. * @param shapeId (integer) the shape identifier
  111725. * @returns a new solid particle array
  111726. */
  111727. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111728. /**
  111729. * Populates the passed array "ref" with the particles having the passed shapeId.
  111730. * @param shapeId the shape identifier
  111731. * @returns the SPS
  111732. * @param ref
  111733. */
  111734. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111735. /**
  111736. * Computes the required SubMeshes according the materials assigned to the particles.
  111737. * @returns the solid particle system.
  111738. * Does nothing if called before the SPS mesh is built.
  111739. */
  111740. computeSubMeshes(): SolidParticleSystem;
  111741. /**
  111742. * Sorts the solid particles by material when MultiMaterial is enabled.
  111743. * Updates the indices32 array.
  111744. * Updates the indicesByMaterial array.
  111745. * Updates the mesh indices array.
  111746. * @returns the SPS
  111747. * @hidden
  111748. */
  111749. private _sortParticlesByMaterial;
  111750. /**
  111751. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111752. * @hidden
  111753. */
  111754. private _setMaterialIndexesById;
  111755. /**
  111756. * Returns an array with unique values of Materials from the passed array
  111757. * @param array the material array to be checked and filtered
  111758. * @hidden
  111759. */
  111760. private _filterUniqueMaterialId;
  111761. /**
  111762. * Sets a new Standard Material as _defaultMaterial if not already set.
  111763. * @hidden
  111764. */
  111765. private _setDefaultMaterial;
  111766. /**
  111767. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111768. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111769. * @returns the SPS.
  111770. */
  111771. refreshVisibleSize(): SolidParticleSystem;
  111772. /**
  111773. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111774. * @param size the size (float) of the visibility box
  111775. * note : this doesn't lock the SPS mesh bounding box.
  111776. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111777. */
  111778. setVisibilityBox(size: number): void;
  111779. /**
  111780. * Gets whether the SPS as always visible or not
  111781. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111782. */
  111783. get isAlwaysVisible(): boolean;
  111784. /**
  111785. * Sets the SPS as always visible or not
  111786. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111787. */
  111788. set isAlwaysVisible(val: boolean);
  111789. /**
  111790. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111791. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111792. */
  111793. set isVisibilityBoxLocked(val: boolean);
  111794. /**
  111795. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111796. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111797. */
  111798. get isVisibilityBoxLocked(): boolean;
  111799. /**
  111800. * Tells to `setParticles()` to compute the particle rotations or not.
  111801. * Default value : true. The SPS is faster when it's set to false.
  111802. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111803. */
  111804. set computeParticleRotation(val: boolean);
  111805. /**
  111806. * Tells to `setParticles()` to compute the particle colors or not.
  111807. * Default value : true. The SPS is faster when it's set to false.
  111808. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111809. */
  111810. set computeParticleColor(val: boolean);
  111811. set computeParticleTexture(val: boolean);
  111812. /**
  111813. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111814. * Default value : false. The SPS is faster when it's set to false.
  111815. * Note : the particle custom vertex positions aren't stored values.
  111816. */
  111817. set computeParticleVertex(val: boolean);
  111818. /**
  111819. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111820. */
  111821. set computeBoundingBox(val: boolean);
  111822. /**
  111823. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111824. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111825. * Default : `true`
  111826. */
  111827. set depthSortParticles(val: boolean);
  111828. /**
  111829. * Gets if `setParticles()` computes the particle rotations or not.
  111830. * Default value : true. The SPS is faster when it's set to false.
  111831. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111832. */
  111833. get computeParticleRotation(): boolean;
  111834. /**
  111835. * Gets if `setParticles()` computes the particle colors or not.
  111836. * Default value : true. The SPS is faster when it's set to false.
  111837. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111838. */
  111839. get computeParticleColor(): boolean;
  111840. /**
  111841. * Gets if `setParticles()` computes the particle textures or not.
  111842. * Default value : true. The SPS is faster when it's set to false.
  111843. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111844. */
  111845. get computeParticleTexture(): boolean;
  111846. /**
  111847. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111848. * Default value : false. The SPS is faster when it's set to false.
  111849. * Note : the particle custom vertex positions aren't stored values.
  111850. */
  111851. get computeParticleVertex(): boolean;
  111852. /**
  111853. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111854. */
  111855. get computeBoundingBox(): boolean;
  111856. /**
  111857. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111858. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111859. * Default : `true`
  111860. */
  111861. get depthSortParticles(): boolean;
  111862. /**
  111863. * Gets if the SPS is created as expandable at construction time.
  111864. * Default : `false`
  111865. */
  111866. get expandable(): boolean;
  111867. /**
  111868. * Gets if the SPS supports the Multi Materials
  111869. */
  111870. get multimaterialEnabled(): boolean;
  111871. /**
  111872. * Gets if the SPS uses the model materials for its own multimaterial.
  111873. */
  111874. get useModelMaterial(): boolean;
  111875. /**
  111876. * The SPS used material array.
  111877. */
  111878. get materials(): Material[];
  111879. /**
  111880. * Sets the SPS MultiMaterial from the passed materials.
  111881. * Note : the passed array is internally copied and not used then by reference.
  111882. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111883. */
  111884. setMultiMaterial(materials: Material[]): void;
  111885. /**
  111886. * The SPS computed multimaterial object
  111887. */
  111888. get multimaterial(): MultiMaterial;
  111889. set multimaterial(mm: MultiMaterial);
  111890. /**
  111891. * If the subMeshes must be updated on the next call to setParticles()
  111892. */
  111893. get autoUpdateSubMeshes(): boolean;
  111894. set autoUpdateSubMeshes(val: boolean);
  111895. /**
  111896. * This function does nothing. It may be overwritten to set all the particle first values.
  111897. * The SPS doesn't call this function, you may have to call it by your own.
  111898. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111899. */
  111900. initParticles(): void;
  111901. /**
  111902. * This function does nothing. It may be overwritten to recycle a particle.
  111903. * The SPS doesn't call this function, you may have to call it by your own.
  111904. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111905. * @param particle The particle to recycle
  111906. * @returns the recycled particle
  111907. */
  111908. recycleParticle(particle: SolidParticle): SolidParticle;
  111909. /**
  111910. * Updates a particle : this function should be overwritten by the user.
  111911. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111912. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111913. * @example : just set a particle position or velocity and recycle conditions
  111914. * @param particle The particle to update
  111915. * @returns the updated particle
  111916. */
  111917. updateParticle(particle: SolidParticle): SolidParticle;
  111918. /**
  111919. * Updates a vertex of a particle : it can be overwritten by the user.
  111920. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111921. * @param particle the current particle
  111922. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111923. * @param pt the index of the current vertex in the particle shape
  111924. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111925. * @example : just set a vertex particle position or color
  111926. * @returns the sps
  111927. */
  111928. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111929. /**
  111930. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111931. * This does nothing and may be overwritten by the user.
  111932. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111933. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111934. * @param update the boolean update value actually passed to setParticles()
  111935. */
  111936. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111937. /**
  111938. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111939. * This will be passed three parameters.
  111940. * This does nothing and may be overwritten by the user.
  111941. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111942. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111943. * @param update the boolean update value actually passed to setParticles()
  111944. */
  111945. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111946. }
  111947. }
  111948. declare module BABYLON {
  111949. /**
  111950. * Represents one particle of a solid particle system.
  111951. */
  111952. export class SolidParticle {
  111953. /**
  111954. * particle global index
  111955. */
  111956. idx: number;
  111957. /**
  111958. * particle identifier
  111959. */
  111960. id: number;
  111961. /**
  111962. * The color of the particle
  111963. */
  111964. color: Nullable<Color4>;
  111965. /**
  111966. * The world space position of the particle.
  111967. */
  111968. position: Vector3;
  111969. /**
  111970. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111971. */
  111972. rotation: Vector3;
  111973. /**
  111974. * The world space rotation quaternion of the particle.
  111975. */
  111976. rotationQuaternion: Nullable<Quaternion>;
  111977. /**
  111978. * The scaling of the particle.
  111979. */
  111980. scaling: Vector3;
  111981. /**
  111982. * The uvs of the particle.
  111983. */
  111984. uvs: Vector4;
  111985. /**
  111986. * The current speed of the particle.
  111987. */
  111988. velocity: Vector3;
  111989. /**
  111990. * The pivot point in the particle local space.
  111991. */
  111992. pivot: Vector3;
  111993. /**
  111994. * Must the particle be translated from its pivot point in its local space ?
  111995. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111996. * Default : false
  111997. */
  111998. translateFromPivot: boolean;
  111999. /**
  112000. * Is the particle active or not ?
  112001. */
  112002. alive: boolean;
  112003. /**
  112004. * Is the particle visible or not ?
  112005. */
  112006. isVisible: boolean;
  112007. /**
  112008. * Index of this particle in the global "positions" array (Internal use)
  112009. * @hidden
  112010. */
  112011. _pos: number;
  112012. /**
  112013. * @hidden Index of this particle in the global "indices" array (Internal use)
  112014. */
  112015. _ind: number;
  112016. /**
  112017. * @hidden ModelShape of this particle (Internal use)
  112018. */
  112019. _model: ModelShape;
  112020. /**
  112021. * ModelShape id of this particle
  112022. */
  112023. shapeId: number;
  112024. /**
  112025. * Index of the particle in its shape id
  112026. */
  112027. idxInShape: number;
  112028. /**
  112029. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  112030. */
  112031. _modelBoundingInfo: BoundingInfo;
  112032. /**
  112033. * @hidden Particle BoundingInfo object (Internal use)
  112034. */
  112035. _boundingInfo: BoundingInfo;
  112036. /**
  112037. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  112038. */
  112039. _sps: SolidParticleSystem;
  112040. /**
  112041. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  112042. */
  112043. _stillInvisible: boolean;
  112044. /**
  112045. * @hidden Last computed particle rotation matrix
  112046. */
  112047. _rotationMatrix: number[];
  112048. /**
  112049. * Parent particle Id, if any.
  112050. * Default null.
  112051. */
  112052. parentId: Nullable<number>;
  112053. /**
  112054. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  112055. */
  112056. materialIndex: Nullable<number>;
  112057. /**
  112058. * Custom object or properties.
  112059. */
  112060. props: Nullable<any>;
  112061. /**
  112062. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  112063. * The possible values are :
  112064. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  112065. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  112066. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  112067. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  112068. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  112069. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  112070. * */
  112071. cullingStrategy: number;
  112072. /**
  112073. * @hidden Internal global position in the SPS.
  112074. */
  112075. _globalPosition: Vector3;
  112076. /**
  112077. * Creates a Solid Particle object.
  112078. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  112079. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  112080. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  112081. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  112082. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  112083. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  112084. * @param shapeId (integer) is the model shape identifier in the SPS.
  112085. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  112086. * @param sps defines the sps it is associated to
  112087. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  112088. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  112089. */
  112090. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  112091. /**
  112092. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  112093. * @param target the particle target
  112094. * @returns the current particle
  112095. */
  112096. copyToRef(target: SolidParticle): SolidParticle;
  112097. /**
  112098. * Legacy support, changed scale to scaling
  112099. */
  112100. get scale(): Vector3;
  112101. /**
  112102. * Legacy support, changed scale to scaling
  112103. */
  112104. set scale(scale: Vector3);
  112105. /**
  112106. * Legacy support, changed quaternion to rotationQuaternion
  112107. */
  112108. get quaternion(): Nullable<Quaternion>;
  112109. /**
  112110. * Legacy support, changed quaternion to rotationQuaternion
  112111. */
  112112. set quaternion(q: Nullable<Quaternion>);
  112113. /**
  112114. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  112115. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  112116. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  112117. * @returns true if it intersects
  112118. */
  112119. intersectsMesh(target: Mesh | SolidParticle): boolean;
  112120. /**
  112121. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  112122. * A particle is in the frustum if its bounding box intersects the frustum
  112123. * @param frustumPlanes defines the frustum to test
  112124. * @returns true if the particle is in the frustum planes
  112125. */
  112126. isInFrustum(frustumPlanes: Plane[]): boolean;
  112127. /**
  112128. * get the rotation matrix of the particle
  112129. * @hidden
  112130. */
  112131. getRotationMatrix(m: Matrix): void;
  112132. }
  112133. /**
  112134. * Represents the shape of the model used by one particle of a solid particle system.
  112135. * SPS internal tool, don't use it manually.
  112136. */
  112137. export class ModelShape {
  112138. /**
  112139. * The shape id
  112140. * @hidden
  112141. */
  112142. shapeID: number;
  112143. /**
  112144. * flat array of model positions (internal use)
  112145. * @hidden
  112146. */
  112147. _shape: Vector3[];
  112148. /**
  112149. * flat array of model UVs (internal use)
  112150. * @hidden
  112151. */
  112152. _shapeUV: number[];
  112153. /**
  112154. * color array of the model
  112155. * @hidden
  112156. */
  112157. _shapeColors: number[];
  112158. /**
  112159. * indices array of the model
  112160. * @hidden
  112161. */
  112162. _indices: number[];
  112163. /**
  112164. * normals array of the model
  112165. * @hidden
  112166. */
  112167. _normals: number[];
  112168. /**
  112169. * length of the shape in the model indices array (internal use)
  112170. * @hidden
  112171. */
  112172. _indicesLength: number;
  112173. /**
  112174. * Custom position function (internal use)
  112175. * @hidden
  112176. */
  112177. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  112178. /**
  112179. * Custom vertex function (internal use)
  112180. * @hidden
  112181. */
  112182. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  112183. /**
  112184. * Model material (internal use)
  112185. * @hidden
  112186. */
  112187. _material: Nullable<Material>;
  112188. /**
  112189. * 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.
  112190. * SPS internal tool, don't use it manually.
  112191. * @hidden
  112192. */
  112193. 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>);
  112194. }
  112195. /**
  112196. * Represents a Depth Sorted Particle in the solid particle system.
  112197. * @hidden
  112198. */
  112199. export class DepthSortedParticle {
  112200. /**
  112201. * Particle index
  112202. */
  112203. idx: number;
  112204. /**
  112205. * Index of the particle in the "indices" array
  112206. */
  112207. ind: number;
  112208. /**
  112209. * Length of the particle shape in the "indices" array
  112210. */
  112211. indicesLength: number;
  112212. /**
  112213. * Squared distance from the particle to the camera
  112214. */
  112215. sqDistance: number;
  112216. /**
  112217. * Material index when used with MultiMaterials
  112218. */
  112219. materialIndex: number;
  112220. /**
  112221. * Creates a new sorted particle
  112222. * @param materialIndex
  112223. */
  112224. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  112225. }
  112226. /**
  112227. * Represents a solid particle vertex
  112228. */
  112229. export class SolidParticleVertex {
  112230. /**
  112231. * Vertex position
  112232. */
  112233. position: Vector3;
  112234. /**
  112235. * Vertex color
  112236. */
  112237. color: Color4;
  112238. /**
  112239. * Vertex UV
  112240. */
  112241. uv: Vector2;
  112242. /**
  112243. * Creates a new solid particle vertex
  112244. */
  112245. constructor();
  112246. /** Vertex x coordinate */
  112247. get x(): number;
  112248. set x(val: number);
  112249. /** Vertex y coordinate */
  112250. get y(): number;
  112251. set y(val: number);
  112252. /** Vertex z coordinate */
  112253. get z(): number;
  112254. set z(val: number);
  112255. }
  112256. }
  112257. declare module BABYLON {
  112258. /**
  112259. * @hidden
  112260. */
  112261. export class _MeshCollisionData {
  112262. _checkCollisions: boolean;
  112263. _collisionMask: number;
  112264. _collisionGroup: number;
  112265. _surroundingMeshes: Nullable<AbstractMesh[]>;
  112266. _collider: Nullable<Collider>;
  112267. _oldPositionForCollisions: Vector3;
  112268. _diffPositionForCollisions: Vector3;
  112269. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  112270. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  112271. _collisionResponse: boolean;
  112272. }
  112273. }
  112274. declare module BABYLON {
  112275. /** @hidden */
  112276. class _FacetDataStorage {
  112277. facetPositions: Vector3[];
  112278. facetNormals: Vector3[];
  112279. facetPartitioning: number[][];
  112280. facetNb: number;
  112281. partitioningSubdivisions: number;
  112282. partitioningBBoxRatio: number;
  112283. facetDataEnabled: boolean;
  112284. facetParameters: any;
  112285. bbSize: Vector3;
  112286. subDiv: {
  112287. max: number;
  112288. X: number;
  112289. Y: number;
  112290. Z: number;
  112291. };
  112292. facetDepthSort: boolean;
  112293. facetDepthSortEnabled: boolean;
  112294. depthSortedIndices: IndicesArray;
  112295. depthSortedFacets: {
  112296. ind: number;
  112297. sqDistance: number;
  112298. }[];
  112299. facetDepthSortFunction: (f1: {
  112300. ind: number;
  112301. sqDistance: number;
  112302. }, f2: {
  112303. ind: number;
  112304. sqDistance: number;
  112305. }) => number;
  112306. facetDepthSortFrom: Vector3;
  112307. facetDepthSortOrigin: Vector3;
  112308. invertedMatrix: Matrix;
  112309. }
  112310. /**
  112311. * @hidden
  112312. **/
  112313. class _InternalAbstractMeshDataInfo {
  112314. _hasVertexAlpha: boolean;
  112315. _useVertexColors: boolean;
  112316. _numBoneInfluencers: number;
  112317. _applyFog: boolean;
  112318. _receiveShadows: boolean;
  112319. _facetData: _FacetDataStorage;
  112320. _visibility: number;
  112321. _skeleton: Nullable<Skeleton>;
  112322. _layerMask: number;
  112323. _computeBonesUsingShaders: boolean;
  112324. _isActive: boolean;
  112325. _onlyForInstances: boolean;
  112326. _isActiveIntermediate: boolean;
  112327. _onlyForInstancesIntermediate: boolean;
  112328. _actAsRegularMesh: boolean;
  112329. }
  112330. /**
  112331. * Class used to store all common mesh properties
  112332. */
  112333. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  112334. /** No occlusion */
  112335. static OCCLUSION_TYPE_NONE: number;
  112336. /** Occlusion set to optimisitic */
  112337. static OCCLUSION_TYPE_OPTIMISTIC: number;
  112338. /** Occlusion set to strict */
  112339. static OCCLUSION_TYPE_STRICT: number;
  112340. /** Use an accurante occlusion algorithm */
  112341. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  112342. /** Use a conservative occlusion algorithm */
  112343. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  112344. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  112345. * Test order :
  112346. * Is the bounding sphere outside the frustum ?
  112347. * If not, are the bounding box vertices outside the frustum ?
  112348. * It not, then the cullable object is in the frustum.
  112349. */
  112350. static readonly CULLINGSTRATEGY_STANDARD: number;
  112351. /** Culling strategy : Bounding Sphere Only.
  112352. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  112353. * It's also less accurate than the standard because some not visible objects can still be selected.
  112354. * Test : is the bounding sphere outside the frustum ?
  112355. * If not, then the cullable object is in the frustum.
  112356. */
  112357. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  112358. /** Culling strategy : Optimistic Inclusion.
  112359. * This in an inclusion test first, then the standard exclusion test.
  112360. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  112361. * 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.
  112362. * Anyway, it's as accurate as the standard strategy.
  112363. * Test :
  112364. * Is the cullable object bounding sphere center in the frustum ?
  112365. * If not, apply the default culling strategy.
  112366. */
  112367. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  112368. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  112369. * This in an inclusion test first, then the bounding sphere only exclusion test.
  112370. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  112371. * 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.
  112372. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  112373. * Test :
  112374. * Is the cullable object bounding sphere center in the frustum ?
  112375. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  112376. */
  112377. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  112378. /**
  112379. * No billboard
  112380. */
  112381. static get BILLBOARDMODE_NONE(): number;
  112382. /** Billboard on X axis */
  112383. static get BILLBOARDMODE_X(): number;
  112384. /** Billboard on Y axis */
  112385. static get BILLBOARDMODE_Y(): number;
  112386. /** Billboard on Z axis */
  112387. static get BILLBOARDMODE_Z(): number;
  112388. /** Billboard on all axes */
  112389. static get BILLBOARDMODE_ALL(): number;
  112390. /** Billboard on using position instead of orientation */
  112391. static get BILLBOARDMODE_USE_POSITION(): number;
  112392. /** @hidden */
  112393. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  112394. /**
  112395. * The culling strategy to use to check whether the mesh must be rendered or not.
  112396. * This value can be changed at any time and will be used on the next render mesh selection.
  112397. * The possible values are :
  112398. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  112399. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  112400. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  112401. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  112402. * Please read each static variable documentation to get details about the culling process.
  112403. * */
  112404. cullingStrategy: number;
  112405. /**
  112406. * Gets the number of facets in the mesh
  112407. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  112408. */
  112409. get facetNb(): number;
  112410. /**
  112411. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  112412. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  112413. */
  112414. get partitioningSubdivisions(): number;
  112415. set partitioningSubdivisions(nb: number);
  112416. /**
  112417. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  112418. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  112419. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  112420. */
  112421. get partitioningBBoxRatio(): number;
  112422. set partitioningBBoxRatio(ratio: number);
  112423. /**
  112424. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  112425. * Works only for updatable meshes.
  112426. * Doesn't work with multi-materials
  112427. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  112428. */
  112429. get mustDepthSortFacets(): boolean;
  112430. set mustDepthSortFacets(sort: boolean);
  112431. /**
  112432. * The location (Vector3) where the facet depth sort must be computed from.
  112433. * By default, the active camera position.
  112434. * Used only when facet depth sort is enabled
  112435. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  112436. */
  112437. get facetDepthSortFrom(): Vector3;
  112438. set facetDepthSortFrom(location: Vector3);
  112439. /**
  112440. * gets a boolean indicating if facetData is enabled
  112441. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  112442. */
  112443. get isFacetDataEnabled(): boolean;
  112444. /** @hidden */
  112445. _updateNonUniformScalingState(value: boolean): boolean;
  112446. /**
  112447. * An event triggered when this mesh collides with another one
  112448. */
  112449. onCollideObservable: Observable<AbstractMesh>;
  112450. /** Set a function to call when this mesh collides with another one */
  112451. set onCollide(callback: () => void);
  112452. /**
  112453. * An event triggered when the collision's position changes
  112454. */
  112455. onCollisionPositionChangeObservable: Observable<Vector3>;
  112456. /** Set a function to call when the collision's position changes */
  112457. set onCollisionPositionChange(callback: () => void);
  112458. /**
  112459. * An event triggered when material is changed
  112460. */
  112461. onMaterialChangedObservable: Observable<AbstractMesh>;
  112462. /**
  112463. * Gets or sets the orientation for POV movement & rotation
  112464. */
  112465. definedFacingForward: boolean;
  112466. /** @hidden */
  112467. _occlusionQuery: Nullable<WebGLQuery>;
  112468. /** @hidden */
  112469. _renderingGroup: Nullable<RenderingGroup>;
  112470. /**
  112471. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  112472. */
  112473. get visibility(): number;
  112474. /**
  112475. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  112476. */
  112477. set visibility(value: number);
  112478. /** Gets or sets the alpha index used to sort transparent meshes
  112479. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  112480. */
  112481. alphaIndex: number;
  112482. /**
  112483. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  112484. */
  112485. isVisible: boolean;
  112486. /**
  112487. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  112488. */
  112489. isPickable: boolean;
  112490. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  112491. showSubMeshesBoundingBox: boolean;
  112492. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  112493. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  112494. */
  112495. isBlocker: boolean;
  112496. /**
  112497. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  112498. */
  112499. enablePointerMoveEvents: boolean;
  112500. private _renderingGroupId;
  112501. /**
  112502. * Specifies the rendering group id for this mesh (0 by default)
  112503. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  112504. */
  112505. get renderingGroupId(): number;
  112506. set renderingGroupId(value: number);
  112507. private _material;
  112508. /** Gets or sets current material */
  112509. get material(): Nullable<Material>;
  112510. set material(value: Nullable<Material>);
  112511. /**
  112512. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  112513. * @see https://doc.babylonjs.com/babylon101/shadows
  112514. */
  112515. get receiveShadows(): boolean;
  112516. set receiveShadows(value: boolean);
  112517. /** Defines color to use when rendering outline */
  112518. outlineColor: Color3;
  112519. /** Define width to use when rendering outline */
  112520. outlineWidth: number;
  112521. /** Defines color to use when rendering overlay */
  112522. overlayColor: Color3;
  112523. /** Defines alpha to use when rendering overlay */
  112524. overlayAlpha: number;
  112525. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  112526. get hasVertexAlpha(): boolean;
  112527. set hasVertexAlpha(value: boolean);
  112528. /** 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) */
  112529. get useVertexColors(): boolean;
  112530. set useVertexColors(value: boolean);
  112531. /**
  112532. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  112533. */
  112534. get computeBonesUsingShaders(): boolean;
  112535. set computeBonesUsingShaders(value: boolean);
  112536. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  112537. get numBoneInfluencers(): number;
  112538. set numBoneInfluencers(value: number);
  112539. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  112540. get applyFog(): boolean;
  112541. set applyFog(value: boolean);
  112542. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  112543. useOctreeForRenderingSelection: boolean;
  112544. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  112545. useOctreeForPicking: boolean;
  112546. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  112547. useOctreeForCollisions: boolean;
  112548. /**
  112549. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  112550. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  112551. */
  112552. get layerMask(): number;
  112553. set layerMask(value: number);
  112554. /**
  112555. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  112556. */
  112557. alwaysSelectAsActiveMesh: boolean;
  112558. /**
  112559. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  112560. */
  112561. doNotSyncBoundingInfo: boolean;
  112562. /**
  112563. * Gets or sets the current action manager
  112564. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112565. */
  112566. actionManager: Nullable<AbstractActionManager>;
  112567. private _meshCollisionData;
  112568. /**
  112569. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  112570. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112571. */
  112572. ellipsoid: Vector3;
  112573. /**
  112574. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  112575. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112576. */
  112577. ellipsoidOffset: Vector3;
  112578. /**
  112579. * Gets or sets a collision mask used to mask collisions (default is -1).
  112580. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  112581. */
  112582. get collisionMask(): number;
  112583. set collisionMask(mask: number);
  112584. /**
  112585. * Gets or sets a collision response flag (default is true).
  112586. * when collisionResponse is false, events are still triggered but colliding entity has no response
  112587. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  112588. * to respond to the collision.
  112589. */
  112590. get collisionResponse(): boolean;
  112591. set collisionResponse(response: boolean);
  112592. /**
  112593. * Gets or sets the current collision group mask (-1 by default).
  112594. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  112595. */
  112596. get collisionGroup(): number;
  112597. set collisionGroup(mask: number);
  112598. /**
  112599. * Gets or sets current surrounding meshes (null by default).
  112600. *
  112601. * By default collision detection is tested against every mesh in the scene.
  112602. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  112603. * meshes will be tested for the collision.
  112604. *
  112605. * Note: if set to an empty array no collision will happen when this mesh is moved.
  112606. */
  112607. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  112608. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  112609. /**
  112610. * Defines edge width used when edgesRenderer is enabled
  112611. * @see https://www.babylonjs-playground.com/#10OJSG#13
  112612. */
  112613. edgesWidth: number;
  112614. /**
  112615. * Defines edge color used when edgesRenderer is enabled
  112616. * @see https://www.babylonjs-playground.com/#10OJSG#13
  112617. */
  112618. edgesColor: Color4;
  112619. /** @hidden */
  112620. _edgesRenderer: Nullable<IEdgesRenderer>;
  112621. /** @hidden */
  112622. _masterMesh: Nullable<AbstractMesh>;
  112623. /** @hidden */
  112624. _boundingInfo: Nullable<BoundingInfo>;
  112625. /** @hidden */
  112626. _renderId: number;
  112627. /**
  112628. * Gets or sets the list of subMeshes
  112629. * @see https://doc.babylonjs.com/how_to/multi_materials
  112630. */
  112631. subMeshes: SubMesh[];
  112632. /** @hidden */
  112633. _intersectionsInProgress: AbstractMesh[];
  112634. /** @hidden */
  112635. _unIndexed: boolean;
  112636. /** @hidden */
  112637. _lightSources: Light[];
  112638. /** Gets the list of lights affecting that mesh */
  112639. get lightSources(): Light[];
  112640. /** @hidden */
  112641. get _positions(): Nullable<Vector3[]>;
  112642. /** @hidden */
  112643. _waitingData: {
  112644. lods: Nullable<any>;
  112645. actions: Nullable<any>;
  112646. freezeWorldMatrix: Nullable<boolean>;
  112647. };
  112648. /** @hidden */
  112649. _bonesTransformMatrices: Nullable<Float32Array>;
  112650. /** @hidden */
  112651. _transformMatrixTexture: Nullable<RawTexture>;
  112652. /**
  112653. * Gets or sets a skeleton to apply skining transformations
  112654. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  112655. */
  112656. set skeleton(value: Nullable<Skeleton>);
  112657. get skeleton(): Nullable<Skeleton>;
  112658. /**
  112659. * An event triggered when the mesh is rebuilt.
  112660. */
  112661. onRebuildObservable: Observable<AbstractMesh>;
  112662. /**
  112663. * Creates a new AbstractMesh
  112664. * @param name defines the name of the mesh
  112665. * @param scene defines the hosting scene
  112666. */
  112667. constructor(name: string, scene?: Nullable<Scene>);
  112668. /**
  112669. * Returns the string "AbstractMesh"
  112670. * @returns "AbstractMesh"
  112671. */
  112672. getClassName(): string;
  112673. /**
  112674. * Gets a string representation of the current mesh
  112675. * @param fullDetails defines a boolean indicating if full details must be included
  112676. * @returns a string representation of the current mesh
  112677. */
  112678. toString(fullDetails?: boolean): string;
  112679. /**
  112680. * @hidden
  112681. */
  112682. protected _getEffectiveParent(): Nullable<Node>;
  112683. /** @hidden */
  112684. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112685. /** @hidden */
  112686. _rebuild(): void;
  112687. /** @hidden */
  112688. _resyncLightSources(): void;
  112689. /** @hidden */
  112690. _resyncLightSource(light: Light): void;
  112691. /** @hidden */
  112692. _unBindEffect(): void;
  112693. /** @hidden */
  112694. _removeLightSource(light: Light, dispose: boolean): void;
  112695. private _markSubMeshesAsDirty;
  112696. /** @hidden */
  112697. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  112698. /** @hidden */
  112699. _markSubMeshesAsAttributesDirty(): void;
  112700. /** @hidden */
  112701. _markSubMeshesAsMiscDirty(): void;
  112702. /**
  112703. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  112704. */
  112705. get scaling(): Vector3;
  112706. set scaling(newScaling: Vector3);
  112707. /**
  112708. * Returns true if the mesh is blocked. Implemented by child classes
  112709. */
  112710. get isBlocked(): boolean;
  112711. /**
  112712. * Returns the mesh itself by default. Implemented by child classes
  112713. * @param camera defines the camera to use to pick the right LOD level
  112714. * @returns the currentAbstractMesh
  112715. */
  112716. getLOD(camera: Camera): Nullable<AbstractMesh>;
  112717. /**
  112718. * Returns 0 by default. Implemented by child classes
  112719. * @returns an integer
  112720. */
  112721. getTotalVertices(): number;
  112722. /**
  112723. * Returns a positive integer : the total number of indices in this mesh geometry.
  112724. * @returns the numner of indices or zero if the mesh has no geometry.
  112725. */
  112726. getTotalIndices(): number;
  112727. /**
  112728. * Returns null by default. Implemented by child classes
  112729. * @returns null
  112730. */
  112731. getIndices(): Nullable<IndicesArray>;
  112732. /**
  112733. * Returns the array of the requested vertex data kind. Implemented by child classes
  112734. * @param kind defines the vertex data kind to use
  112735. * @returns null
  112736. */
  112737. getVerticesData(kind: string): Nullable<FloatArray>;
  112738. /**
  112739. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112740. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112741. * Note that a new underlying VertexBuffer object is created each call.
  112742. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112743. * @param kind defines vertex data kind:
  112744. * * VertexBuffer.PositionKind
  112745. * * VertexBuffer.UVKind
  112746. * * VertexBuffer.UV2Kind
  112747. * * VertexBuffer.UV3Kind
  112748. * * VertexBuffer.UV4Kind
  112749. * * VertexBuffer.UV5Kind
  112750. * * VertexBuffer.UV6Kind
  112751. * * VertexBuffer.ColorKind
  112752. * * VertexBuffer.MatricesIndicesKind
  112753. * * VertexBuffer.MatricesIndicesExtraKind
  112754. * * VertexBuffer.MatricesWeightsKind
  112755. * * VertexBuffer.MatricesWeightsExtraKind
  112756. * @param data defines the data source
  112757. * @param updatable defines if the data must be flagged as updatable (or static)
  112758. * @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
  112759. * @returns the current mesh
  112760. */
  112761. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112762. /**
  112763. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112764. * If the mesh has no geometry, it is simply returned as it is.
  112765. * @param kind defines vertex data kind:
  112766. * * VertexBuffer.PositionKind
  112767. * * VertexBuffer.UVKind
  112768. * * VertexBuffer.UV2Kind
  112769. * * VertexBuffer.UV3Kind
  112770. * * VertexBuffer.UV4Kind
  112771. * * VertexBuffer.UV5Kind
  112772. * * VertexBuffer.UV6Kind
  112773. * * VertexBuffer.ColorKind
  112774. * * VertexBuffer.MatricesIndicesKind
  112775. * * VertexBuffer.MatricesIndicesExtraKind
  112776. * * VertexBuffer.MatricesWeightsKind
  112777. * * VertexBuffer.MatricesWeightsExtraKind
  112778. * @param data defines the data source
  112779. * @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
  112780. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112781. * @returns the current mesh
  112782. */
  112783. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112784. /**
  112785. * Sets the mesh indices,
  112786. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112787. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112788. * @param totalVertices Defines the total number of vertices
  112789. * @returns the current mesh
  112790. */
  112791. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112792. /**
  112793. * Gets a boolean indicating if specific vertex data is present
  112794. * @param kind defines the vertex data kind to use
  112795. * @returns true is data kind is present
  112796. */
  112797. isVerticesDataPresent(kind: string): boolean;
  112798. /**
  112799. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112800. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112801. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112802. * @returns a BoundingInfo
  112803. */
  112804. getBoundingInfo(): BoundingInfo;
  112805. /**
  112806. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112807. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112808. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112809. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112810. * @returns the current mesh
  112811. */
  112812. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112813. /**
  112814. * Overwrite the current bounding info
  112815. * @param boundingInfo defines the new bounding info
  112816. * @returns the current mesh
  112817. */
  112818. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112819. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112820. get useBones(): boolean;
  112821. /** @hidden */
  112822. _preActivate(): void;
  112823. /** @hidden */
  112824. _preActivateForIntermediateRendering(renderId: number): void;
  112825. /** @hidden */
  112826. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112827. /** @hidden */
  112828. _postActivate(): void;
  112829. /** @hidden */
  112830. _freeze(): void;
  112831. /** @hidden */
  112832. _unFreeze(): void;
  112833. /**
  112834. * Gets the current world matrix
  112835. * @returns a Matrix
  112836. */
  112837. getWorldMatrix(): Matrix;
  112838. /** @hidden */
  112839. _getWorldMatrixDeterminant(): number;
  112840. /**
  112841. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112842. */
  112843. get isAnInstance(): boolean;
  112844. /**
  112845. * Gets a boolean indicating if this mesh has instances
  112846. */
  112847. get hasInstances(): boolean;
  112848. /**
  112849. * Gets a boolean indicating if this mesh has thin instances
  112850. */
  112851. get hasThinInstances(): boolean;
  112852. /**
  112853. * Perform relative position change from the point of view of behind the front of the mesh.
  112854. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112855. * Supports definition of mesh facing forward or backward
  112856. * @param amountRight defines the distance on the right axis
  112857. * @param amountUp defines the distance on the up axis
  112858. * @param amountForward defines the distance on the forward axis
  112859. * @returns the current mesh
  112860. */
  112861. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112862. /**
  112863. * Calculate relative position change from the point of view of behind the front of the mesh.
  112864. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112865. * Supports definition of mesh facing forward or backward
  112866. * @param amountRight defines the distance on the right axis
  112867. * @param amountUp defines the distance on the up axis
  112868. * @param amountForward defines the distance on the forward axis
  112869. * @returns the new displacement vector
  112870. */
  112871. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112872. /**
  112873. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112874. * Supports definition of mesh facing forward or backward
  112875. * @param flipBack defines the flip
  112876. * @param twirlClockwise defines the twirl
  112877. * @param tiltRight defines the tilt
  112878. * @returns the current mesh
  112879. */
  112880. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112881. /**
  112882. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112883. * Supports definition of mesh facing forward or backward.
  112884. * @param flipBack defines the flip
  112885. * @param twirlClockwise defines the twirl
  112886. * @param tiltRight defines the tilt
  112887. * @returns the new rotation vector
  112888. */
  112889. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112890. /**
  112891. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112892. * This means the mesh underlying bounding box and sphere are recomputed.
  112893. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112894. * @returns the current mesh
  112895. */
  112896. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112897. /** @hidden */
  112898. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112899. /** @hidden */
  112900. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112901. /** @hidden */
  112902. _updateBoundingInfo(): AbstractMesh;
  112903. /** @hidden */
  112904. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112905. /** @hidden */
  112906. protected _afterComputeWorldMatrix(): void;
  112907. /** @hidden */
  112908. get _effectiveMesh(): AbstractMesh;
  112909. /**
  112910. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112911. * A mesh is in the frustum if its bounding box intersects the frustum
  112912. * @param frustumPlanes defines the frustum to test
  112913. * @returns true if the mesh is in the frustum planes
  112914. */
  112915. isInFrustum(frustumPlanes: Plane[]): boolean;
  112916. /**
  112917. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112918. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112919. * @param frustumPlanes defines the frustum to test
  112920. * @returns true if the mesh is completely in the frustum planes
  112921. */
  112922. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112923. /**
  112924. * True if the mesh intersects another mesh or a SolidParticle object
  112925. * @param mesh defines a target mesh or SolidParticle to test
  112926. * @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)
  112927. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112928. * @returns true if there is an intersection
  112929. */
  112930. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112931. /**
  112932. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112933. * @param point defines the point to test
  112934. * @returns true if there is an intersection
  112935. */
  112936. intersectsPoint(point: Vector3): boolean;
  112937. /**
  112938. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112939. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112940. */
  112941. get checkCollisions(): boolean;
  112942. set checkCollisions(collisionEnabled: boolean);
  112943. /**
  112944. * Gets Collider object used to compute collisions (not physics)
  112945. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112946. */
  112947. get collider(): Nullable<Collider>;
  112948. /**
  112949. * Move the mesh using collision engine
  112950. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112951. * @param displacement defines the requested displacement vector
  112952. * @returns the current mesh
  112953. */
  112954. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112955. private _onCollisionPositionChange;
  112956. /** @hidden */
  112957. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112958. /** @hidden */
  112959. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112960. /** @hidden */
  112961. _checkCollision(collider: Collider): AbstractMesh;
  112962. /** @hidden */
  112963. _generatePointsArray(): boolean;
  112964. /**
  112965. * Checks if the passed Ray intersects with the mesh
  112966. * @param ray defines the ray to use
  112967. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112968. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112969. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112970. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112971. * @returns the picking info
  112972. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112973. */
  112974. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112975. /**
  112976. * Clones the current mesh
  112977. * @param name defines the mesh name
  112978. * @param newParent defines the new mesh parent
  112979. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112980. * @returns the new mesh
  112981. */
  112982. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112983. /**
  112984. * Disposes all the submeshes of the current meshnp
  112985. * @returns the current mesh
  112986. */
  112987. releaseSubMeshes(): AbstractMesh;
  112988. /**
  112989. * Releases resources associated with this abstract mesh.
  112990. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112991. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112992. */
  112993. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112994. /**
  112995. * Adds the passed mesh as a child to the current mesh
  112996. * @param mesh defines the child mesh
  112997. * @returns the current mesh
  112998. */
  112999. addChild(mesh: AbstractMesh): AbstractMesh;
  113000. /**
  113001. * Removes the passed mesh from the current mesh children list
  113002. * @param mesh defines the child mesh
  113003. * @returns the current mesh
  113004. */
  113005. removeChild(mesh: AbstractMesh): AbstractMesh;
  113006. /** @hidden */
  113007. private _initFacetData;
  113008. /**
  113009. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  113010. * This method can be called within the render loop.
  113011. * 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
  113012. * @returns the current mesh
  113013. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113014. */
  113015. updateFacetData(): AbstractMesh;
  113016. /**
  113017. * Returns the facetLocalNormals array.
  113018. * The normals are expressed in the mesh local spac
  113019. * @returns an array of Vector3
  113020. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113021. */
  113022. getFacetLocalNormals(): Vector3[];
  113023. /**
  113024. * Returns the facetLocalPositions array.
  113025. * The facet positions are expressed in the mesh local space
  113026. * @returns an array of Vector3
  113027. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113028. */
  113029. getFacetLocalPositions(): Vector3[];
  113030. /**
  113031. * Returns the facetLocalPartioning array
  113032. * @returns an array of array of numbers
  113033. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113034. */
  113035. getFacetLocalPartitioning(): number[][];
  113036. /**
  113037. * Returns the i-th facet position in the world system.
  113038. * This method allocates a new Vector3 per call
  113039. * @param i defines the facet index
  113040. * @returns a new Vector3
  113041. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113042. */
  113043. getFacetPosition(i: number): Vector3;
  113044. /**
  113045. * Sets the reference Vector3 with the i-th facet position in the world system
  113046. * @param i defines the facet index
  113047. * @param ref defines the target vector
  113048. * @returns the current mesh
  113049. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113050. */
  113051. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  113052. /**
  113053. * Returns the i-th facet normal in the world system.
  113054. * This method allocates a new Vector3 per call
  113055. * @param i defines the facet index
  113056. * @returns a new Vector3
  113057. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113058. */
  113059. getFacetNormal(i: number): Vector3;
  113060. /**
  113061. * Sets the reference Vector3 with the i-th facet normal in the world system
  113062. * @param i defines the facet index
  113063. * @param ref defines the target vector
  113064. * @returns the current mesh
  113065. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113066. */
  113067. getFacetNormalToRef(i: number, ref: Vector3): this;
  113068. /**
  113069. * 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)
  113070. * @param x defines x coordinate
  113071. * @param y defines y coordinate
  113072. * @param z defines z coordinate
  113073. * @returns the array of facet indexes
  113074. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113075. */
  113076. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  113077. /**
  113078. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  113079. * @param projected sets as the (x,y,z) world projection on the facet
  113080. * @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
  113081. * @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
  113082. * @param x defines x coordinate
  113083. * @param y defines y coordinate
  113084. * @param z defines z coordinate
  113085. * @returns the face index if found (or null instead)
  113086. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113087. */
  113088. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  113089. /**
  113090. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  113091. * @param projected sets as the (x,y,z) local projection on the facet
  113092. * @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
  113093. * @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
  113094. * @param x defines x coordinate
  113095. * @param y defines y coordinate
  113096. * @param z defines z coordinate
  113097. * @returns the face index if found (or null instead)
  113098. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113099. */
  113100. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  113101. /**
  113102. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  113103. * @returns the parameters
  113104. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113105. */
  113106. getFacetDataParameters(): any;
  113107. /**
  113108. * Disables the feature FacetData and frees the related memory
  113109. * @returns the current mesh
  113110. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113111. */
  113112. disableFacetData(): AbstractMesh;
  113113. /**
  113114. * Updates the AbstractMesh indices array
  113115. * @param indices defines the data source
  113116. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  113117. * @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)
  113118. * @returns the current mesh
  113119. */
  113120. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  113121. /**
  113122. * Creates new normals data for the mesh
  113123. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  113124. * @returns the current mesh
  113125. */
  113126. createNormals(updatable: boolean): AbstractMesh;
  113127. /**
  113128. * Align the mesh with a normal
  113129. * @param normal defines the normal to use
  113130. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  113131. * @returns the current mesh
  113132. */
  113133. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  113134. /** @hidden */
  113135. _checkOcclusionQuery(): boolean;
  113136. /**
  113137. * Disables the mesh edge rendering mode
  113138. * @returns the currentAbstractMesh
  113139. */
  113140. disableEdgesRendering(): AbstractMesh;
  113141. /**
  113142. * Enables the edge rendering mode on the mesh.
  113143. * This mode makes the mesh edges visible
  113144. * @param epsilon defines the maximal distance between two angles to detect a face
  113145. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  113146. * @returns the currentAbstractMesh
  113147. * @see https://www.babylonjs-playground.com/#19O9TU#0
  113148. */
  113149. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  113150. /**
  113151. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  113152. * @returns an array of particle systems in the scene that use the mesh as an emitter
  113153. */
  113154. getConnectedParticleSystems(): IParticleSystem[];
  113155. }
  113156. }
  113157. declare module BABYLON {
  113158. /**
  113159. * Interface used to define ActionEvent
  113160. */
  113161. export interface IActionEvent {
  113162. /** The mesh or sprite that triggered the action */
  113163. source: any;
  113164. /** The X mouse cursor position at the time of the event */
  113165. pointerX: number;
  113166. /** The Y mouse cursor position at the time of the event */
  113167. pointerY: number;
  113168. /** The mesh that is currently pointed at (can be null) */
  113169. meshUnderPointer: Nullable<AbstractMesh>;
  113170. /** the original (browser) event that triggered the ActionEvent */
  113171. sourceEvent?: any;
  113172. /** additional data for the event */
  113173. additionalData?: any;
  113174. }
  113175. /**
  113176. * ActionEvent is the event being sent when an action is triggered.
  113177. */
  113178. export class ActionEvent implements IActionEvent {
  113179. /** The mesh or sprite that triggered the action */
  113180. source: any;
  113181. /** The X mouse cursor position at the time of the event */
  113182. pointerX: number;
  113183. /** The Y mouse cursor position at the time of the event */
  113184. pointerY: number;
  113185. /** The mesh that is currently pointed at (can be null) */
  113186. meshUnderPointer: Nullable<AbstractMesh>;
  113187. /** the original (browser) event that triggered the ActionEvent */
  113188. sourceEvent?: any;
  113189. /** additional data for the event */
  113190. additionalData?: any;
  113191. /**
  113192. * Creates a new ActionEvent
  113193. * @param source The mesh or sprite that triggered the action
  113194. * @param pointerX The X mouse cursor position at the time of the event
  113195. * @param pointerY The Y mouse cursor position at the time of the event
  113196. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  113197. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  113198. * @param additionalData additional data for the event
  113199. */
  113200. constructor(
  113201. /** The mesh or sprite that triggered the action */
  113202. source: any,
  113203. /** The X mouse cursor position at the time of the event */
  113204. pointerX: number,
  113205. /** The Y mouse cursor position at the time of the event */
  113206. pointerY: number,
  113207. /** The mesh that is currently pointed at (can be null) */
  113208. meshUnderPointer: Nullable<AbstractMesh>,
  113209. /** the original (browser) event that triggered the ActionEvent */
  113210. sourceEvent?: any,
  113211. /** additional data for the event */
  113212. additionalData?: any);
  113213. /**
  113214. * Helper function to auto-create an ActionEvent from a source mesh.
  113215. * @param source The source mesh that triggered the event
  113216. * @param evt The original (browser) event
  113217. * @param additionalData additional data for the event
  113218. * @returns the new ActionEvent
  113219. */
  113220. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  113221. /**
  113222. * Helper function to auto-create an ActionEvent from a source sprite
  113223. * @param source The source sprite that triggered the event
  113224. * @param scene Scene associated with the sprite
  113225. * @param evt The original (browser) event
  113226. * @param additionalData additional data for the event
  113227. * @returns the new ActionEvent
  113228. */
  113229. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  113230. /**
  113231. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  113232. * @param scene the scene where the event occurred
  113233. * @param evt The original (browser) event
  113234. * @returns the new ActionEvent
  113235. */
  113236. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  113237. /**
  113238. * Helper function to auto-create an ActionEvent from a primitive
  113239. * @param prim defines the target primitive
  113240. * @param pointerPos defines the pointer position
  113241. * @param evt The original (browser) event
  113242. * @param additionalData additional data for the event
  113243. * @returns the new ActionEvent
  113244. */
  113245. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  113246. }
  113247. }
  113248. declare module BABYLON {
  113249. /**
  113250. * Abstract class used to decouple action Manager from scene and meshes.
  113251. * Do not instantiate.
  113252. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  113253. */
  113254. export abstract class AbstractActionManager implements IDisposable {
  113255. /** Gets the list of active triggers */
  113256. static Triggers: {
  113257. [key: string]: number;
  113258. };
  113259. /** Gets the cursor to use when hovering items */
  113260. hoverCursor: string;
  113261. /** Gets the list of actions */
  113262. actions: IAction[];
  113263. /**
  113264. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  113265. */
  113266. isRecursive: boolean;
  113267. /**
  113268. * Releases all associated resources
  113269. */
  113270. abstract dispose(): void;
  113271. /**
  113272. * Does this action manager has pointer triggers
  113273. */
  113274. abstract get hasPointerTriggers(): boolean;
  113275. /**
  113276. * Does this action manager has pick triggers
  113277. */
  113278. abstract get hasPickTriggers(): boolean;
  113279. /**
  113280. * Process a specific trigger
  113281. * @param trigger defines the trigger to process
  113282. * @param evt defines the event details to be processed
  113283. */
  113284. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  113285. /**
  113286. * Does this action manager handles actions of any of the given triggers
  113287. * @param triggers defines the triggers to be tested
  113288. * @return a boolean indicating whether one (or more) of the triggers is handled
  113289. */
  113290. abstract hasSpecificTriggers(triggers: number[]): boolean;
  113291. /**
  113292. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  113293. * speed.
  113294. * @param triggerA defines the trigger to be tested
  113295. * @param triggerB defines the trigger to be tested
  113296. * @return a boolean indicating whether one (or more) of the triggers is handled
  113297. */
  113298. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  113299. /**
  113300. * Does this action manager handles actions of a given trigger
  113301. * @param trigger defines the trigger to be tested
  113302. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  113303. * @return whether the trigger is handled
  113304. */
  113305. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  113306. /**
  113307. * Serialize this manager to a JSON object
  113308. * @param name defines the property name to store this manager
  113309. * @returns a JSON representation of this manager
  113310. */
  113311. abstract serialize(name: string): any;
  113312. /**
  113313. * Registers an action to this action manager
  113314. * @param action defines the action to be registered
  113315. * @return the action amended (prepared) after registration
  113316. */
  113317. abstract registerAction(action: IAction): Nullable<IAction>;
  113318. /**
  113319. * Unregisters an action to this action manager
  113320. * @param action defines the action to be unregistered
  113321. * @return a boolean indicating whether the action has been unregistered
  113322. */
  113323. abstract unregisterAction(action: IAction): Boolean;
  113324. /**
  113325. * Does exist one action manager with at least one trigger
  113326. **/
  113327. static get HasTriggers(): boolean;
  113328. /**
  113329. * Does exist one action manager with at least one pick trigger
  113330. **/
  113331. static get HasPickTriggers(): boolean;
  113332. /**
  113333. * Does exist one action manager that handles actions of a given trigger
  113334. * @param trigger defines the trigger to be tested
  113335. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  113336. **/
  113337. static HasSpecificTrigger(trigger: number): boolean;
  113338. }
  113339. }
  113340. declare module BABYLON {
  113341. /**
  113342. * Defines how a node can be built from a string name.
  113343. */
  113344. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  113345. /**
  113346. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  113347. */
  113348. export class Node implements IBehaviorAware<Node> {
  113349. /** @hidden */
  113350. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  113351. private static _NodeConstructors;
  113352. /**
  113353. * Add a new node constructor
  113354. * @param type defines the type name of the node to construct
  113355. * @param constructorFunc defines the constructor function
  113356. */
  113357. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  113358. /**
  113359. * Returns a node constructor based on type name
  113360. * @param type defines the type name
  113361. * @param name defines the new node name
  113362. * @param scene defines the hosting scene
  113363. * @param options defines optional options to transmit to constructors
  113364. * @returns the new constructor or null
  113365. */
  113366. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  113367. /**
  113368. * Gets or sets the name of the node
  113369. */
  113370. name: string;
  113371. /**
  113372. * Gets or sets the id of the node
  113373. */
  113374. id: string;
  113375. /**
  113376. * Gets or sets the unique id of the node
  113377. */
  113378. uniqueId: number;
  113379. /**
  113380. * Gets or sets a string used to store user defined state for the node
  113381. */
  113382. state: string;
  113383. /**
  113384. * Gets or sets an object used to store user defined information for the node
  113385. */
  113386. metadata: any;
  113387. /**
  113388. * For internal use only. Please do not use.
  113389. */
  113390. reservedDataStore: any;
  113391. /**
  113392. * List of inspectable custom properties (used by the Inspector)
  113393. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  113394. */
  113395. inspectableCustomProperties: IInspectable[];
  113396. private _doNotSerialize;
  113397. /**
  113398. * Gets or sets a boolean used to define if the node must be serialized
  113399. */
  113400. get doNotSerialize(): boolean;
  113401. set doNotSerialize(value: boolean);
  113402. /** @hidden */
  113403. _isDisposed: boolean;
  113404. /**
  113405. * Gets a list of Animations associated with the node
  113406. */
  113407. animations: Animation[];
  113408. protected _ranges: {
  113409. [name: string]: Nullable<AnimationRange>;
  113410. };
  113411. /**
  113412. * Callback raised when the node is ready to be used
  113413. */
  113414. onReady: Nullable<(node: Node) => void>;
  113415. private _isEnabled;
  113416. private _isParentEnabled;
  113417. private _isReady;
  113418. /** @hidden */
  113419. _currentRenderId: number;
  113420. private _parentUpdateId;
  113421. /** @hidden */
  113422. _childUpdateId: number;
  113423. /** @hidden */
  113424. _waitingParentId: Nullable<string>;
  113425. /** @hidden */
  113426. _scene: Scene;
  113427. /** @hidden */
  113428. _cache: any;
  113429. private _parentNode;
  113430. private _children;
  113431. /** @hidden */
  113432. _worldMatrix: Matrix;
  113433. /** @hidden */
  113434. _worldMatrixDeterminant: number;
  113435. /** @hidden */
  113436. _worldMatrixDeterminantIsDirty: boolean;
  113437. /** @hidden */
  113438. private _sceneRootNodesIndex;
  113439. /**
  113440. * Gets a boolean indicating if the node has been disposed
  113441. * @returns true if the node was disposed
  113442. */
  113443. isDisposed(): boolean;
  113444. /**
  113445. * Gets or sets the parent of the node (without keeping the current position in the scene)
  113446. * @see https://doc.babylonjs.com/how_to/parenting
  113447. */
  113448. set parent(parent: Nullable<Node>);
  113449. get parent(): Nullable<Node>;
  113450. /** @hidden */
  113451. _addToSceneRootNodes(): void;
  113452. /** @hidden */
  113453. _removeFromSceneRootNodes(): void;
  113454. private _animationPropertiesOverride;
  113455. /**
  113456. * Gets or sets the animation properties override
  113457. */
  113458. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  113459. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  113460. /**
  113461. * Gets a string identifying the name of the class
  113462. * @returns "Node" string
  113463. */
  113464. getClassName(): string;
  113465. /** @hidden */
  113466. readonly _isNode: boolean;
  113467. /**
  113468. * An event triggered when the mesh is disposed
  113469. */
  113470. onDisposeObservable: Observable<Node>;
  113471. private _onDisposeObserver;
  113472. /**
  113473. * Sets a callback that will be raised when the node will be disposed
  113474. */
  113475. set onDispose(callback: () => void);
  113476. /**
  113477. * Creates a new Node
  113478. * @param name the name and id to be given to this node
  113479. * @param scene the scene this node will be added to
  113480. */
  113481. constructor(name: string, scene?: Nullable<Scene>);
  113482. /**
  113483. * Gets the scene of the node
  113484. * @returns a scene
  113485. */
  113486. getScene(): Scene;
  113487. /**
  113488. * Gets the engine of the node
  113489. * @returns a Engine
  113490. */
  113491. getEngine(): Engine;
  113492. private _behaviors;
  113493. /**
  113494. * Attach a behavior to the node
  113495. * @see https://doc.babylonjs.com/features/behaviour
  113496. * @param behavior defines the behavior to attach
  113497. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  113498. * @returns the current Node
  113499. */
  113500. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  113501. /**
  113502. * Remove an attached behavior
  113503. * @see https://doc.babylonjs.com/features/behaviour
  113504. * @param behavior defines the behavior to attach
  113505. * @returns the current Node
  113506. */
  113507. removeBehavior(behavior: Behavior<Node>): Node;
  113508. /**
  113509. * Gets the list of attached behaviors
  113510. * @see https://doc.babylonjs.com/features/behaviour
  113511. */
  113512. get behaviors(): Behavior<Node>[];
  113513. /**
  113514. * Gets an attached behavior by name
  113515. * @param name defines the name of the behavior to look for
  113516. * @see https://doc.babylonjs.com/features/behaviour
  113517. * @returns null if behavior was not found else the requested behavior
  113518. */
  113519. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  113520. /**
  113521. * Returns the latest update of the World matrix
  113522. * @returns a Matrix
  113523. */
  113524. getWorldMatrix(): Matrix;
  113525. /** @hidden */
  113526. _getWorldMatrixDeterminant(): number;
  113527. /**
  113528. * Returns directly the latest state of the mesh World matrix.
  113529. * A Matrix is returned.
  113530. */
  113531. get worldMatrixFromCache(): Matrix;
  113532. /** @hidden */
  113533. _initCache(): void;
  113534. /** @hidden */
  113535. updateCache(force?: boolean): void;
  113536. /** @hidden */
  113537. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  113538. /** @hidden */
  113539. _updateCache(ignoreParentClass?: boolean): void;
  113540. /** @hidden */
  113541. _isSynchronized(): boolean;
  113542. /** @hidden */
  113543. _markSyncedWithParent(): void;
  113544. /** @hidden */
  113545. isSynchronizedWithParent(): boolean;
  113546. /** @hidden */
  113547. isSynchronized(): boolean;
  113548. /**
  113549. * Is this node ready to be used/rendered
  113550. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  113551. * @return true if the node is ready
  113552. */
  113553. isReady(completeCheck?: boolean): boolean;
  113554. /**
  113555. * Is this node enabled?
  113556. * 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
  113557. * @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
  113558. * @return whether this node (and its parent) is enabled
  113559. */
  113560. isEnabled(checkAncestors?: boolean): boolean;
  113561. /** @hidden */
  113562. protected _syncParentEnabledState(): void;
  113563. /**
  113564. * Set the enabled state of this node
  113565. * @param value defines the new enabled state
  113566. */
  113567. setEnabled(value: boolean): void;
  113568. /**
  113569. * Is this node a descendant of the given node?
  113570. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  113571. * @param ancestor defines the parent node to inspect
  113572. * @returns a boolean indicating if this node is a descendant of the given node
  113573. */
  113574. isDescendantOf(ancestor: Node): boolean;
  113575. /** @hidden */
  113576. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  113577. /**
  113578. * Will return all nodes that have this node as ascendant
  113579. * @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
  113580. * @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
  113581. * @return all children nodes of all types
  113582. */
  113583. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  113584. /**
  113585. * Get all child-meshes of this node
  113586. * @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)
  113587. * @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
  113588. * @returns an array of AbstractMesh
  113589. */
  113590. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  113591. /**
  113592. * Get all direct children of this node
  113593. * @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
  113594. * @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)
  113595. * @returns an array of Node
  113596. */
  113597. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  113598. /** @hidden */
  113599. _setReady(state: boolean): void;
  113600. /**
  113601. * Get an animation by name
  113602. * @param name defines the name of the animation to look for
  113603. * @returns null if not found else the requested animation
  113604. */
  113605. getAnimationByName(name: string): Nullable<Animation>;
  113606. /**
  113607. * Creates an animation range for this node
  113608. * @param name defines the name of the range
  113609. * @param from defines the starting key
  113610. * @param to defines the end key
  113611. */
  113612. createAnimationRange(name: string, from: number, to: number): void;
  113613. /**
  113614. * Delete a specific animation range
  113615. * @param name defines the name of the range to delete
  113616. * @param deleteFrames defines if animation frames from the range must be deleted as well
  113617. */
  113618. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  113619. /**
  113620. * Get an animation range by name
  113621. * @param name defines the name of the animation range to look for
  113622. * @returns null if not found else the requested animation range
  113623. */
  113624. getAnimationRange(name: string): Nullable<AnimationRange>;
  113625. /**
  113626. * Gets the list of all animation ranges defined on this node
  113627. * @returns an array
  113628. */
  113629. getAnimationRanges(): Nullable<AnimationRange>[];
  113630. /**
  113631. * Will start the animation sequence
  113632. * @param name defines the range frames for animation sequence
  113633. * @param loop defines if the animation should loop (false by default)
  113634. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  113635. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  113636. * @returns the object created for this animation. If range does not exist, it will return null
  113637. */
  113638. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  113639. /**
  113640. * Serialize animation ranges into a JSON compatible object
  113641. * @returns serialization object
  113642. */
  113643. serializeAnimationRanges(): any;
  113644. /**
  113645. * Computes the world matrix of the node
  113646. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  113647. * @returns the world matrix
  113648. */
  113649. computeWorldMatrix(force?: boolean): Matrix;
  113650. /**
  113651. * Releases resources associated with this node.
  113652. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  113653. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  113654. */
  113655. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  113656. /**
  113657. * Parse animation range data from a serialization object and store them into a given node
  113658. * @param node defines where to store the animation ranges
  113659. * @param parsedNode defines the serialization object to read data from
  113660. * @param scene defines the hosting scene
  113661. */
  113662. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  113663. /**
  113664. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  113665. * @param includeDescendants Include bounding info from descendants as well (true by default)
  113666. * @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
  113667. * @returns the new bounding vectors
  113668. */
  113669. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  113670. min: Vector3;
  113671. max: Vector3;
  113672. };
  113673. }
  113674. }
  113675. declare module BABYLON {
  113676. /**
  113677. * @hidden
  113678. */
  113679. export class _IAnimationState {
  113680. key: number;
  113681. repeatCount: number;
  113682. workValue?: any;
  113683. loopMode?: number;
  113684. offsetValue?: any;
  113685. highLimitValue?: any;
  113686. }
  113687. /**
  113688. * Class used to store any kind of animation
  113689. */
  113690. export class Animation {
  113691. /**Name of the animation */
  113692. name: string;
  113693. /**Property to animate */
  113694. targetProperty: string;
  113695. /**The frames per second of the animation */
  113696. framePerSecond: number;
  113697. /**The data type of the animation */
  113698. dataType: number;
  113699. /**The loop mode of the animation */
  113700. loopMode?: number | undefined;
  113701. /**Specifies if blending should be enabled */
  113702. enableBlending?: boolean | undefined;
  113703. /**
  113704. * Use matrix interpolation instead of using direct key value when animating matrices
  113705. */
  113706. static AllowMatricesInterpolation: boolean;
  113707. /**
  113708. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  113709. */
  113710. static AllowMatrixDecomposeForInterpolation: boolean;
  113711. /** Define the Url to load snippets */
  113712. static SnippetUrl: string;
  113713. /** Snippet ID if the animation was created from the snippet server */
  113714. snippetId: string;
  113715. /**
  113716. * Stores the key frames of the animation
  113717. */
  113718. private _keys;
  113719. /**
  113720. * Stores the easing function of the animation
  113721. */
  113722. private _easingFunction;
  113723. /**
  113724. * @hidden Internal use only
  113725. */
  113726. _runtimeAnimations: RuntimeAnimation[];
  113727. /**
  113728. * The set of event that will be linked to this animation
  113729. */
  113730. private _events;
  113731. /**
  113732. * Stores an array of target property paths
  113733. */
  113734. targetPropertyPath: string[];
  113735. /**
  113736. * Stores the blending speed of the animation
  113737. */
  113738. blendingSpeed: number;
  113739. /**
  113740. * Stores the animation ranges for the animation
  113741. */
  113742. private _ranges;
  113743. /**
  113744. * @hidden Internal use
  113745. */
  113746. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113747. /**
  113748. * Sets up an animation
  113749. * @param property The property to animate
  113750. * @param animationType The animation type to apply
  113751. * @param framePerSecond The frames per second of the animation
  113752. * @param easingFunction The easing function used in the animation
  113753. * @returns The created animation
  113754. */
  113755. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113756. /**
  113757. * Create and start an animation on a node
  113758. * @param name defines the name of the global animation that will be run on all nodes
  113759. * @param node defines the root node where the animation will take place
  113760. * @param targetProperty defines property to animate
  113761. * @param framePerSecond defines the number of frame per second yo use
  113762. * @param totalFrame defines the number of frames in total
  113763. * @param from defines the initial value
  113764. * @param to defines the final value
  113765. * @param loopMode defines which loop mode you want to use (off by default)
  113766. * @param easingFunction defines the easing function to use (linear by default)
  113767. * @param onAnimationEnd defines the callback to call when animation end
  113768. * @returns the animatable created for this animation
  113769. */
  113770. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113771. /**
  113772. * Create and start an animation on a node and its descendants
  113773. * @param name defines the name of the global animation that will be run on all nodes
  113774. * @param node defines the root node where the animation will take place
  113775. * @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
  113776. * @param targetProperty defines property to animate
  113777. * @param framePerSecond defines the number of frame per second to use
  113778. * @param totalFrame defines the number of frames in total
  113779. * @param from defines the initial value
  113780. * @param to defines the final value
  113781. * @param loopMode defines which loop mode you want to use (off by default)
  113782. * @param easingFunction defines the easing function to use (linear by default)
  113783. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113784. * @returns the list of animatables created for all nodes
  113785. * @example https://www.babylonjs-playground.com/#MH0VLI
  113786. */
  113787. 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[]>;
  113788. /**
  113789. * Creates a new animation, merges it with the existing animations and starts it
  113790. * @param name Name of the animation
  113791. * @param node Node which contains the scene that begins the animations
  113792. * @param targetProperty Specifies which property to animate
  113793. * @param framePerSecond The frames per second of the animation
  113794. * @param totalFrame The total number of frames
  113795. * @param from The frame at the beginning of the animation
  113796. * @param to The frame at the end of the animation
  113797. * @param loopMode Specifies the loop mode of the animation
  113798. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113799. * @param onAnimationEnd Callback to run once the animation is complete
  113800. * @returns Nullable animation
  113801. */
  113802. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113803. /**
  113804. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113805. * @param sourceAnimation defines the Animation containing keyframes to convert
  113806. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113807. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113808. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113809. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113810. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113811. */
  113812. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113813. /**
  113814. * Transition property of an host to the target Value
  113815. * @param property The property to transition
  113816. * @param targetValue The target Value of the property
  113817. * @param host The object where the property to animate belongs
  113818. * @param scene Scene used to run the animation
  113819. * @param frameRate Framerate (in frame/s) to use
  113820. * @param transition The transition type we want to use
  113821. * @param duration The duration of the animation, in milliseconds
  113822. * @param onAnimationEnd Callback trigger at the end of the animation
  113823. * @returns Nullable animation
  113824. */
  113825. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113826. /**
  113827. * Return the array of runtime animations currently using this animation
  113828. */
  113829. get runtimeAnimations(): RuntimeAnimation[];
  113830. /**
  113831. * Specifies if any of the runtime animations are currently running
  113832. */
  113833. get hasRunningRuntimeAnimations(): boolean;
  113834. /**
  113835. * Initializes the animation
  113836. * @param name Name of the animation
  113837. * @param targetProperty Property to animate
  113838. * @param framePerSecond The frames per second of the animation
  113839. * @param dataType The data type of the animation
  113840. * @param loopMode The loop mode of the animation
  113841. * @param enableBlending Specifies if blending should be enabled
  113842. */
  113843. constructor(
  113844. /**Name of the animation */
  113845. name: string,
  113846. /**Property to animate */
  113847. targetProperty: string,
  113848. /**The frames per second of the animation */
  113849. framePerSecond: number,
  113850. /**The data type of the animation */
  113851. dataType: number,
  113852. /**The loop mode of the animation */
  113853. loopMode?: number | undefined,
  113854. /**Specifies if blending should be enabled */
  113855. enableBlending?: boolean | undefined);
  113856. /**
  113857. * Converts the animation to a string
  113858. * @param fullDetails support for multiple levels of logging within scene loading
  113859. * @returns String form of the animation
  113860. */
  113861. toString(fullDetails?: boolean): string;
  113862. /**
  113863. * Add an event to this animation
  113864. * @param event Event to add
  113865. */
  113866. addEvent(event: AnimationEvent): void;
  113867. /**
  113868. * Remove all events found at the given frame
  113869. * @param frame The frame to remove events from
  113870. */
  113871. removeEvents(frame: number): void;
  113872. /**
  113873. * Retrieves all the events from the animation
  113874. * @returns Events from the animation
  113875. */
  113876. getEvents(): AnimationEvent[];
  113877. /**
  113878. * Creates an animation range
  113879. * @param name Name of the animation range
  113880. * @param from Starting frame of the animation range
  113881. * @param to Ending frame of the animation
  113882. */
  113883. createRange(name: string, from: number, to: number): void;
  113884. /**
  113885. * Deletes an animation range by name
  113886. * @param name Name of the animation range to delete
  113887. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113888. */
  113889. deleteRange(name: string, deleteFrames?: boolean): void;
  113890. /**
  113891. * Gets the animation range by name, or null if not defined
  113892. * @param name Name of the animation range
  113893. * @returns Nullable animation range
  113894. */
  113895. getRange(name: string): Nullable<AnimationRange>;
  113896. /**
  113897. * Gets the key frames from the animation
  113898. * @returns The key frames of the animation
  113899. */
  113900. getKeys(): Array<IAnimationKey>;
  113901. /**
  113902. * Gets the highest frame rate of the animation
  113903. * @returns Highest frame rate of the animation
  113904. */
  113905. getHighestFrame(): number;
  113906. /**
  113907. * Gets the easing function of the animation
  113908. * @returns Easing function of the animation
  113909. */
  113910. getEasingFunction(): IEasingFunction;
  113911. /**
  113912. * Sets the easing function of the animation
  113913. * @param easingFunction A custom mathematical formula for animation
  113914. */
  113915. setEasingFunction(easingFunction: EasingFunction): void;
  113916. /**
  113917. * Interpolates a scalar linearly
  113918. * @param startValue Start value of the animation curve
  113919. * @param endValue End value of the animation curve
  113920. * @param gradient Scalar amount to interpolate
  113921. * @returns Interpolated scalar value
  113922. */
  113923. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113924. /**
  113925. * Interpolates a scalar cubically
  113926. * @param startValue Start value of the animation curve
  113927. * @param outTangent End tangent of the animation
  113928. * @param endValue End value of the animation curve
  113929. * @param inTangent Start tangent of the animation curve
  113930. * @param gradient Scalar amount to interpolate
  113931. * @returns Interpolated scalar value
  113932. */
  113933. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113934. /**
  113935. * Interpolates a quaternion using a spherical linear interpolation
  113936. * @param startValue Start value of the animation curve
  113937. * @param endValue End value of the animation curve
  113938. * @param gradient Scalar amount to interpolate
  113939. * @returns Interpolated quaternion value
  113940. */
  113941. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113942. /**
  113943. * Interpolates a quaternion cubically
  113944. * @param startValue Start value of the animation curve
  113945. * @param outTangent End tangent of the animation curve
  113946. * @param endValue End value of the animation curve
  113947. * @param inTangent Start tangent of the animation curve
  113948. * @param gradient Scalar amount to interpolate
  113949. * @returns Interpolated quaternion value
  113950. */
  113951. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113952. /**
  113953. * Interpolates a Vector3 linearl
  113954. * @param startValue Start value of the animation curve
  113955. * @param endValue End value of the animation curve
  113956. * @param gradient Scalar amount to interpolate
  113957. * @returns Interpolated scalar value
  113958. */
  113959. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113960. /**
  113961. * Interpolates a Vector3 cubically
  113962. * @param startValue Start value of the animation curve
  113963. * @param outTangent End tangent of the animation
  113964. * @param endValue End value of the animation curve
  113965. * @param inTangent Start tangent of the animation curve
  113966. * @param gradient Scalar amount to interpolate
  113967. * @returns InterpolatedVector3 value
  113968. */
  113969. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113970. /**
  113971. * Interpolates a Vector2 linearly
  113972. * @param startValue Start value of the animation curve
  113973. * @param endValue End value of the animation curve
  113974. * @param gradient Scalar amount to interpolate
  113975. * @returns Interpolated Vector2 value
  113976. */
  113977. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113978. /**
  113979. * Interpolates a Vector2 cubically
  113980. * @param startValue Start value of the animation curve
  113981. * @param outTangent End tangent of the animation
  113982. * @param endValue End value of the animation curve
  113983. * @param inTangent Start tangent of the animation curve
  113984. * @param gradient Scalar amount to interpolate
  113985. * @returns Interpolated Vector2 value
  113986. */
  113987. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113988. /**
  113989. * Interpolates a size linearly
  113990. * @param startValue Start value of the animation curve
  113991. * @param endValue End value of the animation curve
  113992. * @param gradient Scalar amount to interpolate
  113993. * @returns Interpolated Size value
  113994. */
  113995. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113996. /**
  113997. * Interpolates a Color3 linearly
  113998. * @param startValue Start value of the animation curve
  113999. * @param endValue End value of the animation curve
  114000. * @param gradient Scalar amount to interpolate
  114001. * @returns Interpolated Color3 value
  114002. */
  114003. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  114004. /**
  114005. * Interpolates a Color4 linearly
  114006. * @param startValue Start value of the animation curve
  114007. * @param endValue End value of the animation curve
  114008. * @param gradient Scalar amount to interpolate
  114009. * @returns Interpolated Color3 value
  114010. */
  114011. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  114012. /**
  114013. * @hidden Internal use only
  114014. */
  114015. _getKeyValue(value: any): any;
  114016. /**
  114017. * @hidden Internal use only
  114018. */
  114019. _interpolate(currentFrame: number, state: _IAnimationState): any;
  114020. /**
  114021. * Defines the function to use to interpolate matrices
  114022. * @param startValue defines the start matrix
  114023. * @param endValue defines the end matrix
  114024. * @param gradient defines the gradient between both matrices
  114025. * @param result defines an optional target matrix where to store the interpolation
  114026. * @returns the interpolated matrix
  114027. */
  114028. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  114029. /**
  114030. * Makes a copy of the animation
  114031. * @returns Cloned animation
  114032. */
  114033. clone(): Animation;
  114034. /**
  114035. * Sets the key frames of the animation
  114036. * @param values The animation key frames to set
  114037. */
  114038. setKeys(values: Array<IAnimationKey>): void;
  114039. /**
  114040. * Serializes the animation to an object
  114041. * @returns Serialized object
  114042. */
  114043. serialize(): any;
  114044. /**
  114045. * Float animation type
  114046. */
  114047. static readonly ANIMATIONTYPE_FLOAT: number;
  114048. /**
  114049. * Vector3 animation type
  114050. */
  114051. static readonly ANIMATIONTYPE_VECTOR3: number;
  114052. /**
  114053. * Quaternion animation type
  114054. */
  114055. static readonly ANIMATIONTYPE_QUATERNION: number;
  114056. /**
  114057. * Matrix animation type
  114058. */
  114059. static readonly ANIMATIONTYPE_MATRIX: number;
  114060. /**
  114061. * Color3 animation type
  114062. */
  114063. static readonly ANIMATIONTYPE_COLOR3: number;
  114064. /**
  114065. * Color3 animation type
  114066. */
  114067. static readonly ANIMATIONTYPE_COLOR4: number;
  114068. /**
  114069. * Vector2 animation type
  114070. */
  114071. static readonly ANIMATIONTYPE_VECTOR2: number;
  114072. /**
  114073. * Size animation type
  114074. */
  114075. static readonly ANIMATIONTYPE_SIZE: number;
  114076. /**
  114077. * Relative Loop Mode
  114078. */
  114079. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  114080. /**
  114081. * Cycle Loop Mode
  114082. */
  114083. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  114084. /**
  114085. * Constant Loop Mode
  114086. */
  114087. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  114088. /** @hidden */
  114089. static _UniversalLerp(left: any, right: any, amount: number): any;
  114090. /**
  114091. * Parses an animation object and creates an animation
  114092. * @param parsedAnimation Parsed animation object
  114093. * @returns Animation object
  114094. */
  114095. static Parse(parsedAnimation: any): Animation;
  114096. /**
  114097. * Appends the serialized animations from the source animations
  114098. * @param source Source containing the animations
  114099. * @param destination Target to store the animations
  114100. */
  114101. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  114102. /**
  114103. * Creates a new animation or an array of animations from a snippet saved in a remote file
  114104. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  114105. * @param url defines the url to load from
  114106. * @returns a promise that will resolve to the new animation or an array of animations
  114107. */
  114108. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  114109. /**
  114110. * Creates an animation or an array of animations from a snippet saved by the Inspector
  114111. * @param snippetId defines the snippet to load
  114112. * @returns a promise that will resolve to the new animation or a new array of animations
  114113. */
  114114. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  114115. }
  114116. }
  114117. declare module BABYLON {
  114118. /**
  114119. * Interface containing an array of animations
  114120. */
  114121. export interface IAnimatable {
  114122. /**
  114123. * Array of animations
  114124. */
  114125. animations: Nullable<Array<Animation>>;
  114126. }
  114127. }
  114128. declare module BABYLON {
  114129. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  114130. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114131. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114132. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114133. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114134. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114135. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114136. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114137. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114138. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114139. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114140. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114141. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114142. /**
  114143. * Decorator used to define property that can be serialized as reference to a camera
  114144. * @param sourceName defines the name of the property to decorate
  114145. */
  114146. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114147. /**
  114148. * Class used to help serialization objects
  114149. */
  114150. export class SerializationHelper {
  114151. /** @hidden */
  114152. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  114153. /** @hidden */
  114154. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  114155. /** @hidden */
  114156. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  114157. /** @hidden */
  114158. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  114159. /**
  114160. * Appends the serialized animations from the source animations
  114161. * @param source Source containing the animations
  114162. * @param destination Target to store the animations
  114163. */
  114164. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  114165. /**
  114166. * Static function used to serialized a specific entity
  114167. * @param entity defines the entity to serialize
  114168. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  114169. * @returns a JSON compatible object representing the serialization of the entity
  114170. */
  114171. static Serialize<T>(entity: T, serializationObject?: any): any;
  114172. /**
  114173. * Creates a new entity from a serialization data object
  114174. * @param creationFunction defines a function used to instanciated the new entity
  114175. * @param source defines the source serialization data
  114176. * @param scene defines the hosting scene
  114177. * @param rootUrl defines the root url for resources
  114178. * @returns a new entity
  114179. */
  114180. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  114181. /**
  114182. * Clones an object
  114183. * @param creationFunction defines the function used to instanciate the new object
  114184. * @param source defines the source object
  114185. * @returns the cloned object
  114186. */
  114187. static Clone<T>(creationFunction: () => T, source: T): T;
  114188. /**
  114189. * Instanciates a new object based on a source one (some data will be shared between both object)
  114190. * @param creationFunction defines the function used to instanciate the new object
  114191. * @param source defines the source object
  114192. * @returns the new object
  114193. */
  114194. static Instanciate<T>(creationFunction: () => T, source: T): T;
  114195. }
  114196. }
  114197. declare module BABYLON {
  114198. /**
  114199. * Base class of all the textures in babylon.
  114200. * It groups all the common properties the materials, post process, lights... might need
  114201. * in order to make a correct use of the texture.
  114202. */
  114203. export class BaseTexture implements IAnimatable {
  114204. /**
  114205. * Default anisotropic filtering level for the application.
  114206. * It is set to 4 as a good tradeoff between perf and quality.
  114207. */
  114208. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  114209. /**
  114210. * Gets or sets the unique id of the texture
  114211. */
  114212. uniqueId: number;
  114213. /**
  114214. * Define the name of the texture.
  114215. */
  114216. name: string;
  114217. /**
  114218. * Gets or sets an object used to store user defined information.
  114219. */
  114220. metadata: any;
  114221. /**
  114222. * For internal use only. Please do not use.
  114223. */
  114224. reservedDataStore: any;
  114225. private _hasAlpha;
  114226. /**
  114227. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  114228. */
  114229. set hasAlpha(value: boolean);
  114230. get hasAlpha(): boolean;
  114231. /**
  114232. * Defines if the alpha value should be determined via the rgb values.
  114233. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  114234. */
  114235. getAlphaFromRGB: boolean;
  114236. /**
  114237. * Intensity or strength of the texture.
  114238. * It is commonly used by materials to fine tune the intensity of the texture
  114239. */
  114240. level: number;
  114241. /**
  114242. * Define the UV chanel to use starting from 0 and defaulting to 0.
  114243. * This is part of the texture as textures usually maps to one uv set.
  114244. */
  114245. coordinatesIndex: number;
  114246. protected _coordinatesMode: number;
  114247. /**
  114248. * How a texture is mapped.
  114249. *
  114250. * | Value | Type | Description |
  114251. * | ----- | ----------------------------------- | ----------- |
  114252. * | 0 | EXPLICIT_MODE | |
  114253. * | 1 | SPHERICAL_MODE | |
  114254. * | 2 | PLANAR_MODE | |
  114255. * | 3 | CUBIC_MODE | |
  114256. * | 4 | PROJECTION_MODE | |
  114257. * | 5 | SKYBOX_MODE | |
  114258. * | 6 | INVCUBIC_MODE | |
  114259. * | 7 | EQUIRECTANGULAR_MODE | |
  114260. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  114261. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  114262. */
  114263. set coordinatesMode(value: number);
  114264. get coordinatesMode(): number;
  114265. private _wrapU;
  114266. /**
  114267. * | Value | Type | Description |
  114268. * | ----- | ------------------ | ----------- |
  114269. * | 0 | CLAMP_ADDRESSMODE | |
  114270. * | 1 | WRAP_ADDRESSMODE | |
  114271. * | 2 | MIRROR_ADDRESSMODE | |
  114272. */
  114273. get wrapU(): number;
  114274. set wrapU(value: number);
  114275. private _wrapV;
  114276. /**
  114277. * | Value | Type | Description |
  114278. * | ----- | ------------------ | ----------- |
  114279. * | 0 | CLAMP_ADDRESSMODE | |
  114280. * | 1 | WRAP_ADDRESSMODE | |
  114281. * | 2 | MIRROR_ADDRESSMODE | |
  114282. */
  114283. get wrapV(): number;
  114284. set wrapV(value: number);
  114285. /**
  114286. * | Value | Type | Description |
  114287. * | ----- | ------------------ | ----------- |
  114288. * | 0 | CLAMP_ADDRESSMODE | |
  114289. * | 1 | WRAP_ADDRESSMODE | |
  114290. * | 2 | MIRROR_ADDRESSMODE | |
  114291. */
  114292. wrapR: number;
  114293. /**
  114294. * With compliant hardware and browser (supporting anisotropic filtering)
  114295. * this defines the level of anisotropic filtering in the texture.
  114296. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  114297. */
  114298. anisotropicFilteringLevel: number;
  114299. /**
  114300. * Define if the texture is a cube texture or if false a 2d texture.
  114301. */
  114302. get isCube(): boolean;
  114303. set isCube(value: boolean);
  114304. /**
  114305. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  114306. */
  114307. get is3D(): boolean;
  114308. set is3D(value: boolean);
  114309. /**
  114310. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  114311. */
  114312. get is2DArray(): boolean;
  114313. set is2DArray(value: boolean);
  114314. private _gammaSpace;
  114315. /**
  114316. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  114317. * HDR texture are usually stored in linear space.
  114318. * This only impacts the PBR and Background materials
  114319. */
  114320. get gammaSpace(): boolean;
  114321. set gammaSpace(gamma: boolean);
  114322. /**
  114323. * Gets or sets whether or not the texture contains RGBD data.
  114324. */
  114325. get isRGBD(): boolean;
  114326. set isRGBD(value: boolean);
  114327. /**
  114328. * Is Z inverted in the texture (useful in a cube texture).
  114329. */
  114330. invertZ: boolean;
  114331. /**
  114332. * Are mip maps generated for this texture or not.
  114333. */
  114334. get noMipmap(): boolean;
  114335. /**
  114336. * @hidden
  114337. */
  114338. lodLevelInAlpha: boolean;
  114339. /**
  114340. * With prefiltered texture, defined the offset used during the prefiltering steps.
  114341. */
  114342. get lodGenerationOffset(): number;
  114343. set lodGenerationOffset(value: number);
  114344. /**
  114345. * With prefiltered texture, defined the scale used during the prefiltering steps.
  114346. */
  114347. get lodGenerationScale(): number;
  114348. set lodGenerationScale(value: number);
  114349. /**
  114350. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  114351. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  114352. * average roughness values.
  114353. */
  114354. get linearSpecularLOD(): boolean;
  114355. set linearSpecularLOD(value: boolean);
  114356. /**
  114357. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  114358. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  114359. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  114360. */
  114361. get irradianceTexture(): Nullable<BaseTexture>;
  114362. set irradianceTexture(value: Nullable<BaseTexture>);
  114363. /**
  114364. * Define if the texture is a render target.
  114365. */
  114366. isRenderTarget: boolean;
  114367. /**
  114368. * Define the unique id of the texture in the scene.
  114369. */
  114370. get uid(): string;
  114371. /** @hidden */
  114372. _prefiltered: boolean;
  114373. /**
  114374. * Return a string representation of the texture.
  114375. * @returns the texture as a string
  114376. */
  114377. toString(): string;
  114378. /**
  114379. * Get the class name of the texture.
  114380. * @returns "BaseTexture"
  114381. */
  114382. getClassName(): string;
  114383. /**
  114384. * Define the list of animation attached to the texture.
  114385. */
  114386. animations: Animation[];
  114387. /**
  114388. * An event triggered when the texture is disposed.
  114389. */
  114390. onDisposeObservable: Observable<BaseTexture>;
  114391. private _onDisposeObserver;
  114392. /**
  114393. * Callback triggered when the texture has been disposed.
  114394. * Kept for back compatibility, you can use the onDisposeObservable instead.
  114395. */
  114396. set onDispose(callback: () => void);
  114397. /**
  114398. * Define the current state of the loading sequence when in delayed load mode.
  114399. */
  114400. delayLoadState: number;
  114401. protected _scene: Nullable<Scene>;
  114402. protected _engine: Nullable<ThinEngine>;
  114403. /** @hidden */
  114404. _texture: Nullable<InternalTexture>;
  114405. private _uid;
  114406. /**
  114407. * Define if the texture is preventinga material to render or not.
  114408. * If not and the texture is not ready, the engine will use a default black texture instead.
  114409. */
  114410. get isBlocking(): boolean;
  114411. /**
  114412. * Instantiates a new BaseTexture.
  114413. * Base class of all the textures in babylon.
  114414. * It groups all the common properties the materials, post process, lights... might need
  114415. * in order to make a correct use of the texture.
  114416. * @param sceneOrEngine Define the scene or engine the texture blongs to
  114417. */
  114418. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  114419. /**
  114420. * Get the scene the texture belongs to.
  114421. * @returns the scene or null if undefined
  114422. */
  114423. getScene(): Nullable<Scene>;
  114424. /** @hidden */
  114425. protected _getEngine(): Nullable<ThinEngine>;
  114426. /**
  114427. * Get the texture transform matrix used to offset tile the texture for istance.
  114428. * @returns the transformation matrix
  114429. */
  114430. getTextureMatrix(): Matrix;
  114431. /**
  114432. * Get the texture reflection matrix used to rotate/transform the reflection.
  114433. * @returns the reflection matrix
  114434. */
  114435. getReflectionTextureMatrix(): Matrix;
  114436. /**
  114437. * Get the underlying lower level texture from Babylon.
  114438. * @returns the insternal texture
  114439. */
  114440. getInternalTexture(): Nullable<InternalTexture>;
  114441. /**
  114442. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  114443. * @returns true if ready or not blocking
  114444. */
  114445. isReadyOrNotBlocking(): boolean;
  114446. /**
  114447. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  114448. * @returns true if fully ready
  114449. */
  114450. isReady(): boolean;
  114451. private _cachedSize;
  114452. /**
  114453. * Get the size of the texture.
  114454. * @returns the texture size.
  114455. */
  114456. getSize(): ISize;
  114457. /**
  114458. * Get the base size of the texture.
  114459. * It can be different from the size if the texture has been resized for POT for instance
  114460. * @returns the base size
  114461. */
  114462. getBaseSize(): ISize;
  114463. /**
  114464. * Update the sampling mode of the texture.
  114465. * Default is Trilinear mode.
  114466. *
  114467. * | Value | Type | Description |
  114468. * | ----- | ------------------ | ----------- |
  114469. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  114470. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  114471. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  114472. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  114473. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  114474. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  114475. * | 7 | NEAREST_LINEAR | |
  114476. * | 8 | NEAREST_NEAREST | |
  114477. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  114478. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  114479. * | 11 | LINEAR_LINEAR | |
  114480. * | 12 | LINEAR_NEAREST | |
  114481. *
  114482. * > _mag_: magnification filter (close to the viewer)
  114483. * > _min_: minification filter (far from the viewer)
  114484. * > _mip_: filter used between mip map levels
  114485. *@param samplingMode Define the new sampling mode of the texture
  114486. */
  114487. updateSamplingMode(samplingMode: number): void;
  114488. /**
  114489. * Scales the texture if is `canRescale()`
  114490. * @param ratio the resize factor we want to use to rescale
  114491. */
  114492. scale(ratio: number): void;
  114493. /**
  114494. * Get if the texture can rescale.
  114495. */
  114496. get canRescale(): boolean;
  114497. /** @hidden */
  114498. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  114499. /** @hidden */
  114500. _rebuild(): void;
  114501. /**
  114502. * Triggers the load sequence in delayed load mode.
  114503. */
  114504. delayLoad(): void;
  114505. /**
  114506. * Clones the texture.
  114507. * @returns the cloned texture
  114508. */
  114509. clone(): Nullable<BaseTexture>;
  114510. /**
  114511. * Get the texture underlying type (INT, FLOAT...)
  114512. */
  114513. get textureType(): number;
  114514. /**
  114515. * Get the texture underlying format (RGB, RGBA...)
  114516. */
  114517. get textureFormat(): number;
  114518. /**
  114519. * Indicates that textures need to be re-calculated for all materials
  114520. */
  114521. protected _markAllSubMeshesAsTexturesDirty(): void;
  114522. /**
  114523. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  114524. * This will returns an RGBA array buffer containing either in values (0-255) or
  114525. * float values (0-1) depending of the underlying buffer type.
  114526. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  114527. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  114528. * @param buffer defines a user defined buffer to fill with data (can be null)
  114529. * @returns The Array buffer containing the pixels data.
  114530. */
  114531. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  114532. /**
  114533. * Release and destroy the underlying lower level texture aka internalTexture.
  114534. */
  114535. releaseInternalTexture(): void;
  114536. /** @hidden */
  114537. get _lodTextureHigh(): Nullable<BaseTexture>;
  114538. /** @hidden */
  114539. get _lodTextureMid(): Nullable<BaseTexture>;
  114540. /** @hidden */
  114541. get _lodTextureLow(): Nullable<BaseTexture>;
  114542. /**
  114543. * Dispose the texture and release its associated resources.
  114544. */
  114545. dispose(): void;
  114546. /**
  114547. * Serialize the texture into a JSON representation that can be parsed later on.
  114548. * @returns the JSON representation of the texture
  114549. */
  114550. serialize(): any;
  114551. /**
  114552. * Helper function to be called back once a list of texture contains only ready textures.
  114553. * @param textures Define the list of textures to wait for
  114554. * @param callback Define the callback triggered once the entire list will be ready
  114555. */
  114556. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  114557. private static _isScene;
  114558. }
  114559. }
  114560. declare module BABYLON {
  114561. /**
  114562. * Options to be used when creating an effect.
  114563. */
  114564. export interface IEffectCreationOptions {
  114565. /**
  114566. * Atrributes that will be used in the shader.
  114567. */
  114568. attributes: string[];
  114569. /**
  114570. * Uniform varible names that will be set in the shader.
  114571. */
  114572. uniformsNames: string[];
  114573. /**
  114574. * Uniform buffer variable names that will be set in the shader.
  114575. */
  114576. uniformBuffersNames: string[];
  114577. /**
  114578. * Sampler texture variable names that will be set in the shader.
  114579. */
  114580. samplers: string[];
  114581. /**
  114582. * Define statements that will be set in the shader.
  114583. */
  114584. defines: any;
  114585. /**
  114586. * Possible fallbacks for this effect to improve performance when needed.
  114587. */
  114588. fallbacks: Nullable<IEffectFallbacks>;
  114589. /**
  114590. * Callback that will be called when the shader is compiled.
  114591. */
  114592. onCompiled: Nullable<(effect: Effect) => void>;
  114593. /**
  114594. * Callback that will be called if an error occurs during shader compilation.
  114595. */
  114596. onError: Nullable<(effect: Effect, errors: string) => void>;
  114597. /**
  114598. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114599. */
  114600. indexParameters?: any;
  114601. /**
  114602. * Max number of lights that can be used in the shader.
  114603. */
  114604. maxSimultaneousLights?: number;
  114605. /**
  114606. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  114607. */
  114608. transformFeedbackVaryings?: Nullable<string[]>;
  114609. /**
  114610. * 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
  114611. */
  114612. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  114613. /**
  114614. * Is this effect rendering to several color attachments ?
  114615. */
  114616. multiTarget?: boolean;
  114617. }
  114618. /**
  114619. * Effect containing vertex and fragment shader that can be executed on an object.
  114620. */
  114621. export class Effect implements IDisposable {
  114622. /**
  114623. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114624. */
  114625. static ShadersRepository: string;
  114626. /**
  114627. * Enable logging of the shader code when a compilation error occurs
  114628. */
  114629. static LogShaderCodeOnCompilationError: boolean;
  114630. /**
  114631. * Name of the effect.
  114632. */
  114633. name: any;
  114634. /**
  114635. * String container all the define statements that should be set on the shader.
  114636. */
  114637. defines: string;
  114638. /**
  114639. * Callback that will be called when the shader is compiled.
  114640. */
  114641. onCompiled: Nullable<(effect: Effect) => void>;
  114642. /**
  114643. * Callback that will be called if an error occurs during shader compilation.
  114644. */
  114645. onError: Nullable<(effect: Effect, errors: string) => void>;
  114646. /**
  114647. * Callback that will be called when effect is bound.
  114648. */
  114649. onBind: Nullable<(effect: Effect) => void>;
  114650. /**
  114651. * Unique ID of the effect.
  114652. */
  114653. uniqueId: number;
  114654. /**
  114655. * Observable that will be called when the shader is compiled.
  114656. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  114657. */
  114658. onCompileObservable: Observable<Effect>;
  114659. /**
  114660. * Observable that will be called if an error occurs during shader compilation.
  114661. */
  114662. onErrorObservable: Observable<Effect>;
  114663. /** @hidden */
  114664. _onBindObservable: Nullable<Observable<Effect>>;
  114665. /**
  114666. * @hidden
  114667. * Specifies if the effect was previously ready
  114668. */
  114669. _wasPreviouslyReady: boolean;
  114670. /**
  114671. * Observable that will be called when effect is bound.
  114672. */
  114673. get onBindObservable(): Observable<Effect>;
  114674. /** @hidden */
  114675. _bonesComputationForcedToCPU: boolean;
  114676. /** @hidden */
  114677. _multiTarget: boolean;
  114678. private static _uniqueIdSeed;
  114679. private _engine;
  114680. private _uniformBuffersNames;
  114681. private _uniformBuffersNamesList;
  114682. private _uniformsNames;
  114683. private _samplerList;
  114684. private _samplers;
  114685. private _isReady;
  114686. private _compilationError;
  114687. private _allFallbacksProcessed;
  114688. private _attributesNames;
  114689. private _attributes;
  114690. private _attributeLocationByName;
  114691. private _uniforms;
  114692. /**
  114693. * Key for the effect.
  114694. * @hidden
  114695. */
  114696. _key: string;
  114697. private _indexParameters;
  114698. private _fallbacks;
  114699. private _vertexSourceCode;
  114700. private _fragmentSourceCode;
  114701. private _vertexSourceCodeOverride;
  114702. private _fragmentSourceCodeOverride;
  114703. private _transformFeedbackVaryings;
  114704. /**
  114705. * Compiled shader to webGL program.
  114706. * @hidden
  114707. */
  114708. _pipelineContext: Nullable<IPipelineContext>;
  114709. private _valueCache;
  114710. private static _baseCache;
  114711. /**
  114712. * Instantiates an effect.
  114713. * An effect can be used to create/manage/execute vertex and fragment shaders.
  114714. * @param baseName Name of the effect.
  114715. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  114716. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  114717. * @param samplers List of sampler variables that will be passed to the shader.
  114718. * @param engine Engine to be used to render the effect
  114719. * @param defines Define statements to be added to the shader.
  114720. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  114721. * @param onCompiled Callback that will be called when the shader is compiled.
  114722. * @param onError Callback that will be called if an error occurs during shader compilation.
  114723. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114724. */
  114725. 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);
  114726. private _useFinalCode;
  114727. /**
  114728. * Unique key for this effect
  114729. */
  114730. get key(): string;
  114731. /**
  114732. * If the effect has been compiled and prepared.
  114733. * @returns if the effect is compiled and prepared.
  114734. */
  114735. isReady(): boolean;
  114736. private _isReadyInternal;
  114737. /**
  114738. * The engine the effect was initialized with.
  114739. * @returns the engine.
  114740. */
  114741. getEngine(): Engine;
  114742. /**
  114743. * The pipeline context for this effect
  114744. * @returns the associated pipeline context
  114745. */
  114746. getPipelineContext(): Nullable<IPipelineContext>;
  114747. /**
  114748. * The set of names of attribute variables for the shader.
  114749. * @returns An array of attribute names.
  114750. */
  114751. getAttributesNames(): string[];
  114752. /**
  114753. * Returns the attribute at the given index.
  114754. * @param index The index of the attribute.
  114755. * @returns The location of the attribute.
  114756. */
  114757. getAttributeLocation(index: number): number;
  114758. /**
  114759. * Returns the attribute based on the name of the variable.
  114760. * @param name of the attribute to look up.
  114761. * @returns the attribute location.
  114762. */
  114763. getAttributeLocationByName(name: string): number;
  114764. /**
  114765. * The number of attributes.
  114766. * @returns the numnber of attributes.
  114767. */
  114768. getAttributesCount(): number;
  114769. /**
  114770. * Gets the index of a uniform variable.
  114771. * @param uniformName of the uniform to look up.
  114772. * @returns the index.
  114773. */
  114774. getUniformIndex(uniformName: string): number;
  114775. /**
  114776. * Returns the attribute based on the name of the variable.
  114777. * @param uniformName of the uniform to look up.
  114778. * @returns the location of the uniform.
  114779. */
  114780. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114781. /**
  114782. * Returns an array of sampler variable names
  114783. * @returns The array of sampler variable names.
  114784. */
  114785. getSamplers(): string[];
  114786. /**
  114787. * Returns an array of uniform variable names
  114788. * @returns The array of uniform variable names.
  114789. */
  114790. getUniformNames(): string[];
  114791. /**
  114792. * Returns an array of uniform buffer variable names
  114793. * @returns The array of uniform buffer variable names.
  114794. */
  114795. getUniformBuffersNames(): string[];
  114796. /**
  114797. * Returns the index parameters used to create the effect
  114798. * @returns The index parameters object
  114799. */
  114800. getIndexParameters(): any;
  114801. /**
  114802. * The error from the last compilation.
  114803. * @returns the error string.
  114804. */
  114805. getCompilationError(): string;
  114806. /**
  114807. * Gets a boolean indicating that all fallbacks were used during compilation
  114808. * @returns true if all fallbacks were used
  114809. */
  114810. allFallbacksProcessed(): boolean;
  114811. /**
  114812. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114813. * @param func The callback to be used.
  114814. */
  114815. executeWhenCompiled(func: (effect: Effect) => void): void;
  114816. private _checkIsReady;
  114817. private _loadShader;
  114818. /**
  114819. * Gets the vertex shader source code of this effect
  114820. */
  114821. get vertexSourceCode(): string;
  114822. /**
  114823. * Gets the fragment shader source code of this effect
  114824. */
  114825. get fragmentSourceCode(): string;
  114826. /**
  114827. * Recompiles the webGL program
  114828. * @param vertexSourceCode The source code for the vertex shader.
  114829. * @param fragmentSourceCode The source code for the fragment shader.
  114830. * @param onCompiled Callback called when completed.
  114831. * @param onError Callback called on error.
  114832. * @hidden
  114833. */
  114834. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114835. /**
  114836. * Prepares the effect
  114837. * @hidden
  114838. */
  114839. _prepareEffect(): void;
  114840. private _getShaderCodeAndErrorLine;
  114841. private _processCompilationErrors;
  114842. /**
  114843. * Checks if the effect is supported. (Must be called after compilation)
  114844. */
  114845. get isSupported(): boolean;
  114846. /**
  114847. * Binds a texture to the engine to be used as output of the shader.
  114848. * @param channel Name of the output variable.
  114849. * @param texture Texture to bind.
  114850. * @hidden
  114851. */
  114852. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114853. /**
  114854. * Sets a texture on the engine to be used in the shader.
  114855. * @param channel Name of the sampler variable.
  114856. * @param texture Texture to set.
  114857. */
  114858. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114859. /**
  114860. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114861. * @param channel Name of the sampler variable.
  114862. * @param texture Texture to set.
  114863. */
  114864. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114865. /**
  114866. * Sets an array of textures on the engine to be used in the shader.
  114867. * @param channel Name of the variable.
  114868. * @param textures Textures to set.
  114869. */
  114870. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114871. /**
  114872. * 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)
  114873. * @param channel Name of the sampler variable.
  114874. * @param postProcess Post process to get the input texture from.
  114875. */
  114876. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114877. /**
  114878. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114879. * 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)
  114880. * @param channel Name of the sampler variable.
  114881. * @param postProcess Post process to get the output texture from.
  114882. */
  114883. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114884. /** @hidden */
  114885. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114886. /** @hidden */
  114887. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114888. /** @hidden */
  114889. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114890. /** @hidden */
  114891. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114892. /**
  114893. * Binds a buffer to a uniform.
  114894. * @param buffer Buffer to bind.
  114895. * @param name Name of the uniform variable to bind to.
  114896. */
  114897. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114898. /**
  114899. * Binds block to a uniform.
  114900. * @param blockName Name of the block to bind.
  114901. * @param index Index to bind.
  114902. */
  114903. bindUniformBlock(blockName: string, index: number): void;
  114904. /**
  114905. * Sets an interger value on a uniform variable.
  114906. * @param uniformName Name of the variable.
  114907. * @param value Value to be set.
  114908. * @returns this effect.
  114909. */
  114910. setInt(uniformName: string, value: number): Effect;
  114911. /**
  114912. * Sets an int array on a uniform variable.
  114913. * @param uniformName Name of the variable.
  114914. * @param array array to be set.
  114915. * @returns this effect.
  114916. */
  114917. setIntArray(uniformName: string, array: Int32Array): Effect;
  114918. /**
  114919. * 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)
  114920. * @param uniformName Name of the variable.
  114921. * @param array array to be set.
  114922. * @returns this effect.
  114923. */
  114924. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114925. /**
  114926. * 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)
  114927. * @param uniformName Name of the variable.
  114928. * @param array array to be set.
  114929. * @returns this effect.
  114930. */
  114931. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114932. /**
  114933. * 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)
  114934. * @param uniformName Name of the variable.
  114935. * @param array array to be set.
  114936. * @returns this effect.
  114937. */
  114938. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114939. /**
  114940. * Sets an float array on a uniform variable.
  114941. * @param uniformName Name of the variable.
  114942. * @param array array to be set.
  114943. * @returns this effect.
  114944. */
  114945. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114946. /**
  114947. * 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)
  114948. * @param uniformName Name of the variable.
  114949. * @param array array to be set.
  114950. * @returns this effect.
  114951. */
  114952. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114953. /**
  114954. * 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)
  114955. * @param uniformName Name of the variable.
  114956. * @param array array to be set.
  114957. * @returns this effect.
  114958. */
  114959. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114960. /**
  114961. * 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)
  114962. * @param uniformName Name of the variable.
  114963. * @param array array to be set.
  114964. * @returns this effect.
  114965. */
  114966. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114967. /**
  114968. * Sets an array on a uniform variable.
  114969. * @param uniformName Name of the variable.
  114970. * @param array array to be set.
  114971. * @returns this effect.
  114972. */
  114973. setArray(uniformName: string, array: number[]): Effect;
  114974. /**
  114975. * 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)
  114976. * @param uniformName Name of the variable.
  114977. * @param array array to be set.
  114978. * @returns this effect.
  114979. */
  114980. setArray2(uniformName: string, array: number[]): Effect;
  114981. /**
  114982. * 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)
  114983. * @param uniformName Name of the variable.
  114984. * @param array array to be set.
  114985. * @returns this effect.
  114986. */
  114987. setArray3(uniformName: string, array: number[]): Effect;
  114988. /**
  114989. * 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)
  114990. * @param uniformName Name of the variable.
  114991. * @param array array to be set.
  114992. * @returns this effect.
  114993. */
  114994. setArray4(uniformName: string, array: number[]): Effect;
  114995. /**
  114996. * Sets matrices on a uniform variable.
  114997. * @param uniformName Name of the variable.
  114998. * @param matrices matrices to be set.
  114999. * @returns this effect.
  115000. */
  115001. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  115002. /**
  115003. * Sets matrix on a uniform variable.
  115004. * @param uniformName Name of the variable.
  115005. * @param matrix matrix to be set.
  115006. * @returns this effect.
  115007. */
  115008. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  115009. /**
  115010. * 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)
  115011. * @param uniformName Name of the variable.
  115012. * @param matrix matrix to be set.
  115013. * @returns this effect.
  115014. */
  115015. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  115016. /**
  115017. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  115018. * @param uniformName Name of the variable.
  115019. * @param matrix matrix to be set.
  115020. * @returns this effect.
  115021. */
  115022. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  115023. /**
  115024. * Sets a float on a uniform variable.
  115025. * @param uniformName Name of the variable.
  115026. * @param value value to be set.
  115027. * @returns this effect.
  115028. */
  115029. setFloat(uniformName: string, value: number): Effect;
  115030. /**
  115031. * Sets a boolean on a uniform variable.
  115032. * @param uniformName Name of the variable.
  115033. * @param bool value to be set.
  115034. * @returns this effect.
  115035. */
  115036. setBool(uniformName: string, bool: boolean): Effect;
  115037. /**
  115038. * Sets a Vector2 on a uniform variable.
  115039. * @param uniformName Name of the variable.
  115040. * @param vector2 vector2 to be set.
  115041. * @returns this effect.
  115042. */
  115043. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  115044. /**
  115045. * Sets a float2 on a uniform variable.
  115046. * @param uniformName Name of the variable.
  115047. * @param x First float in float2.
  115048. * @param y Second float in float2.
  115049. * @returns this effect.
  115050. */
  115051. setFloat2(uniformName: string, x: number, y: number): Effect;
  115052. /**
  115053. * Sets a Vector3 on a uniform variable.
  115054. * @param uniformName Name of the variable.
  115055. * @param vector3 Value to be set.
  115056. * @returns this effect.
  115057. */
  115058. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  115059. /**
  115060. * Sets a float3 on a uniform variable.
  115061. * @param uniformName Name of the variable.
  115062. * @param x First float in float3.
  115063. * @param y Second float in float3.
  115064. * @param z Third float in float3.
  115065. * @returns this effect.
  115066. */
  115067. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  115068. /**
  115069. * Sets a Vector4 on a uniform variable.
  115070. * @param uniformName Name of the variable.
  115071. * @param vector4 Value to be set.
  115072. * @returns this effect.
  115073. */
  115074. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  115075. /**
  115076. * Sets a float4 on a uniform variable.
  115077. * @param uniformName Name of the variable.
  115078. * @param x First float in float4.
  115079. * @param y Second float in float4.
  115080. * @param z Third float in float4.
  115081. * @param w Fourth float in float4.
  115082. * @returns this effect.
  115083. */
  115084. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  115085. /**
  115086. * Sets a Color3 on a uniform variable.
  115087. * @param uniformName Name of the variable.
  115088. * @param color3 Value to be set.
  115089. * @returns this effect.
  115090. */
  115091. setColor3(uniformName: string, color3: IColor3Like): Effect;
  115092. /**
  115093. * Sets a Color4 on a uniform variable.
  115094. * @param uniformName Name of the variable.
  115095. * @param color3 Value to be set.
  115096. * @param alpha Alpha value to be set.
  115097. * @returns this effect.
  115098. */
  115099. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  115100. /**
  115101. * Sets a Color4 on a uniform variable
  115102. * @param uniformName defines the name of the variable
  115103. * @param color4 defines the value to be set
  115104. * @returns this effect.
  115105. */
  115106. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  115107. /** Release all associated resources */
  115108. dispose(): void;
  115109. /**
  115110. * This function will add a new shader to the shader store
  115111. * @param name the name of the shader
  115112. * @param pixelShader optional pixel shader content
  115113. * @param vertexShader optional vertex shader content
  115114. */
  115115. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  115116. /**
  115117. * Store of each shader (The can be looked up using effect.key)
  115118. */
  115119. static ShadersStore: {
  115120. [key: string]: string;
  115121. };
  115122. /**
  115123. * Store of each included file for a shader (The can be looked up using effect.key)
  115124. */
  115125. static IncludesShadersStore: {
  115126. [key: string]: string;
  115127. };
  115128. /**
  115129. * Resets the cache of effects.
  115130. */
  115131. static ResetCache(): void;
  115132. }
  115133. }
  115134. declare module BABYLON {
  115135. /**
  115136. * Interface used to describe the capabilities of the engine relatively to the current browser
  115137. */
  115138. export interface EngineCapabilities {
  115139. /** Maximum textures units per fragment shader */
  115140. maxTexturesImageUnits: number;
  115141. /** Maximum texture units per vertex shader */
  115142. maxVertexTextureImageUnits: number;
  115143. /** Maximum textures units in the entire pipeline */
  115144. maxCombinedTexturesImageUnits: number;
  115145. /** Maximum texture size */
  115146. maxTextureSize: number;
  115147. /** Maximum texture samples */
  115148. maxSamples?: number;
  115149. /** Maximum cube texture size */
  115150. maxCubemapTextureSize: number;
  115151. /** Maximum render texture size */
  115152. maxRenderTextureSize: number;
  115153. /** Maximum number of vertex attributes */
  115154. maxVertexAttribs: number;
  115155. /** Maximum number of varyings */
  115156. maxVaryingVectors: number;
  115157. /** Maximum number of uniforms per vertex shader */
  115158. maxVertexUniformVectors: number;
  115159. /** Maximum number of uniforms per fragment shader */
  115160. maxFragmentUniformVectors: number;
  115161. /** Defines if standard derivates (dx/dy) are supported */
  115162. standardDerivatives: boolean;
  115163. /** Defines if s3tc texture compression is supported */
  115164. s3tc?: WEBGL_compressed_texture_s3tc;
  115165. /** Defines if pvrtc texture compression is supported */
  115166. pvrtc: any;
  115167. /** Defines if etc1 texture compression is supported */
  115168. etc1: any;
  115169. /** Defines if etc2 texture compression is supported */
  115170. etc2: any;
  115171. /** Defines if astc texture compression is supported */
  115172. astc: any;
  115173. /** Defines if bptc texture compression is supported */
  115174. bptc: any;
  115175. /** Defines if float textures are supported */
  115176. textureFloat: boolean;
  115177. /** Defines if vertex array objects are supported */
  115178. vertexArrayObject: boolean;
  115179. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  115180. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  115181. /** Gets the maximum level of anisotropy supported */
  115182. maxAnisotropy: number;
  115183. /** Defines if instancing is supported */
  115184. instancedArrays: boolean;
  115185. /** Defines if 32 bits indices are supported */
  115186. uintIndices: boolean;
  115187. /** Defines if high precision shaders are supported */
  115188. highPrecisionShaderSupported: boolean;
  115189. /** Defines if depth reading in the fragment shader is supported */
  115190. fragmentDepthSupported: boolean;
  115191. /** Defines if float texture linear filtering is supported*/
  115192. textureFloatLinearFiltering: boolean;
  115193. /** Defines if rendering to float textures is supported */
  115194. textureFloatRender: boolean;
  115195. /** Defines if half float textures are supported*/
  115196. textureHalfFloat: boolean;
  115197. /** Defines if half float texture linear filtering is supported*/
  115198. textureHalfFloatLinearFiltering: boolean;
  115199. /** Defines if rendering to half float textures is supported */
  115200. textureHalfFloatRender: boolean;
  115201. /** Defines if textureLOD shader command is supported */
  115202. textureLOD: boolean;
  115203. /** Defines if draw buffers extension is supported */
  115204. drawBuffersExtension: boolean;
  115205. /** Defines if depth textures are supported */
  115206. depthTextureExtension: boolean;
  115207. /** Defines if float color buffer are supported */
  115208. colorBufferFloat: boolean;
  115209. /** Gets disjoint timer query extension (null if not supported) */
  115210. timerQuery?: EXT_disjoint_timer_query;
  115211. /** Defines if timestamp can be used with timer query */
  115212. canUseTimestampForTimerQuery: boolean;
  115213. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  115214. multiview?: any;
  115215. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  115216. oculusMultiview?: any;
  115217. /** Function used to let the system compiles shaders in background */
  115218. parallelShaderCompile?: {
  115219. COMPLETION_STATUS_KHR: number;
  115220. };
  115221. /** Max number of texture samples for MSAA */
  115222. maxMSAASamples: number;
  115223. /** Defines if the blend min max extension is supported */
  115224. blendMinMax: boolean;
  115225. }
  115226. }
  115227. declare module BABYLON {
  115228. /**
  115229. * @hidden
  115230. **/
  115231. export class DepthCullingState {
  115232. private _isDepthTestDirty;
  115233. private _isDepthMaskDirty;
  115234. private _isDepthFuncDirty;
  115235. private _isCullFaceDirty;
  115236. private _isCullDirty;
  115237. private _isZOffsetDirty;
  115238. private _isFrontFaceDirty;
  115239. private _depthTest;
  115240. private _depthMask;
  115241. private _depthFunc;
  115242. private _cull;
  115243. private _cullFace;
  115244. private _zOffset;
  115245. private _frontFace;
  115246. /**
  115247. * Initializes the state.
  115248. */
  115249. constructor();
  115250. get isDirty(): boolean;
  115251. get zOffset(): number;
  115252. set zOffset(value: number);
  115253. get cullFace(): Nullable<number>;
  115254. set cullFace(value: Nullable<number>);
  115255. get cull(): Nullable<boolean>;
  115256. set cull(value: Nullable<boolean>);
  115257. get depthFunc(): Nullable<number>;
  115258. set depthFunc(value: Nullable<number>);
  115259. get depthMask(): boolean;
  115260. set depthMask(value: boolean);
  115261. get depthTest(): boolean;
  115262. set depthTest(value: boolean);
  115263. get frontFace(): Nullable<number>;
  115264. set frontFace(value: Nullable<number>);
  115265. reset(): void;
  115266. apply(gl: WebGLRenderingContext): void;
  115267. }
  115268. }
  115269. declare module BABYLON {
  115270. /**
  115271. * @hidden
  115272. **/
  115273. export class StencilState {
  115274. /** 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 */
  115275. static readonly ALWAYS: number;
  115276. /** Passed to stencilOperation to specify that stencil value must be kept */
  115277. static readonly KEEP: number;
  115278. /** Passed to stencilOperation to specify that stencil value must be replaced */
  115279. static readonly REPLACE: number;
  115280. private _isStencilTestDirty;
  115281. private _isStencilMaskDirty;
  115282. private _isStencilFuncDirty;
  115283. private _isStencilOpDirty;
  115284. private _stencilTest;
  115285. private _stencilMask;
  115286. private _stencilFunc;
  115287. private _stencilFuncRef;
  115288. private _stencilFuncMask;
  115289. private _stencilOpStencilFail;
  115290. private _stencilOpDepthFail;
  115291. private _stencilOpStencilDepthPass;
  115292. get isDirty(): boolean;
  115293. get stencilFunc(): number;
  115294. set stencilFunc(value: number);
  115295. get stencilFuncRef(): number;
  115296. set stencilFuncRef(value: number);
  115297. get stencilFuncMask(): number;
  115298. set stencilFuncMask(value: number);
  115299. get stencilOpStencilFail(): number;
  115300. set stencilOpStencilFail(value: number);
  115301. get stencilOpDepthFail(): number;
  115302. set stencilOpDepthFail(value: number);
  115303. get stencilOpStencilDepthPass(): number;
  115304. set stencilOpStencilDepthPass(value: number);
  115305. get stencilMask(): number;
  115306. set stencilMask(value: number);
  115307. get stencilTest(): boolean;
  115308. set stencilTest(value: boolean);
  115309. constructor();
  115310. reset(): void;
  115311. apply(gl: WebGLRenderingContext): void;
  115312. }
  115313. }
  115314. declare module BABYLON {
  115315. /**
  115316. * @hidden
  115317. **/
  115318. export class AlphaState {
  115319. private _isAlphaBlendDirty;
  115320. private _isBlendFunctionParametersDirty;
  115321. private _isBlendEquationParametersDirty;
  115322. private _isBlendConstantsDirty;
  115323. private _alphaBlend;
  115324. private _blendFunctionParameters;
  115325. private _blendEquationParameters;
  115326. private _blendConstants;
  115327. /**
  115328. * Initializes the state.
  115329. */
  115330. constructor();
  115331. get isDirty(): boolean;
  115332. get alphaBlend(): boolean;
  115333. set alphaBlend(value: boolean);
  115334. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  115335. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  115336. setAlphaEquationParameters(rgb: number, alpha: number): void;
  115337. reset(): void;
  115338. apply(gl: WebGLRenderingContext): void;
  115339. }
  115340. }
  115341. declare module BABYLON {
  115342. /** @hidden */
  115343. export class WebGL2ShaderProcessor implements IShaderProcessor {
  115344. attributeProcessor(attribute: string): string;
  115345. varyingProcessor(varying: string, isFragment: boolean): string;
  115346. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  115347. }
  115348. }
  115349. declare module BABYLON {
  115350. /**
  115351. * Interface for attribute information associated with buffer instanciation
  115352. */
  115353. export interface InstancingAttributeInfo {
  115354. /**
  115355. * Name of the GLSL attribute
  115356. * if attribute index is not specified, this is used to retrieve the index from the effect
  115357. */
  115358. attributeName: string;
  115359. /**
  115360. * Index/offset of the attribute in the vertex shader
  115361. * if not specified, this will be computes from the name.
  115362. */
  115363. index?: number;
  115364. /**
  115365. * size of the attribute, 1, 2, 3 or 4
  115366. */
  115367. attributeSize: number;
  115368. /**
  115369. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  115370. */
  115371. offset: number;
  115372. /**
  115373. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  115374. * default to 1
  115375. */
  115376. divisor?: number;
  115377. /**
  115378. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  115379. * default is FLOAT
  115380. */
  115381. attributeType?: number;
  115382. /**
  115383. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  115384. */
  115385. normalized?: boolean;
  115386. }
  115387. }
  115388. declare module BABYLON {
  115389. interface ThinEngine {
  115390. /**
  115391. * Update a video texture
  115392. * @param texture defines the texture to update
  115393. * @param video defines the video element to use
  115394. * @param invertY defines if data must be stored with Y axis inverted
  115395. */
  115396. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  115397. }
  115398. }
  115399. declare module BABYLON {
  115400. interface ThinEngine {
  115401. /**
  115402. * Creates a dynamic texture
  115403. * @param width defines the width of the texture
  115404. * @param height defines the height of the texture
  115405. * @param generateMipMaps defines if the engine should generate the mip levels
  115406. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  115407. * @returns the dynamic texture inside an InternalTexture
  115408. */
  115409. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  115410. /**
  115411. * Update the content of a dynamic texture
  115412. * @param texture defines the texture to update
  115413. * @param canvas defines the canvas containing the source
  115414. * @param invertY defines if data must be stored with Y axis inverted
  115415. * @param premulAlpha defines if alpha is stored as premultiplied
  115416. * @param format defines the format of the data
  115417. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  115418. */
  115419. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  115420. }
  115421. }
  115422. declare module BABYLON {
  115423. /**
  115424. * Settings for finer control over video usage
  115425. */
  115426. export interface VideoTextureSettings {
  115427. /**
  115428. * Applies `autoplay` to video, if specified
  115429. */
  115430. autoPlay?: boolean;
  115431. /**
  115432. * Applies `loop` to video, if specified
  115433. */
  115434. loop?: boolean;
  115435. /**
  115436. * Automatically updates internal texture from video at every frame in the render loop
  115437. */
  115438. autoUpdateTexture: boolean;
  115439. /**
  115440. * Image src displayed during the video loading or until the user interacts with the video.
  115441. */
  115442. poster?: string;
  115443. }
  115444. /**
  115445. * If you want to display a video in your scene, this is the special texture for that.
  115446. * This special texture works similar to other textures, with the exception of a few parameters.
  115447. * @see https://doc.babylonjs.com/how_to/video_texture
  115448. */
  115449. export class VideoTexture extends Texture {
  115450. /**
  115451. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  115452. */
  115453. readonly autoUpdateTexture: boolean;
  115454. /**
  115455. * The video instance used by the texture internally
  115456. */
  115457. readonly video: HTMLVideoElement;
  115458. private _onUserActionRequestedObservable;
  115459. /**
  115460. * Event triggerd when a dom action is required by the user to play the video.
  115461. * This happens due to recent changes in browser policies preventing video to auto start.
  115462. */
  115463. get onUserActionRequestedObservable(): Observable<Texture>;
  115464. private _generateMipMaps;
  115465. private _stillImageCaptured;
  115466. private _displayingPosterTexture;
  115467. private _settings;
  115468. private _createInternalTextureOnEvent;
  115469. private _frameId;
  115470. private _currentSrc;
  115471. /**
  115472. * Creates a video texture.
  115473. * If you want to display a video in your scene, this is the special texture for that.
  115474. * This special texture works similar to other textures, with the exception of a few parameters.
  115475. * @see https://doc.babylonjs.com/how_to/video_texture
  115476. * @param name optional name, will detect from video source, if not defined
  115477. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  115478. * @param scene is obviously the current scene.
  115479. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  115480. * @param invertY is false by default but can be used to invert video on Y axis
  115481. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  115482. * @param settings allows finer control over video usage
  115483. */
  115484. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  115485. private _getName;
  115486. private _getVideo;
  115487. private _createInternalTexture;
  115488. private reset;
  115489. /**
  115490. * @hidden Internal method to initiate `update`.
  115491. */
  115492. _rebuild(): void;
  115493. /**
  115494. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  115495. */
  115496. update(): void;
  115497. /**
  115498. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  115499. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  115500. */
  115501. updateTexture(isVisible: boolean): void;
  115502. protected _updateInternalTexture: () => void;
  115503. /**
  115504. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  115505. * @param url New url.
  115506. */
  115507. updateURL(url: string): void;
  115508. /**
  115509. * Clones the texture.
  115510. * @returns the cloned texture
  115511. */
  115512. clone(): VideoTexture;
  115513. /**
  115514. * Dispose the texture and release its associated resources.
  115515. */
  115516. dispose(): void;
  115517. /**
  115518. * Creates a video texture straight from a stream.
  115519. * @param scene Define the scene the texture should be created in
  115520. * @param stream Define the stream the texture should be created from
  115521. * @returns The created video texture as a promise
  115522. */
  115523. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  115524. /**
  115525. * Creates a video texture straight from your WebCam video feed.
  115526. * @param scene Define the scene the texture should be created in
  115527. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  115528. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  115529. * @returns The created video texture as a promise
  115530. */
  115531. static CreateFromWebCamAsync(scene: Scene, constraints: {
  115532. minWidth: number;
  115533. maxWidth: number;
  115534. minHeight: number;
  115535. maxHeight: number;
  115536. deviceId: string;
  115537. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  115538. /**
  115539. * Creates a video texture straight from your WebCam video feed.
  115540. * @param scene Define the scene the texture should be created in
  115541. * @param onReady Define a callback to triggered once the texture will be ready
  115542. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  115543. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  115544. */
  115545. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  115546. minWidth: number;
  115547. maxWidth: number;
  115548. minHeight: number;
  115549. maxHeight: number;
  115550. deviceId: string;
  115551. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  115552. }
  115553. }
  115554. declare module BABYLON {
  115555. /**
  115556. * Defines the interface used by objects working like Scene
  115557. * @hidden
  115558. */
  115559. export interface ISceneLike {
  115560. _addPendingData(data: any): void;
  115561. _removePendingData(data: any): void;
  115562. offlineProvider: IOfflineProvider;
  115563. }
  115564. /**
  115565. * Information about the current host
  115566. */
  115567. export interface HostInformation {
  115568. /**
  115569. * Defines if the current host is a mobile
  115570. */
  115571. isMobile: boolean;
  115572. }
  115573. /** Interface defining initialization parameters for Engine class */
  115574. export interface EngineOptions extends WebGLContextAttributes {
  115575. /**
  115576. * Defines if the engine should no exceed a specified device ratio
  115577. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  115578. */
  115579. limitDeviceRatio?: number;
  115580. /**
  115581. * Defines if webvr should be enabled automatically
  115582. * @see https://doc.babylonjs.com/how_to/webvr_camera
  115583. */
  115584. autoEnableWebVR?: boolean;
  115585. /**
  115586. * Defines if webgl2 should be turned off even if supported
  115587. * @see https://doc.babylonjs.com/features/webgl2
  115588. */
  115589. disableWebGL2Support?: boolean;
  115590. /**
  115591. * Defines if webaudio should be initialized as well
  115592. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115593. */
  115594. audioEngine?: boolean;
  115595. /**
  115596. * Defines if animations should run using a deterministic lock step
  115597. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  115598. */
  115599. deterministicLockstep?: boolean;
  115600. /** Defines the maximum steps to use with deterministic lock step mode */
  115601. lockstepMaxSteps?: number;
  115602. /** Defines the seconds between each deterministic lock step */
  115603. timeStep?: number;
  115604. /**
  115605. * Defines that engine should ignore context lost events
  115606. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  115607. */
  115608. doNotHandleContextLost?: boolean;
  115609. /**
  115610. * Defines that engine should ignore modifying touch action attribute and style
  115611. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  115612. */
  115613. doNotHandleTouchAction?: boolean;
  115614. /**
  115615. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  115616. */
  115617. useHighPrecisionFloats?: boolean;
  115618. /**
  115619. * Make the canvas XR Compatible for XR sessions
  115620. */
  115621. xrCompatible?: boolean;
  115622. /**
  115623. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  115624. */
  115625. useHighPrecisionMatrix?: boolean;
  115626. }
  115627. /**
  115628. * The base engine class (root of all engines)
  115629. */
  115630. export class ThinEngine {
  115631. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  115632. static ExceptionList: ({
  115633. key: string;
  115634. capture: string;
  115635. captureConstraint: number;
  115636. targets: string[];
  115637. } | {
  115638. key: string;
  115639. capture: null;
  115640. captureConstraint: null;
  115641. targets: string[];
  115642. })[];
  115643. /** @hidden */
  115644. static _TextureLoaders: IInternalTextureLoader[];
  115645. /**
  115646. * Returns the current npm package of the sdk
  115647. */
  115648. static get NpmPackage(): string;
  115649. /**
  115650. * Returns the current version of the framework
  115651. */
  115652. static get Version(): string;
  115653. /**
  115654. * Returns a string describing the current engine
  115655. */
  115656. get description(): string;
  115657. /**
  115658. * Gets or sets the epsilon value used by collision engine
  115659. */
  115660. static CollisionsEpsilon: number;
  115661. /**
  115662. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  115663. */
  115664. static get ShadersRepository(): string;
  115665. static set ShadersRepository(value: string);
  115666. /** @hidden */
  115667. _shaderProcessor: IShaderProcessor;
  115668. /**
  115669. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  115670. */
  115671. forcePOTTextures: boolean;
  115672. /**
  115673. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  115674. */
  115675. isFullscreen: boolean;
  115676. /**
  115677. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  115678. */
  115679. cullBackFaces: boolean;
  115680. /**
  115681. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  115682. */
  115683. renderEvenInBackground: boolean;
  115684. /**
  115685. * Gets or sets a boolean indicating that cache can be kept between frames
  115686. */
  115687. preventCacheWipeBetweenFrames: boolean;
  115688. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  115689. validateShaderPrograms: boolean;
  115690. /**
  115691. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  115692. * This can provide greater z depth for distant objects.
  115693. */
  115694. useReverseDepthBuffer: boolean;
  115695. /**
  115696. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  115697. */
  115698. disableUniformBuffers: boolean;
  115699. /** @hidden */
  115700. _uniformBuffers: UniformBuffer[];
  115701. /**
  115702. * Gets a boolean indicating that the engine supports uniform buffers
  115703. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  115704. */
  115705. get supportsUniformBuffers(): boolean;
  115706. /** @hidden */
  115707. _gl: WebGLRenderingContext;
  115708. /** @hidden */
  115709. _webGLVersion: number;
  115710. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  115711. protected _windowIsBackground: boolean;
  115712. protected _creationOptions: EngineOptions;
  115713. protected _highPrecisionShadersAllowed: boolean;
  115714. /** @hidden */
  115715. get _shouldUseHighPrecisionShader(): boolean;
  115716. /**
  115717. * Gets a boolean indicating that only power of 2 textures are supported
  115718. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  115719. */
  115720. get needPOTTextures(): boolean;
  115721. /** @hidden */
  115722. _badOS: boolean;
  115723. /** @hidden */
  115724. _badDesktopOS: boolean;
  115725. private _hardwareScalingLevel;
  115726. /** @hidden */
  115727. _caps: EngineCapabilities;
  115728. private _isStencilEnable;
  115729. private _glVersion;
  115730. private _glRenderer;
  115731. private _glVendor;
  115732. /** @hidden */
  115733. _videoTextureSupported: boolean;
  115734. protected _renderingQueueLaunched: boolean;
  115735. protected _activeRenderLoops: (() => void)[];
  115736. /**
  115737. * Observable signaled when a context lost event is raised
  115738. */
  115739. onContextLostObservable: Observable<ThinEngine>;
  115740. /**
  115741. * Observable signaled when a context restored event is raised
  115742. */
  115743. onContextRestoredObservable: Observable<ThinEngine>;
  115744. private _onContextLost;
  115745. private _onContextRestored;
  115746. protected _contextWasLost: boolean;
  115747. /** @hidden */
  115748. _doNotHandleContextLost: boolean;
  115749. /**
  115750. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115751. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115752. */
  115753. get doNotHandleContextLost(): boolean;
  115754. set doNotHandleContextLost(value: boolean);
  115755. /**
  115756. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115757. */
  115758. disableVertexArrayObjects: boolean;
  115759. /** @hidden */
  115760. protected _colorWrite: boolean;
  115761. /** @hidden */
  115762. protected _colorWriteChanged: boolean;
  115763. /** @hidden */
  115764. protected _depthCullingState: DepthCullingState;
  115765. /** @hidden */
  115766. protected _stencilState: StencilState;
  115767. /** @hidden */
  115768. _alphaState: AlphaState;
  115769. /** @hidden */
  115770. _alphaMode: number;
  115771. /** @hidden */
  115772. _alphaEquation: number;
  115773. /** @hidden */
  115774. _internalTexturesCache: InternalTexture[];
  115775. /** @hidden */
  115776. protected _activeChannel: number;
  115777. private _currentTextureChannel;
  115778. /** @hidden */
  115779. protected _boundTexturesCache: {
  115780. [key: string]: Nullable<InternalTexture>;
  115781. };
  115782. /** @hidden */
  115783. protected _currentEffect: Nullable<Effect>;
  115784. /** @hidden */
  115785. protected _currentProgram: Nullable<WebGLProgram>;
  115786. private _compiledEffects;
  115787. private _vertexAttribArraysEnabled;
  115788. /** @hidden */
  115789. protected _cachedViewport: Nullable<IViewportLike>;
  115790. private _cachedVertexArrayObject;
  115791. /** @hidden */
  115792. protected _cachedVertexBuffers: any;
  115793. /** @hidden */
  115794. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115795. /** @hidden */
  115796. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115797. /** @hidden */
  115798. _currentRenderTarget: Nullable<InternalTexture>;
  115799. private _uintIndicesCurrentlySet;
  115800. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115801. /** @hidden */
  115802. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115803. /** @hidden */
  115804. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115805. private _currentBufferPointers;
  115806. private _currentInstanceLocations;
  115807. private _currentInstanceBuffers;
  115808. private _textureUnits;
  115809. /** @hidden */
  115810. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115811. /** @hidden */
  115812. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115813. /** @hidden */
  115814. _boundRenderFunction: any;
  115815. private _vaoRecordInProgress;
  115816. private _mustWipeVertexAttributes;
  115817. private _emptyTexture;
  115818. private _emptyCubeTexture;
  115819. private _emptyTexture3D;
  115820. private _emptyTexture2DArray;
  115821. /** @hidden */
  115822. _frameHandler: number;
  115823. private _nextFreeTextureSlots;
  115824. private _maxSimultaneousTextures;
  115825. private _activeRequests;
  115826. /** @hidden */
  115827. _transformTextureUrl: Nullable<(url: string) => string>;
  115828. /**
  115829. * Gets information about the current host
  115830. */
  115831. hostInformation: HostInformation;
  115832. protected get _supportsHardwareTextureRescaling(): boolean;
  115833. private _framebufferDimensionsObject;
  115834. /**
  115835. * sets the object from which width and height will be taken from when getting render width and height
  115836. * Will fallback to the gl object
  115837. * @param dimensions the framebuffer width and height that will be used.
  115838. */
  115839. set framebufferDimensionsObject(dimensions: Nullable<{
  115840. framebufferWidth: number;
  115841. framebufferHeight: number;
  115842. }>);
  115843. /**
  115844. * Gets the current viewport
  115845. */
  115846. get currentViewport(): Nullable<IViewportLike>;
  115847. /**
  115848. * Gets the default empty texture
  115849. */
  115850. get emptyTexture(): InternalTexture;
  115851. /**
  115852. * Gets the default empty 3D texture
  115853. */
  115854. get emptyTexture3D(): InternalTexture;
  115855. /**
  115856. * Gets the default empty 2D array texture
  115857. */
  115858. get emptyTexture2DArray(): InternalTexture;
  115859. /**
  115860. * Gets the default empty cube texture
  115861. */
  115862. get emptyCubeTexture(): InternalTexture;
  115863. /**
  115864. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115865. */
  115866. readonly premultipliedAlpha: boolean;
  115867. /**
  115868. * Observable event triggered before each texture is initialized
  115869. */
  115870. onBeforeTextureInitObservable: Observable<Texture>;
  115871. /**
  115872. * Creates a new engine
  115873. * @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
  115874. * @param antialias defines enable antialiasing (default: false)
  115875. * @param options defines further options to be sent to the getContext() function
  115876. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115877. */
  115878. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115879. private _rebuildInternalTextures;
  115880. private _rebuildEffects;
  115881. /**
  115882. * Gets a boolean indicating if all created effects are ready
  115883. * @returns true if all effects are ready
  115884. */
  115885. areAllEffectsReady(): boolean;
  115886. protected _rebuildBuffers(): void;
  115887. protected _initGLContext(): void;
  115888. /**
  115889. * Gets version of the current webGL context
  115890. */
  115891. get webGLVersion(): number;
  115892. /**
  115893. * Gets a string identifying the name of the class
  115894. * @returns "Engine" string
  115895. */
  115896. getClassName(): string;
  115897. /**
  115898. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115899. */
  115900. get isStencilEnable(): boolean;
  115901. /** @hidden */
  115902. _prepareWorkingCanvas(): void;
  115903. /**
  115904. * Reset the texture cache to empty state
  115905. */
  115906. resetTextureCache(): void;
  115907. /**
  115908. * Gets an object containing information about the current webGL context
  115909. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115910. */
  115911. getGlInfo(): {
  115912. vendor: string;
  115913. renderer: string;
  115914. version: string;
  115915. };
  115916. /**
  115917. * Defines the hardware scaling level.
  115918. * By default the hardware scaling level is computed from the window device ratio.
  115919. * 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.
  115920. * @param level defines the level to use
  115921. */
  115922. setHardwareScalingLevel(level: number): void;
  115923. /**
  115924. * Gets the current hardware scaling level.
  115925. * By default the hardware scaling level is computed from the window device ratio.
  115926. * 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.
  115927. * @returns a number indicating the current hardware scaling level
  115928. */
  115929. getHardwareScalingLevel(): number;
  115930. /**
  115931. * Gets the list of loaded textures
  115932. * @returns an array containing all loaded textures
  115933. */
  115934. getLoadedTexturesCache(): InternalTexture[];
  115935. /**
  115936. * Gets the object containing all engine capabilities
  115937. * @returns the EngineCapabilities object
  115938. */
  115939. getCaps(): EngineCapabilities;
  115940. /**
  115941. * stop executing a render loop function and remove it from the execution array
  115942. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115943. */
  115944. stopRenderLoop(renderFunction?: () => void): void;
  115945. /** @hidden */
  115946. _renderLoop(): void;
  115947. /**
  115948. * Gets the HTML canvas attached with the current webGL context
  115949. * @returns a HTML canvas
  115950. */
  115951. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115952. /**
  115953. * Gets host window
  115954. * @returns the host window object
  115955. */
  115956. getHostWindow(): Nullable<Window>;
  115957. /**
  115958. * Gets the current render width
  115959. * @param useScreen defines if screen size must be used (or the current render target if any)
  115960. * @returns a number defining the current render width
  115961. */
  115962. getRenderWidth(useScreen?: boolean): number;
  115963. /**
  115964. * Gets the current render height
  115965. * @param useScreen defines if screen size must be used (or the current render target if any)
  115966. * @returns a number defining the current render height
  115967. */
  115968. getRenderHeight(useScreen?: boolean): number;
  115969. /**
  115970. * Can be used to override the current requestAnimationFrame requester.
  115971. * @hidden
  115972. */
  115973. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115974. /**
  115975. * Register and execute a render loop. The engine can have more than one render function
  115976. * @param renderFunction defines the function to continuously execute
  115977. */
  115978. runRenderLoop(renderFunction: () => void): void;
  115979. /**
  115980. * Clear the current render buffer or the current render target (if any is set up)
  115981. * @param color defines the color to use
  115982. * @param backBuffer defines if the back buffer must be cleared
  115983. * @param depth defines if the depth buffer must be cleared
  115984. * @param stencil defines if the stencil buffer must be cleared
  115985. */
  115986. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115987. private _viewportCached;
  115988. /** @hidden */
  115989. _viewport(x: number, y: number, width: number, height: number): void;
  115990. /**
  115991. * Set the WebGL's viewport
  115992. * @param viewport defines the viewport element to be used
  115993. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115994. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115995. */
  115996. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115997. /**
  115998. * Begin a new frame
  115999. */
  116000. beginFrame(): void;
  116001. /**
  116002. * Enf the current frame
  116003. */
  116004. endFrame(): void;
  116005. /**
  116006. * Resize the view according to the canvas' size
  116007. */
  116008. resize(): void;
  116009. /**
  116010. * Force a specific size of the canvas
  116011. * @param width defines the new canvas' width
  116012. * @param height defines the new canvas' height
  116013. * @returns true if the size was changed
  116014. */
  116015. setSize(width: number, height: number): boolean;
  116016. /**
  116017. * Binds the frame buffer to the specified texture.
  116018. * @param texture The texture to render to or null for the default canvas
  116019. * @param faceIndex The face of the texture to render to in case of cube texture
  116020. * @param requiredWidth The width of the target to render to
  116021. * @param requiredHeight The height of the target to render to
  116022. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  116023. * @param lodLevel defines the lod level to bind to the frame buffer
  116024. * @param layer defines the 2d array index to bind to frame buffer to
  116025. */
  116026. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  116027. /** @hidden */
  116028. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  116029. /**
  116030. * Unbind the current render target texture from the webGL context
  116031. * @param texture defines the render target texture to unbind
  116032. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  116033. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  116034. */
  116035. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  116036. /**
  116037. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  116038. */
  116039. flushFramebuffer(): void;
  116040. /**
  116041. * Unbind the current render target and bind the default framebuffer
  116042. */
  116043. restoreDefaultFramebuffer(): void;
  116044. /** @hidden */
  116045. protected _resetVertexBufferBinding(): void;
  116046. /**
  116047. * Creates a vertex buffer
  116048. * @param data the data for the vertex buffer
  116049. * @returns the new WebGL static buffer
  116050. */
  116051. createVertexBuffer(data: DataArray): DataBuffer;
  116052. private _createVertexBuffer;
  116053. /**
  116054. * Creates a dynamic vertex buffer
  116055. * @param data the data for the dynamic vertex buffer
  116056. * @returns the new WebGL dynamic buffer
  116057. */
  116058. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  116059. protected _resetIndexBufferBinding(): void;
  116060. /**
  116061. * Creates a new index buffer
  116062. * @param indices defines the content of the index buffer
  116063. * @param updatable defines if the index buffer must be updatable
  116064. * @returns a new webGL buffer
  116065. */
  116066. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  116067. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  116068. /**
  116069. * Bind a webGL buffer to the webGL context
  116070. * @param buffer defines the buffer to bind
  116071. */
  116072. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  116073. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  116074. private bindBuffer;
  116075. /**
  116076. * update the bound buffer with the given data
  116077. * @param data defines the data to update
  116078. */
  116079. updateArrayBuffer(data: Float32Array): void;
  116080. private _vertexAttribPointer;
  116081. /** @hidden */
  116082. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  116083. private _bindVertexBuffersAttributes;
  116084. /**
  116085. * Records a vertex array object
  116086. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  116087. * @param vertexBuffers defines the list of vertex buffers to store
  116088. * @param indexBuffer defines the index buffer to store
  116089. * @param effect defines the effect to store
  116090. * @returns the new vertex array object
  116091. */
  116092. recordVertexArrayObject(vertexBuffers: {
  116093. [key: string]: VertexBuffer;
  116094. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  116095. /**
  116096. * Bind a specific vertex array object
  116097. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  116098. * @param vertexArrayObject defines the vertex array object to bind
  116099. * @param indexBuffer defines the index buffer to bind
  116100. */
  116101. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  116102. /**
  116103. * Bind webGl buffers directly to the webGL context
  116104. * @param vertexBuffer defines the vertex buffer to bind
  116105. * @param indexBuffer defines the index buffer to bind
  116106. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  116107. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  116108. * @param effect defines the effect associated with the vertex buffer
  116109. */
  116110. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  116111. private _unbindVertexArrayObject;
  116112. /**
  116113. * Bind a list of vertex buffers to the webGL context
  116114. * @param vertexBuffers defines the list of vertex buffers to bind
  116115. * @param indexBuffer defines the index buffer to bind
  116116. * @param effect defines the effect associated with the vertex buffers
  116117. */
  116118. bindBuffers(vertexBuffers: {
  116119. [key: string]: Nullable<VertexBuffer>;
  116120. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  116121. /**
  116122. * Unbind all instance attributes
  116123. */
  116124. unbindInstanceAttributes(): void;
  116125. /**
  116126. * Release and free the memory of a vertex array object
  116127. * @param vao defines the vertex array object to delete
  116128. */
  116129. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  116130. /** @hidden */
  116131. _releaseBuffer(buffer: DataBuffer): boolean;
  116132. protected _deleteBuffer(buffer: DataBuffer): void;
  116133. /**
  116134. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  116135. * @param instancesBuffer defines the webGL buffer to update and bind
  116136. * @param data defines the data to store in the buffer
  116137. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  116138. */
  116139. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  116140. /**
  116141. * Bind the content of a webGL buffer used with instantiation
  116142. * @param instancesBuffer defines the webGL buffer to bind
  116143. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  116144. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  116145. */
  116146. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  116147. /**
  116148. * Disable the instance attribute corresponding to the name in parameter
  116149. * @param name defines the name of the attribute to disable
  116150. */
  116151. disableInstanceAttributeByName(name: string): void;
  116152. /**
  116153. * Disable the instance attribute corresponding to the location in parameter
  116154. * @param attributeLocation defines the attribute location of the attribute to disable
  116155. */
  116156. disableInstanceAttribute(attributeLocation: number): void;
  116157. /**
  116158. * Disable the attribute corresponding to the location in parameter
  116159. * @param attributeLocation defines the attribute location of the attribute to disable
  116160. */
  116161. disableAttributeByIndex(attributeLocation: number): void;
  116162. /**
  116163. * Send a draw order
  116164. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  116165. * @param indexStart defines the starting index
  116166. * @param indexCount defines the number of index to draw
  116167. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116168. */
  116169. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  116170. /**
  116171. * Draw a list of points
  116172. * @param verticesStart defines the index of first vertex to draw
  116173. * @param verticesCount defines the count of vertices to draw
  116174. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116175. */
  116176. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  116177. /**
  116178. * Draw a list of unindexed primitives
  116179. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  116180. * @param verticesStart defines the index of first vertex to draw
  116181. * @param verticesCount defines the count of vertices to draw
  116182. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116183. */
  116184. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  116185. /**
  116186. * Draw a list of indexed primitives
  116187. * @param fillMode defines the primitive to use
  116188. * @param indexStart defines the starting index
  116189. * @param indexCount defines the number of index to draw
  116190. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116191. */
  116192. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  116193. /**
  116194. * Draw a list of unindexed primitives
  116195. * @param fillMode defines the primitive to use
  116196. * @param verticesStart defines the index of first vertex to draw
  116197. * @param verticesCount defines the count of vertices to draw
  116198. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116199. */
  116200. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  116201. private _drawMode;
  116202. /** @hidden */
  116203. protected _reportDrawCall(): void;
  116204. /** @hidden */
  116205. _releaseEffect(effect: Effect): void;
  116206. /** @hidden */
  116207. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  116208. /**
  116209. * Create a new effect (used to store vertex/fragment shaders)
  116210. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  116211. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  116212. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  116213. * @param samplers defines an array of string used to represent textures
  116214. * @param defines defines the string containing the defines to use to compile the shaders
  116215. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  116216. * @param onCompiled defines a function to call when the effect creation is successful
  116217. * @param onError defines a function to call when the effect creation has failed
  116218. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  116219. * @returns the new Effect
  116220. */
  116221. 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;
  116222. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  116223. private _compileShader;
  116224. private _compileRawShader;
  116225. /** @hidden */
  116226. _getShaderSource(shader: WebGLShader): Nullable<string>;
  116227. /**
  116228. * Directly creates a webGL program
  116229. * @param pipelineContext defines the pipeline context to attach to
  116230. * @param vertexCode defines the vertex shader code to use
  116231. * @param fragmentCode defines the fragment shader code to use
  116232. * @param context defines the webGL context to use (if not set, the current one will be used)
  116233. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  116234. * @returns the new webGL program
  116235. */
  116236. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116237. /**
  116238. * Creates a webGL program
  116239. * @param pipelineContext defines the pipeline context to attach to
  116240. * @param vertexCode defines the vertex shader code to use
  116241. * @param fragmentCode defines the fragment shader code to use
  116242. * @param defines defines the string containing the defines to use to compile the shaders
  116243. * @param context defines the webGL context to use (if not set, the current one will be used)
  116244. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  116245. * @returns the new webGL program
  116246. */
  116247. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116248. /**
  116249. * Creates a new pipeline context
  116250. * @returns the new pipeline
  116251. */
  116252. createPipelineContext(): IPipelineContext;
  116253. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116254. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  116255. /** @hidden */
  116256. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  116257. /** @hidden */
  116258. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  116259. /** @hidden */
  116260. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  116261. /**
  116262. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  116263. * @param pipelineContext defines the pipeline context to use
  116264. * @param uniformsNames defines the list of uniform names
  116265. * @returns an array of webGL uniform locations
  116266. */
  116267. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  116268. /**
  116269. * Gets the lsit of active attributes for a given webGL program
  116270. * @param pipelineContext defines the pipeline context to use
  116271. * @param attributesNames defines the list of attribute names to get
  116272. * @returns an array of indices indicating the offset of each attribute
  116273. */
  116274. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  116275. /**
  116276. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  116277. * @param effect defines the effect to activate
  116278. */
  116279. enableEffect(effect: Nullable<Effect>): void;
  116280. /**
  116281. * Set the value of an uniform to a number (int)
  116282. * @param uniform defines the webGL uniform location where to store the value
  116283. * @param value defines the int number to store
  116284. * @returns true if the value was set
  116285. */
  116286. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  116287. /**
  116288. * Set the value of an uniform to an array of int32
  116289. * @param uniform defines the webGL uniform location where to store the value
  116290. * @param array defines the array of int32 to store
  116291. * @returns true if the value was set
  116292. */
  116293. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116294. /**
  116295. * Set the value of an uniform to an array of int32 (stored as vec2)
  116296. * @param uniform defines the webGL uniform location where to store the value
  116297. * @param array defines the array of int32 to store
  116298. * @returns true if the value was set
  116299. */
  116300. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116301. /**
  116302. * Set the value of an uniform to an array of int32 (stored as vec3)
  116303. * @param uniform defines the webGL uniform location where to store the value
  116304. * @param array defines the array of int32 to store
  116305. * @returns true if the value was set
  116306. */
  116307. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116308. /**
  116309. * Set the value of an uniform to an array of int32 (stored as vec4)
  116310. * @param uniform defines the webGL uniform location where to store the value
  116311. * @param array defines the array of int32 to store
  116312. * @returns true if the value was set
  116313. */
  116314. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116315. /**
  116316. * Set the value of an uniform to an array of number
  116317. * @param uniform defines the webGL uniform location where to store the value
  116318. * @param array defines the array of number to store
  116319. * @returns true if the value was set
  116320. */
  116321. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116322. /**
  116323. * Set the value of an uniform to an array of number (stored as vec2)
  116324. * @param uniform defines the webGL uniform location where to store the value
  116325. * @param array defines the array of number to store
  116326. * @returns true if the value was set
  116327. */
  116328. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116329. /**
  116330. * Set the value of an uniform to an array of number (stored as vec3)
  116331. * @param uniform defines the webGL uniform location where to store the value
  116332. * @param array defines the array of number to store
  116333. * @returns true if the value was set
  116334. */
  116335. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116336. /**
  116337. * Set the value of an uniform to an array of number (stored as vec4)
  116338. * @param uniform defines the webGL uniform location where to store the value
  116339. * @param array defines the array of number to store
  116340. * @returns true if the value was set
  116341. */
  116342. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116343. /**
  116344. * Set the value of an uniform to an array of float32 (stored as matrices)
  116345. * @param uniform defines the webGL uniform location where to store the value
  116346. * @param matrices defines the array of float32 to store
  116347. * @returns true if the value was set
  116348. */
  116349. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  116350. /**
  116351. * Set the value of an uniform to a matrix (3x3)
  116352. * @param uniform defines the webGL uniform location where to store the value
  116353. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  116354. * @returns true if the value was set
  116355. */
  116356. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  116357. /**
  116358. * Set the value of an uniform to a matrix (2x2)
  116359. * @param uniform defines the webGL uniform location where to store the value
  116360. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  116361. * @returns true if the value was set
  116362. */
  116363. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  116364. /**
  116365. * Set the value of an uniform to a number (float)
  116366. * @param uniform defines the webGL uniform location where to store the value
  116367. * @param value defines the float number to store
  116368. * @returns true if the value was transfered
  116369. */
  116370. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  116371. /**
  116372. * Set the value of an uniform to a vec2
  116373. * @param uniform defines the webGL uniform location where to store the value
  116374. * @param x defines the 1st component of the value
  116375. * @param y defines the 2nd component of the value
  116376. * @returns true if the value was set
  116377. */
  116378. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  116379. /**
  116380. * Set the value of an uniform to a vec3
  116381. * @param uniform defines the webGL uniform location where to store the value
  116382. * @param x defines the 1st component of the value
  116383. * @param y defines the 2nd component of the value
  116384. * @param z defines the 3rd component of the value
  116385. * @returns true if the value was set
  116386. */
  116387. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  116388. /**
  116389. * Set the value of an uniform to a vec4
  116390. * @param uniform defines the webGL uniform location where to store the value
  116391. * @param x defines the 1st component of the value
  116392. * @param y defines the 2nd component of the value
  116393. * @param z defines the 3rd component of the value
  116394. * @param w defines the 4th component of the value
  116395. * @returns true if the value was set
  116396. */
  116397. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  116398. /**
  116399. * Apply all cached states (depth, culling, stencil and alpha)
  116400. */
  116401. applyStates(): void;
  116402. /**
  116403. * Enable or disable color writing
  116404. * @param enable defines the state to set
  116405. */
  116406. setColorWrite(enable: boolean): void;
  116407. /**
  116408. * Gets a boolean indicating if color writing is enabled
  116409. * @returns the current color writing state
  116410. */
  116411. getColorWrite(): boolean;
  116412. /**
  116413. * Gets the depth culling state manager
  116414. */
  116415. get depthCullingState(): DepthCullingState;
  116416. /**
  116417. * Gets the alpha state manager
  116418. */
  116419. get alphaState(): AlphaState;
  116420. /**
  116421. * Gets the stencil state manager
  116422. */
  116423. get stencilState(): StencilState;
  116424. /**
  116425. * Clears the list of texture accessible through engine.
  116426. * This can help preventing texture load conflict due to name collision.
  116427. */
  116428. clearInternalTexturesCache(): void;
  116429. /**
  116430. * Force the entire cache to be cleared
  116431. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  116432. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  116433. */
  116434. wipeCaches(bruteForce?: boolean): void;
  116435. /** @hidden */
  116436. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  116437. min: number;
  116438. mag: number;
  116439. };
  116440. /** @hidden */
  116441. _createTexture(): WebGLTexture;
  116442. /**
  116443. * Usually called from Texture.ts.
  116444. * Passed information to create a WebGLTexture
  116445. * @param url defines a value which contains one of the following:
  116446. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  116447. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  116448. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  116449. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  116450. * @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)
  116451. * @param scene needed for loading to the correct scene
  116452. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  116453. * @param onLoad optional callback to be called upon successful completion
  116454. * @param onError optional callback to be called upon failure
  116455. * @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
  116456. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  116457. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  116458. * @param forcedExtension defines the extension to use to pick the right loader
  116459. * @param mimeType defines an optional mime type
  116460. * @returns a InternalTexture for assignment back into BABYLON.Texture
  116461. */
  116462. 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;
  116463. /**
  116464. * Loads an image as an HTMLImageElement.
  116465. * @param input url string, ArrayBuffer, or Blob to load
  116466. * @param onLoad callback called when the image successfully loads
  116467. * @param onError callback called when the image fails to load
  116468. * @param offlineProvider offline provider for caching
  116469. * @param mimeType optional mime type
  116470. * @returns the HTMLImageElement of the loaded image
  116471. * @hidden
  116472. */
  116473. 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>;
  116474. /**
  116475. * @hidden
  116476. */
  116477. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  116478. private _unpackFlipYCached;
  116479. /**
  116480. * In case you are sharing the context with other applications, it might
  116481. * be interested to not cache the unpack flip y state to ensure a consistent
  116482. * value would be set.
  116483. */
  116484. enableUnpackFlipYCached: boolean;
  116485. /** @hidden */
  116486. _unpackFlipY(value: boolean): void;
  116487. /** @hidden */
  116488. _getUnpackAlignement(): number;
  116489. private _getTextureTarget;
  116490. /**
  116491. * Update the sampling mode of a given texture
  116492. * @param samplingMode defines the required sampling mode
  116493. * @param texture defines the texture to update
  116494. * @param generateMipMaps defines whether to generate mipmaps for the texture
  116495. */
  116496. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  116497. /**
  116498. * Update the sampling mode of a given texture
  116499. * @param texture defines the texture to update
  116500. * @param wrapU defines the texture wrap mode of the u coordinates
  116501. * @param wrapV defines the texture wrap mode of the v coordinates
  116502. * @param wrapR defines the texture wrap mode of the r coordinates
  116503. */
  116504. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  116505. /** @hidden */
  116506. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  116507. width: number;
  116508. height: number;
  116509. layers?: number;
  116510. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  116511. /** @hidden */
  116512. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  116513. /** @hidden */
  116514. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  116515. /**
  116516. * Update a portion of an internal texture
  116517. * @param texture defines the texture to update
  116518. * @param imageData defines the data to store into the texture
  116519. * @param xOffset defines the x coordinates of the update rectangle
  116520. * @param yOffset defines the y coordinates of the update rectangle
  116521. * @param width defines the width of the update rectangle
  116522. * @param height defines the height of the update rectangle
  116523. * @param faceIndex defines the face index if texture is a cube (0 by default)
  116524. * @param lod defines the lod level to update (0 by default)
  116525. */
  116526. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  116527. /** @hidden */
  116528. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  116529. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  116530. private _prepareWebGLTexture;
  116531. /** @hidden */
  116532. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  116533. private _getDepthStencilBuffer;
  116534. /** @hidden */
  116535. _releaseFramebufferObjects(texture: InternalTexture): void;
  116536. /** @hidden */
  116537. _releaseTexture(texture: InternalTexture): void;
  116538. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  116539. protected _setProgram(program: WebGLProgram): void;
  116540. protected _boundUniforms: {
  116541. [key: number]: WebGLUniformLocation;
  116542. };
  116543. /**
  116544. * Binds an effect to the webGL context
  116545. * @param effect defines the effect to bind
  116546. */
  116547. bindSamplers(effect: Effect): void;
  116548. private _activateCurrentTexture;
  116549. /** @hidden */
  116550. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  116551. /** @hidden */
  116552. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  116553. /**
  116554. * Unbind all textures from the webGL context
  116555. */
  116556. unbindAllTextures(): void;
  116557. /**
  116558. * Sets a texture to the according uniform.
  116559. * @param channel The texture channel
  116560. * @param uniform The uniform to set
  116561. * @param texture The texture to apply
  116562. */
  116563. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  116564. private _bindSamplerUniformToChannel;
  116565. private _getTextureWrapMode;
  116566. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  116567. /**
  116568. * Sets an array of texture to the webGL context
  116569. * @param channel defines the channel where the texture array must be set
  116570. * @param uniform defines the associated uniform location
  116571. * @param textures defines the array of textures to bind
  116572. */
  116573. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  116574. /** @hidden */
  116575. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  116576. private _setTextureParameterFloat;
  116577. private _setTextureParameterInteger;
  116578. /**
  116579. * Unbind all vertex attributes from the webGL context
  116580. */
  116581. unbindAllAttributes(): void;
  116582. /**
  116583. * 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
  116584. */
  116585. releaseEffects(): void;
  116586. /**
  116587. * Dispose and release all associated resources
  116588. */
  116589. dispose(): void;
  116590. /**
  116591. * Attach a new callback raised when context lost event is fired
  116592. * @param callback defines the callback to call
  116593. */
  116594. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  116595. /**
  116596. * Attach a new callback raised when context restored event is fired
  116597. * @param callback defines the callback to call
  116598. */
  116599. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  116600. /**
  116601. * Get the current error code of the webGL context
  116602. * @returns the error code
  116603. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  116604. */
  116605. getError(): number;
  116606. private _canRenderToFloatFramebuffer;
  116607. private _canRenderToHalfFloatFramebuffer;
  116608. private _canRenderToFramebuffer;
  116609. /** @hidden */
  116610. _getWebGLTextureType(type: number): number;
  116611. /** @hidden */
  116612. _getInternalFormat(format: number): number;
  116613. /** @hidden */
  116614. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  116615. /** @hidden */
  116616. _getRGBAMultiSampleBufferFormat(type: number): number;
  116617. /** @hidden */
  116618. _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;
  116619. /**
  116620. * Loads a file from a url
  116621. * @param url url to load
  116622. * @param onSuccess callback called when the file successfully loads
  116623. * @param onProgress callback called while file is loading (if the server supports this mode)
  116624. * @param offlineProvider defines the offline provider for caching
  116625. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116626. * @param onError callback called when the file fails to load
  116627. * @returns a file request object
  116628. * @hidden
  116629. */
  116630. 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;
  116631. /**
  116632. * Reads pixels from the current frame buffer. Please note that this function can be slow
  116633. * @param x defines the x coordinate of the rectangle where pixels must be read
  116634. * @param y defines the y coordinate of the rectangle where pixels must be read
  116635. * @param width defines the width of the rectangle where pixels must be read
  116636. * @param height defines the height of the rectangle where pixels must be read
  116637. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  116638. * @returns a Uint8Array containing RGBA colors
  116639. */
  116640. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  116641. private static _isSupported;
  116642. /**
  116643. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  116644. * @returns true if the engine can be created
  116645. * @ignorenaming
  116646. */
  116647. static isSupported(): boolean;
  116648. /**
  116649. * Find the next highest power of two.
  116650. * @param x Number to start search from.
  116651. * @return Next highest power of two.
  116652. */
  116653. static CeilingPOT(x: number): number;
  116654. /**
  116655. * Find the next lowest power of two.
  116656. * @param x Number to start search from.
  116657. * @return Next lowest power of two.
  116658. */
  116659. static FloorPOT(x: number): number;
  116660. /**
  116661. * Find the nearest power of two.
  116662. * @param x Number to start search from.
  116663. * @return Next nearest power of two.
  116664. */
  116665. static NearestPOT(x: number): number;
  116666. /**
  116667. * Get the closest exponent of two
  116668. * @param value defines the value to approximate
  116669. * @param max defines the maximum value to return
  116670. * @param mode defines how to define the closest value
  116671. * @returns closest exponent of two of the given value
  116672. */
  116673. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  116674. /**
  116675. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  116676. * @param func - the function to be called
  116677. * @param requester - the object that will request the next frame. Falls back to window.
  116678. * @returns frame number
  116679. */
  116680. static QueueNewFrame(func: () => void, requester?: any): number;
  116681. /**
  116682. * Gets host document
  116683. * @returns the host document object
  116684. */
  116685. getHostDocument(): Nullable<Document>;
  116686. }
  116687. }
  116688. declare module BABYLON {
  116689. /**
  116690. * Class representing spherical harmonics coefficients to the 3rd degree
  116691. */
  116692. export class SphericalHarmonics {
  116693. /**
  116694. * Defines whether or not the harmonics have been prescaled for rendering.
  116695. */
  116696. preScaled: boolean;
  116697. /**
  116698. * The l0,0 coefficients of the spherical harmonics
  116699. */
  116700. l00: Vector3;
  116701. /**
  116702. * The l1,-1 coefficients of the spherical harmonics
  116703. */
  116704. l1_1: Vector3;
  116705. /**
  116706. * The l1,0 coefficients of the spherical harmonics
  116707. */
  116708. l10: Vector3;
  116709. /**
  116710. * The l1,1 coefficients of the spherical harmonics
  116711. */
  116712. l11: Vector3;
  116713. /**
  116714. * The l2,-2 coefficients of the spherical harmonics
  116715. */
  116716. l2_2: Vector3;
  116717. /**
  116718. * The l2,-1 coefficients of the spherical harmonics
  116719. */
  116720. l2_1: Vector3;
  116721. /**
  116722. * The l2,0 coefficients of the spherical harmonics
  116723. */
  116724. l20: Vector3;
  116725. /**
  116726. * The l2,1 coefficients of the spherical harmonics
  116727. */
  116728. l21: Vector3;
  116729. /**
  116730. * The l2,2 coefficients of the spherical harmonics
  116731. */
  116732. l22: Vector3;
  116733. /**
  116734. * Adds a light to the spherical harmonics
  116735. * @param direction the direction of the light
  116736. * @param color the color of the light
  116737. * @param deltaSolidAngle the delta solid angle of the light
  116738. */
  116739. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  116740. /**
  116741. * Scales the spherical harmonics by the given amount
  116742. * @param scale the amount to scale
  116743. */
  116744. scaleInPlace(scale: number): void;
  116745. /**
  116746. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116747. *
  116748. * ```
  116749. * E_lm = A_l * L_lm
  116750. * ```
  116751. *
  116752. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116753. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116754. * the scaling factors are given in equation 9.
  116755. */
  116756. convertIncidentRadianceToIrradiance(): void;
  116757. /**
  116758. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116759. *
  116760. * ```
  116761. * L = (1/pi) * E * rho
  116762. * ```
  116763. *
  116764. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116765. */
  116766. convertIrradianceToLambertianRadiance(): void;
  116767. /**
  116768. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116769. * required operations at run time.
  116770. *
  116771. * This is simply done by scaling back the SH with Ylm constants parameter.
  116772. * The trigonometric part being applied by the shader at run time.
  116773. */
  116774. preScaleForRendering(): void;
  116775. /**
  116776. * Constructs a spherical harmonics from an array.
  116777. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116778. * @returns the spherical harmonics
  116779. */
  116780. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116781. /**
  116782. * Gets the spherical harmonics from polynomial
  116783. * @param polynomial the spherical polynomial
  116784. * @returns the spherical harmonics
  116785. */
  116786. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116787. }
  116788. /**
  116789. * Class representing spherical polynomial coefficients to the 3rd degree
  116790. */
  116791. export class SphericalPolynomial {
  116792. private _harmonics;
  116793. /**
  116794. * The spherical harmonics used to create the polynomials.
  116795. */
  116796. get preScaledHarmonics(): SphericalHarmonics;
  116797. /**
  116798. * The x coefficients of the spherical polynomial
  116799. */
  116800. x: Vector3;
  116801. /**
  116802. * The y coefficients of the spherical polynomial
  116803. */
  116804. y: Vector3;
  116805. /**
  116806. * The z coefficients of the spherical polynomial
  116807. */
  116808. z: Vector3;
  116809. /**
  116810. * The xx coefficients of the spherical polynomial
  116811. */
  116812. xx: Vector3;
  116813. /**
  116814. * The yy coefficients of the spherical polynomial
  116815. */
  116816. yy: Vector3;
  116817. /**
  116818. * The zz coefficients of the spherical polynomial
  116819. */
  116820. zz: Vector3;
  116821. /**
  116822. * The xy coefficients of the spherical polynomial
  116823. */
  116824. xy: Vector3;
  116825. /**
  116826. * The yz coefficients of the spherical polynomial
  116827. */
  116828. yz: Vector3;
  116829. /**
  116830. * The zx coefficients of the spherical polynomial
  116831. */
  116832. zx: Vector3;
  116833. /**
  116834. * Adds an ambient color to the spherical polynomial
  116835. * @param color the color to add
  116836. */
  116837. addAmbient(color: Color3): void;
  116838. /**
  116839. * Scales the spherical polynomial by the given amount
  116840. * @param scale the amount to scale
  116841. */
  116842. scaleInPlace(scale: number): void;
  116843. /**
  116844. * Gets the spherical polynomial from harmonics
  116845. * @param harmonics the spherical harmonics
  116846. * @returns the spherical polynomial
  116847. */
  116848. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116849. /**
  116850. * Constructs a spherical polynomial from an array.
  116851. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116852. * @returns the spherical polynomial
  116853. */
  116854. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116855. }
  116856. }
  116857. declare module BABYLON {
  116858. /**
  116859. * Defines the source of the internal texture
  116860. */
  116861. export enum InternalTextureSource {
  116862. /**
  116863. * The source of the texture data is unknown
  116864. */
  116865. Unknown = 0,
  116866. /**
  116867. * Texture data comes from an URL
  116868. */
  116869. Url = 1,
  116870. /**
  116871. * Texture data is only used for temporary storage
  116872. */
  116873. Temp = 2,
  116874. /**
  116875. * Texture data comes from raw data (ArrayBuffer)
  116876. */
  116877. Raw = 3,
  116878. /**
  116879. * Texture content is dynamic (video or dynamic texture)
  116880. */
  116881. Dynamic = 4,
  116882. /**
  116883. * Texture content is generated by rendering to it
  116884. */
  116885. RenderTarget = 5,
  116886. /**
  116887. * Texture content is part of a multi render target process
  116888. */
  116889. MultiRenderTarget = 6,
  116890. /**
  116891. * Texture data comes from a cube data file
  116892. */
  116893. Cube = 7,
  116894. /**
  116895. * Texture data comes from a raw cube data
  116896. */
  116897. CubeRaw = 8,
  116898. /**
  116899. * Texture data come from a prefiltered cube data file
  116900. */
  116901. CubePrefiltered = 9,
  116902. /**
  116903. * Texture content is raw 3D data
  116904. */
  116905. Raw3D = 10,
  116906. /**
  116907. * Texture content is raw 2D array data
  116908. */
  116909. Raw2DArray = 11,
  116910. /**
  116911. * Texture content is a depth texture
  116912. */
  116913. Depth = 12,
  116914. /**
  116915. * Texture data comes from a raw cube data encoded with RGBD
  116916. */
  116917. CubeRawRGBD = 13
  116918. }
  116919. /**
  116920. * Class used to store data associated with WebGL texture data for the engine
  116921. * This class should not be used directly
  116922. */
  116923. export class InternalTexture {
  116924. /** @hidden */
  116925. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116926. /**
  116927. * Defines if the texture is ready
  116928. */
  116929. isReady: boolean;
  116930. /**
  116931. * Defines if the texture is a cube texture
  116932. */
  116933. isCube: boolean;
  116934. /**
  116935. * Defines if the texture contains 3D data
  116936. */
  116937. is3D: boolean;
  116938. /**
  116939. * Defines if the texture contains 2D array data
  116940. */
  116941. is2DArray: boolean;
  116942. /**
  116943. * Defines if the texture contains multiview data
  116944. */
  116945. isMultiview: boolean;
  116946. /**
  116947. * Gets the URL used to load this texture
  116948. */
  116949. url: string;
  116950. /**
  116951. * Gets the sampling mode of the texture
  116952. */
  116953. samplingMode: number;
  116954. /**
  116955. * Gets a boolean indicating if the texture needs mipmaps generation
  116956. */
  116957. generateMipMaps: boolean;
  116958. /**
  116959. * Gets the number of samples used by the texture (WebGL2+ only)
  116960. */
  116961. samples: number;
  116962. /**
  116963. * Gets the type of the texture (int, float...)
  116964. */
  116965. type: number;
  116966. /**
  116967. * Gets the format of the texture (RGB, RGBA...)
  116968. */
  116969. format: number;
  116970. /**
  116971. * Observable called when the texture is loaded
  116972. */
  116973. onLoadedObservable: Observable<InternalTexture>;
  116974. /**
  116975. * Gets the width of the texture
  116976. */
  116977. width: number;
  116978. /**
  116979. * Gets the height of the texture
  116980. */
  116981. height: number;
  116982. /**
  116983. * Gets the depth of the texture
  116984. */
  116985. depth: number;
  116986. /**
  116987. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116988. */
  116989. baseWidth: number;
  116990. /**
  116991. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116992. */
  116993. baseHeight: number;
  116994. /**
  116995. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116996. */
  116997. baseDepth: number;
  116998. /**
  116999. * Gets a boolean indicating if the texture is inverted on Y axis
  117000. */
  117001. invertY: boolean;
  117002. /** @hidden */
  117003. _invertVScale: boolean;
  117004. /** @hidden */
  117005. _associatedChannel: number;
  117006. /** @hidden */
  117007. _source: InternalTextureSource;
  117008. /** @hidden */
  117009. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  117010. /** @hidden */
  117011. _bufferView: Nullable<ArrayBufferView>;
  117012. /** @hidden */
  117013. _bufferViewArray: Nullable<ArrayBufferView[]>;
  117014. /** @hidden */
  117015. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  117016. /** @hidden */
  117017. _size: number;
  117018. /** @hidden */
  117019. _extension: string;
  117020. /** @hidden */
  117021. _files: Nullable<string[]>;
  117022. /** @hidden */
  117023. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  117024. /** @hidden */
  117025. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  117026. /** @hidden */
  117027. _framebuffer: Nullable<WebGLFramebuffer>;
  117028. /** @hidden */
  117029. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  117030. /** @hidden */
  117031. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  117032. /** @hidden */
  117033. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  117034. /** @hidden */
  117035. _attachments: Nullable<number[]>;
  117036. /** @hidden */
  117037. _textureArray: Nullable<InternalTexture[]>;
  117038. /** @hidden */
  117039. _cachedCoordinatesMode: Nullable<number>;
  117040. /** @hidden */
  117041. _cachedWrapU: Nullable<number>;
  117042. /** @hidden */
  117043. _cachedWrapV: Nullable<number>;
  117044. /** @hidden */
  117045. _cachedWrapR: Nullable<number>;
  117046. /** @hidden */
  117047. _cachedAnisotropicFilteringLevel: Nullable<number>;
  117048. /** @hidden */
  117049. _isDisabled: boolean;
  117050. /** @hidden */
  117051. _compression: Nullable<string>;
  117052. /** @hidden */
  117053. _generateStencilBuffer: boolean;
  117054. /** @hidden */
  117055. _generateDepthBuffer: boolean;
  117056. /** @hidden */
  117057. _comparisonFunction: number;
  117058. /** @hidden */
  117059. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  117060. /** @hidden */
  117061. _lodGenerationScale: number;
  117062. /** @hidden */
  117063. _lodGenerationOffset: number;
  117064. /** @hidden */
  117065. _depthStencilTexture: Nullable<InternalTexture>;
  117066. /** @hidden */
  117067. _colorTextureArray: Nullable<WebGLTexture>;
  117068. /** @hidden */
  117069. _depthStencilTextureArray: Nullable<WebGLTexture>;
  117070. /** @hidden */
  117071. _lodTextureHigh: Nullable<BaseTexture>;
  117072. /** @hidden */
  117073. _lodTextureMid: Nullable<BaseTexture>;
  117074. /** @hidden */
  117075. _lodTextureLow: Nullable<BaseTexture>;
  117076. /** @hidden */
  117077. _isRGBD: boolean;
  117078. /** @hidden */
  117079. _linearSpecularLOD: boolean;
  117080. /** @hidden */
  117081. _irradianceTexture: Nullable<BaseTexture>;
  117082. /** @hidden */
  117083. _webGLTexture: Nullable<WebGLTexture>;
  117084. /** @hidden */
  117085. _references: number;
  117086. /** @hidden */
  117087. _gammaSpace: Nullable<boolean>;
  117088. private _engine;
  117089. /**
  117090. * Gets the Engine the texture belongs to.
  117091. * @returns The babylon engine
  117092. */
  117093. getEngine(): ThinEngine;
  117094. /**
  117095. * Gets the data source type of the texture
  117096. */
  117097. get source(): InternalTextureSource;
  117098. /**
  117099. * Creates a new InternalTexture
  117100. * @param engine defines the engine to use
  117101. * @param source defines the type of data that will be used
  117102. * @param delayAllocation if the texture allocation should be delayed (default: false)
  117103. */
  117104. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  117105. /**
  117106. * Increments the number of references (ie. the number of Texture that point to it)
  117107. */
  117108. incrementReferences(): void;
  117109. /**
  117110. * Change the size of the texture (not the size of the content)
  117111. * @param width defines the new width
  117112. * @param height defines the new height
  117113. * @param depth defines the new depth (1 by default)
  117114. */
  117115. updateSize(width: int, height: int, depth?: int): void;
  117116. /** @hidden */
  117117. _rebuild(): void;
  117118. /** @hidden */
  117119. _swapAndDie(target: InternalTexture): void;
  117120. /**
  117121. * Dispose the current allocated resources
  117122. */
  117123. dispose(): void;
  117124. }
  117125. }
  117126. declare module BABYLON {
  117127. /**
  117128. * Class used to work with sound analyzer using fast fourier transform (FFT)
  117129. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117130. */
  117131. export class Analyser {
  117132. /**
  117133. * Gets or sets the smoothing
  117134. * @ignorenaming
  117135. */
  117136. SMOOTHING: number;
  117137. /**
  117138. * Gets or sets the FFT table size
  117139. * @ignorenaming
  117140. */
  117141. FFT_SIZE: number;
  117142. /**
  117143. * Gets or sets the bar graph amplitude
  117144. * @ignorenaming
  117145. */
  117146. BARGRAPHAMPLITUDE: number;
  117147. /**
  117148. * Gets or sets the position of the debug canvas
  117149. * @ignorenaming
  117150. */
  117151. DEBUGCANVASPOS: {
  117152. x: number;
  117153. y: number;
  117154. };
  117155. /**
  117156. * Gets or sets the debug canvas size
  117157. * @ignorenaming
  117158. */
  117159. DEBUGCANVASSIZE: {
  117160. width: number;
  117161. height: number;
  117162. };
  117163. private _byteFreqs;
  117164. private _byteTime;
  117165. private _floatFreqs;
  117166. private _webAudioAnalyser;
  117167. private _debugCanvas;
  117168. private _debugCanvasContext;
  117169. private _scene;
  117170. private _registerFunc;
  117171. private _audioEngine;
  117172. /**
  117173. * Creates a new analyser
  117174. * @param scene defines hosting scene
  117175. */
  117176. constructor(scene: Scene);
  117177. /**
  117178. * Get the number of data values you will have to play with for the visualization
  117179. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  117180. * @returns a number
  117181. */
  117182. getFrequencyBinCount(): number;
  117183. /**
  117184. * Gets the current frequency data as a byte array
  117185. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  117186. * @returns a Uint8Array
  117187. */
  117188. getByteFrequencyData(): Uint8Array;
  117189. /**
  117190. * Gets the current waveform as a byte array
  117191. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  117192. * @returns a Uint8Array
  117193. */
  117194. getByteTimeDomainData(): Uint8Array;
  117195. /**
  117196. * Gets the current frequency data as a float array
  117197. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  117198. * @returns a Float32Array
  117199. */
  117200. getFloatFrequencyData(): Float32Array;
  117201. /**
  117202. * Renders the debug canvas
  117203. */
  117204. drawDebugCanvas(): void;
  117205. /**
  117206. * Stops rendering the debug canvas and removes it
  117207. */
  117208. stopDebugCanvas(): void;
  117209. /**
  117210. * Connects two audio nodes
  117211. * @param inputAudioNode defines first node to connect
  117212. * @param outputAudioNode defines second node to connect
  117213. */
  117214. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  117215. /**
  117216. * Releases all associated resources
  117217. */
  117218. dispose(): void;
  117219. }
  117220. }
  117221. declare module BABYLON {
  117222. /**
  117223. * This represents an audio engine and it is responsible
  117224. * to play, synchronize and analyse sounds throughout the application.
  117225. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117226. */
  117227. export interface IAudioEngine extends IDisposable {
  117228. /**
  117229. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  117230. */
  117231. readonly canUseWebAudio: boolean;
  117232. /**
  117233. * Gets the current AudioContext if available.
  117234. */
  117235. readonly audioContext: Nullable<AudioContext>;
  117236. /**
  117237. * The master gain node defines the global audio volume of your audio engine.
  117238. */
  117239. readonly masterGain: GainNode;
  117240. /**
  117241. * Gets whether or not mp3 are supported by your browser.
  117242. */
  117243. readonly isMP3supported: boolean;
  117244. /**
  117245. * Gets whether or not ogg are supported by your browser.
  117246. */
  117247. readonly isOGGsupported: boolean;
  117248. /**
  117249. * Defines if Babylon should emit a warning if WebAudio is not supported.
  117250. * @ignoreNaming
  117251. */
  117252. WarnedWebAudioUnsupported: boolean;
  117253. /**
  117254. * Defines if the audio engine relies on a custom unlocked button.
  117255. * In this case, the embedded button will not be displayed.
  117256. */
  117257. useCustomUnlockedButton: boolean;
  117258. /**
  117259. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  117260. */
  117261. readonly unlocked: boolean;
  117262. /**
  117263. * Event raised when audio has been unlocked on the browser.
  117264. */
  117265. onAudioUnlockedObservable: Observable<AudioEngine>;
  117266. /**
  117267. * Event raised when audio has been locked on the browser.
  117268. */
  117269. onAudioLockedObservable: Observable<AudioEngine>;
  117270. /**
  117271. * Flags the audio engine in Locked state.
  117272. * This happens due to new browser policies preventing audio to autoplay.
  117273. */
  117274. lock(): void;
  117275. /**
  117276. * Unlocks the audio engine once a user action has been done on the dom.
  117277. * This is helpful to resume play once browser policies have been satisfied.
  117278. */
  117279. unlock(): void;
  117280. /**
  117281. * Gets the global volume sets on the master gain.
  117282. * @returns the global volume if set or -1 otherwise
  117283. */
  117284. getGlobalVolume(): number;
  117285. /**
  117286. * Sets the global volume of your experience (sets on the master gain).
  117287. * @param newVolume Defines the new global volume of the application
  117288. */
  117289. setGlobalVolume(newVolume: number): void;
  117290. /**
  117291. * Connect the audio engine to an audio analyser allowing some amazing
  117292. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  117293. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  117294. * @param analyser The analyser to connect to the engine
  117295. */
  117296. connectToAnalyser(analyser: Analyser): void;
  117297. }
  117298. /**
  117299. * This represents the default audio engine used in babylon.
  117300. * It is responsible to play, synchronize and analyse sounds throughout the application.
  117301. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117302. */
  117303. export class AudioEngine implements IAudioEngine {
  117304. private _audioContext;
  117305. private _audioContextInitialized;
  117306. private _muteButton;
  117307. private _hostElement;
  117308. /**
  117309. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  117310. */
  117311. canUseWebAudio: boolean;
  117312. /**
  117313. * The master gain node defines the global audio volume of your audio engine.
  117314. */
  117315. masterGain: GainNode;
  117316. /**
  117317. * Defines if Babylon should emit a warning if WebAudio is not supported.
  117318. * @ignoreNaming
  117319. */
  117320. WarnedWebAudioUnsupported: boolean;
  117321. /**
  117322. * Gets whether or not mp3 are supported by your browser.
  117323. */
  117324. isMP3supported: boolean;
  117325. /**
  117326. * Gets whether or not ogg are supported by your browser.
  117327. */
  117328. isOGGsupported: boolean;
  117329. /**
  117330. * Gets whether audio has been unlocked on the device.
  117331. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  117332. * a user interaction has happened.
  117333. */
  117334. unlocked: boolean;
  117335. /**
  117336. * Defines if the audio engine relies on a custom unlocked button.
  117337. * In this case, the embedded button will not be displayed.
  117338. */
  117339. useCustomUnlockedButton: boolean;
  117340. /**
  117341. * Event raised when audio has been unlocked on the browser.
  117342. */
  117343. onAudioUnlockedObservable: Observable<AudioEngine>;
  117344. /**
  117345. * Event raised when audio has been locked on the browser.
  117346. */
  117347. onAudioLockedObservable: Observable<AudioEngine>;
  117348. /**
  117349. * Gets the current AudioContext if available.
  117350. */
  117351. get audioContext(): Nullable<AudioContext>;
  117352. private _connectedAnalyser;
  117353. /**
  117354. * Instantiates a new audio engine.
  117355. *
  117356. * There should be only one per page as some browsers restrict the number
  117357. * of audio contexts you can create.
  117358. * @param hostElement defines the host element where to display the mute icon if necessary
  117359. */
  117360. constructor(hostElement?: Nullable<HTMLElement>);
  117361. /**
  117362. * Flags the audio engine in Locked state.
  117363. * This happens due to new browser policies preventing audio to autoplay.
  117364. */
  117365. lock(): void;
  117366. /**
  117367. * Unlocks the audio engine once a user action has been done on the dom.
  117368. * This is helpful to resume play once browser policies have been satisfied.
  117369. */
  117370. unlock(): void;
  117371. private _resumeAudioContext;
  117372. private _initializeAudioContext;
  117373. private _tryToRun;
  117374. private _triggerRunningState;
  117375. private _triggerSuspendedState;
  117376. private _displayMuteButton;
  117377. private _moveButtonToTopLeft;
  117378. private _onResize;
  117379. private _hideMuteButton;
  117380. /**
  117381. * Destroy and release the resources associated with the audio ccontext.
  117382. */
  117383. dispose(): void;
  117384. /**
  117385. * Gets the global volume sets on the master gain.
  117386. * @returns the global volume if set or -1 otherwise
  117387. */
  117388. getGlobalVolume(): number;
  117389. /**
  117390. * Sets the global volume of your experience (sets on the master gain).
  117391. * @param newVolume Defines the new global volume of the application
  117392. */
  117393. setGlobalVolume(newVolume: number): void;
  117394. /**
  117395. * Connect the audio engine to an audio analyser allowing some amazing
  117396. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  117397. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  117398. * @param analyser The analyser to connect to the engine
  117399. */
  117400. connectToAnalyser(analyser: Analyser): void;
  117401. }
  117402. }
  117403. declare module BABYLON {
  117404. /**
  117405. * Interface used to present a loading screen while loading a scene
  117406. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117407. */
  117408. export interface ILoadingScreen {
  117409. /**
  117410. * Function called to display the loading screen
  117411. */
  117412. displayLoadingUI: () => void;
  117413. /**
  117414. * Function called to hide the loading screen
  117415. */
  117416. hideLoadingUI: () => void;
  117417. /**
  117418. * Gets or sets the color to use for the background
  117419. */
  117420. loadingUIBackgroundColor: string;
  117421. /**
  117422. * Gets or sets the text to display while loading
  117423. */
  117424. loadingUIText: string;
  117425. }
  117426. /**
  117427. * Class used for the default loading screen
  117428. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117429. */
  117430. export class DefaultLoadingScreen implements ILoadingScreen {
  117431. private _renderingCanvas;
  117432. private _loadingText;
  117433. private _loadingDivBackgroundColor;
  117434. private _loadingDiv;
  117435. private _loadingTextDiv;
  117436. /** Gets or sets the logo url to use for the default loading screen */
  117437. static DefaultLogoUrl: string;
  117438. /** Gets or sets the spinner url to use for the default loading screen */
  117439. static DefaultSpinnerUrl: string;
  117440. /**
  117441. * Creates a new default loading screen
  117442. * @param _renderingCanvas defines the canvas used to render the scene
  117443. * @param _loadingText defines the default text to display
  117444. * @param _loadingDivBackgroundColor defines the default background color
  117445. */
  117446. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  117447. /**
  117448. * Function called to display the loading screen
  117449. */
  117450. displayLoadingUI(): void;
  117451. /**
  117452. * Function called to hide the loading screen
  117453. */
  117454. hideLoadingUI(): void;
  117455. /**
  117456. * Gets or sets the text to display while loading
  117457. */
  117458. set loadingUIText(text: string);
  117459. get loadingUIText(): string;
  117460. /**
  117461. * Gets or sets the color to use for the background
  117462. */
  117463. get loadingUIBackgroundColor(): string;
  117464. set loadingUIBackgroundColor(color: string);
  117465. private _resizeLoadingUI;
  117466. }
  117467. }
  117468. declare module BABYLON {
  117469. /**
  117470. * Interface for any object that can request an animation frame
  117471. */
  117472. export interface ICustomAnimationFrameRequester {
  117473. /**
  117474. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  117475. */
  117476. renderFunction?: Function;
  117477. /**
  117478. * Called to request the next frame to render to
  117479. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  117480. */
  117481. requestAnimationFrame: Function;
  117482. /**
  117483. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  117484. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  117485. */
  117486. requestID?: number;
  117487. }
  117488. }
  117489. declare module BABYLON {
  117490. /**
  117491. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  117492. */
  117493. export class PerformanceMonitor {
  117494. private _enabled;
  117495. private _rollingFrameTime;
  117496. private _lastFrameTimeMs;
  117497. /**
  117498. * constructor
  117499. * @param frameSampleSize The number of samples required to saturate the sliding window
  117500. */
  117501. constructor(frameSampleSize?: number);
  117502. /**
  117503. * Samples current frame
  117504. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  117505. */
  117506. sampleFrame(timeMs?: number): void;
  117507. /**
  117508. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  117509. */
  117510. get averageFrameTime(): number;
  117511. /**
  117512. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  117513. */
  117514. get averageFrameTimeVariance(): number;
  117515. /**
  117516. * Returns the frame time of the most recent frame
  117517. */
  117518. get instantaneousFrameTime(): number;
  117519. /**
  117520. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  117521. */
  117522. get averageFPS(): number;
  117523. /**
  117524. * Returns the average framerate in frames per second using the most recent frame time
  117525. */
  117526. get instantaneousFPS(): number;
  117527. /**
  117528. * Returns true if enough samples have been taken to completely fill the sliding window
  117529. */
  117530. get isSaturated(): boolean;
  117531. /**
  117532. * Enables contributions to the sliding window sample set
  117533. */
  117534. enable(): void;
  117535. /**
  117536. * Disables contributions to the sliding window sample set
  117537. * Samples will not be interpolated over the disabled period
  117538. */
  117539. disable(): void;
  117540. /**
  117541. * Returns true if sampling is enabled
  117542. */
  117543. get isEnabled(): boolean;
  117544. /**
  117545. * Resets performance monitor
  117546. */
  117547. reset(): void;
  117548. }
  117549. /**
  117550. * RollingAverage
  117551. *
  117552. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  117553. */
  117554. export class RollingAverage {
  117555. /**
  117556. * Current average
  117557. */
  117558. average: number;
  117559. /**
  117560. * Current variance
  117561. */
  117562. variance: number;
  117563. protected _samples: Array<number>;
  117564. protected _sampleCount: number;
  117565. protected _pos: number;
  117566. protected _m2: number;
  117567. /**
  117568. * constructor
  117569. * @param length The number of samples required to saturate the sliding window
  117570. */
  117571. constructor(length: number);
  117572. /**
  117573. * Adds a sample to the sample set
  117574. * @param v The sample value
  117575. */
  117576. add(v: number): void;
  117577. /**
  117578. * Returns previously added values or null if outside of history or outside the sliding window domain
  117579. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  117580. * @return Value previously recorded with add() or null if outside of range
  117581. */
  117582. history(i: number): number;
  117583. /**
  117584. * Returns true if enough samples have been taken to completely fill the sliding window
  117585. * @return true if sample-set saturated
  117586. */
  117587. isSaturated(): boolean;
  117588. /**
  117589. * Resets the rolling average (equivalent to 0 samples taken so far)
  117590. */
  117591. reset(): void;
  117592. /**
  117593. * Wraps a value around the sample range boundaries
  117594. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  117595. * @return Wrapped position in sample range
  117596. */
  117597. protected _wrapPosition(i: number): number;
  117598. }
  117599. }
  117600. declare module BABYLON {
  117601. /**
  117602. * This class is used to track a performance counter which is number based.
  117603. * The user has access to many properties which give statistics of different nature.
  117604. *
  117605. * The implementer can track two kinds of Performance Counter: time and count.
  117606. * 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.
  117607. * 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.
  117608. */
  117609. export class PerfCounter {
  117610. /**
  117611. * Gets or sets a global boolean to turn on and off all the counters
  117612. */
  117613. static Enabled: boolean;
  117614. /**
  117615. * Returns the smallest value ever
  117616. */
  117617. get min(): number;
  117618. /**
  117619. * Returns the biggest value ever
  117620. */
  117621. get max(): number;
  117622. /**
  117623. * Returns the average value since the performance counter is running
  117624. */
  117625. get average(): number;
  117626. /**
  117627. * Returns the average value of the last second the counter was monitored
  117628. */
  117629. get lastSecAverage(): number;
  117630. /**
  117631. * Returns the current value
  117632. */
  117633. get current(): number;
  117634. /**
  117635. * Gets the accumulated total
  117636. */
  117637. get total(): number;
  117638. /**
  117639. * Gets the total value count
  117640. */
  117641. get count(): number;
  117642. /**
  117643. * Creates a new counter
  117644. */
  117645. constructor();
  117646. /**
  117647. * Call this method to start monitoring a new frame.
  117648. * 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.
  117649. */
  117650. fetchNewFrame(): void;
  117651. /**
  117652. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  117653. * @param newCount the count value to add to the monitored count
  117654. * @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.
  117655. */
  117656. addCount(newCount: number, fetchResult: boolean): void;
  117657. /**
  117658. * Start monitoring this performance counter
  117659. */
  117660. beginMonitoring(): void;
  117661. /**
  117662. * Compute the time lapsed since the previous beginMonitoring() call.
  117663. * @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
  117664. */
  117665. endMonitoring(newFrame?: boolean): void;
  117666. private _fetchResult;
  117667. private _startMonitoringTime;
  117668. private _min;
  117669. private _max;
  117670. private _average;
  117671. private _current;
  117672. private _totalValueCount;
  117673. private _totalAccumulated;
  117674. private _lastSecAverage;
  117675. private _lastSecAccumulated;
  117676. private _lastSecTime;
  117677. private _lastSecValueCount;
  117678. }
  117679. }
  117680. declare module BABYLON {
  117681. interface ThinEngine {
  117682. /** @hidden */
  117683. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  117684. }
  117685. }
  117686. declare module BABYLON {
  117687. /**
  117688. * Defines the interface used by display changed events
  117689. */
  117690. export interface IDisplayChangedEventArgs {
  117691. /** Gets the vrDisplay object (if any) */
  117692. vrDisplay: Nullable<any>;
  117693. /** Gets a boolean indicating if webVR is supported */
  117694. vrSupported: boolean;
  117695. }
  117696. /**
  117697. * Defines the interface used by objects containing a viewport (like a camera)
  117698. */
  117699. interface IViewportOwnerLike {
  117700. /**
  117701. * Gets or sets the viewport
  117702. */
  117703. viewport: IViewportLike;
  117704. }
  117705. /**
  117706. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  117707. */
  117708. export class Engine extends ThinEngine {
  117709. /** Defines that alpha blending is disabled */
  117710. static readonly ALPHA_DISABLE: number;
  117711. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  117712. static readonly ALPHA_ADD: number;
  117713. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  117714. static readonly ALPHA_COMBINE: number;
  117715. /** Defines that alpha blending to DEST - SRC * DEST */
  117716. static readonly ALPHA_SUBTRACT: number;
  117717. /** Defines that alpha blending to SRC * DEST */
  117718. static readonly ALPHA_MULTIPLY: number;
  117719. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  117720. static readonly ALPHA_MAXIMIZED: number;
  117721. /** Defines that alpha blending to SRC + DEST */
  117722. static readonly ALPHA_ONEONE: number;
  117723. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  117724. static readonly ALPHA_PREMULTIPLIED: number;
  117725. /**
  117726. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  117727. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  117728. */
  117729. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  117730. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  117731. static readonly ALPHA_INTERPOLATE: number;
  117732. /**
  117733. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  117734. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  117735. */
  117736. static readonly ALPHA_SCREENMODE: number;
  117737. /** Defines that the ressource is not delayed*/
  117738. static readonly DELAYLOADSTATE_NONE: number;
  117739. /** Defines that the ressource was successfully delay loaded */
  117740. static readonly DELAYLOADSTATE_LOADED: number;
  117741. /** Defines that the ressource is currently delay loading */
  117742. static readonly DELAYLOADSTATE_LOADING: number;
  117743. /** Defines that the ressource is delayed and has not started loading */
  117744. static readonly DELAYLOADSTATE_NOTLOADED: number;
  117745. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  117746. static readonly NEVER: number;
  117747. /** 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 */
  117748. static readonly ALWAYS: number;
  117749. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117750. static readonly LESS: number;
  117751. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117752. static readonly EQUAL: number;
  117753. /** 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 */
  117754. static readonly LEQUAL: number;
  117755. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117756. static readonly GREATER: number;
  117757. /** 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 */
  117758. static readonly GEQUAL: number;
  117759. /** 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 */
  117760. static readonly NOTEQUAL: number;
  117761. /** Passed to stencilOperation to specify that stencil value must be kept */
  117762. static readonly KEEP: number;
  117763. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117764. static readonly REPLACE: number;
  117765. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117766. static readonly INCR: number;
  117767. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117768. static readonly DECR: number;
  117769. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117770. static readonly INVERT: number;
  117771. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117772. static readonly INCR_WRAP: number;
  117773. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117774. static readonly DECR_WRAP: number;
  117775. /** Texture is not repeating outside of 0..1 UVs */
  117776. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117777. /** Texture is repeating outside of 0..1 UVs */
  117778. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117779. /** Texture is repeating and mirrored */
  117780. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117781. /** ALPHA */
  117782. static readonly TEXTUREFORMAT_ALPHA: number;
  117783. /** LUMINANCE */
  117784. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117785. /** LUMINANCE_ALPHA */
  117786. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117787. /** RGB */
  117788. static readonly TEXTUREFORMAT_RGB: number;
  117789. /** RGBA */
  117790. static readonly TEXTUREFORMAT_RGBA: number;
  117791. /** RED */
  117792. static readonly TEXTUREFORMAT_RED: number;
  117793. /** RED (2nd reference) */
  117794. static readonly TEXTUREFORMAT_R: number;
  117795. /** RG */
  117796. static readonly TEXTUREFORMAT_RG: number;
  117797. /** RED_INTEGER */
  117798. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117799. /** RED_INTEGER (2nd reference) */
  117800. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117801. /** RG_INTEGER */
  117802. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117803. /** RGB_INTEGER */
  117804. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117805. /** RGBA_INTEGER */
  117806. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117807. /** UNSIGNED_BYTE */
  117808. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117809. /** UNSIGNED_BYTE (2nd reference) */
  117810. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117811. /** FLOAT */
  117812. static readonly TEXTURETYPE_FLOAT: number;
  117813. /** HALF_FLOAT */
  117814. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117815. /** BYTE */
  117816. static readonly TEXTURETYPE_BYTE: number;
  117817. /** SHORT */
  117818. static readonly TEXTURETYPE_SHORT: number;
  117819. /** UNSIGNED_SHORT */
  117820. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117821. /** INT */
  117822. static readonly TEXTURETYPE_INT: number;
  117823. /** UNSIGNED_INT */
  117824. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117825. /** UNSIGNED_SHORT_4_4_4_4 */
  117826. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117827. /** UNSIGNED_SHORT_5_5_5_1 */
  117828. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117829. /** UNSIGNED_SHORT_5_6_5 */
  117830. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117831. /** UNSIGNED_INT_2_10_10_10_REV */
  117832. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117833. /** UNSIGNED_INT_24_8 */
  117834. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117835. /** UNSIGNED_INT_10F_11F_11F_REV */
  117836. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117837. /** UNSIGNED_INT_5_9_9_9_REV */
  117838. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117839. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117840. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117841. /** nearest is mag = nearest and min = nearest and mip = linear */
  117842. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117843. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117844. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117845. /** Trilinear is mag = linear and min = linear and mip = linear */
  117846. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117847. /** nearest is mag = nearest and min = nearest and mip = linear */
  117848. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117849. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117850. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117851. /** Trilinear is mag = linear and min = linear and mip = linear */
  117852. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117853. /** mag = nearest and min = nearest and mip = nearest */
  117854. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117855. /** mag = nearest and min = linear and mip = nearest */
  117856. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117857. /** mag = nearest and min = linear and mip = linear */
  117858. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117859. /** mag = nearest and min = linear and mip = none */
  117860. static readonly TEXTURE_NEAREST_LINEAR: number;
  117861. /** mag = nearest and min = nearest and mip = none */
  117862. static readonly TEXTURE_NEAREST_NEAREST: number;
  117863. /** mag = linear and min = nearest and mip = nearest */
  117864. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117865. /** mag = linear and min = nearest and mip = linear */
  117866. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117867. /** mag = linear and min = linear and mip = none */
  117868. static readonly TEXTURE_LINEAR_LINEAR: number;
  117869. /** mag = linear and min = nearest and mip = none */
  117870. static readonly TEXTURE_LINEAR_NEAREST: number;
  117871. /** Explicit coordinates mode */
  117872. static readonly TEXTURE_EXPLICIT_MODE: number;
  117873. /** Spherical coordinates mode */
  117874. static readonly TEXTURE_SPHERICAL_MODE: number;
  117875. /** Planar coordinates mode */
  117876. static readonly TEXTURE_PLANAR_MODE: number;
  117877. /** Cubic coordinates mode */
  117878. static readonly TEXTURE_CUBIC_MODE: number;
  117879. /** Projection coordinates mode */
  117880. static readonly TEXTURE_PROJECTION_MODE: number;
  117881. /** Skybox coordinates mode */
  117882. static readonly TEXTURE_SKYBOX_MODE: number;
  117883. /** Inverse Cubic coordinates mode */
  117884. static readonly TEXTURE_INVCUBIC_MODE: number;
  117885. /** Equirectangular coordinates mode */
  117886. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117887. /** Equirectangular Fixed coordinates mode */
  117888. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117889. /** Equirectangular Fixed Mirrored coordinates mode */
  117890. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117891. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117892. static readonly SCALEMODE_FLOOR: number;
  117893. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117894. static readonly SCALEMODE_NEAREST: number;
  117895. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117896. static readonly SCALEMODE_CEILING: number;
  117897. /**
  117898. * Returns the current npm package of the sdk
  117899. */
  117900. static get NpmPackage(): string;
  117901. /**
  117902. * Returns the current version of the framework
  117903. */
  117904. static get Version(): string;
  117905. /** Gets the list of created engines */
  117906. static get Instances(): Engine[];
  117907. /**
  117908. * Gets the latest created engine
  117909. */
  117910. static get LastCreatedEngine(): Nullable<Engine>;
  117911. /**
  117912. * Gets the latest created scene
  117913. */
  117914. static get LastCreatedScene(): Nullable<Scene>;
  117915. /**
  117916. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117917. * @param flag defines which part of the materials must be marked as dirty
  117918. * @param predicate defines a predicate used to filter which materials should be affected
  117919. */
  117920. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117921. /**
  117922. * Method called to create the default loading screen.
  117923. * This can be overriden in your own app.
  117924. * @param canvas The rendering canvas element
  117925. * @returns The loading screen
  117926. */
  117927. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117928. /**
  117929. * Method called to create the default rescale post process on each engine.
  117930. */
  117931. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117932. /**
  117933. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117934. **/
  117935. enableOfflineSupport: boolean;
  117936. /**
  117937. * 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)
  117938. **/
  117939. disableManifestCheck: boolean;
  117940. /**
  117941. * Gets the list of created scenes
  117942. */
  117943. scenes: Scene[];
  117944. /**
  117945. * Event raised when a new scene is created
  117946. */
  117947. onNewSceneAddedObservable: Observable<Scene>;
  117948. /**
  117949. * Gets the list of created postprocesses
  117950. */
  117951. postProcesses: PostProcess[];
  117952. /**
  117953. * Gets a boolean indicating if the pointer is currently locked
  117954. */
  117955. isPointerLock: boolean;
  117956. /**
  117957. * Observable event triggered each time the rendering canvas is resized
  117958. */
  117959. onResizeObservable: Observable<Engine>;
  117960. /**
  117961. * Observable event triggered each time the canvas loses focus
  117962. */
  117963. onCanvasBlurObservable: Observable<Engine>;
  117964. /**
  117965. * Observable event triggered each time the canvas gains focus
  117966. */
  117967. onCanvasFocusObservable: Observable<Engine>;
  117968. /**
  117969. * Observable event triggered each time the canvas receives pointerout event
  117970. */
  117971. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117972. /**
  117973. * Observable raised when the engine begins a new frame
  117974. */
  117975. onBeginFrameObservable: Observable<Engine>;
  117976. /**
  117977. * If set, will be used to request the next animation frame for the render loop
  117978. */
  117979. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117980. /**
  117981. * Observable raised when the engine ends the current frame
  117982. */
  117983. onEndFrameObservable: Observable<Engine>;
  117984. /**
  117985. * Observable raised when the engine is about to compile a shader
  117986. */
  117987. onBeforeShaderCompilationObservable: Observable<Engine>;
  117988. /**
  117989. * Observable raised when the engine has jsut compiled a shader
  117990. */
  117991. onAfterShaderCompilationObservable: Observable<Engine>;
  117992. /**
  117993. * Gets the audio engine
  117994. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117995. * @ignorenaming
  117996. */
  117997. static audioEngine: IAudioEngine;
  117998. /**
  117999. * Default AudioEngine factory responsible of creating the Audio Engine.
  118000. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  118001. */
  118002. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  118003. /**
  118004. * Default offline support factory responsible of creating a tool used to store data locally.
  118005. * By default, this will create a Database object if the workload has been embedded.
  118006. */
  118007. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  118008. private _loadingScreen;
  118009. private _pointerLockRequested;
  118010. private _rescalePostProcess;
  118011. private _deterministicLockstep;
  118012. private _lockstepMaxSteps;
  118013. private _timeStep;
  118014. protected get _supportsHardwareTextureRescaling(): boolean;
  118015. private _fps;
  118016. private _deltaTime;
  118017. /** @hidden */
  118018. _drawCalls: PerfCounter;
  118019. /** 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 */
  118020. canvasTabIndex: number;
  118021. /**
  118022. * Turn this value on if you want to pause FPS computation when in background
  118023. */
  118024. disablePerformanceMonitorInBackground: boolean;
  118025. private _performanceMonitor;
  118026. /**
  118027. * Gets the performance monitor attached to this engine
  118028. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  118029. */
  118030. get performanceMonitor(): PerformanceMonitor;
  118031. private _onFocus;
  118032. private _onBlur;
  118033. private _onCanvasPointerOut;
  118034. private _onCanvasBlur;
  118035. private _onCanvasFocus;
  118036. private _onFullscreenChange;
  118037. private _onPointerLockChange;
  118038. /**
  118039. * Gets the HTML element used to attach event listeners
  118040. * @returns a HTML element
  118041. */
  118042. getInputElement(): Nullable<HTMLElement>;
  118043. /**
  118044. * Creates a new engine
  118045. * @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
  118046. * @param antialias defines enable antialiasing (default: false)
  118047. * @param options defines further options to be sent to the getContext() function
  118048. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  118049. */
  118050. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  118051. /**
  118052. * Gets current aspect ratio
  118053. * @param viewportOwner defines the camera to use to get the aspect ratio
  118054. * @param useScreen defines if screen size must be used (or the current render target if any)
  118055. * @returns a number defining the aspect ratio
  118056. */
  118057. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  118058. /**
  118059. * Gets current screen aspect ratio
  118060. * @returns a number defining the aspect ratio
  118061. */
  118062. getScreenAspectRatio(): number;
  118063. /**
  118064. * Gets the client rect of the HTML canvas attached with the current webGL context
  118065. * @returns a client rectanglee
  118066. */
  118067. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  118068. /**
  118069. * Gets the client rect of the HTML element used for events
  118070. * @returns a client rectanglee
  118071. */
  118072. getInputElementClientRect(): Nullable<ClientRect>;
  118073. /**
  118074. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  118075. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118076. * @returns true if engine is in deterministic lock step mode
  118077. */
  118078. isDeterministicLockStep(): boolean;
  118079. /**
  118080. * Gets the max steps when engine is running in deterministic lock step
  118081. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118082. * @returns the max steps
  118083. */
  118084. getLockstepMaxSteps(): number;
  118085. /**
  118086. * Returns the time in ms between steps when using deterministic lock step.
  118087. * @returns time step in (ms)
  118088. */
  118089. getTimeStep(): number;
  118090. /**
  118091. * Force the mipmap generation for the given render target texture
  118092. * @param texture defines the render target texture to use
  118093. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  118094. */
  118095. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  118096. /** States */
  118097. /**
  118098. * Set various states to the webGL context
  118099. * @param culling defines backface culling state
  118100. * @param zOffset defines the value to apply to zOffset (0 by default)
  118101. * @param force defines if states must be applied even if cache is up to date
  118102. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  118103. */
  118104. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  118105. /**
  118106. * Set the z offset to apply to current rendering
  118107. * @param value defines the offset to apply
  118108. */
  118109. setZOffset(value: number): void;
  118110. /**
  118111. * Gets the current value of the zOffset
  118112. * @returns the current zOffset state
  118113. */
  118114. getZOffset(): number;
  118115. /**
  118116. * Enable or disable depth buffering
  118117. * @param enable defines the state to set
  118118. */
  118119. setDepthBuffer(enable: boolean): void;
  118120. /**
  118121. * Gets a boolean indicating if depth writing is enabled
  118122. * @returns the current depth writing state
  118123. */
  118124. getDepthWrite(): boolean;
  118125. /**
  118126. * Enable or disable depth writing
  118127. * @param enable defines the state to set
  118128. */
  118129. setDepthWrite(enable: boolean): void;
  118130. /**
  118131. * Gets a boolean indicating if stencil buffer is enabled
  118132. * @returns the current stencil buffer state
  118133. */
  118134. getStencilBuffer(): boolean;
  118135. /**
  118136. * Enable or disable the stencil buffer
  118137. * @param enable defines if the stencil buffer must be enabled or disabled
  118138. */
  118139. setStencilBuffer(enable: boolean): void;
  118140. /**
  118141. * Gets the current stencil mask
  118142. * @returns a number defining the new stencil mask to use
  118143. */
  118144. getStencilMask(): number;
  118145. /**
  118146. * Sets the current stencil mask
  118147. * @param mask defines the new stencil mask to use
  118148. */
  118149. setStencilMask(mask: number): void;
  118150. /**
  118151. * Gets the current stencil function
  118152. * @returns a number defining the stencil function to use
  118153. */
  118154. getStencilFunction(): number;
  118155. /**
  118156. * Gets the current stencil reference value
  118157. * @returns a number defining the stencil reference value to use
  118158. */
  118159. getStencilFunctionReference(): number;
  118160. /**
  118161. * Gets the current stencil mask
  118162. * @returns a number defining the stencil mask to use
  118163. */
  118164. getStencilFunctionMask(): number;
  118165. /**
  118166. * Sets the current stencil function
  118167. * @param stencilFunc defines the new stencil function to use
  118168. */
  118169. setStencilFunction(stencilFunc: number): void;
  118170. /**
  118171. * Sets the current stencil reference
  118172. * @param reference defines the new stencil reference to use
  118173. */
  118174. setStencilFunctionReference(reference: number): void;
  118175. /**
  118176. * Sets the current stencil mask
  118177. * @param mask defines the new stencil mask to use
  118178. */
  118179. setStencilFunctionMask(mask: number): void;
  118180. /**
  118181. * Gets the current stencil operation when stencil fails
  118182. * @returns a number defining stencil operation to use when stencil fails
  118183. */
  118184. getStencilOperationFail(): number;
  118185. /**
  118186. * Gets the current stencil operation when depth fails
  118187. * @returns a number defining stencil operation to use when depth fails
  118188. */
  118189. getStencilOperationDepthFail(): number;
  118190. /**
  118191. * Gets the current stencil operation when stencil passes
  118192. * @returns a number defining stencil operation to use when stencil passes
  118193. */
  118194. getStencilOperationPass(): number;
  118195. /**
  118196. * Sets the stencil operation to use when stencil fails
  118197. * @param operation defines the stencil operation to use when stencil fails
  118198. */
  118199. setStencilOperationFail(operation: number): void;
  118200. /**
  118201. * Sets the stencil operation to use when depth fails
  118202. * @param operation defines the stencil operation to use when depth fails
  118203. */
  118204. setStencilOperationDepthFail(operation: number): void;
  118205. /**
  118206. * Sets the stencil operation to use when stencil passes
  118207. * @param operation defines the stencil operation to use when stencil passes
  118208. */
  118209. setStencilOperationPass(operation: number): void;
  118210. /**
  118211. * Sets a boolean indicating if the dithering state is enabled or disabled
  118212. * @param value defines the dithering state
  118213. */
  118214. setDitheringState(value: boolean): void;
  118215. /**
  118216. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  118217. * @param value defines the rasterizer state
  118218. */
  118219. setRasterizerState(value: boolean): void;
  118220. /**
  118221. * Gets the current depth function
  118222. * @returns a number defining the depth function
  118223. */
  118224. getDepthFunction(): Nullable<number>;
  118225. /**
  118226. * Sets the current depth function
  118227. * @param depthFunc defines the function to use
  118228. */
  118229. setDepthFunction(depthFunc: number): void;
  118230. /**
  118231. * Sets the current depth function to GREATER
  118232. */
  118233. setDepthFunctionToGreater(): void;
  118234. /**
  118235. * Sets the current depth function to GEQUAL
  118236. */
  118237. setDepthFunctionToGreaterOrEqual(): void;
  118238. /**
  118239. * Sets the current depth function to LESS
  118240. */
  118241. setDepthFunctionToLess(): void;
  118242. /**
  118243. * Sets the current depth function to LEQUAL
  118244. */
  118245. setDepthFunctionToLessOrEqual(): void;
  118246. private _cachedStencilBuffer;
  118247. private _cachedStencilFunction;
  118248. private _cachedStencilMask;
  118249. private _cachedStencilOperationPass;
  118250. private _cachedStencilOperationFail;
  118251. private _cachedStencilOperationDepthFail;
  118252. private _cachedStencilReference;
  118253. /**
  118254. * Caches the the state of the stencil buffer
  118255. */
  118256. cacheStencilState(): void;
  118257. /**
  118258. * Restores the state of the stencil buffer
  118259. */
  118260. restoreStencilState(): void;
  118261. /**
  118262. * Directly set the WebGL Viewport
  118263. * @param x defines the x coordinate of the viewport (in screen space)
  118264. * @param y defines the y coordinate of the viewport (in screen space)
  118265. * @param width defines the width of the viewport (in screen space)
  118266. * @param height defines the height of the viewport (in screen space)
  118267. * @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
  118268. */
  118269. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  118270. /**
  118271. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  118272. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  118273. * @param y defines the y-coordinate of the corner of the clear rectangle
  118274. * @param width defines the width of the clear rectangle
  118275. * @param height defines the height of the clear rectangle
  118276. * @param clearColor defines the clear color
  118277. */
  118278. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  118279. /**
  118280. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  118281. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  118282. * @param y defines the y-coordinate of the corner of the clear rectangle
  118283. * @param width defines the width of the clear rectangle
  118284. * @param height defines the height of the clear rectangle
  118285. */
  118286. enableScissor(x: number, y: number, width: number, height: number): void;
  118287. /**
  118288. * Disable previously set scissor test rectangle
  118289. */
  118290. disableScissor(): void;
  118291. protected _reportDrawCall(): void;
  118292. /**
  118293. * Initializes a webVR display and starts listening to display change events
  118294. * The onVRDisplayChangedObservable will be notified upon these changes
  118295. * @returns The onVRDisplayChangedObservable
  118296. */
  118297. initWebVR(): Observable<IDisplayChangedEventArgs>;
  118298. /** @hidden */
  118299. _prepareVRComponent(): void;
  118300. /** @hidden */
  118301. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  118302. /** @hidden */
  118303. _submitVRFrame(): void;
  118304. /**
  118305. * Call this function to leave webVR mode
  118306. * Will do nothing if webVR is not supported or if there is no webVR device
  118307. * @see https://doc.babylonjs.com/how_to/webvr_camera
  118308. */
  118309. disableVR(): void;
  118310. /**
  118311. * Gets a boolean indicating that the system is in VR mode and is presenting
  118312. * @returns true if VR mode is engaged
  118313. */
  118314. isVRPresenting(): boolean;
  118315. /** @hidden */
  118316. _requestVRFrame(): void;
  118317. /** @hidden */
  118318. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  118319. /**
  118320. * Gets the source code of the vertex shader associated with a specific webGL program
  118321. * @param program defines the program to use
  118322. * @returns a string containing the source code of the vertex shader associated with the program
  118323. */
  118324. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  118325. /**
  118326. * Gets the source code of the fragment shader associated with a specific webGL program
  118327. * @param program defines the program to use
  118328. * @returns a string containing the source code of the fragment shader associated with the program
  118329. */
  118330. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  118331. /**
  118332. * Sets a depth stencil texture from a render target to the according uniform.
  118333. * @param channel The texture channel
  118334. * @param uniform The uniform to set
  118335. * @param texture The render target texture containing the depth stencil texture to apply
  118336. */
  118337. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  118338. /**
  118339. * Sets a texture to the webGL context from a postprocess
  118340. * @param channel defines the channel to use
  118341. * @param postProcess defines the source postprocess
  118342. */
  118343. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  118344. /**
  118345. * Binds the output of the passed in post process to the texture channel specified
  118346. * @param channel The channel the texture should be bound to
  118347. * @param postProcess The post process which's output should be bound
  118348. */
  118349. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  118350. protected _rebuildBuffers(): void;
  118351. /** @hidden */
  118352. _renderFrame(): void;
  118353. _renderLoop(): void;
  118354. /** @hidden */
  118355. _renderViews(): boolean;
  118356. /**
  118357. * Toggle full screen mode
  118358. * @param requestPointerLock defines if a pointer lock should be requested from the user
  118359. */
  118360. switchFullscreen(requestPointerLock: boolean): void;
  118361. /**
  118362. * Enters full screen mode
  118363. * @param requestPointerLock defines if a pointer lock should be requested from the user
  118364. */
  118365. enterFullscreen(requestPointerLock: boolean): void;
  118366. /**
  118367. * Exits full screen mode
  118368. */
  118369. exitFullscreen(): void;
  118370. /**
  118371. * Enters Pointerlock mode
  118372. */
  118373. enterPointerlock(): void;
  118374. /**
  118375. * Exits Pointerlock mode
  118376. */
  118377. exitPointerlock(): void;
  118378. /**
  118379. * Begin a new frame
  118380. */
  118381. beginFrame(): void;
  118382. /**
  118383. * Enf the current frame
  118384. */
  118385. endFrame(): void;
  118386. resize(): void;
  118387. /**
  118388. * Force a specific size of the canvas
  118389. * @param width defines the new canvas' width
  118390. * @param height defines the new canvas' height
  118391. * @returns true if the size was changed
  118392. */
  118393. setSize(width: number, height: number): boolean;
  118394. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  118395. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  118396. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  118397. _releaseTexture(texture: InternalTexture): void;
  118398. /**
  118399. * @hidden
  118400. * Rescales a texture
  118401. * @param source input texutre
  118402. * @param destination destination texture
  118403. * @param scene scene to use to render the resize
  118404. * @param internalFormat format to use when resizing
  118405. * @param onComplete callback to be called when resize has completed
  118406. */
  118407. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  118408. /**
  118409. * Gets the current framerate
  118410. * @returns a number representing the framerate
  118411. */
  118412. getFps(): number;
  118413. /**
  118414. * Gets the time spent between current and previous frame
  118415. * @returns a number representing the delta time in ms
  118416. */
  118417. getDeltaTime(): number;
  118418. private _measureFps;
  118419. /** @hidden */
  118420. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  118421. /**
  118422. * Updates the sample count of a render target texture
  118423. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  118424. * @param texture defines the texture to update
  118425. * @param samples defines the sample count to set
  118426. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  118427. */
  118428. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  118429. /**
  118430. * Updates a depth texture Comparison Mode and Function.
  118431. * If the comparison Function is equal to 0, the mode will be set to none.
  118432. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  118433. * @param texture The texture to set the comparison function for
  118434. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  118435. */
  118436. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  118437. /**
  118438. * Creates a webGL buffer to use with instanciation
  118439. * @param capacity defines the size of the buffer
  118440. * @returns the webGL buffer
  118441. */
  118442. createInstancesBuffer(capacity: number): DataBuffer;
  118443. /**
  118444. * Delete a webGL buffer used with instanciation
  118445. * @param buffer defines the webGL buffer to delete
  118446. */
  118447. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  118448. private _clientWaitAsync;
  118449. /** @hidden */
  118450. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  118451. dispose(): void;
  118452. private _disableTouchAction;
  118453. /**
  118454. * Display the loading screen
  118455. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118456. */
  118457. displayLoadingUI(): void;
  118458. /**
  118459. * Hide the loading screen
  118460. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118461. */
  118462. hideLoadingUI(): void;
  118463. /**
  118464. * Gets the current loading screen object
  118465. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118466. */
  118467. get loadingScreen(): ILoadingScreen;
  118468. /**
  118469. * Sets the current loading screen object
  118470. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118471. */
  118472. set loadingScreen(loadingScreen: ILoadingScreen);
  118473. /**
  118474. * Sets the current loading screen text
  118475. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118476. */
  118477. set loadingUIText(text: string);
  118478. /**
  118479. * Sets the current loading screen background color
  118480. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118481. */
  118482. set loadingUIBackgroundColor(color: string);
  118483. /** Pointerlock and fullscreen */
  118484. /**
  118485. * Ask the browser to promote the current element to pointerlock mode
  118486. * @param element defines the DOM element to promote
  118487. */
  118488. static _RequestPointerlock(element: HTMLElement): void;
  118489. /**
  118490. * Asks the browser to exit pointerlock mode
  118491. */
  118492. static _ExitPointerlock(): void;
  118493. /**
  118494. * Ask the browser to promote the current element to fullscreen rendering mode
  118495. * @param element defines the DOM element to promote
  118496. */
  118497. static _RequestFullscreen(element: HTMLElement): void;
  118498. /**
  118499. * Asks the browser to exit fullscreen mode
  118500. */
  118501. static _ExitFullscreen(): void;
  118502. }
  118503. }
  118504. declare module BABYLON {
  118505. /**
  118506. * The engine store class is responsible to hold all the instances of Engine and Scene created
  118507. * during the life time of the application.
  118508. */
  118509. export class EngineStore {
  118510. /** Gets the list of created engines */
  118511. static Instances: Engine[];
  118512. /** @hidden */
  118513. static _LastCreatedScene: Nullable<Scene>;
  118514. /**
  118515. * Gets the latest created engine
  118516. */
  118517. static get LastCreatedEngine(): Nullable<Engine>;
  118518. /**
  118519. * Gets the latest created scene
  118520. */
  118521. static get LastCreatedScene(): Nullable<Scene>;
  118522. /**
  118523. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  118524. * @ignorenaming
  118525. */
  118526. static UseFallbackTexture: boolean;
  118527. /**
  118528. * Texture content used if a texture cannot loaded
  118529. * @ignorenaming
  118530. */
  118531. static FallbackTexture: string;
  118532. }
  118533. }
  118534. declare module BABYLON {
  118535. /**
  118536. * Helper class that provides a small promise polyfill
  118537. */
  118538. export class PromisePolyfill {
  118539. /**
  118540. * Static function used to check if the polyfill is required
  118541. * If this is the case then the function will inject the polyfill to window.Promise
  118542. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  118543. */
  118544. static Apply(force?: boolean): void;
  118545. }
  118546. }
  118547. declare module BABYLON {
  118548. /**
  118549. * Interface for screenshot methods with describe argument called `size` as object with options
  118550. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  118551. */
  118552. export interface IScreenshotSize {
  118553. /**
  118554. * number in pixels for canvas height
  118555. */
  118556. height?: number;
  118557. /**
  118558. * multiplier allowing render at a higher or lower resolution
  118559. * If value is defined then height and width will be ignored and taken from camera
  118560. */
  118561. precision?: number;
  118562. /**
  118563. * number in pixels for canvas width
  118564. */
  118565. width?: number;
  118566. }
  118567. }
  118568. declare module BABYLON {
  118569. interface IColor4Like {
  118570. r: float;
  118571. g: float;
  118572. b: float;
  118573. a: float;
  118574. }
  118575. /**
  118576. * Class containing a set of static utilities functions
  118577. */
  118578. export class Tools {
  118579. /**
  118580. * Gets or sets the base URL to use to load assets
  118581. */
  118582. static get BaseUrl(): string;
  118583. static set BaseUrl(value: string);
  118584. /**
  118585. * Enable/Disable Custom HTTP Request Headers globally.
  118586. * default = false
  118587. * @see CustomRequestHeaders
  118588. */
  118589. static UseCustomRequestHeaders: boolean;
  118590. /**
  118591. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  118592. * i.e. when loading files, where the server/service expects an Authorization header
  118593. */
  118594. static CustomRequestHeaders: {
  118595. [key: string]: string;
  118596. };
  118597. /**
  118598. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  118599. */
  118600. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  118601. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  118602. /**
  118603. * Default behaviour for cors in the application.
  118604. * It can be a string if the expected behavior is identical in the entire app.
  118605. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  118606. */
  118607. static get CorsBehavior(): string | ((url: string | string[]) => string);
  118608. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  118609. /**
  118610. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  118611. * @ignorenaming
  118612. */
  118613. static get UseFallbackTexture(): boolean;
  118614. static set UseFallbackTexture(value: boolean);
  118615. /**
  118616. * Use this object to register external classes like custom textures or material
  118617. * to allow the laoders to instantiate them
  118618. */
  118619. static get RegisteredExternalClasses(): {
  118620. [key: string]: Object;
  118621. };
  118622. static set RegisteredExternalClasses(classes: {
  118623. [key: string]: Object;
  118624. });
  118625. /**
  118626. * Texture content used if a texture cannot loaded
  118627. * @ignorenaming
  118628. */
  118629. static get fallbackTexture(): string;
  118630. static set fallbackTexture(value: string);
  118631. /**
  118632. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  118633. * @param u defines the coordinate on X axis
  118634. * @param v defines the coordinate on Y axis
  118635. * @param width defines the width of the source data
  118636. * @param height defines the height of the source data
  118637. * @param pixels defines the source byte array
  118638. * @param color defines the output color
  118639. */
  118640. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  118641. /**
  118642. * Interpolates between a and b via alpha
  118643. * @param a The lower value (returned when alpha = 0)
  118644. * @param b The upper value (returned when alpha = 1)
  118645. * @param alpha The interpolation-factor
  118646. * @return The mixed value
  118647. */
  118648. static Mix(a: number, b: number, alpha: number): number;
  118649. /**
  118650. * Tries to instantiate a new object from a given class name
  118651. * @param className defines the class name to instantiate
  118652. * @returns the new object or null if the system was not able to do the instantiation
  118653. */
  118654. static Instantiate(className: string): any;
  118655. /**
  118656. * Provides a slice function that will work even on IE
  118657. * @param data defines the array to slice
  118658. * @param start defines the start of the data (optional)
  118659. * @param end defines the end of the data (optional)
  118660. * @returns the new sliced array
  118661. */
  118662. static Slice<T>(data: T, start?: number, end?: number): T;
  118663. /**
  118664. * Polyfill for setImmediate
  118665. * @param action defines the action to execute after the current execution block
  118666. */
  118667. static SetImmediate(action: () => void): void;
  118668. /**
  118669. * Function indicating if a number is an exponent of 2
  118670. * @param value defines the value to test
  118671. * @returns true if the value is an exponent of 2
  118672. */
  118673. static IsExponentOfTwo(value: number): boolean;
  118674. private static _tmpFloatArray;
  118675. /**
  118676. * Returns the nearest 32-bit single precision float representation of a Number
  118677. * @param value A Number. If the parameter is of a different type, it will get converted
  118678. * to a number or to NaN if it cannot be converted
  118679. * @returns number
  118680. */
  118681. static FloatRound(value: number): number;
  118682. /**
  118683. * Extracts the filename from a path
  118684. * @param path defines the path to use
  118685. * @returns the filename
  118686. */
  118687. static GetFilename(path: string): string;
  118688. /**
  118689. * Extracts the "folder" part of a path (everything before the filename).
  118690. * @param uri The URI to extract the info from
  118691. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  118692. * @returns The "folder" part of the path
  118693. */
  118694. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  118695. /**
  118696. * Extracts text content from a DOM element hierarchy
  118697. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  118698. */
  118699. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  118700. /**
  118701. * Convert an angle in radians to degrees
  118702. * @param angle defines the angle to convert
  118703. * @returns the angle in degrees
  118704. */
  118705. static ToDegrees(angle: number): number;
  118706. /**
  118707. * Convert an angle in degrees to radians
  118708. * @param angle defines the angle to convert
  118709. * @returns the angle in radians
  118710. */
  118711. static ToRadians(angle: number): number;
  118712. /**
  118713. * Returns an array if obj is not an array
  118714. * @param obj defines the object to evaluate as an array
  118715. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  118716. * @returns either obj directly if obj is an array or a new array containing obj
  118717. */
  118718. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  118719. /**
  118720. * Gets the pointer prefix to use
  118721. * @param engine defines the engine we are finding the prefix for
  118722. * @returns "pointer" if touch is enabled. Else returns "mouse"
  118723. */
  118724. static GetPointerPrefix(engine: Engine): string;
  118725. /**
  118726. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  118727. * @param url define the url we are trying
  118728. * @param element define the dom element where to configure the cors policy
  118729. */
  118730. static SetCorsBehavior(url: string | string[], element: {
  118731. crossOrigin: string | null;
  118732. }): void;
  118733. /**
  118734. * Removes unwanted characters from an url
  118735. * @param url defines the url to clean
  118736. * @returns the cleaned url
  118737. */
  118738. static CleanUrl(url: string): string;
  118739. /**
  118740. * Gets or sets a function used to pre-process url before using them to load assets
  118741. */
  118742. static get PreprocessUrl(): (url: string) => string;
  118743. static set PreprocessUrl(processor: (url: string) => string);
  118744. /**
  118745. * Loads an image as an HTMLImageElement.
  118746. * @param input url string, ArrayBuffer, or Blob to load
  118747. * @param onLoad callback called when the image successfully loads
  118748. * @param onError callback called when the image fails to load
  118749. * @param offlineProvider offline provider for caching
  118750. * @param mimeType optional mime type
  118751. * @returns the HTMLImageElement of the loaded image
  118752. */
  118753. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118754. /**
  118755. * Loads a file from a url
  118756. * @param url url string, ArrayBuffer, or Blob to load
  118757. * @param onSuccess callback called when the file successfully loads
  118758. * @param onProgress callback called while file is loading (if the server supports this mode)
  118759. * @param offlineProvider defines the offline provider for caching
  118760. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118761. * @param onError callback called when the file fails to load
  118762. * @returns a file request object
  118763. */
  118764. 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;
  118765. /**
  118766. * Loads a file from a url
  118767. * @param url the file url to load
  118768. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118769. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118770. */
  118771. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118772. /**
  118773. * Load a script (identified by an url). When the url returns, the
  118774. * content of this file is added into a new script element, attached to the DOM (body element)
  118775. * @param scriptUrl defines the url of the script to laod
  118776. * @param onSuccess defines the callback called when the script is loaded
  118777. * @param onError defines the callback to call if an error occurs
  118778. * @param scriptId defines the id of the script element
  118779. */
  118780. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118781. /**
  118782. * Load an asynchronous script (identified by an url). When the url returns, the
  118783. * content of this file is added into a new script element, attached to the DOM (body element)
  118784. * @param scriptUrl defines the url of the script to laod
  118785. * @param scriptId defines the id of the script element
  118786. * @returns a promise request object
  118787. */
  118788. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118789. /**
  118790. * Loads a file from a blob
  118791. * @param fileToLoad defines the blob to use
  118792. * @param callback defines the callback to call when data is loaded
  118793. * @param progressCallback defines the callback to call during loading process
  118794. * @returns a file request object
  118795. */
  118796. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118797. /**
  118798. * Reads a file from a File object
  118799. * @param file defines the file to load
  118800. * @param onSuccess defines the callback to call when data is loaded
  118801. * @param onProgress defines the callback to call during loading process
  118802. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118803. * @param onError defines the callback to call when an error occurs
  118804. * @returns a file request object
  118805. */
  118806. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118807. /**
  118808. * Creates a data url from a given string content
  118809. * @param content defines the content to convert
  118810. * @returns the new data url link
  118811. */
  118812. static FileAsURL(content: string): string;
  118813. /**
  118814. * Format the given number to a specific decimal format
  118815. * @param value defines the number to format
  118816. * @param decimals defines the number of decimals to use
  118817. * @returns the formatted string
  118818. */
  118819. static Format(value: number, decimals?: number): string;
  118820. /**
  118821. * Tries to copy an object by duplicating every property
  118822. * @param source defines the source object
  118823. * @param destination defines the target object
  118824. * @param doNotCopyList defines a list of properties to avoid
  118825. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118826. */
  118827. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118828. /**
  118829. * Gets a boolean indicating if the given object has no own property
  118830. * @param obj defines the object to test
  118831. * @returns true if object has no own property
  118832. */
  118833. static IsEmpty(obj: any): boolean;
  118834. /**
  118835. * Function used to register events at window level
  118836. * @param windowElement defines the Window object to use
  118837. * @param events defines the events to register
  118838. */
  118839. static RegisterTopRootEvents(windowElement: Window, events: {
  118840. name: string;
  118841. handler: Nullable<(e: FocusEvent) => any>;
  118842. }[]): void;
  118843. /**
  118844. * Function used to unregister events from window level
  118845. * @param windowElement defines the Window object to use
  118846. * @param events defines the events to unregister
  118847. */
  118848. static UnregisterTopRootEvents(windowElement: Window, events: {
  118849. name: string;
  118850. handler: Nullable<(e: FocusEvent) => any>;
  118851. }[]): void;
  118852. /**
  118853. * @ignore
  118854. */
  118855. static _ScreenshotCanvas: HTMLCanvasElement;
  118856. /**
  118857. * Dumps the current bound framebuffer
  118858. * @param width defines the rendering width
  118859. * @param height defines the rendering height
  118860. * @param engine defines the hosting engine
  118861. * @param successCallback defines the callback triggered once the data are available
  118862. * @param mimeType defines the mime type of the result
  118863. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118864. */
  118865. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118866. /**
  118867. * Converts the canvas data to blob.
  118868. * This acts as a polyfill for browsers not supporting the to blob function.
  118869. * @param canvas Defines the canvas to extract the data from
  118870. * @param successCallback Defines the callback triggered once the data are available
  118871. * @param mimeType Defines the mime type of the result
  118872. */
  118873. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118874. /**
  118875. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118876. * @param successCallback defines the callback triggered once the data are available
  118877. * @param mimeType defines the mime type of the result
  118878. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118879. */
  118880. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118881. /**
  118882. * Downloads a blob in the browser
  118883. * @param blob defines the blob to download
  118884. * @param fileName defines the name of the downloaded file
  118885. */
  118886. static Download(blob: Blob, fileName: string): void;
  118887. /**
  118888. * Captures a screenshot of the current rendering
  118889. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118890. * @param engine defines the rendering engine
  118891. * @param camera defines the source camera
  118892. * @param size This parameter can be set to a single number or to an object with the
  118893. * following (optional) properties: precision, width, height. If a single number is passed,
  118894. * it will be used for both width and height. If an object is passed, the screenshot size
  118895. * will be derived from the parameters. The precision property is a multiplier allowing
  118896. * rendering at a higher or lower resolution
  118897. * @param successCallback defines the callback receives a single parameter which contains the
  118898. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118899. * src parameter of an <img> to display it
  118900. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118901. * Check your browser for supported MIME types
  118902. */
  118903. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118904. /**
  118905. * Captures a screenshot of the current rendering
  118906. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118907. * @param engine defines the rendering engine
  118908. * @param camera defines the source camera
  118909. * @param size This parameter can be set to a single number or to an object with the
  118910. * following (optional) properties: precision, width, height. If a single number is passed,
  118911. * it will be used for both width and height. If an object is passed, the screenshot size
  118912. * will be derived from the parameters. The precision property is a multiplier allowing
  118913. * rendering at a higher or lower resolution
  118914. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118915. * Check your browser for supported MIME types
  118916. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118917. * to the src parameter of an <img> to display it
  118918. */
  118919. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118920. /**
  118921. * Generates an image screenshot from the specified camera.
  118922. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118923. * @param engine The engine to use for rendering
  118924. * @param camera The camera to use for rendering
  118925. * @param size This parameter can be set to a single number or to an object with the
  118926. * following (optional) properties: precision, width, height. If a single number is passed,
  118927. * it will be used for both width and height. If an object is passed, the screenshot size
  118928. * will be derived from the parameters. The precision property is a multiplier allowing
  118929. * rendering at a higher or lower resolution
  118930. * @param successCallback The callback receives a single parameter which contains the
  118931. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118932. * src parameter of an <img> to display it
  118933. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118934. * Check your browser for supported MIME types
  118935. * @param samples Texture samples (default: 1)
  118936. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118937. * @param fileName A name for for the downloaded file.
  118938. */
  118939. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118940. /**
  118941. * Generates an image screenshot from the specified camera.
  118942. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118943. * @param engine The engine to use for rendering
  118944. * @param camera The camera to use for rendering
  118945. * @param size This parameter can be set to a single number or to an object with the
  118946. * following (optional) properties: precision, width, height. If a single number is passed,
  118947. * it will be used for both width and height. If an object is passed, the screenshot size
  118948. * will be derived from the parameters. The precision property is a multiplier allowing
  118949. * rendering at a higher or lower resolution
  118950. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118951. * Check your browser for supported MIME types
  118952. * @param samples Texture samples (default: 1)
  118953. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118954. * @param fileName A name for for the downloaded file.
  118955. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118956. * to the src parameter of an <img> to display it
  118957. */
  118958. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118959. /**
  118960. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118961. * Be aware Math.random() could cause collisions, but:
  118962. * "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"
  118963. * @returns a pseudo random id
  118964. */
  118965. static RandomId(): string;
  118966. /**
  118967. * Test if the given uri is a base64 string
  118968. * @param uri The uri to test
  118969. * @return True if the uri is a base64 string or false otherwise
  118970. */
  118971. static IsBase64(uri: string): boolean;
  118972. /**
  118973. * Decode the given base64 uri.
  118974. * @param uri The uri to decode
  118975. * @return The decoded base64 data.
  118976. */
  118977. static DecodeBase64(uri: string): ArrayBuffer;
  118978. /**
  118979. * Gets the absolute url.
  118980. * @param url the input url
  118981. * @return the absolute url
  118982. */
  118983. static GetAbsoluteUrl(url: string): string;
  118984. /**
  118985. * No log
  118986. */
  118987. static readonly NoneLogLevel: number;
  118988. /**
  118989. * Only message logs
  118990. */
  118991. static readonly MessageLogLevel: number;
  118992. /**
  118993. * Only warning logs
  118994. */
  118995. static readonly WarningLogLevel: number;
  118996. /**
  118997. * Only error logs
  118998. */
  118999. static readonly ErrorLogLevel: number;
  119000. /**
  119001. * All logs
  119002. */
  119003. static readonly AllLogLevel: number;
  119004. /**
  119005. * Gets a value indicating the number of loading errors
  119006. * @ignorenaming
  119007. */
  119008. static get errorsCount(): number;
  119009. /**
  119010. * Callback called when a new log is added
  119011. */
  119012. static OnNewCacheEntry: (entry: string) => void;
  119013. /**
  119014. * Log a message to the console
  119015. * @param message defines the message to log
  119016. */
  119017. static Log(message: string): void;
  119018. /**
  119019. * Write a warning message to the console
  119020. * @param message defines the message to log
  119021. */
  119022. static Warn(message: string): void;
  119023. /**
  119024. * Write an error message to the console
  119025. * @param message defines the message to log
  119026. */
  119027. static Error(message: string): void;
  119028. /**
  119029. * Gets current log cache (list of logs)
  119030. */
  119031. static get LogCache(): string;
  119032. /**
  119033. * Clears the log cache
  119034. */
  119035. static ClearLogCache(): void;
  119036. /**
  119037. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  119038. */
  119039. static set LogLevels(level: number);
  119040. /**
  119041. * Checks if the window object exists
  119042. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  119043. */
  119044. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  119045. /**
  119046. * No performance log
  119047. */
  119048. static readonly PerformanceNoneLogLevel: number;
  119049. /**
  119050. * Use user marks to log performance
  119051. */
  119052. static readonly PerformanceUserMarkLogLevel: number;
  119053. /**
  119054. * Log performance to the console
  119055. */
  119056. static readonly PerformanceConsoleLogLevel: number;
  119057. private static _performance;
  119058. /**
  119059. * Sets the current performance log level
  119060. */
  119061. static set PerformanceLogLevel(level: number);
  119062. private static _StartPerformanceCounterDisabled;
  119063. private static _EndPerformanceCounterDisabled;
  119064. private static _StartUserMark;
  119065. private static _EndUserMark;
  119066. private static _StartPerformanceConsole;
  119067. private static _EndPerformanceConsole;
  119068. /**
  119069. * Starts a performance counter
  119070. */
  119071. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  119072. /**
  119073. * Ends a specific performance coutner
  119074. */
  119075. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  119076. /**
  119077. * Gets either window.performance.now() if supported or Date.now() else
  119078. */
  119079. static get Now(): number;
  119080. /**
  119081. * This method will return the name of the class used to create the instance of the given object.
  119082. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  119083. * @param object the object to get the class name from
  119084. * @param isType defines if the object is actually a type
  119085. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  119086. */
  119087. static GetClassName(object: any, isType?: boolean): string;
  119088. /**
  119089. * Gets the first element of an array satisfying a given predicate
  119090. * @param array defines the array to browse
  119091. * @param predicate defines the predicate to use
  119092. * @returns null if not found or the element
  119093. */
  119094. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  119095. /**
  119096. * This method will return the name of the full name of the class, including its owning module (if any).
  119097. * 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).
  119098. * @param object the object to get the class name from
  119099. * @param isType defines if the object is actually a type
  119100. * @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.
  119101. * @ignorenaming
  119102. */
  119103. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  119104. /**
  119105. * Returns a promise that resolves after the given amount of time.
  119106. * @param delay Number of milliseconds to delay
  119107. * @returns Promise that resolves after the given amount of time
  119108. */
  119109. static DelayAsync(delay: number): Promise<void>;
  119110. /**
  119111. * Utility function to detect if the current user agent is Safari
  119112. * @returns whether or not the current user agent is safari
  119113. */
  119114. static IsSafari(): boolean;
  119115. }
  119116. /**
  119117. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  119118. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  119119. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  119120. * @param name The name of the class, case should be preserved
  119121. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  119122. */
  119123. export function className(name: string, module?: string): (target: Object) => void;
  119124. /**
  119125. * An implementation of a loop for asynchronous functions.
  119126. */
  119127. export class AsyncLoop {
  119128. /**
  119129. * Defines the number of iterations for the loop
  119130. */
  119131. iterations: number;
  119132. /**
  119133. * Defines the current index of the loop.
  119134. */
  119135. index: number;
  119136. private _done;
  119137. private _fn;
  119138. private _successCallback;
  119139. /**
  119140. * Constructor.
  119141. * @param iterations the number of iterations.
  119142. * @param func the function to run each iteration
  119143. * @param successCallback the callback that will be called upon succesful execution
  119144. * @param offset starting offset.
  119145. */
  119146. constructor(
  119147. /**
  119148. * Defines the number of iterations for the loop
  119149. */
  119150. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  119151. /**
  119152. * Execute the next iteration. Must be called after the last iteration was finished.
  119153. */
  119154. executeNext(): void;
  119155. /**
  119156. * Break the loop and run the success callback.
  119157. */
  119158. breakLoop(): void;
  119159. /**
  119160. * Create and run an async loop.
  119161. * @param iterations the number of iterations.
  119162. * @param fn the function to run each iteration
  119163. * @param successCallback the callback that will be called upon succesful execution
  119164. * @param offset starting offset.
  119165. * @returns the created async loop object
  119166. */
  119167. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  119168. /**
  119169. * A for-loop that will run a given number of iterations synchronous and the rest async.
  119170. * @param iterations total number of iterations
  119171. * @param syncedIterations number of synchronous iterations in each async iteration.
  119172. * @param fn the function to call each iteration.
  119173. * @param callback a success call back that will be called when iterating stops.
  119174. * @param breakFunction a break condition (optional)
  119175. * @param timeout timeout settings for the setTimeout function. default - 0.
  119176. * @returns the created async loop object
  119177. */
  119178. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  119179. }
  119180. }
  119181. declare module BABYLON {
  119182. /**
  119183. * This class implement a typical dictionary using a string as key and the generic type T as value.
  119184. * The underlying implementation relies on an associative array to ensure the best performances.
  119185. * The value can be anything including 'null' but except 'undefined'
  119186. */
  119187. export class StringDictionary<T> {
  119188. /**
  119189. * This will clear this dictionary and copy the content from the 'source' one.
  119190. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  119191. * @param source the dictionary to take the content from and copy to this dictionary
  119192. */
  119193. copyFrom(source: StringDictionary<T>): void;
  119194. /**
  119195. * Get a value based from its key
  119196. * @param key the given key to get the matching value from
  119197. * @return the value if found, otherwise undefined is returned
  119198. */
  119199. get(key: string): T | undefined;
  119200. /**
  119201. * Get a value from its key or add it if it doesn't exist.
  119202. * This method will ensure you that a given key/data will be present in the dictionary.
  119203. * @param key the given key to get the matching value from
  119204. * @param factory the factory that will create the value if the key is not present in the dictionary.
  119205. * The factory will only be invoked if there's no data for the given key.
  119206. * @return the value corresponding to the key.
  119207. */
  119208. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  119209. /**
  119210. * Get a value from its key if present in the dictionary otherwise add it
  119211. * @param key the key to get the value from
  119212. * @param val if there's no such key/value pair in the dictionary add it with this value
  119213. * @return the value corresponding to the key
  119214. */
  119215. getOrAdd(key: string, val: T): T;
  119216. /**
  119217. * Check if there's a given key in the dictionary
  119218. * @param key the key to check for
  119219. * @return true if the key is present, false otherwise
  119220. */
  119221. contains(key: string): boolean;
  119222. /**
  119223. * Add a new key and its corresponding value
  119224. * @param key the key to add
  119225. * @param value the value corresponding to the key
  119226. * @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
  119227. */
  119228. add(key: string, value: T): boolean;
  119229. /**
  119230. * Update a specific value associated to a key
  119231. * @param key defines the key to use
  119232. * @param value defines the value to store
  119233. * @returns true if the value was updated (or false if the key was not found)
  119234. */
  119235. set(key: string, value: T): boolean;
  119236. /**
  119237. * Get the element of the given key and remove it from the dictionary
  119238. * @param key defines the key to search
  119239. * @returns the value associated with the key or null if not found
  119240. */
  119241. getAndRemove(key: string): Nullable<T>;
  119242. /**
  119243. * Remove a key/value from the dictionary.
  119244. * @param key the key to remove
  119245. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  119246. */
  119247. remove(key: string): boolean;
  119248. /**
  119249. * Clear the whole content of the dictionary
  119250. */
  119251. clear(): void;
  119252. /**
  119253. * Gets the current count
  119254. */
  119255. get count(): number;
  119256. /**
  119257. * Execute a callback on each key/val of the dictionary.
  119258. * Note that you can remove any element in this dictionary in the callback implementation
  119259. * @param callback the callback to execute on a given key/value pair
  119260. */
  119261. forEach(callback: (key: string, val: T) => void): void;
  119262. /**
  119263. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  119264. * If the callback returns null or undefined the method will iterate to the next key/value pair
  119265. * Note that you can remove any element in this dictionary in the callback implementation
  119266. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  119267. * @returns the first item
  119268. */
  119269. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  119270. private _count;
  119271. private _data;
  119272. }
  119273. }
  119274. declare module BABYLON {
  119275. /** @hidden */
  119276. export interface ICollisionCoordinator {
  119277. createCollider(): Collider;
  119278. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  119279. init(scene: Scene): void;
  119280. }
  119281. /** @hidden */
  119282. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  119283. private _scene;
  119284. private _scaledPosition;
  119285. private _scaledVelocity;
  119286. private _finalPosition;
  119287. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  119288. createCollider(): Collider;
  119289. init(scene: Scene): void;
  119290. private _collideWithWorld;
  119291. }
  119292. }
  119293. declare module BABYLON {
  119294. /**
  119295. * Class used to manage all inputs for the scene.
  119296. */
  119297. export class InputManager {
  119298. /** The distance in pixel that you have to move to prevent some events */
  119299. static DragMovementThreshold: number;
  119300. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  119301. static LongPressDelay: number;
  119302. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  119303. static DoubleClickDelay: number;
  119304. /** If you need to check double click without raising a single click at first click, enable this flag */
  119305. static ExclusiveDoubleClickMode: boolean;
  119306. /** 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. */
  119307. private _alreadyAttached;
  119308. private _wheelEventName;
  119309. private _onPointerMove;
  119310. private _onPointerDown;
  119311. private _onPointerUp;
  119312. private _initClickEvent;
  119313. private _initActionManager;
  119314. private _delayedSimpleClick;
  119315. private _delayedSimpleClickTimeout;
  119316. private _previousDelayedSimpleClickTimeout;
  119317. private _meshPickProceed;
  119318. private _previousButtonPressed;
  119319. private _currentPickResult;
  119320. private _previousPickResult;
  119321. private _totalPointersPressed;
  119322. private _doubleClickOccured;
  119323. private _pointerOverMesh;
  119324. private _pickedDownMesh;
  119325. private _pickedUpMesh;
  119326. private _pointerX;
  119327. private _pointerY;
  119328. private _unTranslatedPointerX;
  119329. private _unTranslatedPointerY;
  119330. private _startingPointerPosition;
  119331. private _previousStartingPointerPosition;
  119332. private _startingPointerTime;
  119333. private _previousStartingPointerTime;
  119334. private _pointerCaptures;
  119335. private _meshUnderPointerId;
  119336. private _onKeyDown;
  119337. private _onKeyUp;
  119338. private _onCanvasFocusObserver;
  119339. private _onCanvasBlurObserver;
  119340. private _scene;
  119341. /**
  119342. * Creates a new InputManager
  119343. * @param scene defines the hosting scene
  119344. */
  119345. constructor(scene: Scene);
  119346. /**
  119347. * Gets the mesh that is currently under the pointer
  119348. */
  119349. get meshUnderPointer(): Nullable<AbstractMesh>;
  119350. /**
  119351. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  119352. * @param pointerId the pointer id to use
  119353. * @returns The mesh under this pointer id or null if not found
  119354. */
  119355. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  119356. /**
  119357. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  119358. */
  119359. get unTranslatedPointer(): Vector2;
  119360. /**
  119361. * Gets or sets the current on-screen X position of the pointer
  119362. */
  119363. get pointerX(): number;
  119364. set pointerX(value: number);
  119365. /**
  119366. * Gets or sets the current on-screen Y position of the pointer
  119367. */
  119368. get pointerY(): number;
  119369. set pointerY(value: number);
  119370. private _updatePointerPosition;
  119371. private _processPointerMove;
  119372. private _setRayOnPointerInfo;
  119373. private _checkPrePointerObservable;
  119374. /**
  119375. * Use this method to simulate a pointer move on a mesh
  119376. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119377. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119378. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119379. */
  119380. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  119381. /**
  119382. * Use this method to simulate a pointer down on a mesh
  119383. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119384. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119385. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119386. */
  119387. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  119388. private _processPointerDown;
  119389. /** @hidden */
  119390. _isPointerSwiping(): boolean;
  119391. /**
  119392. * Use this method to simulate a pointer up on a mesh
  119393. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119394. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119395. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119396. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119397. */
  119398. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  119399. private _processPointerUp;
  119400. /**
  119401. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119402. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119403. * @returns true if the pointer was captured
  119404. */
  119405. isPointerCaptured(pointerId?: number): boolean;
  119406. /**
  119407. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119408. * @param attachUp defines if you want to attach events to pointerup
  119409. * @param attachDown defines if you want to attach events to pointerdown
  119410. * @param attachMove defines if you want to attach events to pointermove
  119411. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  119412. */
  119413. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  119414. /**
  119415. * Detaches all event handlers
  119416. */
  119417. detachControl(): void;
  119418. /**
  119419. * Force the value of meshUnderPointer
  119420. * @param mesh defines the mesh to use
  119421. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  119422. */
  119423. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  119424. /**
  119425. * Gets the mesh under the pointer
  119426. * @returns a Mesh or null if no mesh is under the pointer
  119427. */
  119428. getPointerOverMesh(): Nullable<AbstractMesh>;
  119429. }
  119430. }
  119431. declare module BABYLON {
  119432. /**
  119433. * This class defines the direct association between an animation and a target
  119434. */
  119435. export class TargetedAnimation {
  119436. /**
  119437. * Animation to perform
  119438. */
  119439. animation: Animation;
  119440. /**
  119441. * Target to animate
  119442. */
  119443. target: any;
  119444. /**
  119445. * Returns the string "TargetedAnimation"
  119446. * @returns "TargetedAnimation"
  119447. */
  119448. getClassName(): string;
  119449. /**
  119450. * Serialize the object
  119451. * @returns the JSON object representing the current entity
  119452. */
  119453. serialize(): any;
  119454. }
  119455. /**
  119456. * Use this class to create coordinated animations on multiple targets
  119457. */
  119458. export class AnimationGroup implements IDisposable {
  119459. /** The name of the animation group */
  119460. name: string;
  119461. private _scene;
  119462. private _targetedAnimations;
  119463. private _animatables;
  119464. private _from;
  119465. private _to;
  119466. private _isStarted;
  119467. private _isPaused;
  119468. private _speedRatio;
  119469. private _loopAnimation;
  119470. private _isAdditive;
  119471. /**
  119472. * Gets or sets the unique id of the node
  119473. */
  119474. uniqueId: number;
  119475. /**
  119476. * This observable will notify when one animation have ended
  119477. */
  119478. onAnimationEndObservable: Observable<TargetedAnimation>;
  119479. /**
  119480. * Observer raised when one animation loops
  119481. */
  119482. onAnimationLoopObservable: Observable<TargetedAnimation>;
  119483. /**
  119484. * Observer raised when all animations have looped
  119485. */
  119486. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  119487. /**
  119488. * This observable will notify when all animations have ended.
  119489. */
  119490. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  119491. /**
  119492. * This observable will notify when all animations have paused.
  119493. */
  119494. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  119495. /**
  119496. * This observable will notify when all animations are playing.
  119497. */
  119498. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  119499. /**
  119500. * Gets the first frame
  119501. */
  119502. get from(): number;
  119503. /**
  119504. * Gets the last frame
  119505. */
  119506. get to(): number;
  119507. /**
  119508. * Define if the animations are started
  119509. */
  119510. get isStarted(): boolean;
  119511. /**
  119512. * Gets a value indicating that the current group is playing
  119513. */
  119514. get isPlaying(): boolean;
  119515. /**
  119516. * Gets or sets the speed ratio to use for all animations
  119517. */
  119518. get speedRatio(): number;
  119519. /**
  119520. * Gets or sets the speed ratio to use for all animations
  119521. */
  119522. set speedRatio(value: number);
  119523. /**
  119524. * Gets or sets if all animations should loop or not
  119525. */
  119526. get loopAnimation(): boolean;
  119527. set loopAnimation(value: boolean);
  119528. /**
  119529. * Gets or sets if all animations should be evaluated additively
  119530. */
  119531. get isAdditive(): boolean;
  119532. set isAdditive(value: boolean);
  119533. /**
  119534. * Gets the targeted animations for this animation group
  119535. */
  119536. get targetedAnimations(): Array<TargetedAnimation>;
  119537. /**
  119538. * returning the list of animatables controlled by this animation group.
  119539. */
  119540. get animatables(): Array<Animatable>;
  119541. /**
  119542. * Gets the list of target animations
  119543. */
  119544. get children(): TargetedAnimation[];
  119545. /**
  119546. * Instantiates a new Animation Group.
  119547. * This helps managing several animations at once.
  119548. * @see https://doc.babylonjs.com/how_to/group
  119549. * @param name Defines the name of the group
  119550. * @param scene Defines the scene the group belongs to
  119551. */
  119552. constructor(
  119553. /** The name of the animation group */
  119554. name: string, scene?: Nullable<Scene>);
  119555. /**
  119556. * Add an animation (with its target) in the group
  119557. * @param animation defines the animation we want to add
  119558. * @param target defines the target of the animation
  119559. * @returns the TargetedAnimation object
  119560. */
  119561. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  119562. /**
  119563. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  119564. * It can add constant keys at begin or end
  119565. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  119566. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  119567. * @returns the animation group
  119568. */
  119569. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  119570. private _animationLoopCount;
  119571. private _animationLoopFlags;
  119572. private _processLoop;
  119573. /**
  119574. * Start all animations on given targets
  119575. * @param loop defines if animations must loop
  119576. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  119577. * @param from defines the from key (optional)
  119578. * @param to defines the to key (optional)
  119579. * @param isAdditive defines the additive state for the resulting animatables (optional)
  119580. * @returns the current animation group
  119581. */
  119582. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  119583. /**
  119584. * Pause all animations
  119585. * @returns the animation group
  119586. */
  119587. pause(): AnimationGroup;
  119588. /**
  119589. * Play all animations to initial state
  119590. * This function will start() the animations if they were not started or will restart() them if they were paused
  119591. * @param loop defines if animations must loop
  119592. * @returns the animation group
  119593. */
  119594. play(loop?: boolean): AnimationGroup;
  119595. /**
  119596. * Reset all animations to initial state
  119597. * @returns the animation group
  119598. */
  119599. reset(): AnimationGroup;
  119600. /**
  119601. * Restart animations from key 0
  119602. * @returns the animation group
  119603. */
  119604. restart(): AnimationGroup;
  119605. /**
  119606. * Stop all animations
  119607. * @returns the animation group
  119608. */
  119609. stop(): AnimationGroup;
  119610. /**
  119611. * Set animation weight for all animatables
  119612. * @param weight defines the weight to use
  119613. * @return the animationGroup
  119614. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  119615. */
  119616. setWeightForAllAnimatables(weight: number): AnimationGroup;
  119617. /**
  119618. * Synchronize and normalize all animatables with a source animatable
  119619. * @param root defines the root animatable to synchronize with
  119620. * @return the animationGroup
  119621. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  119622. */
  119623. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  119624. /**
  119625. * Goes to a specific frame in this animation group
  119626. * @param frame the frame number to go to
  119627. * @return the animationGroup
  119628. */
  119629. goToFrame(frame: number): AnimationGroup;
  119630. /**
  119631. * Dispose all associated resources
  119632. */
  119633. dispose(): void;
  119634. private _checkAnimationGroupEnded;
  119635. /**
  119636. * Clone the current animation group and returns a copy
  119637. * @param newName defines the name of the new group
  119638. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  119639. * @returns the new aniamtion group
  119640. */
  119641. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  119642. /**
  119643. * Serializes the animationGroup to an object
  119644. * @returns Serialized object
  119645. */
  119646. serialize(): any;
  119647. /**
  119648. * Returns a new AnimationGroup object parsed from the source provided.
  119649. * @param parsedAnimationGroup defines the source
  119650. * @param scene defines the scene that will receive the animationGroup
  119651. * @returns a new AnimationGroup
  119652. */
  119653. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  119654. /**
  119655. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  119656. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  119657. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  119658. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  119659. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  119660. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  119661. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  119662. */
  119663. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  119664. /**
  119665. * Returns the string "AnimationGroup"
  119666. * @returns "AnimationGroup"
  119667. */
  119668. getClassName(): string;
  119669. /**
  119670. * Creates a detailled string about the object
  119671. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  119672. * @returns a string representing the object
  119673. */
  119674. toString(fullDetails?: boolean): string;
  119675. }
  119676. }
  119677. declare module BABYLON {
  119678. /**
  119679. * Define an interface for all classes that will hold resources
  119680. */
  119681. export interface IDisposable {
  119682. /**
  119683. * Releases all held resources
  119684. */
  119685. dispose(): void;
  119686. }
  119687. /** Interface defining initialization parameters for Scene class */
  119688. export interface SceneOptions {
  119689. /**
  119690. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  119691. * It will improve performance when the number of geometries becomes important.
  119692. */
  119693. useGeometryUniqueIdsMap?: boolean;
  119694. /**
  119695. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  119696. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119697. */
  119698. useMaterialMeshMap?: boolean;
  119699. /**
  119700. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  119701. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119702. */
  119703. useClonedMeshMap?: boolean;
  119704. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  119705. virtual?: boolean;
  119706. }
  119707. /**
  119708. * Represents a scene to be rendered by the engine.
  119709. * @see https://doc.babylonjs.com/features/scene
  119710. */
  119711. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  119712. /** The fog is deactivated */
  119713. static readonly FOGMODE_NONE: number;
  119714. /** The fog density is following an exponential function */
  119715. static readonly FOGMODE_EXP: number;
  119716. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  119717. static readonly FOGMODE_EXP2: number;
  119718. /** The fog density is following a linear function. */
  119719. static readonly FOGMODE_LINEAR: number;
  119720. /**
  119721. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  119722. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119723. */
  119724. static MinDeltaTime: number;
  119725. /**
  119726. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  119727. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119728. */
  119729. static MaxDeltaTime: number;
  119730. /**
  119731. * Factory used to create the default material.
  119732. * @param name The name of the material to create
  119733. * @param scene The scene to create the material for
  119734. * @returns The default material
  119735. */
  119736. static DefaultMaterialFactory(scene: Scene): Material;
  119737. /**
  119738. * Factory used to create the a collision coordinator.
  119739. * @returns The collision coordinator
  119740. */
  119741. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  119742. /** @hidden */
  119743. _inputManager: InputManager;
  119744. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  119745. cameraToUseForPointers: Nullable<Camera>;
  119746. /** @hidden */
  119747. readonly _isScene: boolean;
  119748. /** @hidden */
  119749. _blockEntityCollection: boolean;
  119750. /**
  119751. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119752. */
  119753. autoClear: boolean;
  119754. /**
  119755. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119756. */
  119757. autoClearDepthAndStencil: boolean;
  119758. /**
  119759. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119760. */
  119761. clearColor: Color4;
  119762. /**
  119763. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119764. */
  119765. ambientColor: Color3;
  119766. /**
  119767. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119768. * It should only be one of the following (if not the default embedded one):
  119769. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119770. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119771. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119772. * The material properties need to be setup according to the type of texture in use.
  119773. */
  119774. environmentBRDFTexture: BaseTexture;
  119775. /**
  119776. * Texture used in all pbr material as the reflection texture.
  119777. * As in the majority of the scene they are the same (exception for multi room and so on),
  119778. * this is easier to reference from here than from all the materials.
  119779. */
  119780. get environmentTexture(): Nullable<BaseTexture>;
  119781. /**
  119782. * Texture used in all pbr material as the reflection texture.
  119783. * As in the majority of the scene they are the same (exception for multi room and so on),
  119784. * this is easier to set here than in all the materials.
  119785. */
  119786. set environmentTexture(value: Nullable<BaseTexture>);
  119787. /** @hidden */
  119788. protected _environmentIntensity: number;
  119789. /**
  119790. * Intensity of the environment in all pbr material.
  119791. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119792. * As in the majority of the scene they are the same (exception for multi room and so on),
  119793. * this is easier to reference from here than from all the materials.
  119794. */
  119795. get environmentIntensity(): number;
  119796. /**
  119797. * Intensity of the environment in all pbr material.
  119798. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119799. * As in the majority of the scene they are the same (exception for multi room and so on),
  119800. * this is easier to set here than in all the materials.
  119801. */
  119802. set environmentIntensity(value: number);
  119803. /** @hidden */
  119804. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119805. /**
  119806. * Default image processing configuration used either in the rendering
  119807. * Forward main pass or through the imageProcessingPostProcess if present.
  119808. * As in the majority of the scene they are the same (exception for multi camera),
  119809. * this is easier to reference from here than from all the materials and post process.
  119810. *
  119811. * No setter as we it is a shared configuration, you can set the values instead.
  119812. */
  119813. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119814. private _forceWireframe;
  119815. /**
  119816. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119817. */
  119818. set forceWireframe(value: boolean);
  119819. get forceWireframe(): boolean;
  119820. private _skipFrustumClipping;
  119821. /**
  119822. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119823. */
  119824. set skipFrustumClipping(value: boolean);
  119825. get skipFrustumClipping(): boolean;
  119826. private _forcePointsCloud;
  119827. /**
  119828. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119829. */
  119830. set forcePointsCloud(value: boolean);
  119831. get forcePointsCloud(): boolean;
  119832. /**
  119833. * Gets or sets the active clipplane 1
  119834. */
  119835. clipPlane: Nullable<Plane>;
  119836. /**
  119837. * Gets or sets the active clipplane 2
  119838. */
  119839. clipPlane2: Nullable<Plane>;
  119840. /**
  119841. * Gets or sets the active clipplane 3
  119842. */
  119843. clipPlane3: Nullable<Plane>;
  119844. /**
  119845. * Gets or sets the active clipplane 4
  119846. */
  119847. clipPlane4: Nullable<Plane>;
  119848. /**
  119849. * Gets or sets the active clipplane 5
  119850. */
  119851. clipPlane5: Nullable<Plane>;
  119852. /**
  119853. * Gets or sets the active clipplane 6
  119854. */
  119855. clipPlane6: Nullable<Plane>;
  119856. /**
  119857. * Gets or sets a boolean indicating if animations are enabled
  119858. */
  119859. animationsEnabled: boolean;
  119860. private _animationPropertiesOverride;
  119861. /**
  119862. * Gets or sets the animation properties override
  119863. */
  119864. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119865. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119866. /**
  119867. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119868. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119869. */
  119870. useConstantAnimationDeltaTime: boolean;
  119871. /**
  119872. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119873. * Please note that it requires to run a ray cast through the scene on every frame
  119874. */
  119875. constantlyUpdateMeshUnderPointer: boolean;
  119876. /**
  119877. * Defines the HTML cursor to use when hovering over interactive elements
  119878. */
  119879. hoverCursor: string;
  119880. /**
  119881. * Defines the HTML default cursor to use (empty by default)
  119882. */
  119883. defaultCursor: string;
  119884. /**
  119885. * Defines whether cursors are handled by the scene.
  119886. */
  119887. doNotHandleCursors: boolean;
  119888. /**
  119889. * This is used to call preventDefault() on pointer down
  119890. * in order to block unwanted artifacts like system double clicks
  119891. */
  119892. preventDefaultOnPointerDown: boolean;
  119893. /**
  119894. * This is used to call preventDefault() on pointer up
  119895. * in order to block unwanted artifacts like system double clicks
  119896. */
  119897. preventDefaultOnPointerUp: boolean;
  119898. /**
  119899. * Gets or sets user defined metadata
  119900. */
  119901. metadata: any;
  119902. /**
  119903. * For internal use only. Please do not use.
  119904. */
  119905. reservedDataStore: any;
  119906. /**
  119907. * Gets the name of the plugin used to load this scene (null by default)
  119908. */
  119909. loadingPluginName: string;
  119910. /**
  119911. * Use this array to add regular expressions used to disable offline support for specific urls
  119912. */
  119913. disableOfflineSupportExceptionRules: RegExp[];
  119914. /**
  119915. * An event triggered when the scene is disposed.
  119916. */
  119917. onDisposeObservable: Observable<Scene>;
  119918. private _onDisposeObserver;
  119919. /** Sets a function to be executed when this scene is disposed. */
  119920. set onDispose(callback: () => void);
  119921. /**
  119922. * An event triggered before rendering the scene (right after animations and physics)
  119923. */
  119924. onBeforeRenderObservable: Observable<Scene>;
  119925. private _onBeforeRenderObserver;
  119926. /** Sets a function to be executed before rendering this scene */
  119927. set beforeRender(callback: Nullable<() => void>);
  119928. /**
  119929. * An event triggered after rendering the scene
  119930. */
  119931. onAfterRenderObservable: Observable<Scene>;
  119932. /**
  119933. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119934. */
  119935. onAfterRenderCameraObservable: Observable<Camera>;
  119936. private _onAfterRenderObserver;
  119937. /** Sets a function to be executed after rendering this scene */
  119938. set afterRender(callback: Nullable<() => void>);
  119939. /**
  119940. * An event triggered before animating the scene
  119941. */
  119942. onBeforeAnimationsObservable: Observable<Scene>;
  119943. /**
  119944. * An event triggered after animations processing
  119945. */
  119946. onAfterAnimationsObservable: Observable<Scene>;
  119947. /**
  119948. * An event triggered before draw calls are ready to be sent
  119949. */
  119950. onBeforeDrawPhaseObservable: Observable<Scene>;
  119951. /**
  119952. * An event triggered after draw calls have been sent
  119953. */
  119954. onAfterDrawPhaseObservable: Observable<Scene>;
  119955. /**
  119956. * An event triggered when the scene is ready
  119957. */
  119958. onReadyObservable: Observable<Scene>;
  119959. /**
  119960. * An event triggered before rendering a camera
  119961. */
  119962. onBeforeCameraRenderObservable: Observable<Camera>;
  119963. private _onBeforeCameraRenderObserver;
  119964. /** Sets a function to be executed before rendering a camera*/
  119965. set beforeCameraRender(callback: () => void);
  119966. /**
  119967. * An event triggered after rendering a camera
  119968. */
  119969. onAfterCameraRenderObservable: Observable<Camera>;
  119970. private _onAfterCameraRenderObserver;
  119971. /** Sets a function to be executed after rendering a camera*/
  119972. set afterCameraRender(callback: () => void);
  119973. /**
  119974. * An event triggered when active meshes evaluation is about to start
  119975. */
  119976. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119977. /**
  119978. * An event triggered when active meshes evaluation is done
  119979. */
  119980. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119981. /**
  119982. * An event triggered when particles rendering is about to start
  119983. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119984. */
  119985. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119986. /**
  119987. * An event triggered when particles rendering is done
  119988. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119989. */
  119990. onAfterParticlesRenderingObservable: Observable<Scene>;
  119991. /**
  119992. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119993. */
  119994. onDataLoadedObservable: Observable<Scene>;
  119995. /**
  119996. * An event triggered when a camera is created
  119997. */
  119998. onNewCameraAddedObservable: Observable<Camera>;
  119999. /**
  120000. * An event triggered when a camera is removed
  120001. */
  120002. onCameraRemovedObservable: Observable<Camera>;
  120003. /**
  120004. * An event triggered when a light is created
  120005. */
  120006. onNewLightAddedObservable: Observable<Light>;
  120007. /**
  120008. * An event triggered when a light is removed
  120009. */
  120010. onLightRemovedObservable: Observable<Light>;
  120011. /**
  120012. * An event triggered when a geometry is created
  120013. */
  120014. onNewGeometryAddedObservable: Observable<Geometry>;
  120015. /**
  120016. * An event triggered when a geometry is removed
  120017. */
  120018. onGeometryRemovedObservable: Observable<Geometry>;
  120019. /**
  120020. * An event triggered when a transform node is created
  120021. */
  120022. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  120023. /**
  120024. * An event triggered when a transform node is removed
  120025. */
  120026. onTransformNodeRemovedObservable: Observable<TransformNode>;
  120027. /**
  120028. * An event triggered when a mesh is created
  120029. */
  120030. onNewMeshAddedObservable: Observable<AbstractMesh>;
  120031. /**
  120032. * An event triggered when a mesh is removed
  120033. */
  120034. onMeshRemovedObservable: Observable<AbstractMesh>;
  120035. /**
  120036. * An event triggered when a skeleton is created
  120037. */
  120038. onNewSkeletonAddedObservable: Observable<Skeleton>;
  120039. /**
  120040. * An event triggered when a skeleton is removed
  120041. */
  120042. onSkeletonRemovedObservable: Observable<Skeleton>;
  120043. /**
  120044. * An event triggered when a material is created
  120045. */
  120046. onNewMaterialAddedObservable: Observable<Material>;
  120047. /**
  120048. * An event triggered when a material is removed
  120049. */
  120050. onMaterialRemovedObservable: Observable<Material>;
  120051. /**
  120052. * An event triggered when a texture is created
  120053. */
  120054. onNewTextureAddedObservable: Observable<BaseTexture>;
  120055. /**
  120056. * An event triggered when a texture is removed
  120057. */
  120058. onTextureRemovedObservable: Observable<BaseTexture>;
  120059. /**
  120060. * An event triggered when render targets are about to be rendered
  120061. * Can happen multiple times per frame.
  120062. */
  120063. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  120064. /**
  120065. * An event triggered when render targets were rendered.
  120066. * Can happen multiple times per frame.
  120067. */
  120068. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  120069. /**
  120070. * An event triggered before calculating deterministic simulation step
  120071. */
  120072. onBeforeStepObservable: Observable<Scene>;
  120073. /**
  120074. * An event triggered after calculating deterministic simulation step
  120075. */
  120076. onAfterStepObservable: Observable<Scene>;
  120077. /**
  120078. * An event triggered when the activeCamera property is updated
  120079. */
  120080. onActiveCameraChanged: Observable<Scene>;
  120081. /**
  120082. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  120083. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  120084. * 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)
  120085. */
  120086. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  120087. /**
  120088. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  120089. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  120090. * 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)
  120091. */
  120092. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  120093. /**
  120094. * This Observable will when a mesh has been imported into the scene.
  120095. */
  120096. onMeshImportedObservable: Observable<AbstractMesh>;
  120097. /**
  120098. * This Observable will when an animation file has been imported into the scene.
  120099. */
  120100. onAnimationFileImportedObservable: Observable<Scene>;
  120101. /**
  120102. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  120103. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  120104. */
  120105. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  120106. /** @hidden */
  120107. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  120108. /**
  120109. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  120110. */
  120111. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  120112. /**
  120113. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  120114. */
  120115. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  120116. /**
  120117. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  120118. */
  120119. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  120120. /** Callback called when a pointer move is detected */
  120121. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  120122. /** Callback called when a pointer down is detected */
  120123. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  120124. /** Callback called when a pointer up is detected */
  120125. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  120126. /** Callback called when a pointer pick is detected */
  120127. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  120128. /**
  120129. * 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).
  120130. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  120131. */
  120132. onPrePointerObservable: Observable<PointerInfoPre>;
  120133. /**
  120134. * Observable event triggered each time an input event is received from the rendering canvas
  120135. */
  120136. onPointerObservable: Observable<PointerInfo>;
  120137. /**
  120138. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  120139. */
  120140. get unTranslatedPointer(): Vector2;
  120141. /**
  120142. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  120143. */
  120144. static get DragMovementThreshold(): number;
  120145. static set DragMovementThreshold(value: number);
  120146. /**
  120147. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  120148. */
  120149. static get LongPressDelay(): number;
  120150. static set LongPressDelay(value: number);
  120151. /**
  120152. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  120153. */
  120154. static get DoubleClickDelay(): number;
  120155. static set DoubleClickDelay(value: number);
  120156. /** If you need to check double click without raising a single click at first click, enable this flag */
  120157. static get ExclusiveDoubleClickMode(): boolean;
  120158. static set ExclusiveDoubleClickMode(value: boolean);
  120159. /** @hidden */
  120160. _mirroredCameraPosition: Nullable<Vector3>;
  120161. /**
  120162. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  120163. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  120164. */
  120165. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  120166. /**
  120167. * Observable event triggered each time an keyboard event is received from the hosting window
  120168. */
  120169. onKeyboardObservable: Observable<KeyboardInfo>;
  120170. private _useRightHandedSystem;
  120171. /**
  120172. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  120173. */
  120174. set useRightHandedSystem(value: boolean);
  120175. get useRightHandedSystem(): boolean;
  120176. private _timeAccumulator;
  120177. private _currentStepId;
  120178. private _currentInternalStep;
  120179. /**
  120180. * Sets the step Id used by deterministic lock step
  120181. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  120182. * @param newStepId defines the step Id
  120183. */
  120184. setStepId(newStepId: number): void;
  120185. /**
  120186. * Gets the step Id used by deterministic lock step
  120187. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  120188. * @returns the step Id
  120189. */
  120190. getStepId(): number;
  120191. /**
  120192. * Gets the internal step used by deterministic lock step
  120193. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  120194. * @returns the internal step
  120195. */
  120196. getInternalStep(): number;
  120197. private _fogEnabled;
  120198. /**
  120199. * Gets or sets a boolean indicating if fog is enabled on this scene
  120200. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120201. * (Default is true)
  120202. */
  120203. set fogEnabled(value: boolean);
  120204. get fogEnabled(): boolean;
  120205. private _fogMode;
  120206. /**
  120207. * Gets or sets the fog mode to use
  120208. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120209. * | mode | value |
  120210. * | --- | --- |
  120211. * | FOGMODE_NONE | 0 |
  120212. * | FOGMODE_EXP | 1 |
  120213. * | FOGMODE_EXP2 | 2 |
  120214. * | FOGMODE_LINEAR | 3 |
  120215. */
  120216. set fogMode(value: number);
  120217. get fogMode(): number;
  120218. /**
  120219. * Gets or sets the fog color to use
  120220. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120221. * (Default is Color3(0.2, 0.2, 0.3))
  120222. */
  120223. fogColor: Color3;
  120224. /**
  120225. * Gets or sets the fog density to use
  120226. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120227. * (Default is 0.1)
  120228. */
  120229. fogDensity: number;
  120230. /**
  120231. * Gets or sets the fog start distance to use
  120232. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120233. * (Default is 0)
  120234. */
  120235. fogStart: number;
  120236. /**
  120237. * Gets or sets the fog end distance to use
  120238. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120239. * (Default is 1000)
  120240. */
  120241. fogEnd: number;
  120242. /**
  120243. * Flag indicating that the frame buffer binding is handled by another component
  120244. */
  120245. prePass: boolean;
  120246. private _shadowsEnabled;
  120247. /**
  120248. * Gets or sets a boolean indicating if shadows are enabled on this scene
  120249. */
  120250. set shadowsEnabled(value: boolean);
  120251. get shadowsEnabled(): boolean;
  120252. private _lightsEnabled;
  120253. /**
  120254. * Gets or sets a boolean indicating if lights are enabled on this scene
  120255. */
  120256. set lightsEnabled(value: boolean);
  120257. get lightsEnabled(): boolean;
  120258. /** All of the active cameras added to this scene. */
  120259. activeCameras: Camera[];
  120260. /** @hidden */
  120261. _activeCamera: Nullable<Camera>;
  120262. /** Gets or sets the current active camera */
  120263. get activeCamera(): Nullable<Camera>;
  120264. set activeCamera(value: Nullable<Camera>);
  120265. private _defaultMaterial;
  120266. /** The default material used on meshes when no material is affected */
  120267. get defaultMaterial(): Material;
  120268. /** The default material used on meshes when no material is affected */
  120269. set defaultMaterial(value: Material);
  120270. private _texturesEnabled;
  120271. /**
  120272. * Gets or sets a boolean indicating if textures are enabled on this scene
  120273. */
  120274. set texturesEnabled(value: boolean);
  120275. get texturesEnabled(): boolean;
  120276. /**
  120277. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  120278. */
  120279. physicsEnabled: boolean;
  120280. /**
  120281. * Gets or sets a boolean indicating if particles are enabled on this scene
  120282. */
  120283. particlesEnabled: boolean;
  120284. /**
  120285. * Gets or sets a boolean indicating if sprites are enabled on this scene
  120286. */
  120287. spritesEnabled: boolean;
  120288. private _skeletonsEnabled;
  120289. /**
  120290. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  120291. */
  120292. set skeletonsEnabled(value: boolean);
  120293. get skeletonsEnabled(): boolean;
  120294. /**
  120295. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  120296. */
  120297. lensFlaresEnabled: boolean;
  120298. /**
  120299. * Gets or sets a boolean indicating if collisions are enabled on this scene
  120300. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  120301. */
  120302. collisionsEnabled: boolean;
  120303. private _collisionCoordinator;
  120304. /** @hidden */
  120305. get collisionCoordinator(): ICollisionCoordinator;
  120306. /**
  120307. * Defines the gravity applied to this scene (used only for collisions)
  120308. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  120309. */
  120310. gravity: Vector3;
  120311. /**
  120312. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  120313. */
  120314. postProcessesEnabled: boolean;
  120315. /**
  120316. * Gets the current postprocess manager
  120317. */
  120318. postProcessManager: PostProcessManager;
  120319. /**
  120320. * Gets or sets a boolean indicating if render targets are enabled on this scene
  120321. */
  120322. renderTargetsEnabled: boolean;
  120323. /**
  120324. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  120325. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  120326. */
  120327. dumpNextRenderTargets: boolean;
  120328. /**
  120329. * The list of user defined render targets added to the scene
  120330. */
  120331. customRenderTargets: RenderTargetTexture[];
  120332. /**
  120333. * Defines if texture loading must be delayed
  120334. * If true, textures will only be loaded when they need to be rendered
  120335. */
  120336. useDelayedTextureLoading: boolean;
  120337. /**
  120338. * Gets the list of meshes imported to the scene through SceneLoader
  120339. */
  120340. importedMeshesFiles: String[];
  120341. /**
  120342. * Gets or sets a boolean indicating if probes are enabled on this scene
  120343. */
  120344. probesEnabled: boolean;
  120345. /**
  120346. * Gets or sets the current offline provider to use to store scene data
  120347. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  120348. */
  120349. offlineProvider: IOfflineProvider;
  120350. /**
  120351. * Gets or sets the action manager associated with the scene
  120352. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  120353. */
  120354. actionManager: AbstractActionManager;
  120355. private _meshesForIntersections;
  120356. /**
  120357. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  120358. */
  120359. proceduralTexturesEnabled: boolean;
  120360. private _engine;
  120361. private _totalVertices;
  120362. /** @hidden */
  120363. _activeIndices: PerfCounter;
  120364. /** @hidden */
  120365. _activeParticles: PerfCounter;
  120366. /** @hidden */
  120367. _activeBones: PerfCounter;
  120368. private _animationRatio;
  120369. /** @hidden */
  120370. _animationTimeLast: number;
  120371. /** @hidden */
  120372. _animationTime: number;
  120373. /**
  120374. * Gets or sets a general scale for animation speed
  120375. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  120376. */
  120377. animationTimeScale: number;
  120378. /** @hidden */
  120379. _cachedMaterial: Nullable<Material>;
  120380. /** @hidden */
  120381. _cachedEffect: Nullable<Effect>;
  120382. /** @hidden */
  120383. _cachedVisibility: Nullable<number>;
  120384. private _renderId;
  120385. private _frameId;
  120386. private _executeWhenReadyTimeoutId;
  120387. private _intermediateRendering;
  120388. private _viewUpdateFlag;
  120389. private _projectionUpdateFlag;
  120390. /** @hidden */
  120391. _toBeDisposed: Nullable<IDisposable>[];
  120392. private _activeRequests;
  120393. /** @hidden */
  120394. _pendingData: any[];
  120395. private _isDisposed;
  120396. /**
  120397. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  120398. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  120399. */
  120400. dispatchAllSubMeshesOfActiveMeshes: boolean;
  120401. private _activeMeshes;
  120402. private _processedMaterials;
  120403. private _renderTargets;
  120404. /** @hidden */
  120405. _activeParticleSystems: SmartArray<IParticleSystem>;
  120406. private _activeSkeletons;
  120407. private _softwareSkinnedMeshes;
  120408. private _renderingManager;
  120409. /** @hidden */
  120410. _activeAnimatables: Animatable[];
  120411. private _transformMatrix;
  120412. private _sceneUbo;
  120413. /** @hidden */
  120414. _viewMatrix: Matrix;
  120415. private _projectionMatrix;
  120416. /** @hidden */
  120417. _forcedViewPosition: Nullable<Vector3>;
  120418. /** @hidden */
  120419. _frustumPlanes: Plane[];
  120420. /**
  120421. * Gets the list of frustum planes (built from the active camera)
  120422. */
  120423. get frustumPlanes(): Plane[];
  120424. /**
  120425. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  120426. * This is useful if there are more lights that the maximum simulteanous authorized
  120427. */
  120428. requireLightSorting: boolean;
  120429. /** @hidden */
  120430. readonly useMaterialMeshMap: boolean;
  120431. /** @hidden */
  120432. readonly useClonedMeshMap: boolean;
  120433. private _externalData;
  120434. private _uid;
  120435. /**
  120436. * @hidden
  120437. * Backing store of defined scene components.
  120438. */
  120439. _components: ISceneComponent[];
  120440. /**
  120441. * @hidden
  120442. * Backing store of defined scene components.
  120443. */
  120444. _serializableComponents: ISceneSerializableComponent[];
  120445. /**
  120446. * List of components to register on the next registration step.
  120447. */
  120448. private _transientComponents;
  120449. /**
  120450. * Registers the transient components if needed.
  120451. */
  120452. private _registerTransientComponents;
  120453. /**
  120454. * @hidden
  120455. * Add a component to the scene.
  120456. * Note that the ccomponent could be registered on th next frame if this is called after
  120457. * the register component stage.
  120458. * @param component Defines the component to add to the scene
  120459. */
  120460. _addComponent(component: ISceneComponent): void;
  120461. /**
  120462. * @hidden
  120463. * Gets a component from the scene.
  120464. * @param name defines the name of the component to retrieve
  120465. * @returns the component or null if not present
  120466. */
  120467. _getComponent(name: string): Nullable<ISceneComponent>;
  120468. /**
  120469. * @hidden
  120470. * Defines the actions happening before camera updates.
  120471. */
  120472. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  120473. /**
  120474. * @hidden
  120475. * Defines the actions happening before clear the canvas.
  120476. */
  120477. _beforeClearStage: Stage<SimpleStageAction>;
  120478. /**
  120479. * @hidden
  120480. * Defines the actions when collecting render targets for the frame.
  120481. */
  120482. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  120483. /**
  120484. * @hidden
  120485. * Defines the actions happening for one camera in the frame.
  120486. */
  120487. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  120488. /**
  120489. * @hidden
  120490. * Defines the actions happening during the per mesh ready checks.
  120491. */
  120492. _isReadyForMeshStage: Stage<MeshStageAction>;
  120493. /**
  120494. * @hidden
  120495. * Defines the actions happening before evaluate active mesh checks.
  120496. */
  120497. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  120498. /**
  120499. * @hidden
  120500. * Defines the actions happening during the evaluate sub mesh checks.
  120501. */
  120502. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  120503. /**
  120504. * @hidden
  120505. * Defines the actions happening during the active mesh stage.
  120506. */
  120507. _activeMeshStage: Stage<ActiveMeshStageAction>;
  120508. /**
  120509. * @hidden
  120510. * Defines the actions happening during the per camera render target step.
  120511. */
  120512. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  120513. /**
  120514. * @hidden
  120515. * Defines the actions happening just before the active camera is drawing.
  120516. */
  120517. _beforeCameraDrawStage: Stage<CameraStageAction>;
  120518. /**
  120519. * @hidden
  120520. * Defines the actions happening just before a render target is drawing.
  120521. */
  120522. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  120523. /**
  120524. * @hidden
  120525. * Defines the actions happening just before a rendering group is drawing.
  120526. */
  120527. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  120528. /**
  120529. * @hidden
  120530. * Defines the actions happening just before a mesh is drawing.
  120531. */
  120532. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  120533. /**
  120534. * @hidden
  120535. * Defines the actions happening just after a mesh has been drawn.
  120536. */
  120537. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  120538. /**
  120539. * @hidden
  120540. * Defines the actions happening just after a rendering group has been drawn.
  120541. */
  120542. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  120543. /**
  120544. * @hidden
  120545. * Defines the actions happening just after the active camera has been drawn.
  120546. */
  120547. _afterCameraDrawStage: Stage<CameraStageAction>;
  120548. /**
  120549. * @hidden
  120550. * Defines the actions happening just after a render target has been drawn.
  120551. */
  120552. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  120553. /**
  120554. * @hidden
  120555. * Defines the actions happening just after rendering all cameras and computing intersections.
  120556. */
  120557. _afterRenderStage: Stage<SimpleStageAction>;
  120558. /**
  120559. * @hidden
  120560. * Defines the actions happening when a pointer move event happens.
  120561. */
  120562. _pointerMoveStage: Stage<PointerMoveStageAction>;
  120563. /**
  120564. * @hidden
  120565. * Defines the actions happening when a pointer down event happens.
  120566. */
  120567. _pointerDownStage: Stage<PointerUpDownStageAction>;
  120568. /**
  120569. * @hidden
  120570. * Defines the actions happening when a pointer up event happens.
  120571. */
  120572. _pointerUpStage: Stage<PointerUpDownStageAction>;
  120573. /**
  120574. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  120575. */
  120576. private geometriesByUniqueId;
  120577. /**
  120578. * Creates a new Scene
  120579. * @param engine defines the engine to use to render this scene
  120580. * @param options defines the scene options
  120581. */
  120582. constructor(engine: Engine, options?: SceneOptions);
  120583. /**
  120584. * Gets a string identifying the name of the class
  120585. * @returns "Scene" string
  120586. */
  120587. getClassName(): string;
  120588. private _defaultMeshCandidates;
  120589. /**
  120590. * @hidden
  120591. */
  120592. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  120593. private _defaultSubMeshCandidates;
  120594. /**
  120595. * @hidden
  120596. */
  120597. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  120598. /**
  120599. * Sets the default candidate providers for the scene.
  120600. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  120601. * and getCollidingSubMeshCandidates to their default function
  120602. */
  120603. setDefaultCandidateProviders(): void;
  120604. /**
  120605. * Gets the mesh that is currently under the pointer
  120606. */
  120607. get meshUnderPointer(): Nullable<AbstractMesh>;
  120608. /**
  120609. * Gets or sets the current on-screen X position of the pointer
  120610. */
  120611. get pointerX(): number;
  120612. set pointerX(value: number);
  120613. /**
  120614. * Gets or sets the current on-screen Y position of the pointer
  120615. */
  120616. get pointerY(): number;
  120617. set pointerY(value: number);
  120618. /**
  120619. * Gets the cached material (ie. the latest rendered one)
  120620. * @returns the cached material
  120621. */
  120622. getCachedMaterial(): Nullable<Material>;
  120623. /**
  120624. * Gets the cached effect (ie. the latest rendered one)
  120625. * @returns the cached effect
  120626. */
  120627. getCachedEffect(): Nullable<Effect>;
  120628. /**
  120629. * Gets the cached visibility state (ie. the latest rendered one)
  120630. * @returns the cached visibility state
  120631. */
  120632. getCachedVisibility(): Nullable<number>;
  120633. /**
  120634. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  120635. * @param material defines the current material
  120636. * @param effect defines the current effect
  120637. * @param visibility defines the current visibility state
  120638. * @returns true if one parameter is not cached
  120639. */
  120640. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  120641. /**
  120642. * Gets the engine associated with the scene
  120643. * @returns an Engine
  120644. */
  120645. getEngine(): Engine;
  120646. /**
  120647. * Gets the total number of vertices rendered per frame
  120648. * @returns the total number of vertices rendered per frame
  120649. */
  120650. getTotalVertices(): number;
  120651. /**
  120652. * Gets the performance counter for total vertices
  120653. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120654. */
  120655. get totalVerticesPerfCounter(): PerfCounter;
  120656. /**
  120657. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  120658. * @returns the total number of active indices rendered per frame
  120659. */
  120660. getActiveIndices(): number;
  120661. /**
  120662. * Gets the performance counter for active indices
  120663. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120664. */
  120665. get totalActiveIndicesPerfCounter(): PerfCounter;
  120666. /**
  120667. * Gets the total number of active particles rendered per frame
  120668. * @returns the total number of active particles rendered per frame
  120669. */
  120670. getActiveParticles(): number;
  120671. /**
  120672. * Gets the performance counter for active particles
  120673. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120674. */
  120675. get activeParticlesPerfCounter(): PerfCounter;
  120676. /**
  120677. * Gets the total number of active bones rendered per frame
  120678. * @returns the total number of active bones rendered per frame
  120679. */
  120680. getActiveBones(): number;
  120681. /**
  120682. * Gets the performance counter for active bones
  120683. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120684. */
  120685. get activeBonesPerfCounter(): PerfCounter;
  120686. /**
  120687. * Gets the array of active meshes
  120688. * @returns an array of AbstractMesh
  120689. */
  120690. getActiveMeshes(): SmartArray<AbstractMesh>;
  120691. /**
  120692. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  120693. * @returns a number
  120694. */
  120695. getAnimationRatio(): number;
  120696. /**
  120697. * Gets an unique Id for the current render phase
  120698. * @returns a number
  120699. */
  120700. getRenderId(): number;
  120701. /**
  120702. * Gets an unique Id for the current frame
  120703. * @returns a number
  120704. */
  120705. getFrameId(): number;
  120706. /** Call this function if you want to manually increment the render Id*/
  120707. incrementRenderId(): void;
  120708. private _createUbo;
  120709. /**
  120710. * Use this method to simulate a pointer move on a mesh
  120711. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120712. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120713. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120714. * @returns the current scene
  120715. */
  120716. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120717. /**
  120718. * Use this method to simulate a pointer down on a mesh
  120719. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120720. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120721. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120722. * @returns the current scene
  120723. */
  120724. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120725. /**
  120726. * Use this method to simulate a pointer up on a mesh
  120727. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120728. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120729. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120730. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  120731. * @returns the current scene
  120732. */
  120733. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  120734. /**
  120735. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  120736. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  120737. * @returns true if the pointer was captured
  120738. */
  120739. isPointerCaptured(pointerId?: number): boolean;
  120740. /**
  120741. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  120742. * @param attachUp defines if you want to attach events to pointerup
  120743. * @param attachDown defines if you want to attach events to pointerdown
  120744. * @param attachMove defines if you want to attach events to pointermove
  120745. */
  120746. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  120747. /** Detaches all event handlers*/
  120748. detachControl(): void;
  120749. /**
  120750. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120751. * Delay loaded resources are not taking in account
  120752. * @return true if all required resources are ready
  120753. */
  120754. isReady(): boolean;
  120755. /** Resets all cached information relative to material (including effect and visibility) */
  120756. resetCachedMaterial(): void;
  120757. /**
  120758. * Registers a function to be called before every frame render
  120759. * @param func defines the function to register
  120760. */
  120761. registerBeforeRender(func: () => void): void;
  120762. /**
  120763. * Unregisters a function called before every frame render
  120764. * @param func defines the function to unregister
  120765. */
  120766. unregisterBeforeRender(func: () => void): void;
  120767. /**
  120768. * Registers a function to be called after every frame render
  120769. * @param func defines the function to register
  120770. */
  120771. registerAfterRender(func: () => void): void;
  120772. /**
  120773. * Unregisters a function called after every frame render
  120774. * @param func defines the function to unregister
  120775. */
  120776. unregisterAfterRender(func: () => void): void;
  120777. private _executeOnceBeforeRender;
  120778. /**
  120779. * The provided function will run before render once and will be disposed afterwards.
  120780. * A timeout delay can be provided so that the function will be executed in N ms.
  120781. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120782. * @param func The function to be executed.
  120783. * @param timeout optional delay in ms
  120784. */
  120785. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120786. /** @hidden */
  120787. _addPendingData(data: any): void;
  120788. /** @hidden */
  120789. _removePendingData(data: any): void;
  120790. /**
  120791. * Returns the number of items waiting to be loaded
  120792. * @returns the number of items waiting to be loaded
  120793. */
  120794. getWaitingItemsCount(): number;
  120795. /**
  120796. * Returns a boolean indicating if the scene is still loading data
  120797. */
  120798. get isLoading(): boolean;
  120799. /**
  120800. * Registers a function to be executed when the scene is ready
  120801. * @param {Function} func - the function to be executed
  120802. */
  120803. executeWhenReady(func: () => void): void;
  120804. /**
  120805. * Returns a promise that resolves when the scene is ready
  120806. * @returns A promise that resolves when the scene is ready
  120807. */
  120808. whenReadyAsync(): Promise<void>;
  120809. /** @hidden */
  120810. _checkIsReady(): void;
  120811. /**
  120812. * Gets all animatable attached to the scene
  120813. */
  120814. get animatables(): Animatable[];
  120815. /**
  120816. * Resets the last animation time frame.
  120817. * Useful to override when animations start running when loading a scene for the first time.
  120818. */
  120819. resetLastAnimationTimeFrame(): void;
  120820. /**
  120821. * Gets the current view matrix
  120822. * @returns a Matrix
  120823. */
  120824. getViewMatrix(): Matrix;
  120825. /**
  120826. * Gets the current projection matrix
  120827. * @returns a Matrix
  120828. */
  120829. getProjectionMatrix(): Matrix;
  120830. /**
  120831. * Gets the current transform matrix
  120832. * @returns a Matrix made of View * Projection
  120833. */
  120834. getTransformMatrix(): Matrix;
  120835. /**
  120836. * Sets the current transform matrix
  120837. * @param viewL defines the View matrix to use
  120838. * @param projectionL defines the Projection matrix to use
  120839. * @param viewR defines the right View matrix to use (if provided)
  120840. * @param projectionR defines the right Projection matrix to use (if provided)
  120841. */
  120842. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120843. /**
  120844. * Gets the uniform buffer used to store scene data
  120845. * @returns a UniformBuffer
  120846. */
  120847. getSceneUniformBuffer(): UniformBuffer;
  120848. /**
  120849. * Gets an unique (relatively to the current scene) Id
  120850. * @returns an unique number for the scene
  120851. */
  120852. getUniqueId(): number;
  120853. /**
  120854. * Add a mesh to the list of scene's meshes
  120855. * @param newMesh defines the mesh to add
  120856. * @param recursive if all child meshes should also be added to the scene
  120857. */
  120858. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120859. /**
  120860. * Remove a mesh for the list of scene's meshes
  120861. * @param toRemove defines the mesh to remove
  120862. * @param recursive if all child meshes should also be removed from the scene
  120863. * @returns the index where the mesh was in the mesh list
  120864. */
  120865. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120866. /**
  120867. * Add a transform node to the list of scene's transform nodes
  120868. * @param newTransformNode defines the transform node to add
  120869. */
  120870. addTransformNode(newTransformNode: TransformNode): void;
  120871. /**
  120872. * Remove a transform node for the list of scene's transform nodes
  120873. * @param toRemove defines the transform node to remove
  120874. * @returns the index where the transform node was in the transform node list
  120875. */
  120876. removeTransformNode(toRemove: TransformNode): number;
  120877. /**
  120878. * Remove a skeleton for the list of scene's skeletons
  120879. * @param toRemove defines the skeleton to remove
  120880. * @returns the index where the skeleton was in the skeleton list
  120881. */
  120882. removeSkeleton(toRemove: Skeleton): number;
  120883. /**
  120884. * Remove a morph target for the list of scene's morph targets
  120885. * @param toRemove defines the morph target to remove
  120886. * @returns the index where the morph target was in the morph target list
  120887. */
  120888. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120889. /**
  120890. * Remove a light for the list of scene's lights
  120891. * @param toRemove defines the light to remove
  120892. * @returns the index where the light was in the light list
  120893. */
  120894. removeLight(toRemove: Light): number;
  120895. /**
  120896. * Remove a camera for the list of scene's cameras
  120897. * @param toRemove defines the camera to remove
  120898. * @returns the index where the camera was in the camera list
  120899. */
  120900. removeCamera(toRemove: Camera): number;
  120901. /**
  120902. * Remove a particle system for the list of scene's particle systems
  120903. * @param toRemove defines the particle system to remove
  120904. * @returns the index where the particle system was in the particle system list
  120905. */
  120906. removeParticleSystem(toRemove: IParticleSystem): number;
  120907. /**
  120908. * Remove a animation for the list of scene's animations
  120909. * @param toRemove defines the animation to remove
  120910. * @returns the index where the animation was in the animation list
  120911. */
  120912. removeAnimation(toRemove: Animation): number;
  120913. /**
  120914. * Will stop the animation of the given target
  120915. * @param target - the target
  120916. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120917. * @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)
  120918. */
  120919. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120920. /**
  120921. * Removes the given animation group from this scene.
  120922. * @param toRemove The animation group to remove
  120923. * @returns The index of the removed animation group
  120924. */
  120925. removeAnimationGroup(toRemove: AnimationGroup): number;
  120926. /**
  120927. * Removes the given multi-material from this scene.
  120928. * @param toRemove The multi-material to remove
  120929. * @returns The index of the removed multi-material
  120930. */
  120931. removeMultiMaterial(toRemove: MultiMaterial): number;
  120932. /**
  120933. * Removes the given material from this scene.
  120934. * @param toRemove The material to remove
  120935. * @returns The index of the removed material
  120936. */
  120937. removeMaterial(toRemove: Material): number;
  120938. /**
  120939. * Removes the given action manager from this scene.
  120940. * @param toRemove The action manager to remove
  120941. * @returns The index of the removed action manager
  120942. */
  120943. removeActionManager(toRemove: AbstractActionManager): number;
  120944. /**
  120945. * Removes the given texture from this scene.
  120946. * @param toRemove The texture to remove
  120947. * @returns The index of the removed texture
  120948. */
  120949. removeTexture(toRemove: BaseTexture): number;
  120950. /**
  120951. * Adds the given light to this scene
  120952. * @param newLight The light to add
  120953. */
  120954. addLight(newLight: Light): void;
  120955. /**
  120956. * Sorts the list list based on light priorities
  120957. */
  120958. sortLightsByPriority(): void;
  120959. /**
  120960. * Adds the given camera to this scene
  120961. * @param newCamera The camera to add
  120962. */
  120963. addCamera(newCamera: Camera): void;
  120964. /**
  120965. * Adds the given skeleton to this scene
  120966. * @param newSkeleton The skeleton to add
  120967. */
  120968. addSkeleton(newSkeleton: Skeleton): void;
  120969. /**
  120970. * Adds the given particle system to this scene
  120971. * @param newParticleSystem The particle system to add
  120972. */
  120973. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120974. /**
  120975. * Adds the given animation to this scene
  120976. * @param newAnimation The animation to add
  120977. */
  120978. addAnimation(newAnimation: Animation): void;
  120979. /**
  120980. * Adds the given animation group to this scene.
  120981. * @param newAnimationGroup The animation group to add
  120982. */
  120983. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120984. /**
  120985. * Adds the given multi-material to this scene
  120986. * @param newMultiMaterial The multi-material to add
  120987. */
  120988. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120989. /**
  120990. * Adds the given material to this scene
  120991. * @param newMaterial The material to add
  120992. */
  120993. addMaterial(newMaterial: Material): void;
  120994. /**
  120995. * Adds the given morph target to this scene
  120996. * @param newMorphTargetManager The morph target to add
  120997. */
  120998. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120999. /**
  121000. * Adds the given geometry to this scene
  121001. * @param newGeometry The geometry to add
  121002. */
  121003. addGeometry(newGeometry: Geometry): void;
  121004. /**
  121005. * Adds the given action manager to this scene
  121006. * @param newActionManager The action manager to add
  121007. */
  121008. addActionManager(newActionManager: AbstractActionManager): void;
  121009. /**
  121010. * Adds the given texture to this scene.
  121011. * @param newTexture The texture to add
  121012. */
  121013. addTexture(newTexture: BaseTexture): void;
  121014. /**
  121015. * Switch active camera
  121016. * @param newCamera defines the new active camera
  121017. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  121018. */
  121019. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  121020. /**
  121021. * sets the active camera of the scene using its ID
  121022. * @param id defines the camera's ID
  121023. * @return the new active camera or null if none found.
  121024. */
  121025. setActiveCameraByID(id: string): Nullable<Camera>;
  121026. /**
  121027. * sets the active camera of the scene using its name
  121028. * @param name defines the camera's name
  121029. * @returns the new active camera or null if none found.
  121030. */
  121031. setActiveCameraByName(name: string): Nullable<Camera>;
  121032. /**
  121033. * get an animation group using its name
  121034. * @param name defines the material's name
  121035. * @return the animation group or null if none found.
  121036. */
  121037. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  121038. /**
  121039. * Get a material using its unique id
  121040. * @param uniqueId defines the material's unique id
  121041. * @return the material or null if none found.
  121042. */
  121043. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  121044. /**
  121045. * get a material using its id
  121046. * @param id defines the material's ID
  121047. * @return the material or null if none found.
  121048. */
  121049. getMaterialByID(id: string): Nullable<Material>;
  121050. /**
  121051. * Gets a the last added material using a given id
  121052. * @param id defines the material's ID
  121053. * @return the last material with the given id or null if none found.
  121054. */
  121055. getLastMaterialByID(id: string): Nullable<Material>;
  121056. /**
  121057. * Gets a material using its name
  121058. * @param name defines the material's name
  121059. * @return the material or null if none found.
  121060. */
  121061. getMaterialByName(name: string): Nullable<Material>;
  121062. /**
  121063. * Get a texture using its unique id
  121064. * @param uniqueId defines the texture's unique id
  121065. * @return the texture or null if none found.
  121066. */
  121067. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  121068. /**
  121069. * Gets a camera using its id
  121070. * @param id defines the id to look for
  121071. * @returns the camera or null if not found
  121072. */
  121073. getCameraByID(id: string): Nullable<Camera>;
  121074. /**
  121075. * Gets a camera using its unique id
  121076. * @param uniqueId defines the unique id to look for
  121077. * @returns the camera or null if not found
  121078. */
  121079. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  121080. /**
  121081. * Gets a camera using its name
  121082. * @param name defines the camera's name
  121083. * @return the camera or null if none found.
  121084. */
  121085. getCameraByName(name: string): Nullable<Camera>;
  121086. /**
  121087. * Gets a bone using its id
  121088. * @param id defines the bone's id
  121089. * @return the bone or null if not found
  121090. */
  121091. getBoneByID(id: string): Nullable<Bone>;
  121092. /**
  121093. * Gets a bone using its id
  121094. * @param name defines the bone's name
  121095. * @return the bone or null if not found
  121096. */
  121097. getBoneByName(name: string): Nullable<Bone>;
  121098. /**
  121099. * Gets a light node using its name
  121100. * @param name defines the the light's name
  121101. * @return the light or null if none found.
  121102. */
  121103. getLightByName(name: string): Nullable<Light>;
  121104. /**
  121105. * Gets a light node using its id
  121106. * @param id defines the light's id
  121107. * @return the light or null if none found.
  121108. */
  121109. getLightByID(id: string): Nullable<Light>;
  121110. /**
  121111. * Gets a light node using its scene-generated unique ID
  121112. * @param uniqueId defines the light's unique id
  121113. * @return the light or null if none found.
  121114. */
  121115. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  121116. /**
  121117. * Gets a particle system by id
  121118. * @param id defines the particle system id
  121119. * @return the corresponding system or null if none found
  121120. */
  121121. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  121122. /**
  121123. * Gets a geometry using its ID
  121124. * @param id defines the geometry's id
  121125. * @return the geometry or null if none found.
  121126. */
  121127. getGeometryByID(id: string): Nullable<Geometry>;
  121128. private _getGeometryByUniqueID;
  121129. /**
  121130. * Add a new geometry to this scene
  121131. * @param geometry defines the geometry to be added to the scene.
  121132. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  121133. * @return a boolean defining if the geometry was added or not
  121134. */
  121135. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  121136. /**
  121137. * Removes an existing geometry
  121138. * @param geometry defines the geometry to be removed from the scene
  121139. * @return a boolean defining if the geometry was removed or not
  121140. */
  121141. removeGeometry(geometry: Geometry): boolean;
  121142. /**
  121143. * Gets the list of geometries attached to the scene
  121144. * @returns an array of Geometry
  121145. */
  121146. getGeometries(): Geometry[];
  121147. /**
  121148. * Gets the first added mesh found of a given ID
  121149. * @param id defines the id to search for
  121150. * @return the mesh found or null if not found at all
  121151. */
  121152. getMeshByID(id: string): Nullable<AbstractMesh>;
  121153. /**
  121154. * Gets a list of meshes using their id
  121155. * @param id defines the id to search for
  121156. * @returns a list of meshes
  121157. */
  121158. getMeshesByID(id: string): Array<AbstractMesh>;
  121159. /**
  121160. * Gets the first added transform node found of a given ID
  121161. * @param id defines the id to search for
  121162. * @return the found transform node or null if not found at all.
  121163. */
  121164. getTransformNodeByID(id: string): Nullable<TransformNode>;
  121165. /**
  121166. * Gets a transform node with its auto-generated unique id
  121167. * @param uniqueId efines the unique id to search for
  121168. * @return the found transform node or null if not found at all.
  121169. */
  121170. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  121171. /**
  121172. * Gets a list of transform nodes using their id
  121173. * @param id defines the id to search for
  121174. * @returns a list of transform nodes
  121175. */
  121176. getTransformNodesByID(id: string): Array<TransformNode>;
  121177. /**
  121178. * Gets a mesh with its auto-generated unique id
  121179. * @param uniqueId defines the unique id to search for
  121180. * @return the found mesh or null if not found at all.
  121181. */
  121182. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  121183. /**
  121184. * Gets a the last added mesh using a given id
  121185. * @param id defines the id to search for
  121186. * @return the found mesh or null if not found at all.
  121187. */
  121188. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  121189. /**
  121190. * Gets a the last added node (Mesh, Camera, Light) using a given id
  121191. * @param id defines the id to search for
  121192. * @return the found node or null if not found at all
  121193. */
  121194. getLastEntryByID(id: string): Nullable<Node>;
  121195. /**
  121196. * Gets a node (Mesh, Camera, Light) using a given id
  121197. * @param id defines the id to search for
  121198. * @return the found node or null if not found at all
  121199. */
  121200. getNodeByID(id: string): Nullable<Node>;
  121201. /**
  121202. * Gets a node (Mesh, Camera, Light) using a given name
  121203. * @param name defines the name to search for
  121204. * @return the found node or null if not found at all.
  121205. */
  121206. getNodeByName(name: string): Nullable<Node>;
  121207. /**
  121208. * Gets a mesh using a given name
  121209. * @param name defines the name to search for
  121210. * @return the found mesh or null if not found at all.
  121211. */
  121212. getMeshByName(name: string): Nullable<AbstractMesh>;
  121213. /**
  121214. * Gets a transform node using a given name
  121215. * @param name defines the name to search for
  121216. * @return the found transform node or null if not found at all.
  121217. */
  121218. getTransformNodeByName(name: string): Nullable<TransformNode>;
  121219. /**
  121220. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  121221. * @param id defines the id to search for
  121222. * @return the found skeleton or null if not found at all.
  121223. */
  121224. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  121225. /**
  121226. * Gets a skeleton using a given auto generated unique id
  121227. * @param uniqueId defines the unique id to search for
  121228. * @return the found skeleton or null if not found at all.
  121229. */
  121230. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  121231. /**
  121232. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  121233. * @param id defines the id to search for
  121234. * @return the found skeleton or null if not found at all.
  121235. */
  121236. getSkeletonById(id: string): Nullable<Skeleton>;
  121237. /**
  121238. * Gets a skeleton using a given name
  121239. * @param name defines the name to search for
  121240. * @return the found skeleton or null if not found at all.
  121241. */
  121242. getSkeletonByName(name: string): Nullable<Skeleton>;
  121243. /**
  121244. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  121245. * @param id defines the id to search for
  121246. * @return the found morph target manager or null if not found at all.
  121247. */
  121248. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  121249. /**
  121250. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  121251. * @param id defines the id to search for
  121252. * @return the found morph target or null if not found at all.
  121253. */
  121254. getMorphTargetById(id: string): Nullable<MorphTarget>;
  121255. /**
  121256. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  121257. * @param name defines the name to search for
  121258. * @return the found morph target or null if not found at all.
  121259. */
  121260. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  121261. /**
  121262. * Gets a post process using a given name (if many are found, this function will pick the first one)
  121263. * @param name defines the name to search for
  121264. * @return the found post process or null if not found at all.
  121265. */
  121266. getPostProcessByName(name: string): Nullable<PostProcess>;
  121267. /**
  121268. * Gets a boolean indicating if the given mesh is active
  121269. * @param mesh defines the mesh to look for
  121270. * @returns true if the mesh is in the active list
  121271. */
  121272. isActiveMesh(mesh: AbstractMesh): boolean;
  121273. /**
  121274. * Return a unique id as a string which can serve as an identifier for the scene
  121275. */
  121276. get uid(): string;
  121277. /**
  121278. * Add an externaly attached data from its key.
  121279. * This method call will fail and return false, if such key already exists.
  121280. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  121281. * @param key the unique key that identifies the data
  121282. * @param data the data object to associate to the key for this Engine instance
  121283. * @return true if no such key were already present and the data was added successfully, false otherwise
  121284. */
  121285. addExternalData<T>(key: string, data: T): boolean;
  121286. /**
  121287. * Get an externaly attached data from its key
  121288. * @param key the unique key that identifies the data
  121289. * @return the associated data, if present (can be null), or undefined if not present
  121290. */
  121291. getExternalData<T>(key: string): Nullable<T>;
  121292. /**
  121293. * Get an externaly attached data from its key, create it using a factory if it's not already present
  121294. * @param key the unique key that identifies the data
  121295. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  121296. * @return the associated data, can be null if the factory returned null.
  121297. */
  121298. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  121299. /**
  121300. * Remove an externaly attached data from the Engine instance
  121301. * @param key the unique key that identifies the data
  121302. * @return true if the data was successfully removed, false if it doesn't exist
  121303. */
  121304. removeExternalData(key: string): boolean;
  121305. private _evaluateSubMesh;
  121306. /**
  121307. * Clear the processed materials smart array preventing retention point in material dispose.
  121308. */
  121309. freeProcessedMaterials(): void;
  121310. private _preventFreeActiveMeshesAndRenderingGroups;
  121311. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  121312. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  121313. * when disposing several meshes in a row or a hierarchy of meshes.
  121314. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  121315. */
  121316. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  121317. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  121318. /**
  121319. * Clear the active meshes smart array preventing retention point in mesh dispose.
  121320. */
  121321. freeActiveMeshes(): void;
  121322. /**
  121323. * Clear the info related to rendering groups preventing retention points during dispose.
  121324. */
  121325. freeRenderingGroups(): void;
  121326. /** @hidden */
  121327. _isInIntermediateRendering(): boolean;
  121328. /**
  121329. * Lambda returning the list of potentially active meshes.
  121330. */
  121331. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  121332. /**
  121333. * Lambda returning the list of potentially active sub meshes.
  121334. */
  121335. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  121336. /**
  121337. * Lambda returning the list of potentially intersecting sub meshes.
  121338. */
  121339. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  121340. /**
  121341. * Lambda returning the list of potentially colliding sub meshes.
  121342. */
  121343. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  121344. private _activeMeshesFrozen;
  121345. private _skipEvaluateActiveMeshesCompletely;
  121346. /**
  121347. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  121348. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  121349. * @returns the current scene
  121350. */
  121351. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  121352. /**
  121353. * Use this function to restart evaluating active meshes on every frame
  121354. * @returns the current scene
  121355. */
  121356. unfreezeActiveMeshes(): Scene;
  121357. private _evaluateActiveMeshes;
  121358. private _activeMesh;
  121359. /**
  121360. * Update the transform matrix to update from the current active camera
  121361. * @param force defines a boolean used to force the update even if cache is up to date
  121362. */
  121363. updateTransformMatrix(force?: boolean): void;
  121364. private _bindFrameBuffer;
  121365. /** @hidden */
  121366. _allowPostProcessClearColor: boolean;
  121367. /** @hidden */
  121368. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  121369. private _processSubCameras;
  121370. private _checkIntersections;
  121371. /** @hidden */
  121372. _advancePhysicsEngineStep(step: number): void;
  121373. /**
  121374. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  121375. */
  121376. getDeterministicFrameTime: () => number;
  121377. /** @hidden */
  121378. _animate(): void;
  121379. /** Execute all animations (for a frame) */
  121380. animate(): void;
  121381. /**
  121382. * Render the scene
  121383. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  121384. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  121385. */
  121386. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  121387. /**
  121388. * Freeze all materials
  121389. * A frozen material will not be updatable but should be faster to render
  121390. */
  121391. freezeMaterials(): void;
  121392. /**
  121393. * Unfreeze all materials
  121394. * A frozen material will not be updatable but should be faster to render
  121395. */
  121396. unfreezeMaterials(): void;
  121397. /**
  121398. * Releases all held ressources
  121399. */
  121400. dispose(): void;
  121401. /**
  121402. * Gets if the scene is already disposed
  121403. */
  121404. get isDisposed(): boolean;
  121405. /**
  121406. * Call this function to reduce memory footprint of the scene.
  121407. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  121408. */
  121409. clearCachedVertexData(): void;
  121410. /**
  121411. * This function will remove the local cached buffer data from texture.
  121412. * It will save memory but will prevent the texture from being rebuilt
  121413. */
  121414. cleanCachedTextureBuffer(): void;
  121415. /**
  121416. * Get the world extend vectors with an optional filter
  121417. *
  121418. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  121419. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  121420. */
  121421. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  121422. min: Vector3;
  121423. max: Vector3;
  121424. };
  121425. /**
  121426. * Creates a ray that can be used to pick in the scene
  121427. * @param x defines the x coordinate of the origin (on-screen)
  121428. * @param y defines the y coordinate of the origin (on-screen)
  121429. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  121430. * @param camera defines the camera to use for the picking
  121431. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  121432. * @returns a Ray
  121433. */
  121434. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  121435. /**
  121436. * Creates a ray that can be used to pick in the scene
  121437. * @param x defines the x coordinate of the origin (on-screen)
  121438. * @param y defines the y coordinate of the origin (on-screen)
  121439. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  121440. * @param result defines the ray where to store the picking ray
  121441. * @param camera defines the camera to use for the picking
  121442. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  121443. * @returns the current scene
  121444. */
  121445. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  121446. /**
  121447. * Creates a ray that can be used to pick in the scene
  121448. * @param x defines the x coordinate of the origin (on-screen)
  121449. * @param y defines the y coordinate of the origin (on-screen)
  121450. * @param camera defines the camera to use for the picking
  121451. * @returns a Ray
  121452. */
  121453. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  121454. /**
  121455. * Creates a ray that can be used to pick in the scene
  121456. * @param x defines the x coordinate of the origin (on-screen)
  121457. * @param y defines the y coordinate of the origin (on-screen)
  121458. * @param result defines the ray where to store the picking ray
  121459. * @param camera defines the camera to use for the picking
  121460. * @returns the current scene
  121461. */
  121462. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  121463. /** Launch a ray to try to pick a mesh in the scene
  121464. * @param x position on screen
  121465. * @param y position on screen
  121466. * @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
  121467. * @param fastCheck defines if the first intersection will be used (and not the closest)
  121468. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  121469. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121470. * @returns a PickingInfo
  121471. */
  121472. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  121473. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  121474. * @param x position on screen
  121475. * @param y position on screen
  121476. * @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
  121477. * @param fastCheck defines if the first intersection will be used (and not the closest)
  121478. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  121479. * @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)
  121480. */
  121481. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  121482. /** Use the given ray to pick a mesh in the scene
  121483. * @param ray The ray to use to pick meshes
  121484. * @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
  121485. * @param fastCheck defines if the first intersection will be used (and not the closest)
  121486. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121487. * @returns a PickingInfo
  121488. */
  121489. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  121490. /**
  121491. * Launch a ray to try to pick a mesh in the scene
  121492. * @param x X position on screen
  121493. * @param y Y position on screen
  121494. * @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
  121495. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  121496. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121497. * @returns an array of PickingInfo
  121498. */
  121499. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  121500. /**
  121501. * Launch a ray to try to pick a mesh in the scene
  121502. * @param ray Ray to use
  121503. * @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
  121504. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121505. * @returns an array of PickingInfo
  121506. */
  121507. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  121508. /**
  121509. * Force the value of meshUnderPointer
  121510. * @param mesh defines the mesh to use
  121511. * @param pointerId optional pointer id when using more than one pointer
  121512. */
  121513. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  121514. /**
  121515. * Gets the mesh under the pointer
  121516. * @returns a Mesh or null if no mesh is under the pointer
  121517. */
  121518. getPointerOverMesh(): Nullable<AbstractMesh>;
  121519. /** @hidden */
  121520. _rebuildGeometries(): void;
  121521. /** @hidden */
  121522. _rebuildTextures(): void;
  121523. private _getByTags;
  121524. /**
  121525. * Get a list of meshes by tags
  121526. * @param tagsQuery defines the tags query to use
  121527. * @param forEach defines a predicate used to filter results
  121528. * @returns an array of Mesh
  121529. */
  121530. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  121531. /**
  121532. * Get a list of cameras by tags
  121533. * @param tagsQuery defines the tags query to use
  121534. * @param forEach defines a predicate used to filter results
  121535. * @returns an array of Camera
  121536. */
  121537. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  121538. /**
  121539. * Get a list of lights by tags
  121540. * @param tagsQuery defines the tags query to use
  121541. * @param forEach defines a predicate used to filter results
  121542. * @returns an array of Light
  121543. */
  121544. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  121545. /**
  121546. * Get a list of materials by tags
  121547. * @param tagsQuery defines the tags query to use
  121548. * @param forEach defines a predicate used to filter results
  121549. * @returns an array of Material
  121550. */
  121551. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  121552. /**
  121553. * Get a list of transform nodes by tags
  121554. * @param tagsQuery defines the tags query to use
  121555. * @param forEach defines a predicate used to filter results
  121556. * @returns an array of TransformNode
  121557. */
  121558. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  121559. /**
  121560. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  121561. * This allowed control for front to back rendering or reversly depending of the special needs.
  121562. *
  121563. * @param renderingGroupId The rendering group id corresponding to its index
  121564. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  121565. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  121566. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  121567. */
  121568. 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;
  121569. /**
  121570. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  121571. *
  121572. * @param renderingGroupId The rendering group id corresponding to its index
  121573. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  121574. * @param depth Automatically clears depth between groups if true and autoClear is true.
  121575. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  121576. */
  121577. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  121578. /**
  121579. * Gets the current auto clear configuration for one rendering group of the rendering
  121580. * manager.
  121581. * @param index the rendering group index to get the information for
  121582. * @returns The auto clear setup for the requested rendering group
  121583. */
  121584. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  121585. private _blockMaterialDirtyMechanism;
  121586. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  121587. get blockMaterialDirtyMechanism(): boolean;
  121588. set blockMaterialDirtyMechanism(value: boolean);
  121589. /**
  121590. * Will flag all materials as dirty to trigger new shader compilation
  121591. * @param flag defines the flag used to specify which material part must be marked as dirty
  121592. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  121593. */
  121594. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  121595. /** @hidden */
  121596. _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;
  121597. /** @hidden */
  121598. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  121599. /** @hidden */
  121600. _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;
  121601. /** @hidden */
  121602. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  121603. /** @hidden */
  121604. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  121605. /** @hidden */
  121606. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  121607. }
  121608. }
  121609. declare module BABYLON {
  121610. /**
  121611. * Set of assets to keep when moving a scene into an asset container.
  121612. */
  121613. export class KeepAssets extends AbstractScene {
  121614. }
  121615. /**
  121616. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  121617. */
  121618. export class InstantiatedEntries {
  121619. /**
  121620. * List of new root nodes (eg. nodes with no parent)
  121621. */
  121622. rootNodes: TransformNode[];
  121623. /**
  121624. * List of new skeletons
  121625. */
  121626. skeletons: Skeleton[];
  121627. /**
  121628. * List of new animation groups
  121629. */
  121630. animationGroups: AnimationGroup[];
  121631. }
  121632. /**
  121633. * Container with a set of assets that can be added or removed from a scene.
  121634. */
  121635. export class AssetContainer extends AbstractScene {
  121636. private _wasAddedToScene;
  121637. /**
  121638. * The scene the AssetContainer belongs to.
  121639. */
  121640. scene: Scene;
  121641. /**
  121642. * Instantiates an AssetContainer.
  121643. * @param scene The scene the AssetContainer belongs to.
  121644. */
  121645. constructor(scene: Scene);
  121646. /**
  121647. * Instantiate or clone all meshes and add the new ones to the scene.
  121648. * Skeletons and animation groups will all be cloned
  121649. * @param nameFunction defines an optional function used to get new names for clones
  121650. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  121651. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  121652. */
  121653. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  121654. /**
  121655. * Adds all the assets from the container to the scene.
  121656. */
  121657. addAllToScene(): void;
  121658. /**
  121659. * Removes all the assets in the container from the scene
  121660. */
  121661. removeAllFromScene(): void;
  121662. /**
  121663. * Disposes all the assets in the container
  121664. */
  121665. dispose(): void;
  121666. private _moveAssets;
  121667. /**
  121668. * Removes all the assets contained in the scene and adds them to the container.
  121669. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  121670. */
  121671. moveAllFromScene(keepAssets?: KeepAssets): void;
  121672. /**
  121673. * 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.
  121674. * @returns the root mesh
  121675. */
  121676. createRootMesh(): Mesh;
  121677. /**
  121678. * Merge animations (direct and animation groups) from this asset container into a scene
  121679. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  121680. * @param animatables set of animatables to retarget to a node from the scene
  121681. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  121682. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  121683. */
  121684. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  121685. }
  121686. }
  121687. declare module BABYLON {
  121688. /**
  121689. * Defines how the parser contract is defined.
  121690. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  121691. */
  121692. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  121693. /**
  121694. * Defines how the individual parser contract is defined.
  121695. * These parser can parse an individual asset
  121696. */
  121697. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  121698. /**
  121699. * Base class of the scene acting as a container for the different elements composing a scene.
  121700. * This class is dynamically extended by the different components of the scene increasing
  121701. * flexibility and reducing coupling
  121702. */
  121703. export abstract class AbstractScene {
  121704. /**
  121705. * Stores the list of available parsers in the application.
  121706. */
  121707. private static _BabylonFileParsers;
  121708. /**
  121709. * Stores the list of available individual parsers in the application.
  121710. */
  121711. private static _IndividualBabylonFileParsers;
  121712. /**
  121713. * Adds a parser in the list of available ones
  121714. * @param name Defines the name of the parser
  121715. * @param parser Defines the parser to add
  121716. */
  121717. static AddParser(name: string, parser: BabylonFileParser): void;
  121718. /**
  121719. * Gets a general parser from the list of avaialble ones
  121720. * @param name Defines the name of the parser
  121721. * @returns the requested parser or null
  121722. */
  121723. static GetParser(name: string): Nullable<BabylonFileParser>;
  121724. /**
  121725. * Adds n individual parser in the list of available ones
  121726. * @param name Defines the name of the parser
  121727. * @param parser Defines the parser to add
  121728. */
  121729. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  121730. /**
  121731. * Gets an individual parser from the list of avaialble ones
  121732. * @param name Defines the name of the parser
  121733. * @returns the requested parser or null
  121734. */
  121735. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  121736. /**
  121737. * Parser json data and populate both a scene and its associated container object
  121738. * @param jsonData Defines the data to parse
  121739. * @param scene Defines the scene to parse the data for
  121740. * @param container Defines the container attached to the parsing sequence
  121741. * @param rootUrl Defines the root url of the data
  121742. */
  121743. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  121744. /**
  121745. * Gets the list of root nodes (ie. nodes with no parent)
  121746. */
  121747. rootNodes: Node[];
  121748. /** All of the cameras added to this scene
  121749. * @see https://doc.babylonjs.com/babylon101/cameras
  121750. */
  121751. cameras: Camera[];
  121752. /**
  121753. * All of the lights added to this scene
  121754. * @see https://doc.babylonjs.com/babylon101/lights
  121755. */
  121756. lights: Light[];
  121757. /**
  121758. * All of the (abstract) meshes added to this scene
  121759. */
  121760. meshes: AbstractMesh[];
  121761. /**
  121762. * The list of skeletons added to the scene
  121763. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121764. */
  121765. skeletons: Skeleton[];
  121766. /**
  121767. * All of the particle systems added to this scene
  121768. * @see https://doc.babylonjs.com/babylon101/particles
  121769. */
  121770. particleSystems: IParticleSystem[];
  121771. /**
  121772. * Gets a list of Animations associated with the scene
  121773. */
  121774. animations: Animation[];
  121775. /**
  121776. * All of the animation groups added to this scene
  121777. * @see https://doc.babylonjs.com/how_to/group
  121778. */
  121779. animationGroups: AnimationGroup[];
  121780. /**
  121781. * All of the multi-materials added to this scene
  121782. * @see https://doc.babylonjs.com/how_to/multi_materials
  121783. */
  121784. multiMaterials: MultiMaterial[];
  121785. /**
  121786. * All of the materials added to this scene
  121787. * In the context of a Scene, it is not supposed to be modified manually.
  121788. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121789. * Note also that the order of the Material within the array is not significant and might change.
  121790. * @see https://doc.babylonjs.com/babylon101/materials
  121791. */
  121792. materials: Material[];
  121793. /**
  121794. * The list of morph target managers added to the scene
  121795. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121796. */
  121797. morphTargetManagers: MorphTargetManager[];
  121798. /**
  121799. * The list of geometries used in the scene.
  121800. */
  121801. geometries: Geometry[];
  121802. /**
  121803. * All of the tranform nodes added to this scene
  121804. * In the context of a Scene, it is not supposed to be modified manually.
  121805. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121806. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121807. * @see https://doc.babylonjs.com/how_to/transformnode
  121808. */
  121809. transformNodes: TransformNode[];
  121810. /**
  121811. * ActionManagers available on the scene.
  121812. */
  121813. actionManagers: AbstractActionManager[];
  121814. /**
  121815. * Textures to keep.
  121816. */
  121817. textures: BaseTexture[];
  121818. /** @hidden */
  121819. protected _environmentTexture: Nullable<BaseTexture>;
  121820. /**
  121821. * Texture used in all pbr material as the reflection texture.
  121822. * As in the majority of the scene they are the same (exception for multi room and so on),
  121823. * this is easier to reference from here than from all the materials.
  121824. */
  121825. get environmentTexture(): Nullable<BaseTexture>;
  121826. set environmentTexture(value: Nullable<BaseTexture>);
  121827. /**
  121828. * The list of postprocesses added to the scene
  121829. */
  121830. postProcesses: PostProcess[];
  121831. /**
  121832. * @returns all meshes, lights, cameras, transformNodes and bones
  121833. */
  121834. getNodes(): Array<Node>;
  121835. }
  121836. }
  121837. declare module BABYLON {
  121838. /**
  121839. * Interface used to define options for Sound class
  121840. */
  121841. export interface ISoundOptions {
  121842. /**
  121843. * Does the sound autoplay once loaded.
  121844. */
  121845. autoplay?: boolean;
  121846. /**
  121847. * Does the sound loop after it finishes playing once.
  121848. */
  121849. loop?: boolean;
  121850. /**
  121851. * Sound's volume
  121852. */
  121853. volume?: number;
  121854. /**
  121855. * Is it a spatial sound?
  121856. */
  121857. spatialSound?: boolean;
  121858. /**
  121859. * Maximum distance to hear that sound
  121860. */
  121861. maxDistance?: number;
  121862. /**
  121863. * Uses user defined attenuation function
  121864. */
  121865. useCustomAttenuation?: boolean;
  121866. /**
  121867. * Define the roll off factor of spatial sounds.
  121868. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121869. */
  121870. rolloffFactor?: number;
  121871. /**
  121872. * Define the reference distance the sound should be heard perfectly.
  121873. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121874. */
  121875. refDistance?: number;
  121876. /**
  121877. * Define the distance attenuation model the sound will follow.
  121878. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121879. */
  121880. distanceModel?: string;
  121881. /**
  121882. * Defines the playback speed (1 by default)
  121883. */
  121884. playbackRate?: number;
  121885. /**
  121886. * Defines if the sound is from a streaming source
  121887. */
  121888. streaming?: boolean;
  121889. /**
  121890. * Defines an optional length (in seconds) inside the sound file
  121891. */
  121892. length?: number;
  121893. /**
  121894. * Defines an optional offset (in seconds) inside the sound file
  121895. */
  121896. offset?: number;
  121897. /**
  121898. * If true, URLs will not be required to state the audio file codec to use.
  121899. */
  121900. skipCodecCheck?: boolean;
  121901. }
  121902. /**
  121903. * Defines a sound that can be played in the application.
  121904. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121905. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121906. */
  121907. export class Sound {
  121908. /**
  121909. * The name of the sound in the scene.
  121910. */
  121911. name: string;
  121912. /**
  121913. * Does the sound autoplay once loaded.
  121914. */
  121915. autoplay: boolean;
  121916. /**
  121917. * Does the sound loop after it finishes playing once.
  121918. */
  121919. loop: boolean;
  121920. /**
  121921. * Does the sound use a custom attenuation curve to simulate the falloff
  121922. * happening when the source gets further away from the camera.
  121923. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121924. */
  121925. useCustomAttenuation: boolean;
  121926. /**
  121927. * The sound track id this sound belongs to.
  121928. */
  121929. soundTrackId: number;
  121930. /**
  121931. * Is this sound currently played.
  121932. */
  121933. isPlaying: boolean;
  121934. /**
  121935. * Is this sound currently paused.
  121936. */
  121937. isPaused: boolean;
  121938. /**
  121939. * Does this sound enables spatial sound.
  121940. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121941. */
  121942. spatialSound: boolean;
  121943. /**
  121944. * Define the reference distance the sound should be heard perfectly.
  121945. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121946. */
  121947. refDistance: number;
  121948. /**
  121949. * Define the roll off factor of spatial sounds.
  121950. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121951. */
  121952. rolloffFactor: number;
  121953. /**
  121954. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121955. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121956. */
  121957. maxDistance: number;
  121958. /**
  121959. * Define the distance attenuation model the sound will follow.
  121960. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121961. */
  121962. distanceModel: string;
  121963. /**
  121964. * @hidden
  121965. * Back Compat
  121966. **/
  121967. onended: () => any;
  121968. /**
  121969. * Gets or sets an object used to store user defined information for the sound.
  121970. */
  121971. metadata: any;
  121972. /**
  121973. * Observable event when the current playing sound finishes.
  121974. */
  121975. onEndedObservable: Observable<Sound>;
  121976. private _panningModel;
  121977. private _playbackRate;
  121978. private _streaming;
  121979. private _startTime;
  121980. private _startOffset;
  121981. private _position;
  121982. /** @hidden */
  121983. _positionInEmitterSpace: boolean;
  121984. private _localDirection;
  121985. private _volume;
  121986. private _isReadyToPlay;
  121987. private _isDirectional;
  121988. private _readyToPlayCallback;
  121989. private _audioBuffer;
  121990. private _soundSource;
  121991. private _streamingSource;
  121992. private _soundPanner;
  121993. private _soundGain;
  121994. private _inputAudioNode;
  121995. private _outputAudioNode;
  121996. private _coneInnerAngle;
  121997. private _coneOuterAngle;
  121998. private _coneOuterGain;
  121999. private _scene;
  122000. private _connectedTransformNode;
  122001. private _customAttenuationFunction;
  122002. private _registerFunc;
  122003. private _isOutputConnected;
  122004. private _htmlAudioElement;
  122005. private _urlType;
  122006. private _length?;
  122007. private _offset?;
  122008. /** @hidden */
  122009. static _SceneComponentInitialization: (scene: Scene) => void;
  122010. /**
  122011. * Create a sound and attach it to a scene
  122012. * @param name Name of your sound
  122013. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  122014. * @param scene defines the scene the sound belongs to
  122015. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  122016. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  122017. */
  122018. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  122019. /**
  122020. * Release the sound and its associated resources
  122021. */
  122022. dispose(): void;
  122023. /**
  122024. * Gets if the sounds is ready to be played or not.
  122025. * @returns true if ready, otherwise false
  122026. */
  122027. isReady(): boolean;
  122028. private _soundLoaded;
  122029. /**
  122030. * Sets the data of the sound from an audiobuffer
  122031. * @param audioBuffer The audioBuffer containing the data
  122032. */
  122033. setAudioBuffer(audioBuffer: AudioBuffer): void;
  122034. /**
  122035. * Updates the current sounds options such as maxdistance, loop...
  122036. * @param options A JSON object containing values named as the object properties
  122037. */
  122038. updateOptions(options: ISoundOptions): void;
  122039. private _createSpatialParameters;
  122040. private _updateSpatialParameters;
  122041. /**
  122042. * Switch the panning model to HRTF:
  122043. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  122044. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122045. */
  122046. switchPanningModelToHRTF(): void;
  122047. /**
  122048. * Switch the panning model to Equal Power:
  122049. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  122050. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122051. */
  122052. switchPanningModelToEqualPower(): void;
  122053. private _switchPanningModel;
  122054. /**
  122055. * Connect this sound to a sound track audio node like gain...
  122056. * @param soundTrackAudioNode the sound track audio node to connect to
  122057. */
  122058. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  122059. /**
  122060. * Transform this sound into a directional source
  122061. * @param coneInnerAngle Size of the inner cone in degree
  122062. * @param coneOuterAngle Size of the outer cone in degree
  122063. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  122064. */
  122065. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  122066. /**
  122067. * Gets or sets the inner angle for the directional cone.
  122068. */
  122069. get directionalConeInnerAngle(): number;
  122070. /**
  122071. * Gets or sets the inner angle for the directional cone.
  122072. */
  122073. set directionalConeInnerAngle(value: number);
  122074. /**
  122075. * Gets or sets the outer angle for the directional cone.
  122076. */
  122077. get directionalConeOuterAngle(): number;
  122078. /**
  122079. * Gets or sets the outer angle for the directional cone.
  122080. */
  122081. set directionalConeOuterAngle(value: number);
  122082. /**
  122083. * Sets the position of the emitter if spatial sound is enabled
  122084. * @param newPosition Defines the new posisiton
  122085. */
  122086. setPosition(newPosition: Vector3): void;
  122087. /**
  122088. * Sets the local direction of the emitter if spatial sound is enabled
  122089. * @param newLocalDirection Defines the new local direction
  122090. */
  122091. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  122092. private _updateDirection;
  122093. /** @hidden */
  122094. updateDistanceFromListener(): void;
  122095. /**
  122096. * Sets a new custom attenuation function for the sound.
  122097. * @param callback Defines the function used for the attenuation
  122098. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  122099. */
  122100. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  122101. /**
  122102. * Play the sound
  122103. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  122104. * @param offset (optional) Start the sound at a specific time in seconds
  122105. * @param length (optional) Sound duration (in seconds)
  122106. */
  122107. play(time?: number, offset?: number, length?: number): void;
  122108. private _onended;
  122109. /**
  122110. * Stop the sound
  122111. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  122112. */
  122113. stop(time?: number): void;
  122114. /**
  122115. * Put the sound in pause
  122116. */
  122117. pause(): void;
  122118. /**
  122119. * Sets a dedicated volume for this sounds
  122120. * @param newVolume Define the new volume of the sound
  122121. * @param time Define time for gradual change to new volume
  122122. */
  122123. setVolume(newVolume: number, time?: number): void;
  122124. /**
  122125. * Set the sound play back rate
  122126. * @param newPlaybackRate Define the playback rate the sound should be played at
  122127. */
  122128. setPlaybackRate(newPlaybackRate: number): void;
  122129. /**
  122130. * Gets the volume of the sound.
  122131. * @returns the volume of the sound
  122132. */
  122133. getVolume(): number;
  122134. /**
  122135. * Attach the sound to a dedicated mesh
  122136. * @param transformNode The transform node to connect the sound with
  122137. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  122138. */
  122139. attachToMesh(transformNode: TransformNode): void;
  122140. /**
  122141. * Detach the sound from the previously attached mesh
  122142. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  122143. */
  122144. detachFromMesh(): void;
  122145. private _onRegisterAfterWorldMatrixUpdate;
  122146. /**
  122147. * Clone the current sound in the scene.
  122148. * @returns the new sound clone
  122149. */
  122150. clone(): Nullable<Sound>;
  122151. /**
  122152. * Gets the current underlying audio buffer containing the data
  122153. * @returns the audio buffer
  122154. */
  122155. getAudioBuffer(): Nullable<AudioBuffer>;
  122156. /**
  122157. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  122158. * @returns the source node
  122159. */
  122160. getSoundSource(): Nullable<AudioBufferSourceNode>;
  122161. /**
  122162. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  122163. * @returns the gain node
  122164. */
  122165. getSoundGain(): Nullable<GainNode>;
  122166. /**
  122167. * Serializes the Sound in a JSON representation
  122168. * @returns the JSON representation of the sound
  122169. */
  122170. serialize(): any;
  122171. /**
  122172. * Parse a JSON representation of a sound to innstantiate in a given scene
  122173. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  122174. * @param scene Define the scene the new parsed sound should be created in
  122175. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  122176. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  122177. * @returns the newly parsed sound
  122178. */
  122179. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  122180. }
  122181. }
  122182. declare module BABYLON {
  122183. /**
  122184. * This defines an action helpful to play a defined sound on a triggered action.
  122185. */
  122186. export class PlaySoundAction extends Action {
  122187. private _sound;
  122188. /**
  122189. * Instantiate the action
  122190. * @param triggerOptions defines the trigger options
  122191. * @param sound defines the sound to play
  122192. * @param condition defines the trigger related conditions
  122193. */
  122194. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  122195. /** @hidden */
  122196. _prepare(): void;
  122197. /**
  122198. * Execute the action and play the sound.
  122199. */
  122200. execute(): void;
  122201. /**
  122202. * Serializes the actions and its related information.
  122203. * @param parent defines the object to serialize in
  122204. * @returns the serialized object
  122205. */
  122206. serialize(parent: any): any;
  122207. }
  122208. /**
  122209. * This defines an action helpful to stop a defined sound on a triggered action.
  122210. */
  122211. export class StopSoundAction extends Action {
  122212. private _sound;
  122213. /**
  122214. * Instantiate the action
  122215. * @param triggerOptions defines the trigger options
  122216. * @param sound defines the sound to stop
  122217. * @param condition defines the trigger related conditions
  122218. */
  122219. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  122220. /** @hidden */
  122221. _prepare(): void;
  122222. /**
  122223. * Execute the action and stop the sound.
  122224. */
  122225. execute(): void;
  122226. /**
  122227. * Serializes the actions and its related information.
  122228. * @param parent defines the object to serialize in
  122229. * @returns the serialized object
  122230. */
  122231. serialize(parent: any): any;
  122232. }
  122233. }
  122234. declare module BABYLON {
  122235. /**
  122236. * This defines an action responsible to change the value of a property
  122237. * by interpolating between its current value and the newly set one once triggered.
  122238. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  122239. */
  122240. export class InterpolateValueAction extends Action {
  122241. /**
  122242. * Defines the path of the property where the value should be interpolated
  122243. */
  122244. propertyPath: string;
  122245. /**
  122246. * Defines the target value at the end of the interpolation.
  122247. */
  122248. value: any;
  122249. /**
  122250. * Defines the time it will take for the property to interpolate to the value.
  122251. */
  122252. duration: number;
  122253. /**
  122254. * Defines if the other scene animations should be stopped when the action has been triggered
  122255. */
  122256. stopOtherAnimations?: boolean;
  122257. /**
  122258. * Defines a callback raised once the interpolation animation has been done.
  122259. */
  122260. onInterpolationDone?: () => void;
  122261. /**
  122262. * Observable triggered once the interpolation animation has been done.
  122263. */
  122264. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  122265. private _target;
  122266. private _effectiveTarget;
  122267. private _property;
  122268. /**
  122269. * Instantiate the action
  122270. * @param triggerOptions defines the trigger options
  122271. * @param target defines the object containing the value to interpolate
  122272. * @param propertyPath defines the path to the property in the target object
  122273. * @param value defines the target value at the end of the interpolation
  122274. * @param duration deines the time it will take for the property to interpolate to the value.
  122275. * @param condition defines the trigger related conditions
  122276. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  122277. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  122278. */
  122279. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  122280. /** @hidden */
  122281. _prepare(): void;
  122282. /**
  122283. * Execute the action starts the value interpolation.
  122284. */
  122285. execute(): void;
  122286. /**
  122287. * Serializes the actions and its related information.
  122288. * @param parent defines the object to serialize in
  122289. * @returns the serialized object
  122290. */
  122291. serialize(parent: any): any;
  122292. }
  122293. }
  122294. declare module BABYLON {
  122295. /**
  122296. * Options allowed during the creation of a sound track.
  122297. */
  122298. export interface ISoundTrackOptions {
  122299. /**
  122300. * The volume the sound track should take during creation
  122301. */
  122302. volume?: number;
  122303. /**
  122304. * Define if the sound track is the main sound track of the scene
  122305. */
  122306. mainTrack?: boolean;
  122307. }
  122308. /**
  122309. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  122310. * It will be also used in a future release to apply effects on a specific track.
  122311. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  122312. */
  122313. export class SoundTrack {
  122314. /**
  122315. * The unique identifier of the sound track in the scene.
  122316. */
  122317. id: number;
  122318. /**
  122319. * The list of sounds included in the sound track.
  122320. */
  122321. soundCollection: Array<Sound>;
  122322. private _outputAudioNode;
  122323. private _scene;
  122324. private _connectedAnalyser;
  122325. private _options;
  122326. private _isInitialized;
  122327. /**
  122328. * Creates a new sound track.
  122329. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  122330. * @param scene Define the scene the sound track belongs to
  122331. * @param options
  122332. */
  122333. constructor(scene: Scene, options?: ISoundTrackOptions);
  122334. private _initializeSoundTrackAudioGraph;
  122335. /**
  122336. * Release the sound track and its associated resources
  122337. */
  122338. dispose(): void;
  122339. /**
  122340. * Adds a sound to this sound track
  122341. * @param sound define the cound to add
  122342. * @ignoreNaming
  122343. */
  122344. AddSound(sound: Sound): void;
  122345. /**
  122346. * Removes a sound to this sound track
  122347. * @param sound define the cound to remove
  122348. * @ignoreNaming
  122349. */
  122350. RemoveSound(sound: Sound): void;
  122351. /**
  122352. * Set a global volume for the full sound track.
  122353. * @param newVolume Define the new volume of the sound track
  122354. */
  122355. setVolume(newVolume: number): void;
  122356. /**
  122357. * Switch the panning model to HRTF:
  122358. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  122359. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122360. */
  122361. switchPanningModelToHRTF(): void;
  122362. /**
  122363. * Switch the panning model to Equal Power:
  122364. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  122365. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122366. */
  122367. switchPanningModelToEqualPower(): void;
  122368. /**
  122369. * Connect the sound track to an audio analyser allowing some amazing
  122370. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  122371. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  122372. * @param analyser The analyser to connect to the engine
  122373. */
  122374. connectToAnalyser(analyser: Analyser): void;
  122375. }
  122376. }
  122377. declare module BABYLON {
  122378. interface AbstractScene {
  122379. /**
  122380. * The list of sounds used in the scene.
  122381. */
  122382. sounds: Nullable<Array<Sound>>;
  122383. }
  122384. interface Scene {
  122385. /**
  122386. * @hidden
  122387. * Backing field
  122388. */
  122389. _mainSoundTrack: SoundTrack;
  122390. /**
  122391. * The main sound track played by the scene.
  122392. * It cotains your primary collection of sounds.
  122393. */
  122394. mainSoundTrack: SoundTrack;
  122395. /**
  122396. * The list of sound tracks added to the scene
  122397. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122398. */
  122399. soundTracks: Nullable<Array<SoundTrack>>;
  122400. /**
  122401. * Gets a sound using a given name
  122402. * @param name defines the name to search for
  122403. * @return the found sound or null if not found at all.
  122404. */
  122405. getSoundByName(name: string): Nullable<Sound>;
  122406. /**
  122407. * Gets or sets if audio support is enabled
  122408. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122409. */
  122410. audioEnabled: boolean;
  122411. /**
  122412. * Gets or sets if audio will be output to headphones
  122413. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122414. */
  122415. headphone: boolean;
  122416. /**
  122417. * Gets or sets custom audio listener position provider
  122418. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122419. */
  122420. audioListenerPositionProvider: Nullable<() => Vector3>;
  122421. /**
  122422. * Gets or sets a refresh rate when using 3D audio positioning
  122423. */
  122424. audioPositioningRefreshRate: number;
  122425. }
  122426. /**
  122427. * Defines the sound scene component responsible to manage any sounds
  122428. * in a given scene.
  122429. */
  122430. export class AudioSceneComponent implements ISceneSerializableComponent {
  122431. private static _CameraDirectionLH;
  122432. private static _CameraDirectionRH;
  122433. /**
  122434. * The component name helpfull to identify the component in the list of scene components.
  122435. */
  122436. readonly name: string;
  122437. /**
  122438. * The scene the component belongs to.
  122439. */
  122440. scene: Scene;
  122441. private _audioEnabled;
  122442. /**
  122443. * Gets whether audio is enabled or not.
  122444. * Please use related enable/disable method to switch state.
  122445. */
  122446. get audioEnabled(): boolean;
  122447. private _headphone;
  122448. /**
  122449. * Gets whether audio is outputing to headphone or not.
  122450. * Please use the according Switch methods to change output.
  122451. */
  122452. get headphone(): boolean;
  122453. /**
  122454. * Gets or sets a refresh rate when using 3D audio positioning
  122455. */
  122456. audioPositioningRefreshRate: number;
  122457. private _audioListenerPositionProvider;
  122458. /**
  122459. * Gets the current audio listener position provider
  122460. */
  122461. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  122462. /**
  122463. * Sets a custom listener position for all sounds in the scene
  122464. * By default, this is the position of the first active camera
  122465. */
  122466. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  122467. /**
  122468. * Creates a new instance of the component for the given scene
  122469. * @param scene Defines the scene to register the component in
  122470. */
  122471. constructor(scene: Scene);
  122472. /**
  122473. * Registers the component in a given scene
  122474. */
  122475. register(): void;
  122476. /**
  122477. * Rebuilds the elements related to this component in case of
  122478. * context lost for instance.
  122479. */
  122480. rebuild(): void;
  122481. /**
  122482. * Serializes the component data to the specified json object
  122483. * @param serializationObject The object to serialize to
  122484. */
  122485. serialize(serializationObject: any): void;
  122486. /**
  122487. * Adds all the elements from the container to the scene
  122488. * @param container the container holding the elements
  122489. */
  122490. addFromContainer(container: AbstractScene): void;
  122491. /**
  122492. * Removes all the elements in the container from the scene
  122493. * @param container contains the elements to remove
  122494. * @param dispose if the removed element should be disposed (default: false)
  122495. */
  122496. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  122497. /**
  122498. * Disposes the component and the associated ressources.
  122499. */
  122500. dispose(): void;
  122501. /**
  122502. * Disables audio in the associated scene.
  122503. */
  122504. disableAudio(): void;
  122505. /**
  122506. * Enables audio in the associated scene.
  122507. */
  122508. enableAudio(): void;
  122509. /**
  122510. * Switch audio to headphone output.
  122511. */
  122512. switchAudioModeForHeadphones(): void;
  122513. /**
  122514. * Switch audio to normal speakers.
  122515. */
  122516. switchAudioModeForNormalSpeakers(): void;
  122517. private _cachedCameraDirection;
  122518. private _cachedCameraPosition;
  122519. private _lastCheck;
  122520. private _afterRender;
  122521. }
  122522. }
  122523. declare module BABYLON {
  122524. /**
  122525. * Wraps one or more Sound objects and selects one with random weight for playback.
  122526. */
  122527. export class WeightedSound {
  122528. /** When true a Sound will be selected and played when the current playing Sound completes. */
  122529. loop: boolean;
  122530. private _coneInnerAngle;
  122531. private _coneOuterAngle;
  122532. private _volume;
  122533. /** A Sound is currently playing. */
  122534. isPlaying: boolean;
  122535. /** A Sound is currently paused. */
  122536. isPaused: boolean;
  122537. private _sounds;
  122538. private _weights;
  122539. private _currentIndex?;
  122540. /**
  122541. * Creates a new WeightedSound from the list of sounds given.
  122542. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  122543. * @param sounds Array of Sounds that will be selected from.
  122544. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  122545. */
  122546. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  122547. /**
  122548. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  122549. */
  122550. get directionalConeInnerAngle(): number;
  122551. /**
  122552. * The size of cone in degress for a directional sound in which there will be no attenuation.
  122553. */
  122554. set directionalConeInnerAngle(value: number);
  122555. /**
  122556. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  122557. * Listener angles between innerAngle and outerAngle will falloff linearly.
  122558. */
  122559. get directionalConeOuterAngle(): number;
  122560. /**
  122561. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  122562. * Listener angles between innerAngle and outerAngle will falloff linearly.
  122563. */
  122564. set directionalConeOuterAngle(value: number);
  122565. /**
  122566. * Playback volume.
  122567. */
  122568. get volume(): number;
  122569. /**
  122570. * Playback volume.
  122571. */
  122572. set volume(value: number);
  122573. private _onended;
  122574. /**
  122575. * Suspend playback
  122576. */
  122577. pause(): void;
  122578. /**
  122579. * Stop playback
  122580. */
  122581. stop(): void;
  122582. /**
  122583. * Start playback.
  122584. * @param startOffset Position the clip head at a specific time in seconds.
  122585. */
  122586. play(startOffset?: number): void;
  122587. }
  122588. }
  122589. declare module BABYLON {
  122590. /**
  122591. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  122592. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122593. */
  122594. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  122595. /**
  122596. * Gets the name of the behavior.
  122597. */
  122598. get name(): string;
  122599. /**
  122600. * The easing function used by animations
  122601. */
  122602. static EasingFunction: BackEase;
  122603. /**
  122604. * The easing mode used by animations
  122605. */
  122606. static EasingMode: number;
  122607. /**
  122608. * The duration of the animation, in milliseconds
  122609. */
  122610. transitionDuration: number;
  122611. /**
  122612. * Length of the distance animated by the transition when lower radius is reached
  122613. */
  122614. lowerRadiusTransitionRange: number;
  122615. /**
  122616. * Length of the distance animated by the transition when upper radius is reached
  122617. */
  122618. upperRadiusTransitionRange: number;
  122619. private _autoTransitionRange;
  122620. /**
  122621. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  122622. */
  122623. get autoTransitionRange(): boolean;
  122624. /**
  122625. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  122626. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  122627. */
  122628. set autoTransitionRange(value: boolean);
  122629. private _attachedCamera;
  122630. private _onAfterCheckInputsObserver;
  122631. private _onMeshTargetChangedObserver;
  122632. /**
  122633. * Initializes the behavior.
  122634. */
  122635. init(): void;
  122636. /**
  122637. * Attaches the behavior to its arc rotate camera.
  122638. * @param camera Defines the camera to attach the behavior to
  122639. */
  122640. attach(camera: ArcRotateCamera): void;
  122641. /**
  122642. * Detaches the behavior from its current arc rotate camera.
  122643. */
  122644. detach(): void;
  122645. private _radiusIsAnimating;
  122646. private _radiusBounceTransition;
  122647. private _animatables;
  122648. private _cachedWheelPrecision;
  122649. /**
  122650. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  122651. * @param radiusLimit The limit to check against.
  122652. * @return Bool to indicate if at limit.
  122653. */
  122654. private _isRadiusAtLimit;
  122655. /**
  122656. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  122657. * @param radiusDelta The delta by which to animate to. Can be negative.
  122658. */
  122659. private _applyBoundRadiusAnimation;
  122660. /**
  122661. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  122662. */
  122663. protected _clearAnimationLocks(): void;
  122664. /**
  122665. * Stops and removes all animations that have been applied to the camera
  122666. */
  122667. stopAllAnimations(): void;
  122668. }
  122669. }
  122670. declare module BABYLON {
  122671. /**
  122672. * 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.
  122673. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122674. */
  122675. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  122676. /**
  122677. * Gets the name of the behavior.
  122678. */
  122679. get name(): string;
  122680. private _mode;
  122681. private _radiusScale;
  122682. private _positionScale;
  122683. private _defaultElevation;
  122684. private _elevationReturnTime;
  122685. private _elevationReturnWaitTime;
  122686. private _zoomStopsAnimation;
  122687. private _framingTime;
  122688. /**
  122689. * The easing function used by animations
  122690. */
  122691. static EasingFunction: ExponentialEase;
  122692. /**
  122693. * The easing mode used by animations
  122694. */
  122695. static EasingMode: number;
  122696. /**
  122697. * Sets the current mode used by the behavior
  122698. */
  122699. set mode(mode: number);
  122700. /**
  122701. * Gets current mode used by the behavior.
  122702. */
  122703. get mode(): number;
  122704. /**
  122705. * Sets the scale applied to the radius (1 by default)
  122706. */
  122707. set radiusScale(radius: number);
  122708. /**
  122709. * Gets the scale applied to the radius
  122710. */
  122711. get radiusScale(): number;
  122712. /**
  122713. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122714. */
  122715. set positionScale(scale: number);
  122716. /**
  122717. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122718. */
  122719. get positionScale(): number;
  122720. /**
  122721. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122722. * behaviour is triggered, in radians.
  122723. */
  122724. set defaultElevation(elevation: number);
  122725. /**
  122726. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122727. * behaviour is triggered, in radians.
  122728. */
  122729. get defaultElevation(): number;
  122730. /**
  122731. * Sets the time (in milliseconds) taken to return to the default beta position.
  122732. * Negative value indicates camera should not return to default.
  122733. */
  122734. set elevationReturnTime(speed: number);
  122735. /**
  122736. * Gets the time (in milliseconds) taken to return to the default beta position.
  122737. * Negative value indicates camera should not return to default.
  122738. */
  122739. get elevationReturnTime(): number;
  122740. /**
  122741. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122742. */
  122743. set elevationReturnWaitTime(time: number);
  122744. /**
  122745. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122746. */
  122747. get elevationReturnWaitTime(): number;
  122748. /**
  122749. * Sets the flag that indicates if user zooming should stop animation.
  122750. */
  122751. set zoomStopsAnimation(flag: boolean);
  122752. /**
  122753. * Gets the flag that indicates if user zooming should stop animation.
  122754. */
  122755. get zoomStopsAnimation(): boolean;
  122756. /**
  122757. * Sets the transition time when framing the mesh, in milliseconds
  122758. */
  122759. set framingTime(time: number);
  122760. /**
  122761. * Gets the transition time when framing the mesh, in milliseconds
  122762. */
  122763. get framingTime(): number;
  122764. /**
  122765. * Define if the behavior should automatically change the configured
  122766. * camera limits and sensibilities.
  122767. */
  122768. autoCorrectCameraLimitsAndSensibility: boolean;
  122769. private _onPrePointerObservableObserver;
  122770. private _onAfterCheckInputsObserver;
  122771. private _onMeshTargetChangedObserver;
  122772. private _attachedCamera;
  122773. private _isPointerDown;
  122774. private _lastInteractionTime;
  122775. /**
  122776. * Initializes the behavior.
  122777. */
  122778. init(): void;
  122779. /**
  122780. * Attaches the behavior to its arc rotate camera.
  122781. * @param camera Defines the camera to attach the behavior to
  122782. */
  122783. attach(camera: ArcRotateCamera): void;
  122784. /**
  122785. * Detaches the behavior from its current arc rotate camera.
  122786. */
  122787. detach(): void;
  122788. private _animatables;
  122789. private _betaIsAnimating;
  122790. private _betaTransition;
  122791. private _radiusTransition;
  122792. private _vectorTransition;
  122793. /**
  122794. * Targets the given mesh and updates zoom level accordingly.
  122795. * @param mesh The mesh to target.
  122796. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122797. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122798. */
  122799. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122800. /**
  122801. * Targets the given mesh with its children and updates zoom level accordingly.
  122802. * @param mesh The mesh to target.
  122803. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122804. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122805. */
  122806. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122807. /**
  122808. * Targets the given meshes with their children and updates zoom level accordingly.
  122809. * @param meshes The mesh to target.
  122810. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122811. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122812. */
  122813. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122814. /**
  122815. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122816. * @param minimumWorld Determines the smaller position of the bounding box extend
  122817. * @param maximumWorld Determines the bigger position of the bounding box extend
  122818. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122819. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122820. */
  122821. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122822. /**
  122823. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122824. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122825. * frustum width.
  122826. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122827. * to fully enclose the mesh in the viewing frustum.
  122828. */
  122829. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122830. /**
  122831. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122832. * is automatically returned to its default position (expected to be above ground plane).
  122833. */
  122834. private _maintainCameraAboveGround;
  122835. /**
  122836. * Returns the frustum slope based on the canvas ratio and camera FOV
  122837. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122838. */
  122839. private _getFrustumSlope;
  122840. /**
  122841. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122842. */
  122843. private _clearAnimationLocks;
  122844. /**
  122845. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122846. */
  122847. private _applyUserInteraction;
  122848. /**
  122849. * Stops and removes all animations that have been applied to the camera
  122850. */
  122851. stopAllAnimations(): void;
  122852. /**
  122853. * Gets a value indicating if the user is moving the camera
  122854. */
  122855. get isUserIsMoving(): boolean;
  122856. /**
  122857. * The camera can move all the way towards the mesh.
  122858. */
  122859. static IgnoreBoundsSizeMode: number;
  122860. /**
  122861. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122862. */
  122863. static FitFrustumSidesMode: number;
  122864. }
  122865. }
  122866. declare module BABYLON {
  122867. /**
  122868. * Base class for Camera Pointer Inputs.
  122869. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122870. * for example usage.
  122871. */
  122872. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122873. /**
  122874. * Defines the camera the input is attached to.
  122875. */
  122876. abstract camera: Camera;
  122877. /**
  122878. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122879. */
  122880. protected _altKey: boolean;
  122881. protected _ctrlKey: boolean;
  122882. protected _metaKey: boolean;
  122883. protected _shiftKey: boolean;
  122884. /**
  122885. * Which mouse buttons were pressed at time of last mouse event.
  122886. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122887. */
  122888. protected _buttonsPressed: number;
  122889. /**
  122890. * Defines the buttons associated with the input to handle camera move.
  122891. */
  122892. buttons: number[];
  122893. /**
  122894. * Attach the input controls to a specific dom element to get the input from.
  122895. * @param element Defines the element the controls should be listened from
  122896. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122897. */
  122898. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122899. /**
  122900. * Detach the current controls from the specified dom element.
  122901. * @param element Defines the element to stop listening the inputs from
  122902. */
  122903. detachControl(element: Nullable<HTMLElement>): void;
  122904. /**
  122905. * Gets the class name of the current input.
  122906. * @returns the class name
  122907. */
  122908. getClassName(): string;
  122909. /**
  122910. * Get the friendly name associated with the input class.
  122911. * @returns the input friendly name
  122912. */
  122913. getSimpleName(): string;
  122914. /**
  122915. * Called on pointer POINTERDOUBLETAP event.
  122916. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122917. */
  122918. protected onDoubleTap(type: string): void;
  122919. /**
  122920. * Called on pointer POINTERMOVE event if only a single touch is active.
  122921. * Override this method to provide functionality.
  122922. */
  122923. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122924. /**
  122925. * Called on pointer POINTERMOVE event if multiple touches are active.
  122926. * Override this method to provide functionality.
  122927. */
  122928. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122929. /**
  122930. * Called on JS contextmenu event.
  122931. * Override this method to provide functionality.
  122932. */
  122933. protected onContextMenu(evt: PointerEvent): void;
  122934. /**
  122935. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122936. * press.
  122937. * Override this method to provide functionality.
  122938. */
  122939. protected onButtonDown(evt: PointerEvent): void;
  122940. /**
  122941. * Called each time a new POINTERUP event occurs. Ie, for each button
  122942. * release.
  122943. * Override this method to provide functionality.
  122944. */
  122945. protected onButtonUp(evt: PointerEvent): void;
  122946. /**
  122947. * Called when window becomes inactive.
  122948. * Override this method to provide functionality.
  122949. */
  122950. protected onLostFocus(): void;
  122951. private _pointerInput;
  122952. private _observer;
  122953. private _onLostFocus;
  122954. private pointA;
  122955. private pointB;
  122956. }
  122957. }
  122958. declare module BABYLON {
  122959. /**
  122960. * Manage the pointers inputs to control an arc rotate camera.
  122961. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122962. */
  122963. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122964. /**
  122965. * Defines the camera the input is attached to.
  122966. */
  122967. camera: ArcRotateCamera;
  122968. /**
  122969. * Gets the class name of the current input.
  122970. * @returns the class name
  122971. */
  122972. getClassName(): string;
  122973. /**
  122974. * Defines the buttons associated with the input to handle camera move.
  122975. */
  122976. buttons: number[];
  122977. /**
  122978. * Defines the pointer angular sensibility along the X axis or how fast is
  122979. * the camera rotating.
  122980. */
  122981. angularSensibilityX: number;
  122982. /**
  122983. * Defines the pointer angular sensibility along the Y axis or how fast is
  122984. * the camera rotating.
  122985. */
  122986. angularSensibilityY: number;
  122987. /**
  122988. * Defines the pointer pinch precision or how fast is the camera zooming.
  122989. */
  122990. pinchPrecision: number;
  122991. /**
  122992. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122993. * from 0.
  122994. * It defines the percentage of current camera.radius to use as delta when
  122995. * pinch zoom is used.
  122996. */
  122997. pinchDeltaPercentage: number;
  122998. /**
  122999. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  123000. * that any object in the plane at the camera's target point will scale
  123001. * perfectly with finger motion.
  123002. * Overrides pinchDeltaPercentage and pinchPrecision.
  123003. */
  123004. useNaturalPinchZoom: boolean;
  123005. /**
  123006. * Defines the pointer panning sensibility or how fast is the camera moving.
  123007. */
  123008. panningSensibility: number;
  123009. /**
  123010. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  123011. */
  123012. multiTouchPanning: boolean;
  123013. /**
  123014. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  123015. * zoom (pinch) through multitouch.
  123016. */
  123017. multiTouchPanAndZoom: boolean;
  123018. /**
  123019. * Revers pinch action direction.
  123020. */
  123021. pinchInwards: boolean;
  123022. private _isPanClick;
  123023. private _twoFingerActivityCount;
  123024. private _isPinching;
  123025. /**
  123026. * Called on pointer POINTERMOVE event if only a single touch is active.
  123027. */
  123028. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  123029. /**
  123030. * Called on pointer POINTERDOUBLETAP event.
  123031. */
  123032. protected onDoubleTap(type: string): void;
  123033. /**
  123034. * Called on pointer POINTERMOVE event if multiple touches are active.
  123035. */
  123036. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  123037. /**
  123038. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  123039. * press.
  123040. */
  123041. protected onButtonDown(evt: PointerEvent): void;
  123042. /**
  123043. * Called each time a new POINTERUP event occurs. Ie, for each button
  123044. * release.
  123045. */
  123046. protected onButtonUp(evt: PointerEvent): void;
  123047. /**
  123048. * Called when window becomes inactive.
  123049. */
  123050. protected onLostFocus(): void;
  123051. }
  123052. }
  123053. declare module BABYLON {
  123054. /**
  123055. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  123056. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123057. */
  123058. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  123059. /**
  123060. * Defines the camera the input is attached to.
  123061. */
  123062. camera: ArcRotateCamera;
  123063. /**
  123064. * Defines the list of key codes associated with the up action (increase alpha)
  123065. */
  123066. keysUp: number[];
  123067. /**
  123068. * Defines the list of key codes associated with the down action (decrease alpha)
  123069. */
  123070. keysDown: number[];
  123071. /**
  123072. * Defines the list of key codes associated with the left action (increase beta)
  123073. */
  123074. keysLeft: number[];
  123075. /**
  123076. * Defines the list of key codes associated with the right action (decrease beta)
  123077. */
  123078. keysRight: number[];
  123079. /**
  123080. * Defines the list of key codes associated with the reset action.
  123081. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  123082. */
  123083. keysReset: number[];
  123084. /**
  123085. * Defines the panning sensibility of the inputs.
  123086. * (How fast is the camera panning)
  123087. */
  123088. panningSensibility: number;
  123089. /**
  123090. * Defines the zooming sensibility of the inputs.
  123091. * (How fast is the camera zooming)
  123092. */
  123093. zoomingSensibility: number;
  123094. /**
  123095. * Defines whether maintaining the alt key down switch the movement mode from
  123096. * orientation to zoom.
  123097. */
  123098. useAltToZoom: boolean;
  123099. /**
  123100. * Rotation speed of the camera
  123101. */
  123102. angularSpeed: number;
  123103. private _keys;
  123104. private _ctrlPressed;
  123105. private _altPressed;
  123106. private _onCanvasBlurObserver;
  123107. private _onKeyboardObserver;
  123108. private _engine;
  123109. private _scene;
  123110. /**
  123111. * Attach the input controls to a specific dom element to get the input from.
  123112. * @param element Defines the element the controls should be listened from
  123113. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123114. */
  123115. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123116. /**
  123117. * Detach the current controls from the specified dom element.
  123118. * @param element Defines the element to stop listening the inputs from
  123119. */
  123120. detachControl(element: Nullable<HTMLElement>): void;
  123121. /**
  123122. * Update the current camera state depending on the inputs that have been used this frame.
  123123. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123124. */
  123125. checkInputs(): void;
  123126. /**
  123127. * Gets the class name of the current intput.
  123128. * @returns the class name
  123129. */
  123130. getClassName(): string;
  123131. /**
  123132. * Get the friendly name associated with the input class.
  123133. * @returns the input friendly name
  123134. */
  123135. getSimpleName(): string;
  123136. }
  123137. }
  123138. declare module BABYLON {
  123139. /**
  123140. * Manage the mouse wheel inputs to control an arc rotate camera.
  123141. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123142. */
  123143. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  123144. /**
  123145. * Defines the camera the input is attached to.
  123146. */
  123147. camera: ArcRotateCamera;
  123148. /**
  123149. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  123150. */
  123151. wheelPrecision: number;
  123152. /**
  123153. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  123154. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  123155. */
  123156. wheelDeltaPercentage: number;
  123157. private _wheel;
  123158. private _observer;
  123159. private computeDeltaFromMouseWheelLegacyEvent;
  123160. /**
  123161. * Attach the input controls to a specific dom element to get the input from.
  123162. * @param element Defines the element the controls should be listened from
  123163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123164. */
  123165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123166. /**
  123167. * Detach the current controls from the specified dom element.
  123168. * @param element Defines the element to stop listening the inputs from
  123169. */
  123170. detachControl(element: Nullable<HTMLElement>): void;
  123171. /**
  123172. * Gets the class name of the current intput.
  123173. * @returns the class name
  123174. */
  123175. getClassName(): string;
  123176. /**
  123177. * Get the friendly name associated with the input class.
  123178. * @returns the input friendly name
  123179. */
  123180. getSimpleName(): string;
  123181. }
  123182. }
  123183. declare module BABYLON {
  123184. /**
  123185. * Default Inputs manager for the ArcRotateCamera.
  123186. * It groups all the default supported inputs for ease of use.
  123187. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123188. */
  123189. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  123190. /**
  123191. * Instantiates a new ArcRotateCameraInputsManager.
  123192. * @param camera Defines the camera the inputs belong to
  123193. */
  123194. constructor(camera: ArcRotateCamera);
  123195. /**
  123196. * Add mouse wheel input support to the input manager.
  123197. * @returns the current input manager
  123198. */
  123199. addMouseWheel(): ArcRotateCameraInputsManager;
  123200. /**
  123201. * Add pointers input support to the input manager.
  123202. * @returns the current input manager
  123203. */
  123204. addPointers(): ArcRotateCameraInputsManager;
  123205. /**
  123206. * Add keyboard input support to the input manager.
  123207. * @returns the current input manager
  123208. */
  123209. addKeyboard(): ArcRotateCameraInputsManager;
  123210. }
  123211. }
  123212. declare module BABYLON {
  123213. /**
  123214. * This represents an orbital type of camera.
  123215. *
  123216. * 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.
  123217. * 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.
  123218. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  123219. */
  123220. export class ArcRotateCamera extends TargetCamera {
  123221. /**
  123222. * Defines the rotation angle of the camera along the longitudinal axis.
  123223. */
  123224. alpha: number;
  123225. /**
  123226. * Defines the rotation angle of the camera along the latitudinal axis.
  123227. */
  123228. beta: number;
  123229. /**
  123230. * Defines the radius of the camera from it s target point.
  123231. */
  123232. radius: number;
  123233. protected _target: Vector3;
  123234. protected _targetHost: Nullable<AbstractMesh>;
  123235. /**
  123236. * Defines the target point of the camera.
  123237. * The camera looks towards it form the radius distance.
  123238. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  123239. */
  123240. get target(): Vector3;
  123241. set target(value: Vector3);
  123242. /**
  123243. * Define the current local position of the camera in the scene
  123244. */
  123245. get position(): Vector3;
  123246. set position(newPosition: Vector3);
  123247. protected _upToYMatrix: Matrix;
  123248. protected _YToUpMatrix: Matrix;
  123249. /**
  123250. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  123251. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  123252. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  123253. */
  123254. set upVector(vec: Vector3);
  123255. get upVector(): Vector3;
  123256. /**
  123257. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  123258. */
  123259. setMatUp(): void;
  123260. /**
  123261. * Current inertia value on the longitudinal axis.
  123262. * The bigger this number the longer it will take for the camera to stop.
  123263. */
  123264. inertialAlphaOffset: number;
  123265. /**
  123266. * Current inertia value on the latitudinal axis.
  123267. * The bigger this number the longer it will take for the camera to stop.
  123268. */
  123269. inertialBetaOffset: number;
  123270. /**
  123271. * Current inertia value on the radius axis.
  123272. * The bigger this number the longer it will take for the camera to stop.
  123273. */
  123274. inertialRadiusOffset: number;
  123275. /**
  123276. * Minimum allowed angle on the longitudinal axis.
  123277. * This can help limiting how the Camera is able to move in the scene.
  123278. */
  123279. lowerAlphaLimit: Nullable<number>;
  123280. /**
  123281. * Maximum allowed angle on the longitudinal axis.
  123282. * This can help limiting how the Camera is able to move in the scene.
  123283. */
  123284. upperAlphaLimit: Nullable<number>;
  123285. /**
  123286. * Minimum allowed angle on the latitudinal axis.
  123287. * This can help limiting how the Camera is able to move in the scene.
  123288. */
  123289. lowerBetaLimit: number;
  123290. /**
  123291. * Maximum allowed angle on the latitudinal axis.
  123292. * This can help limiting how the Camera is able to move in the scene.
  123293. */
  123294. upperBetaLimit: number;
  123295. /**
  123296. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  123297. * This can help limiting how the Camera is able to move in the scene.
  123298. */
  123299. lowerRadiusLimit: Nullable<number>;
  123300. /**
  123301. * Maximum allowed distance of the camera to the target (The camera can not get further).
  123302. * This can help limiting how the Camera is able to move in the scene.
  123303. */
  123304. upperRadiusLimit: Nullable<number>;
  123305. /**
  123306. * Defines the current inertia value used during panning of the camera along the X axis.
  123307. */
  123308. inertialPanningX: number;
  123309. /**
  123310. * Defines the current inertia value used during panning of the camera along the Y axis.
  123311. */
  123312. inertialPanningY: number;
  123313. /**
  123314. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  123315. * Basically if your fingers moves away from more than this distance you will be considered
  123316. * in pinch mode.
  123317. */
  123318. pinchToPanMaxDistance: number;
  123319. /**
  123320. * Defines the maximum distance the camera can pan.
  123321. * This could help keeping the cammera always in your scene.
  123322. */
  123323. panningDistanceLimit: Nullable<number>;
  123324. /**
  123325. * Defines the target of the camera before paning.
  123326. */
  123327. panningOriginTarget: Vector3;
  123328. /**
  123329. * Defines the value of the inertia used during panning.
  123330. * 0 would mean stop inertia and one would mean no decelleration at all.
  123331. */
  123332. panningInertia: number;
  123333. /**
  123334. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  123335. */
  123336. get angularSensibilityX(): number;
  123337. set angularSensibilityX(value: number);
  123338. /**
  123339. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  123340. */
  123341. get angularSensibilityY(): number;
  123342. set angularSensibilityY(value: number);
  123343. /**
  123344. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  123345. */
  123346. get pinchPrecision(): number;
  123347. set pinchPrecision(value: number);
  123348. /**
  123349. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  123350. * It will be used instead of pinchDeltaPrecision if different from 0.
  123351. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  123352. */
  123353. get pinchDeltaPercentage(): number;
  123354. set pinchDeltaPercentage(value: number);
  123355. /**
  123356. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  123357. * and pinch delta percentage.
  123358. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  123359. * that any object in the plane at the camera's target point will scale
  123360. * perfectly with finger motion.
  123361. */
  123362. get useNaturalPinchZoom(): boolean;
  123363. set useNaturalPinchZoom(value: boolean);
  123364. /**
  123365. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  123366. */
  123367. get panningSensibility(): number;
  123368. set panningSensibility(value: number);
  123369. /**
  123370. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  123371. */
  123372. get keysUp(): number[];
  123373. set keysUp(value: number[]);
  123374. /**
  123375. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  123376. */
  123377. get keysDown(): number[];
  123378. set keysDown(value: number[]);
  123379. /**
  123380. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  123381. */
  123382. get keysLeft(): number[];
  123383. set keysLeft(value: number[]);
  123384. /**
  123385. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  123386. */
  123387. get keysRight(): number[];
  123388. set keysRight(value: number[]);
  123389. /**
  123390. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  123391. */
  123392. get wheelPrecision(): number;
  123393. set wheelPrecision(value: number);
  123394. /**
  123395. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  123396. * It will be used instead of pinchDeltaPrecision if different from 0.
  123397. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  123398. */
  123399. get wheelDeltaPercentage(): number;
  123400. set wheelDeltaPercentage(value: number);
  123401. /**
  123402. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  123403. */
  123404. zoomOnFactor: number;
  123405. /**
  123406. * Defines a screen offset for the camera position.
  123407. */
  123408. targetScreenOffset: Vector2;
  123409. /**
  123410. * Allows the camera to be completely reversed.
  123411. * If false the camera can not arrive upside down.
  123412. */
  123413. allowUpsideDown: boolean;
  123414. /**
  123415. * Define if double tap/click is used to restore the previously saved state of the camera.
  123416. */
  123417. useInputToRestoreState: boolean;
  123418. /** @hidden */
  123419. _viewMatrix: Matrix;
  123420. /** @hidden */
  123421. _useCtrlForPanning: boolean;
  123422. /** @hidden */
  123423. _panningMouseButton: number;
  123424. /**
  123425. * Defines the input associated to the camera.
  123426. */
  123427. inputs: ArcRotateCameraInputsManager;
  123428. /** @hidden */
  123429. _reset: () => void;
  123430. /**
  123431. * Defines the allowed panning axis.
  123432. */
  123433. panningAxis: Vector3;
  123434. protected _localDirection: Vector3;
  123435. protected _transformedDirection: Vector3;
  123436. private _bouncingBehavior;
  123437. /**
  123438. * Gets the bouncing behavior of the camera if it has been enabled.
  123439. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  123440. */
  123441. get bouncingBehavior(): Nullable<BouncingBehavior>;
  123442. /**
  123443. * Defines if the bouncing behavior of the camera is enabled on the camera.
  123444. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  123445. */
  123446. get useBouncingBehavior(): boolean;
  123447. set useBouncingBehavior(value: boolean);
  123448. private _framingBehavior;
  123449. /**
  123450. * Gets the framing behavior of the camera if it has been enabled.
  123451. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  123452. */
  123453. get framingBehavior(): Nullable<FramingBehavior>;
  123454. /**
  123455. * Defines if the framing behavior of the camera is enabled on the camera.
  123456. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  123457. */
  123458. get useFramingBehavior(): boolean;
  123459. set useFramingBehavior(value: boolean);
  123460. private _autoRotationBehavior;
  123461. /**
  123462. * Gets the auto rotation behavior of the camera if it has been enabled.
  123463. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  123464. */
  123465. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  123466. /**
  123467. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  123468. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  123469. */
  123470. get useAutoRotationBehavior(): boolean;
  123471. set useAutoRotationBehavior(value: boolean);
  123472. /**
  123473. * Observable triggered when the mesh target has been changed on the camera.
  123474. */
  123475. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  123476. /**
  123477. * Event raised when the camera is colliding with a mesh.
  123478. */
  123479. onCollide: (collidedMesh: AbstractMesh) => void;
  123480. /**
  123481. * Defines whether the camera should check collision with the objects oh the scene.
  123482. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  123483. */
  123484. checkCollisions: boolean;
  123485. /**
  123486. * Defines the collision radius of the camera.
  123487. * This simulates a sphere around the camera.
  123488. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123489. */
  123490. collisionRadius: Vector3;
  123491. protected _collider: Collider;
  123492. protected _previousPosition: Vector3;
  123493. protected _collisionVelocity: Vector3;
  123494. protected _newPosition: Vector3;
  123495. protected _previousAlpha: number;
  123496. protected _previousBeta: number;
  123497. protected _previousRadius: number;
  123498. protected _collisionTriggered: boolean;
  123499. protected _targetBoundingCenter: Nullable<Vector3>;
  123500. private _computationVector;
  123501. /**
  123502. * Instantiates a new ArcRotateCamera in a given scene
  123503. * @param name Defines the name of the camera
  123504. * @param alpha Defines the camera rotation along the logitudinal axis
  123505. * @param beta Defines the camera rotation along the latitudinal axis
  123506. * @param radius Defines the camera distance from its target
  123507. * @param target Defines the camera target
  123508. * @param scene Defines the scene the camera belongs to
  123509. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  123510. */
  123511. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123512. /** @hidden */
  123513. _initCache(): void;
  123514. /** @hidden */
  123515. _updateCache(ignoreParentClass?: boolean): void;
  123516. protected _getTargetPosition(): Vector3;
  123517. private _storedAlpha;
  123518. private _storedBeta;
  123519. private _storedRadius;
  123520. private _storedTarget;
  123521. private _storedTargetScreenOffset;
  123522. /**
  123523. * Stores the current state of the camera (alpha, beta, radius and target)
  123524. * @returns the camera itself
  123525. */
  123526. storeState(): Camera;
  123527. /**
  123528. * @hidden
  123529. * Restored camera state. You must call storeState() first
  123530. */
  123531. _restoreStateValues(): boolean;
  123532. /** @hidden */
  123533. _isSynchronizedViewMatrix(): boolean;
  123534. /**
  123535. * Attached controls to the current camera.
  123536. * @param element Defines the element the controls should be listened from
  123537. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123538. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  123539. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  123540. */
  123541. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  123542. /**
  123543. * Detach the current controls from the camera.
  123544. * The camera will stop reacting to inputs.
  123545. * @param element Defines the element to stop listening the inputs from
  123546. */
  123547. detachControl(element: HTMLElement): void;
  123548. /** @hidden */
  123549. _checkInputs(): void;
  123550. protected _checkLimits(): void;
  123551. /**
  123552. * Rebuilds angles (alpha, beta) and radius from the give position and target
  123553. */
  123554. rebuildAnglesAndRadius(): void;
  123555. /**
  123556. * Use a position to define the current camera related information like alpha, beta and radius
  123557. * @param position Defines the position to set the camera at
  123558. */
  123559. setPosition(position: Vector3): void;
  123560. /**
  123561. * Defines the target the camera should look at.
  123562. * This will automatically adapt alpha beta and radius to fit within the new target.
  123563. * @param target Defines the new target as a Vector or a mesh
  123564. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  123565. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  123566. */
  123567. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  123568. /** @hidden */
  123569. _getViewMatrix(): Matrix;
  123570. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  123571. /**
  123572. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  123573. * @param meshes Defines the mesh to zoom on
  123574. * @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)
  123575. */
  123576. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  123577. /**
  123578. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  123579. * The target will be changed but the radius
  123580. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  123581. * @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)
  123582. */
  123583. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  123584. min: Vector3;
  123585. max: Vector3;
  123586. distance: number;
  123587. }, doNotUpdateMaxZ?: boolean): void;
  123588. /**
  123589. * @override
  123590. * Override Camera.createRigCamera
  123591. */
  123592. createRigCamera(name: string, cameraIndex: number): Camera;
  123593. /**
  123594. * @hidden
  123595. * @override
  123596. * Override Camera._updateRigCameras
  123597. */
  123598. _updateRigCameras(): void;
  123599. /**
  123600. * Destroy the camera and release the current resources hold by it.
  123601. */
  123602. dispose(): void;
  123603. /**
  123604. * Gets the current object class name.
  123605. * @return the class name
  123606. */
  123607. getClassName(): string;
  123608. }
  123609. }
  123610. declare module BABYLON {
  123611. /**
  123612. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  123613. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  123614. */
  123615. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  123616. /**
  123617. * Gets the name of the behavior.
  123618. */
  123619. get name(): string;
  123620. private _zoomStopsAnimation;
  123621. private _idleRotationSpeed;
  123622. private _idleRotationWaitTime;
  123623. private _idleRotationSpinupTime;
  123624. /**
  123625. * Sets the flag that indicates if user zooming should stop animation.
  123626. */
  123627. set zoomStopsAnimation(flag: boolean);
  123628. /**
  123629. * Gets the flag that indicates if user zooming should stop animation.
  123630. */
  123631. get zoomStopsAnimation(): boolean;
  123632. /**
  123633. * Sets the default speed at which the camera rotates around the model.
  123634. */
  123635. set idleRotationSpeed(speed: number);
  123636. /**
  123637. * Gets the default speed at which the camera rotates around the model.
  123638. */
  123639. get idleRotationSpeed(): number;
  123640. /**
  123641. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  123642. */
  123643. set idleRotationWaitTime(time: number);
  123644. /**
  123645. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  123646. */
  123647. get idleRotationWaitTime(): number;
  123648. /**
  123649. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123650. */
  123651. set idleRotationSpinupTime(time: number);
  123652. /**
  123653. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123654. */
  123655. get idleRotationSpinupTime(): number;
  123656. /**
  123657. * Gets a value indicating if the camera is currently rotating because of this behavior
  123658. */
  123659. get rotationInProgress(): boolean;
  123660. private _onPrePointerObservableObserver;
  123661. private _onAfterCheckInputsObserver;
  123662. private _attachedCamera;
  123663. private _isPointerDown;
  123664. private _lastFrameTime;
  123665. private _lastInteractionTime;
  123666. private _cameraRotationSpeed;
  123667. /**
  123668. * Initializes the behavior.
  123669. */
  123670. init(): void;
  123671. /**
  123672. * Attaches the behavior to its arc rotate camera.
  123673. * @param camera Defines the camera to attach the behavior to
  123674. */
  123675. attach(camera: ArcRotateCamera): void;
  123676. /**
  123677. * Detaches the behavior from its current arc rotate camera.
  123678. */
  123679. detach(): void;
  123680. /**
  123681. * Returns true if user is scrolling.
  123682. * @return true if user is scrolling.
  123683. */
  123684. private _userIsZooming;
  123685. private _lastFrameRadius;
  123686. private _shouldAnimationStopForInteraction;
  123687. /**
  123688. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  123689. */
  123690. private _applyUserInteraction;
  123691. private _userIsMoving;
  123692. }
  123693. }
  123694. declare module BABYLON {
  123695. /**
  123696. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  123697. */
  123698. export class AttachToBoxBehavior implements Behavior<Mesh> {
  123699. private ui;
  123700. /**
  123701. * The name of the behavior
  123702. */
  123703. name: string;
  123704. /**
  123705. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  123706. */
  123707. distanceAwayFromFace: number;
  123708. /**
  123709. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  123710. */
  123711. distanceAwayFromBottomOfFace: number;
  123712. private _faceVectors;
  123713. private _target;
  123714. private _scene;
  123715. private _onRenderObserver;
  123716. private _tmpMatrix;
  123717. private _tmpVector;
  123718. /**
  123719. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  123720. * @param ui The transform node that should be attched to the mesh
  123721. */
  123722. constructor(ui: TransformNode);
  123723. /**
  123724. * Initializes the behavior
  123725. */
  123726. init(): void;
  123727. private _closestFace;
  123728. private _zeroVector;
  123729. private _lookAtTmpMatrix;
  123730. private _lookAtToRef;
  123731. /**
  123732. * Attaches the AttachToBoxBehavior to the passed in mesh
  123733. * @param target The mesh that the specified node will be attached to
  123734. */
  123735. attach(target: Mesh): void;
  123736. /**
  123737. * Detaches the behavior from the mesh
  123738. */
  123739. detach(): void;
  123740. }
  123741. }
  123742. declare module BABYLON {
  123743. /**
  123744. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  123745. */
  123746. export class FadeInOutBehavior implements Behavior<Mesh> {
  123747. /**
  123748. * Time in milliseconds to delay before fading in (Default: 0)
  123749. */
  123750. delay: number;
  123751. /**
  123752. * Time in milliseconds for the mesh to fade in (Default: 300)
  123753. */
  123754. fadeInTime: number;
  123755. private _millisecondsPerFrame;
  123756. private _hovered;
  123757. private _hoverValue;
  123758. private _ownerNode;
  123759. /**
  123760. * Instatiates the FadeInOutBehavior
  123761. */
  123762. constructor();
  123763. /**
  123764. * The name of the behavior
  123765. */
  123766. get name(): string;
  123767. /**
  123768. * Initializes the behavior
  123769. */
  123770. init(): void;
  123771. /**
  123772. * Attaches the fade behavior on the passed in mesh
  123773. * @param ownerNode The mesh that will be faded in/out once attached
  123774. */
  123775. attach(ownerNode: Mesh): void;
  123776. /**
  123777. * Detaches the behavior from the mesh
  123778. */
  123779. detach(): void;
  123780. /**
  123781. * Triggers the mesh to begin fading in or out
  123782. * @param value if the object should fade in or out (true to fade in)
  123783. */
  123784. fadeIn(value: boolean): void;
  123785. private _update;
  123786. private _setAllVisibility;
  123787. }
  123788. }
  123789. declare module BABYLON {
  123790. /**
  123791. * Class containing a set of static utilities functions for managing Pivots
  123792. * @hidden
  123793. */
  123794. export class PivotTools {
  123795. private static _PivotCached;
  123796. private static _OldPivotPoint;
  123797. private static _PivotTranslation;
  123798. private static _PivotTmpVector;
  123799. private static _PivotPostMultiplyPivotMatrix;
  123800. /** @hidden */
  123801. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123802. /** @hidden */
  123803. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123804. }
  123805. }
  123806. declare module BABYLON {
  123807. /**
  123808. * Class containing static functions to help procedurally build meshes
  123809. */
  123810. export class PlaneBuilder {
  123811. /**
  123812. * Creates a plane mesh
  123813. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123814. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123815. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123816. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123817. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123818. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123819. * @param name defines the name of the mesh
  123820. * @param options defines the options used to create the mesh
  123821. * @param scene defines the hosting scene
  123822. * @returns the plane mesh
  123823. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123824. */
  123825. static CreatePlane(name: string, options: {
  123826. size?: number;
  123827. width?: number;
  123828. height?: number;
  123829. sideOrientation?: number;
  123830. frontUVs?: Vector4;
  123831. backUVs?: Vector4;
  123832. updatable?: boolean;
  123833. sourcePlane?: Plane;
  123834. }, scene?: Nullable<Scene>): Mesh;
  123835. }
  123836. }
  123837. declare module BABYLON {
  123838. /**
  123839. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123840. */
  123841. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123842. private static _AnyMouseID;
  123843. /**
  123844. * Abstract mesh the behavior is set on
  123845. */
  123846. attachedNode: AbstractMesh;
  123847. private _dragPlane;
  123848. private _scene;
  123849. private _pointerObserver;
  123850. private _beforeRenderObserver;
  123851. private static _planeScene;
  123852. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123853. /**
  123854. * 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)
  123855. */
  123856. maxDragAngle: number;
  123857. /**
  123858. * @hidden
  123859. */
  123860. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123861. /**
  123862. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123863. */
  123864. currentDraggingPointerID: number;
  123865. /**
  123866. * The last position where the pointer hit the drag plane in world space
  123867. */
  123868. lastDragPosition: Vector3;
  123869. /**
  123870. * If the behavior is currently in a dragging state
  123871. */
  123872. dragging: boolean;
  123873. /**
  123874. * 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)
  123875. */
  123876. dragDeltaRatio: number;
  123877. /**
  123878. * If the drag plane orientation should be updated during the dragging (Default: true)
  123879. */
  123880. updateDragPlane: boolean;
  123881. private _debugMode;
  123882. private _moving;
  123883. /**
  123884. * Fires each time the attached mesh is dragged with the pointer
  123885. * * delta between last drag position and current drag position in world space
  123886. * * dragDistance along the drag axis
  123887. * * dragPlaneNormal normal of the current drag plane used during the drag
  123888. * * dragPlanePoint in world space where the drag intersects the drag plane
  123889. */
  123890. onDragObservable: Observable<{
  123891. delta: Vector3;
  123892. dragPlanePoint: Vector3;
  123893. dragPlaneNormal: Vector3;
  123894. dragDistance: number;
  123895. pointerId: number;
  123896. }>;
  123897. /**
  123898. * Fires each time a drag begins (eg. mouse down on mesh)
  123899. */
  123900. onDragStartObservable: Observable<{
  123901. dragPlanePoint: Vector3;
  123902. pointerId: number;
  123903. }>;
  123904. /**
  123905. * Fires each time a drag ends (eg. mouse release after drag)
  123906. */
  123907. onDragEndObservable: Observable<{
  123908. dragPlanePoint: Vector3;
  123909. pointerId: number;
  123910. }>;
  123911. /**
  123912. * If the attached mesh should be moved when dragged
  123913. */
  123914. moveAttached: boolean;
  123915. /**
  123916. * If the drag behavior will react to drag events (Default: true)
  123917. */
  123918. enabled: boolean;
  123919. /**
  123920. * If pointer events should start and release the drag (Default: true)
  123921. */
  123922. startAndReleaseDragOnPointerEvents: boolean;
  123923. /**
  123924. * If camera controls should be detached during the drag
  123925. */
  123926. detachCameraControls: boolean;
  123927. /**
  123928. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123929. */
  123930. useObjectOrientationForDragging: boolean;
  123931. private _options;
  123932. /**
  123933. * Gets the options used by the behavior
  123934. */
  123935. get options(): {
  123936. dragAxis?: Vector3;
  123937. dragPlaneNormal?: Vector3;
  123938. };
  123939. /**
  123940. * Sets the options used by the behavior
  123941. */
  123942. set options(options: {
  123943. dragAxis?: Vector3;
  123944. dragPlaneNormal?: Vector3;
  123945. });
  123946. /**
  123947. * Creates a pointer drag behavior that can be attached to a mesh
  123948. * @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)
  123949. */
  123950. constructor(options?: {
  123951. dragAxis?: Vector3;
  123952. dragPlaneNormal?: Vector3;
  123953. });
  123954. /**
  123955. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123956. */
  123957. validateDrag: (targetPosition: Vector3) => boolean;
  123958. /**
  123959. * The name of the behavior
  123960. */
  123961. get name(): string;
  123962. /**
  123963. * Initializes the behavior
  123964. */
  123965. init(): void;
  123966. private _tmpVector;
  123967. private _alternatePickedPoint;
  123968. private _worldDragAxis;
  123969. private _targetPosition;
  123970. private _attachedElement;
  123971. /**
  123972. * Attaches the drag behavior the passed in mesh
  123973. * @param ownerNode The mesh that will be dragged around once attached
  123974. * @param predicate Predicate to use for pick filtering
  123975. */
  123976. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123977. /**
  123978. * Force relase the drag action by code.
  123979. */
  123980. releaseDrag(): void;
  123981. private _startDragRay;
  123982. private _lastPointerRay;
  123983. /**
  123984. * Simulates the start of a pointer drag event on the behavior
  123985. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123986. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123987. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123988. */
  123989. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123990. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123991. private _dragDelta;
  123992. protected _moveDrag(ray: Ray): void;
  123993. private _pickWithRayOnDragPlane;
  123994. private _pointA;
  123995. private _pointC;
  123996. private _localAxis;
  123997. private _lookAt;
  123998. private _updateDragPlanePosition;
  123999. /**
  124000. * Detaches the behavior from the mesh
  124001. */
  124002. detach(): void;
  124003. }
  124004. }
  124005. declare module BABYLON {
  124006. /**
  124007. * A behavior that when attached to a mesh will allow the mesh to be scaled
  124008. */
  124009. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  124010. private _dragBehaviorA;
  124011. private _dragBehaviorB;
  124012. private _startDistance;
  124013. private _initialScale;
  124014. private _targetScale;
  124015. private _ownerNode;
  124016. private _sceneRenderObserver;
  124017. /**
  124018. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  124019. */
  124020. constructor();
  124021. /**
  124022. * The name of the behavior
  124023. */
  124024. get name(): string;
  124025. /**
  124026. * Initializes the behavior
  124027. */
  124028. init(): void;
  124029. private _getCurrentDistance;
  124030. /**
  124031. * Attaches the scale behavior the passed in mesh
  124032. * @param ownerNode The mesh that will be scaled around once attached
  124033. */
  124034. attach(ownerNode: Mesh): void;
  124035. /**
  124036. * Detaches the behavior from the mesh
  124037. */
  124038. detach(): void;
  124039. }
  124040. }
  124041. declare module BABYLON {
  124042. /**
  124043. * 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
  124044. */
  124045. export class SixDofDragBehavior implements Behavior<Mesh> {
  124046. private static _virtualScene;
  124047. private _ownerNode;
  124048. private _sceneRenderObserver;
  124049. private _scene;
  124050. private _targetPosition;
  124051. private _virtualOriginMesh;
  124052. private _virtualDragMesh;
  124053. private _pointerObserver;
  124054. private _moving;
  124055. private _startingOrientation;
  124056. private _attachedElement;
  124057. /**
  124058. * 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)
  124059. */
  124060. private zDragFactor;
  124061. /**
  124062. * If the object should rotate to face the drag origin
  124063. */
  124064. rotateDraggedObject: boolean;
  124065. /**
  124066. * If the behavior is currently in a dragging state
  124067. */
  124068. dragging: boolean;
  124069. /**
  124070. * 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)
  124071. */
  124072. dragDeltaRatio: number;
  124073. /**
  124074. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  124075. */
  124076. currentDraggingPointerID: number;
  124077. /**
  124078. * If camera controls should be detached during the drag
  124079. */
  124080. detachCameraControls: boolean;
  124081. /**
  124082. * Fires each time a drag starts
  124083. */
  124084. onDragStartObservable: Observable<{}>;
  124085. /**
  124086. * Fires each time a drag ends (eg. mouse release after drag)
  124087. */
  124088. onDragEndObservable: Observable<{}>;
  124089. /**
  124090. * 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
  124091. */
  124092. constructor();
  124093. /**
  124094. * The name of the behavior
  124095. */
  124096. get name(): string;
  124097. /**
  124098. * Initializes the behavior
  124099. */
  124100. init(): void;
  124101. /**
  124102. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  124103. */
  124104. private get _pointerCamera();
  124105. /**
  124106. * Attaches the scale behavior the passed in mesh
  124107. * @param ownerNode The mesh that will be scaled around once attached
  124108. */
  124109. attach(ownerNode: Mesh): void;
  124110. /**
  124111. * Detaches the behavior from the mesh
  124112. */
  124113. detach(): void;
  124114. }
  124115. }
  124116. declare module BABYLON {
  124117. /**
  124118. * Class used to apply inverse kinematics to bones
  124119. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  124120. */
  124121. export class BoneIKController {
  124122. private static _tmpVecs;
  124123. private static _tmpQuat;
  124124. private static _tmpMats;
  124125. /**
  124126. * Gets or sets the target mesh
  124127. */
  124128. targetMesh: AbstractMesh;
  124129. /** Gets or sets the mesh used as pole */
  124130. poleTargetMesh: AbstractMesh;
  124131. /**
  124132. * Gets or sets the bone used as pole
  124133. */
  124134. poleTargetBone: Nullable<Bone>;
  124135. /**
  124136. * Gets or sets the target position
  124137. */
  124138. targetPosition: Vector3;
  124139. /**
  124140. * Gets or sets the pole target position
  124141. */
  124142. poleTargetPosition: Vector3;
  124143. /**
  124144. * Gets or sets the pole target local offset
  124145. */
  124146. poleTargetLocalOffset: Vector3;
  124147. /**
  124148. * Gets or sets the pole angle
  124149. */
  124150. poleAngle: number;
  124151. /**
  124152. * Gets or sets the mesh associated with the controller
  124153. */
  124154. mesh: AbstractMesh;
  124155. /**
  124156. * 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)
  124157. */
  124158. slerpAmount: number;
  124159. private _bone1Quat;
  124160. private _bone1Mat;
  124161. private _bone2Ang;
  124162. private _bone1;
  124163. private _bone2;
  124164. private _bone1Length;
  124165. private _bone2Length;
  124166. private _maxAngle;
  124167. private _maxReach;
  124168. private _rightHandedSystem;
  124169. private _bendAxis;
  124170. private _slerping;
  124171. private _adjustRoll;
  124172. /**
  124173. * Gets or sets maximum allowed angle
  124174. */
  124175. get maxAngle(): number;
  124176. set maxAngle(value: number);
  124177. /**
  124178. * Creates a new BoneIKController
  124179. * @param mesh defines the mesh to control
  124180. * @param bone defines the bone to control
  124181. * @param options defines options to set up the controller
  124182. */
  124183. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  124184. targetMesh?: AbstractMesh;
  124185. poleTargetMesh?: AbstractMesh;
  124186. poleTargetBone?: Bone;
  124187. poleTargetLocalOffset?: Vector3;
  124188. poleAngle?: number;
  124189. bendAxis?: Vector3;
  124190. maxAngle?: number;
  124191. slerpAmount?: number;
  124192. });
  124193. private _setMaxAngle;
  124194. /**
  124195. * Force the controller to update the bones
  124196. */
  124197. update(): void;
  124198. }
  124199. }
  124200. declare module BABYLON {
  124201. /**
  124202. * Class used to make a bone look toward a point in space
  124203. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  124204. */
  124205. export class BoneLookController {
  124206. private static _tmpVecs;
  124207. private static _tmpQuat;
  124208. private static _tmpMats;
  124209. /**
  124210. * The target Vector3 that the bone will look at
  124211. */
  124212. target: Vector3;
  124213. /**
  124214. * The mesh that the bone is attached to
  124215. */
  124216. mesh: AbstractMesh;
  124217. /**
  124218. * The bone that will be looking to the target
  124219. */
  124220. bone: Bone;
  124221. /**
  124222. * The up axis of the coordinate system that is used when the bone is rotated
  124223. */
  124224. upAxis: Vector3;
  124225. /**
  124226. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  124227. */
  124228. upAxisSpace: Space;
  124229. /**
  124230. * Used to make an adjustment to the yaw of the bone
  124231. */
  124232. adjustYaw: number;
  124233. /**
  124234. * Used to make an adjustment to the pitch of the bone
  124235. */
  124236. adjustPitch: number;
  124237. /**
  124238. * Used to make an adjustment to the roll of the bone
  124239. */
  124240. adjustRoll: number;
  124241. /**
  124242. * 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)
  124243. */
  124244. slerpAmount: number;
  124245. private _minYaw;
  124246. private _maxYaw;
  124247. private _minPitch;
  124248. private _maxPitch;
  124249. private _minYawSin;
  124250. private _minYawCos;
  124251. private _maxYawSin;
  124252. private _maxYawCos;
  124253. private _midYawConstraint;
  124254. private _minPitchTan;
  124255. private _maxPitchTan;
  124256. private _boneQuat;
  124257. private _slerping;
  124258. private _transformYawPitch;
  124259. private _transformYawPitchInv;
  124260. private _firstFrameSkipped;
  124261. private _yawRange;
  124262. private _fowardAxis;
  124263. /**
  124264. * Gets or sets the minimum yaw angle that the bone can look to
  124265. */
  124266. get minYaw(): number;
  124267. set minYaw(value: number);
  124268. /**
  124269. * Gets or sets the maximum yaw angle that the bone can look to
  124270. */
  124271. get maxYaw(): number;
  124272. set maxYaw(value: number);
  124273. /**
  124274. * Gets or sets the minimum pitch angle that the bone can look to
  124275. */
  124276. get minPitch(): number;
  124277. set minPitch(value: number);
  124278. /**
  124279. * Gets or sets the maximum pitch angle that the bone can look to
  124280. */
  124281. get maxPitch(): number;
  124282. set maxPitch(value: number);
  124283. /**
  124284. * Create a BoneLookController
  124285. * @param mesh the mesh that the bone belongs to
  124286. * @param bone the bone that will be looking to the target
  124287. * @param target the target Vector3 to look at
  124288. * @param options optional settings:
  124289. * * maxYaw: the maximum angle the bone will yaw to
  124290. * * minYaw: the minimum angle the bone will yaw to
  124291. * * maxPitch: the maximum angle the bone will pitch to
  124292. * * minPitch: the minimum angle the bone will yaw to
  124293. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  124294. * * upAxis: the up axis of the coordinate system
  124295. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  124296. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  124297. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  124298. * * adjustYaw: used to make an adjustment to the yaw of the bone
  124299. * * adjustPitch: used to make an adjustment to the pitch of the bone
  124300. * * adjustRoll: used to make an adjustment to the roll of the bone
  124301. **/
  124302. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  124303. maxYaw?: number;
  124304. minYaw?: number;
  124305. maxPitch?: number;
  124306. minPitch?: number;
  124307. slerpAmount?: number;
  124308. upAxis?: Vector3;
  124309. upAxisSpace?: Space;
  124310. yawAxis?: Vector3;
  124311. pitchAxis?: Vector3;
  124312. adjustYaw?: number;
  124313. adjustPitch?: number;
  124314. adjustRoll?: number;
  124315. });
  124316. /**
  124317. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  124318. */
  124319. update(): void;
  124320. private _getAngleDiff;
  124321. private _getAngleBetween;
  124322. private _isAngleBetween;
  124323. }
  124324. }
  124325. declare module BABYLON {
  124326. /**
  124327. * Manage the gamepad inputs to control an arc rotate camera.
  124328. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124329. */
  124330. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  124331. /**
  124332. * Defines the camera the input is attached to.
  124333. */
  124334. camera: ArcRotateCamera;
  124335. /**
  124336. * Defines the gamepad the input is gathering event from.
  124337. */
  124338. gamepad: Nullable<Gamepad>;
  124339. /**
  124340. * Defines the gamepad rotation sensiblity.
  124341. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124342. */
  124343. gamepadRotationSensibility: number;
  124344. /**
  124345. * Defines the gamepad move sensiblity.
  124346. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124347. */
  124348. gamepadMoveSensibility: number;
  124349. private _yAxisScale;
  124350. /**
  124351. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124352. */
  124353. get invertYAxis(): boolean;
  124354. set invertYAxis(value: boolean);
  124355. private _onGamepadConnectedObserver;
  124356. private _onGamepadDisconnectedObserver;
  124357. /**
  124358. * Attach the input controls to a specific dom element to get the input from.
  124359. * @param element Defines the element the controls should be listened from
  124360. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124361. */
  124362. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124363. /**
  124364. * Detach the current controls from the specified dom element.
  124365. * @param element Defines the element to stop listening the inputs from
  124366. */
  124367. detachControl(element: Nullable<HTMLElement>): void;
  124368. /**
  124369. * Update the current camera state depending on the inputs that have been used this frame.
  124370. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124371. */
  124372. checkInputs(): void;
  124373. /**
  124374. * Gets the class name of the current intput.
  124375. * @returns the class name
  124376. */
  124377. getClassName(): string;
  124378. /**
  124379. * Get the friendly name associated with the input class.
  124380. * @returns the input friendly name
  124381. */
  124382. getSimpleName(): string;
  124383. }
  124384. }
  124385. declare module BABYLON {
  124386. interface ArcRotateCameraInputsManager {
  124387. /**
  124388. * Add orientation input support to the input manager.
  124389. * @returns the current input manager
  124390. */
  124391. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  124392. }
  124393. /**
  124394. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  124395. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124396. */
  124397. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  124398. /**
  124399. * Defines the camera the input is attached to.
  124400. */
  124401. camera: ArcRotateCamera;
  124402. /**
  124403. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  124404. */
  124405. alphaCorrection: number;
  124406. /**
  124407. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  124408. */
  124409. gammaCorrection: number;
  124410. private _alpha;
  124411. private _gamma;
  124412. private _dirty;
  124413. private _deviceOrientationHandler;
  124414. /**
  124415. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  124416. */
  124417. constructor();
  124418. /**
  124419. * Attach the input controls to a specific dom element to get the input from.
  124420. * @param element Defines the element the controls should be listened from
  124421. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124422. */
  124423. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124424. /** @hidden */
  124425. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  124426. /**
  124427. * Update the current camera state depending on the inputs that have been used this frame.
  124428. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124429. */
  124430. checkInputs(): void;
  124431. /**
  124432. * Detach the current controls from the specified dom element.
  124433. * @param element Defines the element to stop listening the inputs from
  124434. */
  124435. detachControl(element: Nullable<HTMLElement>): void;
  124436. /**
  124437. * Gets the class name of the current intput.
  124438. * @returns the class name
  124439. */
  124440. getClassName(): string;
  124441. /**
  124442. * Get the friendly name associated with the input class.
  124443. * @returns the input friendly name
  124444. */
  124445. getSimpleName(): string;
  124446. }
  124447. }
  124448. declare module BABYLON {
  124449. /**
  124450. * Listen to mouse events to control the camera.
  124451. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124452. */
  124453. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  124454. /**
  124455. * Defines the camera the input is attached to.
  124456. */
  124457. camera: FlyCamera;
  124458. /**
  124459. * Defines if touch is enabled. (Default is true.)
  124460. */
  124461. touchEnabled: boolean;
  124462. /**
  124463. * Defines the buttons associated with the input to handle camera rotation.
  124464. */
  124465. buttons: number[];
  124466. /**
  124467. * Assign buttons for Yaw control.
  124468. */
  124469. buttonsYaw: number[];
  124470. /**
  124471. * Assign buttons for Pitch control.
  124472. */
  124473. buttonsPitch: number[];
  124474. /**
  124475. * Assign buttons for Roll control.
  124476. */
  124477. buttonsRoll: number[];
  124478. /**
  124479. * Detect if any button is being pressed while mouse is moved.
  124480. * -1 = Mouse locked.
  124481. * 0 = Left button.
  124482. * 1 = Middle Button.
  124483. * 2 = Right Button.
  124484. */
  124485. activeButton: number;
  124486. /**
  124487. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  124488. * Higher values reduce its sensitivity.
  124489. */
  124490. angularSensibility: number;
  124491. private _mousemoveCallback;
  124492. private _observer;
  124493. private _rollObserver;
  124494. private previousPosition;
  124495. private noPreventDefault;
  124496. private element;
  124497. /**
  124498. * Listen to mouse events to control the camera.
  124499. * @param touchEnabled Define if touch is enabled. (Default is true.)
  124500. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124501. */
  124502. constructor(touchEnabled?: boolean);
  124503. /**
  124504. * Attach the mouse control to the HTML DOM element.
  124505. * @param element Defines the element that listens to the input events.
  124506. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  124507. */
  124508. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124509. /**
  124510. * Detach the current controls from the specified dom element.
  124511. * @param element Defines the element to stop listening the inputs from
  124512. */
  124513. detachControl(element: Nullable<HTMLElement>): void;
  124514. /**
  124515. * Gets the class name of the current input.
  124516. * @returns the class name.
  124517. */
  124518. getClassName(): string;
  124519. /**
  124520. * Get the friendly name associated with the input class.
  124521. * @returns the input's friendly name.
  124522. */
  124523. getSimpleName(): string;
  124524. private _pointerInput;
  124525. private _onMouseMove;
  124526. /**
  124527. * Rotate camera by mouse offset.
  124528. */
  124529. private rotateCamera;
  124530. }
  124531. }
  124532. declare module BABYLON {
  124533. /**
  124534. * Default Inputs manager for the FlyCamera.
  124535. * It groups all the default supported inputs for ease of use.
  124536. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124537. */
  124538. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  124539. /**
  124540. * Instantiates a new FlyCameraInputsManager.
  124541. * @param camera Defines the camera the inputs belong to.
  124542. */
  124543. constructor(camera: FlyCamera);
  124544. /**
  124545. * Add keyboard input support to the input manager.
  124546. * @returns the new FlyCameraKeyboardMoveInput().
  124547. */
  124548. addKeyboard(): FlyCameraInputsManager;
  124549. /**
  124550. * Add mouse input support to the input manager.
  124551. * @param touchEnabled Enable touch screen support.
  124552. * @returns the new FlyCameraMouseInput().
  124553. */
  124554. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  124555. }
  124556. }
  124557. declare module BABYLON {
  124558. /**
  124559. * This is a flying camera, designed for 3D movement and rotation in all directions,
  124560. * such as in a 3D Space Shooter or a Flight Simulator.
  124561. */
  124562. export class FlyCamera extends TargetCamera {
  124563. /**
  124564. * Define the collision ellipsoid of the camera.
  124565. * This is helpful for simulating a camera body, like a player's body.
  124566. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  124567. */
  124568. ellipsoid: Vector3;
  124569. /**
  124570. * Define an offset for the position of the ellipsoid around the camera.
  124571. * This can be helpful if the camera is attached away from the player's body center,
  124572. * such as at its head.
  124573. */
  124574. ellipsoidOffset: Vector3;
  124575. /**
  124576. * Enable or disable collisions of the camera with the rest of the scene objects.
  124577. */
  124578. checkCollisions: boolean;
  124579. /**
  124580. * Enable or disable gravity on the camera.
  124581. */
  124582. applyGravity: boolean;
  124583. /**
  124584. * Define the current direction the camera is moving to.
  124585. */
  124586. cameraDirection: Vector3;
  124587. /**
  124588. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  124589. * This overrides and empties cameraRotation.
  124590. */
  124591. rotationQuaternion: Quaternion;
  124592. /**
  124593. * Track Roll to maintain the wanted Rolling when looking around.
  124594. */
  124595. _trackRoll: number;
  124596. /**
  124597. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  124598. */
  124599. rollCorrect: number;
  124600. /**
  124601. * Mimic a banked turn, Rolling the camera when Yawing.
  124602. * It's recommended to use rollCorrect = 10 for faster banking correction.
  124603. */
  124604. bankedTurn: boolean;
  124605. /**
  124606. * Limit in radians for how much Roll banking will add. (Default: 90°)
  124607. */
  124608. bankedTurnLimit: number;
  124609. /**
  124610. * Value of 0 disables the banked Roll.
  124611. * Value of 1 is equal to the Yaw angle in radians.
  124612. */
  124613. bankedTurnMultiplier: number;
  124614. /**
  124615. * The inputs manager loads all the input sources, such as keyboard and mouse.
  124616. */
  124617. inputs: FlyCameraInputsManager;
  124618. /**
  124619. * Gets the input sensibility for mouse input.
  124620. * Higher values reduce sensitivity.
  124621. */
  124622. get angularSensibility(): number;
  124623. /**
  124624. * Sets the input sensibility for a mouse input.
  124625. * Higher values reduce sensitivity.
  124626. */
  124627. set angularSensibility(value: number);
  124628. /**
  124629. * Get the keys for camera movement forward.
  124630. */
  124631. get keysForward(): number[];
  124632. /**
  124633. * Set the keys for camera movement forward.
  124634. */
  124635. set keysForward(value: number[]);
  124636. /**
  124637. * Get the keys for camera movement backward.
  124638. */
  124639. get keysBackward(): number[];
  124640. set keysBackward(value: number[]);
  124641. /**
  124642. * Get the keys for camera movement up.
  124643. */
  124644. get keysUp(): number[];
  124645. /**
  124646. * Set the keys for camera movement up.
  124647. */
  124648. set keysUp(value: number[]);
  124649. /**
  124650. * Get the keys for camera movement down.
  124651. */
  124652. get keysDown(): number[];
  124653. /**
  124654. * Set the keys for camera movement down.
  124655. */
  124656. set keysDown(value: number[]);
  124657. /**
  124658. * Get the keys for camera movement left.
  124659. */
  124660. get keysLeft(): number[];
  124661. /**
  124662. * Set the keys for camera movement left.
  124663. */
  124664. set keysLeft(value: number[]);
  124665. /**
  124666. * Set the keys for camera movement right.
  124667. */
  124668. get keysRight(): number[];
  124669. /**
  124670. * Set the keys for camera movement right.
  124671. */
  124672. set keysRight(value: number[]);
  124673. /**
  124674. * Event raised when the camera collides with a mesh in the scene.
  124675. */
  124676. onCollide: (collidedMesh: AbstractMesh) => void;
  124677. private _collider;
  124678. private _needMoveForGravity;
  124679. private _oldPosition;
  124680. private _diffPosition;
  124681. private _newPosition;
  124682. /** @hidden */
  124683. _localDirection: Vector3;
  124684. /** @hidden */
  124685. _transformedDirection: Vector3;
  124686. /**
  124687. * Instantiates a FlyCamera.
  124688. * This is a flying camera, designed for 3D movement and rotation in all directions,
  124689. * such as in a 3D Space Shooter or a Flight Simulator.
  124690. * @param name Define the name of the camera in the scene.
  124691. * @param position Define the starting position of the camera in the scene.
  124692. * @param scene Define the scene the camera belongs to.
  124693. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  124694. */
  124695. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  124696. /**
  124697. * Attach a control to the HTML DOM element.
  124698. * @param element Defines the element that listens to the input events.
  124699. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  124700. */
  124701. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124702. /**
  124703. * Detach a control from the HTML DOM element.
  124704. * The camera will stop reacting to that input.
  124705. * @param element Defines the element that listens to the input events.
  124706. */
  124707. detachControl(element: HTMLElement): void;
  124708. private _collisionMask;
  124709. /**
  124710. * Get the mask that the camera ignores in collision events.
  124711. */
  124712. get collisionMask(): number;
  124713. /**
  124714. * Set the mask that the camera ignores in collision events.
  124715. */
  124716. set collisionMask(mask: number);
  124717. /** @hidden */
  124718. _collideWithWorld(displacement: Vector3): void;
  124719. /** @hidden */
  124720. private _onCollisionPositionChange;
  124721. /** @hidden */
  124722. _checkInputs(): void;
  124723. /** @hidden */
  124724. _decideIfNeedsToMove(): boolean;
  124725. /** @hidden */
  124726. _updatePosition(): void;
  124727. /**
  124728. * Restore the Roll to its target value at the rate specified.
  124729. * @param rate - Higher means slower restoring.
  124730. * @hidden
  124731. */
  124732. restoreRoll(rate: number): void;
  124733. /**
  124734. * Destroy the camera and release the current resources held by it.
  124735. */
  124736. dispose(): void;
  124737. /**
  124738. * Get the current object class name.
  124739. * @returns the class name.
  124740. */
  124741. getClassName(): string;
  124742. }
  124743. }
  124744. declare module BABYLON {
  124745. /**
  124746. * Listen to keyboard events to control the camera.
  124747. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124748. */
  124749. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  124750. /**
  124751. * Defines the camera the input is attached to.
  124752. */
  124753. camera: FlyCamera;
  124754. /**
  124755. * The list of keyboard keys used to control the forward move of the camera.
  124756. */
  124757. keysForward: number[];
  124758. /**
  124759. * The list of keyboard keys used to control the backward move of the camera.
  124760. */
  124761. keysBackward: number[];
  124762. /**
  124763. * The list of keyboard keys used to control the forward move of the camera.
  124764. */
  124765. keysUp: number[];
  124766. /**
  124767. * The list of keyboard keys used to control the backward move of the camera.
  124768. */
  124769. keysDown: number[];
  124770. /**
  124771. * The list of keyboard keys used to control the right strafe move of the camera.
  124772. */
  124773. keysRight: number[];
  124774. /**
  124775. * The list of keyboard keys used to control the left strafe move of the camera.
  124776. */
  124777. keysLeft: number[];
  124778. private _keys;
  124779. private _onCanvasBlurObserver;
  124780. private _onKeyboardObserver;
  124781. private _engine;
  124782. private _scene;
  124783. /**
  124784. * Attach the input controls to a specific dom element to get the input from.
  124785. * @param element Defines the element the controls should be listened from
  124786. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124787. */
  124788. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124789. /**
  124790. * Detach the current controls from the specified dom element.
  124791. * @param element Defines the element to stop listening the inputs from
  124792. */
  124793. detachControl(element: Nullable<HTMLElement>): void;
  124794. /**
  124795. * Gets the class name of the current intput.
  124796. * @returns the class name
  124797. */
  124798. getClassName(): string;
  124799. /** @hidden */
  124800. _onLostFocus(e: FocusEvent): void;
  124801. /**
  124802. * Get the friendly name associated with the input class.
  124803. * @returns the input friendly name
  124804. */
  124805. getSimpleName(): string;
  124806. /**
  124807. * Update the current camera state depending on the inputs that have been used this frame.
  124808. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124809. */
  124810. checkInputs(): void;
  124811. }
  124812. }
  124813. declare module BABYLON {
  124814. /**
  124815. * Manage the mouse wheel inputs to control a follow camera.
  124816. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124817. */
  124818. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124819. /**
  124820. * Defines the camera the input is attached to.
  124821. */
  124822. camera: FollowCamera;
  124823. /**
  124824. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124825. */
  124826. axisControlRadius: boolean;
  124827. /**
  124828. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124829. */
  124830. axisControlHeight: boolean;
  124831. /**
  124832. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124833. */
  124834. axisControlRotation: boolean;
  124835. /**
  124836. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124837. * relation to mouseWheel events.
  124838. */
  124839. wheelPrecision: number;
  124840. /**
  124841. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124842. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124843. */
  124844. wheelDeltaPercentage: number;
  124845. private _wheel;
  124846. private _observer;
  124847. /**
  124848. * Attach the input controls to a specific dom element to get the input from.
  124849. * @param element Defines the element the controls should be listened from
  124850. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124851. */
  124852. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124853. /**
  124854. * Detach the current controls from the specified dom element.
  124855. * @param element Defines the element to stop listening the inputs from
  124856. */
  124857. detachControl(element: Nullable<HTMLElement>): void;
  124858. /**
  124859. * Gets the class name of the current intput.
  124860. * @returns the class name
  124861. */
  124862. getClassName(): string;
  124863. /**
  124864. * Get the friendly name associated with the input class.
  124865. * @returns the input friendly name
  124866. */
  124867. getSimpleName(): string;
  124868. }
  124869. }
  124870. declare module BABYLON {
  124871. /**
  124872. * Manage the pointers inputs to control an follow camera.
  124873. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124874. */
  124875. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124876. /**
  124877. * Defines the camera the input is attached to.
  124878. */
  124879. camera: FollowCamera;
  124880. /**
  124881. * Gets the class name of the current input.
  124882. * @returns the class name
  124883. */
  124884. getClassName(): string;
  124885. /**
  124886. * Defines the pointer angular sensibility along the X axis or how fast is
  124887. * the camera rotating.
  124888. * A negative number will reverse the axis direction.
  124889. */
  124890. angularSensibilityX: number;
  124891. /**
  124892. * Defines the pointer angular sensibility along the Y axis or how fast is
  124893. * the camera rotating.
  124894. * A negative number will reverse the axis direction.
  124895. */
  124896. angularSensibilityY: number;
  124897. /**
  124898. * Defines the pointer pinch precision or how fast is the camera zooming.
  124899. * A negative number will reverse the axis direction.
  124900. */
  124901. pinchPrecision: number;
  124902. /**
  124903. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124904. * from 0.
  124905. * It defines the percentage of current camera.radius to use as delta when
  124906. * pinch zoom is used.
  124907. */
  124908. pinchDeltaPercentage: number;
  124909. /**
  124910. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124911. */
  124912. axisXControlRadius: boolean;
  124913. /**
  124914. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124915. */
  124916. axisXControlHeight: boolean;
  124917. /**
  124918. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124919. */
  124920. axisXControlRotation: boolean;
  124921. /**
  124922. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124923. */
  124924. axisYControlRadius: boolean;
  124925. /**
  124926. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124927. */
  124928. axisYControlHeight: boolean;
  124929. /**
  124930. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124931. */
  124932. axisYControlRotation: boolean;
  124933. /**
  124934. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124935. */
  124936. axisPinchControlRadius: boolean;
  124937. /**
  124938. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124939. */
  124940. axisPinchControlHeight: boolean;
  124941. /**
  124942. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124943. */
  124944. axisPinchControlRotation: boolean;
  124945. /**
  124946. * Log error messages if basic misconfiguration has occurred.
  124947. */
  124948. warningEnable: boolean;
  124949. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124950. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124951. private _warningCounter;
  124952. private _warning;
  124953. }
  124954. }
  124955. declare module BABYLON {
  124956. /**
  124957. * Default Inputs manager for the FollowCamera.
  124958. * It groups all the default supported inputs for ease of use.
  124959. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124960. */
  124961. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124962. /**
  124963. * Instantiates a new FollowCameraInputsManager.
  124964. * @param camera Defines the camera the inputs belong to
  124965. */
  124966. constructor(camera: FollowCamera);
  124967. /**
  124968. * Add keyboard input support to the input manager.
  124969. * @returns the current input manager
  124970. */
  124971. addKeyboard(): FollowCameraInputsManager;
  124972. /**
  124973. * Add mouse wheel input support to the input manager.
  124974. * @returns the current input manager
  124975. */
  124976. addMouseWheel(): FollowCameraInputsManager;
  124977. /**
  124978. * Add pointers input support to the input manager.
  124979. * @returns the current input manager
  124980. */
  124981. addPointers(): FollowCameraInputsManager;
  124982. /**
  124983. * Add orientation input support to the input manager.
  124984. * @returns the current input manager
  124985. */
  124986. addVRDeviceOrientation(): FollowCameraInputsManager;
  124987. }
  124988. }
  124989. declare module BABYLON {
  124990. /**
  124991. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124992. * an arc rotate version arcFollowCamera are available.
  124993. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124994. */
  124995. export class FollowCamera extends TargetCamera {
  124996. /**
  124997. * Distance the follow camera should follow an object at
  124998. */
  124999. radius: number;
  125000. /**
  125001. * Minimum allowed distance of the camera to the axis of rotation
  125002. * (The camera can not get closer).
  125003. * This can help limiting how the Camera is able to move in the scene.
  125004. */
  125005. lowerRadiusLimit: Nullable<number>;
  125006. /**
  125007. * Maximum allowed distance of the camera to the axis of rotation
  125008. * (The camera can not get further).
  125009. * This can help limiting how the Camera is able to move in the scene.
  125010. */
  125011. upperRadiusLimit: Nullable<number>;
  125012. /**
  125013. * Define a rotation offset between the camera and the object it follows
  125014. */
  125015. rotationOffset: number;
  125016. /**
  125017. * Minimum allowed angle to camera position relative to target object.
  125018. * This can help limiting how the Camera is able to move in the scene.
  125019. */
  125020. lowerRotationOffsetLimit: Nullable<number>;
  125021. /**
  125022. * Maximum allowed angle to camera position relative to target object.
  125023. * This can help limiting how the Camera is able to move in the scene.
  125024. */
  125025. upperRotationOffsetLimit: Nullable<number>;
  125026. /**
  125027. * Define a height offset between the camera and the object it follows.
  125028. * It can help following an object from the top (like a car chaing a plane)
  125029. */
  125030. heightOffset: number;
  125031. /**
  125032. * Minimum allowed height of camera position relative to target object.
  125033. * This can help limiting how the Camera is able to move in the scene.
  125034. */
  125035. lowerHeightOffsetLimit: Nullable<number>;
  125036. /**
  125037. * Maximum allowed height of camera position relative to target object.
  125038. * This can help limiting how the Camera is able to move in the scene.
  125039. */
  125040. upperHeightOffsetLimit: Nullable<number>;
  125041. /**
  125042. * Define how fast the camera can accelerate to follow it s target.
  125043. */
  125044. cameraAcceleration: number;
  125045. /**
  125046. * Define the speed limit of the camera following an object.
  125047. */
  125048. maxCameraSpeed: number;
  125049. /**
  125050. * Define the target of the camera.
  125051. */
  125052. lockedTarget: Nullable<AbstractMesh>;
  125053. /**
  125054. * Defines the input associated with the camera.
  125055. */
  125056. inputs: FollowCameraInputsManager;
  125057. /**
  125058. * Instantiates the follow camera.
  125059. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125060. * @param name Define the name of the camera in the scene
  125061. * @param position Define the position of the camera
  125062. * @param scene Define the scene the camera belong to
  125063. * @param lockedTarget Define the target of the camera
  125064. */
  125065. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  125066. private _follow;
  125067. /**
  125068. * Attached controls to the current camera.
  125069. * @param element Defines the element the controls should be listened from
  125070. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125071. */
  125072. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125073. /**
  125074. * Detach the current controls from the camera.
  125075. * The camera will stop reacting to inputs.
  125076. * @param element Defines the element to stop listening the inputs from
  125077. */
  125078. detachControl(element: HTMLElement): void;
  125079. /** @hidden */
  125080. _checkInputs(): void;
  125081. private _checkLimits;
  125082. /**
  125083. * Gets the camera class name.
  125084. * @returns the class name
  125085. */
  125086. getClassName(): string;
  125087. }
  125088. /**
  125089. * Arc Rotate version of the follow camera.
  125090. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  125091. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125092. */
  125093. export class ArcFollowCamera extends TargetCamera {
  125094. /** The longitudinal angle of the camera */
  125095. alpha: number;
  125096. /** The latitudinal angle of the camera */
  125097. beta: number;
  125098. /** The radius of the camera from its target */
  125099. radius: number;
  125100. private _cartesianCoordinates;
  125101. /** Define the camera target (the mesh it should follow) */
  125102. private _meshTarget;
  125103. /**
  125104. * Instantiates a new ArcFollowCamera
  125105. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125106. * @param name Define the name of the camera
  125107. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  125108. * @param beta Define the rotation angle of the camera around the elevation axis
  125109. * @param radius Define the radius of the camera from its target point
  125110. * @param target Define the target of the camera
  125111. * @param scene Define the scene the camera belongs to
  125112. */
  125113. constructor(name: string,
  125114. /** The longitudinal angle of the camera */
  125115. alpha: number,
  125116. /** The latitudinal angle of the camera */
  125117. beta: number,
  125118. /** The radius of the camera from its target */
  125119. radius: number,
  125120. /** Define the camera target (the mesh it should follow) */
  125121. target: Nullable<AbstractMesh>, scene: Scene);
  125122. private _follow;
  125123. /** @hidden */
  125124. _checkInputs(): void;
  125125. /**
  125126. * Returns the class name of the object.
  125127. * It is mostly used internally for serialization purposes.
  125128. */
  125129. getClassName(): string;
  125130. }
  125131. }
  125132. declare module BABYLON {
  125133. /**
  125134. * Manage the keyboard inputs to control the movement of a follow camera.
  125135. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125136. */
  125137. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  125138. /**
  125139. * Defines the camera the input is attached to.
  125140. */
  125141. camera: FollowCamera;
  125142. /**
  125143. * Defines the list of key codes associated with the up action (increase heightOffset)
  125144. */
  125145. keysHeightOffsetIncr: number[];
  125146. /**
  125147. * Defines the list of key codes associated with the down action (decrease heightOffset)
  125148. */
  125149. keysHeightOffsetDecr: number[];
  125150. /**
  125151. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  125152. */
  125153. keysHeightOffsetModifierAlt: boolean;
  125154. /**
  125155. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  125156. */
  125157. keysHeightOffsetModifierCtrl: boolean;
  125158. /**
  125159. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  125160. */
  125161. keysHeightOffsetModifierShift: boolean;
  125162. /**
  125163. * Defines the list of key codes associated with the left action (increase rotationOffset)
  125164. */
  125165. keysRotationOffsetIncr: number[];
  125166. /**
  125167. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  125168. */
  125169. keysRotationOffsetDecr: number[];
  125170. /**
  125171. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  125172. */
  125173. keysRotationOffsetModifierAlt: boolean;
  125174. /**
  125175. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  125176. */
  125177. keysRotationOffsetModifierCtrl: boolean;
  125178. /**
  125179. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  125180. */
  125181. keysRotationOffsetModifierShift: boolean;
  125182. /**
  125183. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  125184. */
  125185. keysRadiusIncr: number[];
  125186. /**
  125187. * Defines the list of key codes associated with the zoom-out action (increase radius)
  125188. */
  125189. keysRadiusDecr: number[];
  125190. /**
  125191. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  125192. */
  125193. keysRadiusModifierAlt: boolean;
  125194. /**
  125195. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  125196. */
  125197. keysRadiusModifierCtrl: boolean;
  125198. /**
  125199. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  125200. */
  125201. keysRadiusModifierShift: boolean;
  125202. /**
  125203. * Defines the rate of change of heightOffset.
  125204. */
  125205. heightSensibility: number;
  125206. /**
  125207. * Defines the rate of change of rotationOffset.
  125208. */
  125209. rotationSensibility: number;
  125210. /**
  125211. * Defines the rate of change of radius.
  125212. */
  125213. radiusSensibility: number;
  125214. private _keys;
  125215. private _ctrlPressed;
  125216. private _altPressed;
  125217. private _shiftPressed;
  125218. private _onCanvasBlurObserver;
  125219. private _onKeyboardObserver;
  125220. private _engine;
  125221. private _scene;
  125222. /**
  125223. * Attach the input controls to a specific dom element to get the input from.
  125224. * @param element Defines the element the controls should be listened from
  125225. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125226. */
  125227. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125228. /**
  125229. * Detach the current controls from the specified dom element.
  125230. * @param element Defines the element to stop listening the inputs from
  125231. */
  125232. detachControl(element: Nullable<HTMLElement>): void;
  125233. /**
  125234. * Update the current camera state depending on the inputs that have been used this frame.
  125235. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125236. */
  125237. checkInputs(): void;
  125238. /**
  125239. * Gets the class name of the current input.
  125240. * @returns the class name
  125241. */
  125242. getClassName(): string;
  125243. /**
  125244. * Get the friendly name associated with the input class.
  125245. * @returns the input friendly name
  125246. */
  125247. getSimpleName(): string;
  125248. /**
  125249. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  125250. * allow modification of the heightOffset value.
  125251. */
  125252. private _modifierHeightOffset;
  125253. /**
  125254. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  125255. * allow modification of the rotationOffset value.
  125256. */
  125257. private _modifierRotationOffset;
  125258. /**
  125259. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  125260. * allow modification of the radius value.
  125261. */
  125262. private _modifierRadius;
  125263. }
  125264. }
  125265. declare module BABYLON {
  125266. interface FreeCameraInputsManager {
  125267. /**
  125268. * @hidden
  125269. */
  125270. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  125271. /**
  125272. * Add orientation input support to the input manager.
  125273. * @returns the current input manager
  125274. */
  125275. addDeviceOrientation(): FreeCameraInputsManager;
  125276. }
  125277. /**
  125278. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  125279. * Screen rotation is taken into account.
  125280. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125281. */
  125282. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  125283. private _camera;
  125284. private _screenOrientationAngle;
  125285. private _constantTranform;
  125286. private _screenQuaternion;
  125287. private _alpha;
  125288. private _beta;
  125289. private _gamma;
  125290. /**
  125291. * Can be used to detect if a device orientation sensor is available on a device
  125292. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  125293. * @returns a promise that will resolve on orientation change
  125294. */
  125295. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  125296. /**
  125297. * @hidden
  125298. */
  125299. _onDeviceOrientationChangedObservable: Observable<void>;
  125300. /**
  125301. * Instantiates a new input
  125302. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125303. */
  125304. constructor();
  125305. /**
  125306. * Define the camera controlled by the input.
  125307. */
  125308. get camera(): FreeCamera;
  125309. set camera(camera: FreeCamera);
  125310. /**
  125311. * Attach the input controls to a specific dom element to get the input from.
  125312. * @param element Defines the element the controls should be listened from
  125313. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125314. */
  125315. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125316. private _orientationChanged;
  125317. private _deviceOrientation;
  125318. /**
  125319. * Detach the current controls from the specified dom element.
  125320. * @param element Defines the element to stop listening the inputs from
  125321. */
  125322. detachControl(element: Nullable<HTMLElement>): void;
  125323. /**
  125324. * Update the current camera state depending on the inputs that have been used this frame.
  125325. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125326. */
  125327. checkInputs(): void;
  125328. /**
  125329. * Gets the class name of the current intput.
  125330. * @returns the class name
  125331. */
  125332. getClassName(): string;
  125333. /**
  125334. * Get the friendly name associated with the input class.
  125335. * @returns the input friendly name
  125336. */
  125337. getSimpleName(): string;
  125338. }
  125339. }
  125340. declare module BABYLON {
  125341. /**
  125342. * Manage the gamepad inputs to control a free camera.
  125343. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125344. */
  125345. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  125346. /**
  125347. * Define the camera the input is attached to.
  125348. */
  125349. camera: FreeCamera;
  125350. /**
  125351. * Define the Gamepad controlling the input
  125352. */
  125353. gamepad: Nullable<Gamepad>;
  125354. /**
  125355. * Defines the gamepad rotation sensiblity.
  125356. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125357. */
  125358. gamepadAngularSensibility: number;
  125359. /**
  125360. * Defines the gamepad move sensiblity.
  125361. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125362. */
  125363. gamepadMoveSensibility: number;
  125364. private _yAxisScale;
  125365. /**
  125366. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  125367. */
  125368. get invertYAxis(): boolean;
  125369. set invertYAxis(value: boolean);
  125370. private _onGamepadConnectedObserver;
  125371. private _onGamepadDisconnectedObserver;
  125372. private _cameraTransform;
  125373. private _deltaTransform;
  125374. private _vector3;
  125375. private _vector2;
  125376. /**
  125377. * Attach the input controls to a specific dom element to get the input from.
  125378. * @param element Defines the element the controls should be listened from
  125379. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125380. */
  125381. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125382. /**
  125383. * Detach the current controls from the specified dom element.
  125384. * @param element Defines the element to stop listening the inputs from
  125385. */
  125386. detachControl(element: Nullable<HTMLElement>): void;
  125387. /**
  125388. * Update the current camera state depending on the inputs that have been used this frame.
  125389. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125390. */
  125391. checkInputs(): void;
  125392. /**
  125393. * Gets the class name of the current intput.
  125394. * @returns the class name
  125395. */
  125396. getClassName(): string;
  125397. /**
  125398. * Get the friendly name associated with the input class.
  125399. * @returns the input friendly name
  125400. */
  125401. getSimpleName(): string;
  125402. }
  125403. }
  125404. declare module BABYLON {
  125405. /**
  125406. * Defines the potential axis of a Joystick
  125407. */
  125408. export enum JoystickAxis {
  125409. /** X axis */
  125410. X = 0,
  125411. /** Y axis */
  125412. Y = 1,
  125413. /** Z axis */
  125414. Z = 2
  125415. }
  125416. /**
  125417. * Represents the different customization options available
  125418. * for VirtualJoystick
  125419. */
  125420. interface VirtualJoystickCustomizations {
  125421. /**
  125422. * Size of the joystick's puck
  125423. */
  125424. puckSize: number;
  125425. /**
  125426. * Size of the joystick's container
  125427. */
  125428. containerSize: number;
  125429. /**
  125430. * Color of the joystick && puck
  125431. */
  125432. color: string;
  125433. /**
  125434. * Image URL for the joystick's puck
  125435. */
  125436. puckImage?: string;
  125437. /**
  125438. * Image URL for the joystick's container
  125439. */
  125440. containerImage?: string;
  125441. /**
  125442. * Defines the unmoving position of the joystick container
  125443. */
  125444. position?: {
  125445. x: number;
  125446. y: number;
  125447. };
  125448. /**
  125449. * Defines whether or not the joystick container is always visible
  125450. */
  125451. alwaysVisible: boolean;
  125452. /**
  125453. * Defines whether or not to limit the movement of the puck to the joystick's container
  125454. */
  125455. limitToContainer: boolean;
  125456. }
  125457. /**
  125458. * Class used to define virtual joystick (used in touch mode)
  125459. */
  125460. export class VirtualJoystick {
  125461. /**
  125462. * Gets or sets a boolean indicating that left and right values must be inverted
  125463. */
  125464. reverseLeftRight: boolean;
  125465. /**
  125466. * Gets or sets a boolean indicating that up and down values must be inverted
  125467. */
  125468. reverseUpDown: boolean;
  125469. /**
  125470. * Gets the offset value for the position (ie. the change of the position value)
  125471. */
  125472. deltaPosition: Vector3;
  125473. /**
  125474. * Gets a boolean indicating if the virtual joystick was pressed
  125475. */
  125476. pressed: boolean;
  125477. /**
  125478. * Canvas the virtual joystick will render onto, default z-index of this is 5
  125479. */
  125480. static Canvas: Nullable<HTMLCanvasElement>;
  125481. /**
  125482. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  125483. */
  125484. limitToContainer: boolean;
  125485. private static _globalJoystickIndex;
  125486. private static _alwaysVisibleSticks;
  125487. private static vjCanvasContext;
  125488. private static vjCanvasWidth;
  125489. private static vjCanvasHeight;
  125490. private static halfWidth;
  125491. private static _GetDefaultOptions;
  125492. private _action;
  125493. private _axisTargetedByLeftAndRight;
  125494. private _axisTargetedByUpAndDown;
  125495. private _joystickSensibility;
  125496. private _inversedSensibility;
  125497. private _joystickPointerID;
  125498. private _joystickColor;
  125499. private _joystickPointerPos;
  125500. private _joystickPreviousPointerPos;
  125501. private _joystickPointerStartPos;
  125502. private _deltaJoystickVector;
  125503. private _leftJoystick;
  125504. private _touches;
  125505. private _joystickPosition;
  125506. private _alwaysVisible;
  125507. private _puckImage;
  125508. private _containerImage;
  125509. private _joystickPuckSize;
  125510. private _joystickContainerSize;
  125511. private _clearPuckSize;
  125512. private _clearContainerSize;
  125513. private _clearPuckSizeOffset;
  125514. private _clearContainerSizeOffset;
  125515. private _onPointerDownHandlerRef;
  125516. private _onPointerMoveHandlerRef;
  125517. private _onPointerUpHandlerRef;
  125518. private _onResize;
  125519. /**
  125520. * Creates a new virtual joystick
  125521. * @param leftJoystick defines that the joystick is for left hand (false by default)
  125522. * @param customizations Defines the options we want to customize the VirtualJoystick
  125523. */
  125524. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  125525. /**
  125526. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  125527. * @param newJoystickSensibility defines the new sensibility
  125528. */
  125529. setJoystickSensibility(newJoystickSensibility: number): void;
  125530. private _onPointerDown;
  125531. private _onPointerMove;
  125532. private _onPointerUp;
  125533. /**
  125534. * Change the color of the virtual joystick
  125535. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  125536. */
  125537. setJoystickColor(newColor: string): void;
  125538. /**
  125539. * Size of the joystick's container
  125540. */
  125541. set containerSize(newSize: number);
  125542. get containerSize(): number;
  125543. /**
  125544. * Size of the joystick's puck
  125545. */
  125546. set puckSize(newSize: number);
  125547. get puckSize(): number;
  125548. /**
  125549. * Clears the set position of the joystick
  125550. */
  125551. clearPosition(): void;
  125552. /**
  125553. * Defines whether or not the joystick container is always visible
  125554. */
  125555. set alwaysVisible(value: boolean);
  125556. get alwaysVisible(): boolean;
  125557. /**
  125558. * Sets the constant position of the Joystick container
  125559. * @param x X axis coordinate
  125560. * @param y Y axis coordinate
  125561. */
  125562. setPosition(x: number, y: number): void;
  125563. /**
  125564. * Defines a callback to call when the joystick is touched
  125565. * @param action defines the callback
  125566. */
  125567. setActionOnTouch(action: () => any): void;
  125568. /**
  125569. * Defines which axis you'd like to control for left & right
  125570. * @param axis defines the axis to use
  125571. */
  125572. setAxisForLeftRight(axis: JoystickAxis): void;
  125573. /**
  125574. * Defines which axis you'd like to control for up & down
  125575. * @param axis defines the axis to use
  125576. */
  125577. setAxisForUpDown(axis: JoystickAxis): void;
  125578. /**
  125579. * Clears the canvas from the previous puck / container draw
  125580. */
  125581. private _clearPreviousDraw;
  125582. /**
  125583. * Loads `urlPath` to be used for the container's image
  125584. * @param urlPath defines the urlPath of an image to use
  125585. */
  125586. setContainerImage(urlPath: string): void;
  125587. /**
  125588. * Loads `urlPath` to be used for the puck's image
  125589. * @param urlPath defines the urlPath of an image to use
  125590. */
  125591. setPuckImage(urlPath: string): void;
  125592. /**
  125593. * Draws the Virtual Joystick's container
  125594. */
  125595. private _drawContainer;
  125596. /**
  125597. * Draws the Virtual Joystick's puck
  125598. */
  125599. private _drawPuck;
  125600. private _drawVirtualJoystick;
  125601. /**
  125602. * Release internal HTML canvas
  125603. */
  125604. releaseCanvas(): void;
  125605. }
  125606. }
  125607. declare module BABYLON {
  125608. interface FreeCameraInputsManager {
  125609. /**
  125610. * Add virtual joystick input support to the input manager.
  125611. * @returns the current input manager
  125612. */
  125613. addVirtualJoystick(): FreeCameraInputsManager;
  125614. }
  125615. /**
  125616. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  125617. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125618. */
  125619. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  125620. /**
  125621. * Defines the camera the input is attached to.
  125622. */
  125623. camera: FreeCamera;
  125624. private _leftjoystick;
  125625. private _rightjoystick;
  125626. /**
  125627. * Gets the left stick of the virtual joystick.
  125628. * @returns The virtual Joystick
  125629. */
  125630. getLeftJoystick(): VirtualJoystick;
  125631. /**
  125632. * Gets the right stick of the virtual joystick.
  125633. * @returns The virtual Joystick
  125634. */
  125635. getRightJoystick(): VirtualJoystick;
  125636. /**
  125637. * Update the current camera state depending on the inputs that have been used this frame.
  125638. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125639. */
  125640. checkInputs(): void;
  125641. /**
  125642. * Attach the input controls to a specific dom element to get the input from.
  125643. * @param element Defines the element the controls should be listened from
  125644. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125645. */
  125646. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125647. /**
  125648. * Detach the current controls from the specified dom element.
  125649. * @param element Defines the element to stop listening the inputs from
  125650. */
  125651. detachControl(element: Nullable<HTMLElement>): void;
  125652. /**
  125653. * Gets the class name of the current intput.
  125654. * @returns the class name
  125655. */
  125656. getClassName(): string;
  125657. /**
  125658. * Get the friendly name associated with the input class.
  125659. * @returns the input friendly name
  125660. */
  125661. getSimpleName(): string;
  125662. }
  125663. }
  125664. declare module BABYLON {
  125665. /**
  125666. * This represents a FPS type of camera controlled by touch.
  125667. * This is like a universal camera minus the Gamepad controls.
  125668. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125669. */
  125670. export class TouchCamera extends FreeCamera {
  125671. /**
  125672. * Defines the touch sensibility for rotation.
  125673. * The higher the faster.
  125674. */
  125675. get touchAngularSensibility(): number;
  125676. set touchAngularSensibility(value: number);
  125677. /**
  125678. * Defines the touch sensibility for move.
  125679. * The higher the faster.
  125680. */
  125681. get touchMoveSensibility(): number;
  125682. set touchMoveSensibility(value: number);
  125683. /**
  125684. * Instantiates a new touch camera.
  125685. * This represents a FPS type of camera controlled by touch.
  125686. * This is like a universal camera minus the Gamepad controls.
  125687. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125688. * @param name Define the name of the camera in the scene
  125689. * @param position Define the start position of the camera in the scene
  125690. * @param scene Define the scene the camera belongs to
  125691. */
  125692. constructor(name: string, position: Vector3, scene: Scene);
  125693. /**
  125694. * Gets the current object class name.
  125695. * @return the class name
  125696. */
  125697. getClassName(): string;
  125698. /** @hidden */
  125699. _setupInputs(): void;
  125700. }
  125701. }
  125702. declare module BABYLON {
  125703. /**
  125704. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  125705. * being tilted forward or back and left or right.
  125706. */
  125707. export class DeviceOrientationCamera extends FreeCamera {
  125708. private _initialQuaternion;
  125709. private _quaternionCache;
  125710. private _tmpDragQuaternion;
  125711. private _disablePointerInputWhenUsingDeviceOrientation;
  125712. /**
  125713. * Creates a new device orientation camera
  125714. * @param name The name of the camera
  125715. * @param position The start position camera
  125716. * @param scene The scene the camera belongs to
  125717. */
  125718. constructor(name: string, position: Vector3, scene: Scene);
  125719. /**
  125720. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  125721. */
  125722. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  125723. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  125724. private _dragFactor;
  125725. /**
  125726. * Enabled turning on the y axis when the orientation sensor is active
  125727. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  125728. */
  125729. enableHorizontalDragging(dragFactor?: number): void;
  125730. /**
  125731. * Gets the current instance class name ("DeviceOrientationCamera").
  125732. * This helps avoiding instanceof at run time.
  125733. * @returns the class name
  125734. */
  125735. getClassName(): string;
  125736. /**
  125737. * @hidden
  125738. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  125739. */
  125740. _checkInputs(): void;
  125741. /**
  125742. * Reset the camera to its default orientation on the specified axis only.
  125743. * @param axis The axis to reset
  125744. */
  125745. resetToCurrentRotation(axis?: Axis): void;
  125746. }
  125747. }
  125748. declare module BABYLON {
  125749. /**
  125750. * Defines supported buttons for XBox360 compatible gamepads
  125751. */
  125752. export enum Xbox360Button {
  125753. /** A */
  125754. A = 0,
  125755. /** B */
  125756. B = 1,
  125757. /** X */
  125758. X = 2,
  125759. /** Y */
  125760. Y = 3,
  125761. /** Left button */
  125762. LB = 4,
  125763. /** Right button */
  125764. RB = 5,
  125765. /** Back */
  125766. Back = 8,
  125767. /** Start */
  125768. Start = 9,
  125769. /** Left stick */
  125770. LeftStick = 10,
  125771. /** Right stick */
  125772. RightStick = 11
  125773. }
  125774. /** Defines values for XBox360 DPad */
  125775. export enum Xbox360Dpad {
  125776. /** Up */
  125777. Up = 12,
  125778. /** Down */
  125779. Down = 13,
  125780. /** Left */
  125781. Left = 14,
  125782. /** Right */
  125783. Right = 15
  125784. }
  125785. /**
  125786. * Defines a XBox360 gamepad
  125787. */
  125788. export class Xbox360Pad extends Gamepad {
  125789. private _leftTrigger;
  125790. private _rightTrigger;
  125791. private _onlefttriggerchanged;
  125792. private _onrighttriggerchanged;
  125793. private _onbuttondown;
  125794. private _onbuttonup;
  125795. private _ondpaddown;
  125796. private _ondpadup;
  125797. /** Observable raised when a button is pressed */
  125798. onButtonDownObservable: Observable<Xbox360Button>;
  125799. /** Observable raised when a button is released */
  125800. onButtonUpObservable: Observable<Xbox360Button>;
  125801. /** Observable raised when a pad is pressed */
  125802. onPadDownObservable: Observable<Xbox360Dpad>;
  125803. /** Observable raised when a pad is released */
  125804. onPadUpObservable: Observable<Xbox360Dpad>;
  125805. private _buttonA;
  125806. private _buttonB;
  125807. private _buttonX;
  125808. private _buttonY;
  125809. private _buttonBack;
  125810. private _buttonStart;
  125811. private _buttonLB;
  125812. private _buttonRB;
  125813. private _buttonLeftStick;
  125814. private _buttonRightStick;
  125815. private _dPadUp;
  125816. private _dPadDown;
  125817. private _dPadLeft;
  125818. private _dPadRight;
  125819. private _isXboxOnePad;
  125820. /**
  125821. * Creates a new XBox360 gamepad object
  125822. * @param id defines the id of this gamepad
  125823. * @param index defines its index
  125824. * @param gamepad defines the internal HTML gamepad object
  125825. * @param xboxOne defines if it is a XBox One gamepad
  125826. */
  125827. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125828. /**
  125829. * Defines the callback to call when left trigger is pressed
  125830. * @param callback defines the callback to use
  125831. */
  125832. onlefttriggerchanged(callback: (value: number) => void): void;
  125833. /**
  125834. * Defines the callback to call when right trigger is pressed
  125835. * @param callback defines the callback to use
  125836. */
  125837. onrighttriggerchanged(callback: (value: number) => void): void;
  125838. /**
  125839. * Gets the left trigger value
  125840. */
  125841. get leftTrigger(): number;
  125842. /**
  125843. * Sets the left trigger value
  125844. */
  125845. set leftTrigger(newValue: number);
  125846. /**
  125847. * Gets the right trigger value
  125848. */
  125849. get rightTrigger(): number;
  125850. /**
  125851. * Sets the right trigger value
  125852. */
  125853. set rightTrigger(newValue: number);
  125854. /**
  125855. * Defines the callback to call when a button is pressed
  125856. * @param callback defines the callback to use
  125857. */
  125858. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125859. /**
  125860. * Defines the callback to call when a button is released
  125861. * @param callback defines the callback to use
  125862. */
  125863. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125864. /**
  125865. * Defines the callback to call when a pad is pressed
  125866. * @param callback defines the callback to use
  125867. */
  125868. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125869. /**
  125870. * Defines the callback to call when a pad is released
  125871. * @param callback defines the callback to use
  125872. */
  125873. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125874. private _setButtonValue;
  125875. private _setDPadValue;
  125876. /**
  125877. * Gets the value of the `A` button
  125878. */
  125879. get buttonA(): number;
  125880. /**
  125881. * Sets the value of the `A` button
  125882. */
  125883. set buttonA(value: number);
  125884. /**
  125885. * Gets the value of the `B` button
  125886. */
  125887. get buttonB(): number;
  125888. /**
  125889. * Sets the value of the `B` button
  125890. */
  125891. set buttonB(value: number);
  125892. /**
  125893. * Gets the value of the `X` button
  125894. */
  125895. get buttonX(): number;
  125896. /**
  125897. * Sets the value of the `X` button
  125898. */
  125899. set buttonX(value: number);
  125900. /**
  125901. * Gets the value of the `Y` button
  125902. */
  125903. get buttonY(): number;
  125904. /**
  125905. * Sets the value of the `Y` button
  125906. */
  125907. set buttonY(value: number);
  125908. /**
  125909. * Gets the value of the `Start` button
  125910. */
  125911. get buttonStart(): number;
  125912. /**
  125913. * Sets the value of the `Start` button
  125914. */
  125915. set buttonStart(value: number);
  125916. /**
  125917. * Gets the value of the `Back` button
  125918. */
  125919. get buttonBack(): number;
  125920. /**
  125921. * Sets the value of the `Back` button
  125922. */
  125923. set buttonBack(value: number);
  125924. /**
  125925. * Gets the value of the `Left` button
  125926. */
  125927. get buttonLB(): number;
  125928. /**
  125929. * Sets the value of the `Left` button
  125930. */
  125931. set buttonLB(value: number);
  125932. /**
  125933. * Gets the value of the `Right` button
  125934. */
  125935. get buttonRB(): number;
  125936. /**
  125937. * Sets the value of the `Right` button
  125938. */
  125939. set buttonRB(value: number);
  125940. /**
  125941. * Gets the value of the Left joystick
  125942. */
  125943. get buttonLeftStick(): number;
  125944. /**
  125945. * Sets the value of the Left joystick
  125946. */
  125947. set buttonLeftStick(value: number);
  125948. /**
  125949. * Gets the value of the Right joystick
  125950. */
  125951. get buttonRightStick(): number;
  125952. /**
  125953. * Sets the value of the Right joystick
  125954. */
  125955. set buttonRightStick(value: number);
  125956. /**
  125957. * Gets the value of D-pad up
  125958. */
  125959. get dPadUp(): number;
  125960. /**
  125961. * Sets the value of D-pad up
  125962. */
  125963. set dPadUp(value: number);
  125964. /**
  125965. * Gets the value of D-pad down
  125966. */
  125967. get dPadDown(): number;
  125968. /**
  125969. * Sets the value of D-pad down
  125970. */
  125971. set dPadDown(value: number);
  125972. /**
  125973. * Gets the value of D-pad left
  125974. */
  125975. get dPadLeft(): number;
  125976. /**
  125977. * Sets the value of D-pad left
  125978. */
  125979. set dPadLeft(value: number);
  125980. /**
  125981. * Gets the value of D-pad right
  125982. */
  125983. get dPadRight(): number;
  125984. /**
  125985. * Sets the value of D-pad right
  125986. */
  125987. set dPadRight(value: number);
  125988. /**
  125989. * Force the gamepad to synchronize with device values
  125990. */
  125991. update(): void;
  125992. /**
  125993. * Disposes the gamepad
  125994. */
  125995. dispose(): void;
  125996. }
  125997. }
  125998. declare module BABYLON {
  125999. /**
  126000. * Defines supported buttons for DualShock compatible gamepads
  126001. */
  126002. export enum DualShockButton {
  126003. /** Cross */
  126004. Cross = 0,
  126005. /** Circle */
  126006. Circle = 1,
  126007. /** Square */
  126008. Square = 2,
  126009. /** Triangle */
  126010. Triangle = 3,
  126011. /** L1 */
  126012. L1 = 4,
  126013. /** R1 */
  126014. R1 = 5,
  126015. /** Share */
  126016. Share = 8,
  126017. /** Options */
  126018. Options = 9,
  126019. /** Left stick */
  126020. LeftStick = 10,
  126021. /** Right stick */
  126022. RightStick = 11
  126023. }
  126024. /** Defines values for DualShock DPad */
  126025. export enum DualShockDpad {
  126026. /** Up */
  126027. Up = 12,
  126028. /** Down */
  126029. Down = 13,
  126030. /** Left */
  126031. Left = 14,
  126032. /** Right */
  126033. Right = 15
  126034. }
  126035. /**
  126036. * Defines a DualShock gamepad
  126037. */
  126038. export class DualShockPad extends Gamepad {
  126039. private _leftTrigger;
  126040. private _rightTrigger;
  126041. private _onlefttriggerchanged;
  126042. private _onrighttriggerchanged;
  126043. private _onbuttondown;
  126044. private _onbuttonup;
  126045. private _ondpaddown;
  126046. private _ondpadup;
  126047. /** Observable raised when a button is pressed */
  126048. onButtonDownObservable: Observable<DualShockButton>;
  126049. /** Observable raised when a button is released */
  126050. onButtonUpObservable: Observable<DualShockButton>;
  126051. /** Observable raised when a pad is pressed */
  126052. onPadDownObservable: Observable<DualShockDpad>;
  126053. /** Observable raised when a pad is released */
  126054. onPadUpObservable: Observable<DualShockDpad>;
  126055. private _buttonCross;
  126056. private _buttonCircle;
  126057. private _buttonSquare;
  126058. private _buttonTriangle;
  126059. private _buttonShare;
  126060. private _buttonOptions;
  126061. private _buttonL1;
  126062. private _buttonR1;
  126063. private _buttonLeftStick;
  126064. private _buttonRightStick;
  126065. private _dPadUp;
  126066. private _dPadDown;
  126067. private _dPadLeft;
  126068. private _dPadRight;
  126069. /**
  126070. * Creates a new DualShock gamepad object
  126071. * @param id defines the id of this gamepad
  126072. * @param index defines its index
  126073. * @param gamepad defines the internal HTML gamepad object
  126074. */
  126075. constructor(id: string, index: number, gamepad: any);
  126076. /**
  126077. * Defines the callback to call when left trigger is pressed
  126078. * @param callback defines the callback to use
  126079. */
  126080. onlefttriggerchanged(callback: (value: number) => void): void;
  126081. /**
  126082. * Defines the callback to call when right trigger is pressed
  126083. * @param callback defines the callback to use
  126084. */
  126085. onrighttriggerchanged(callback: (value: number) => void): void;
  126086. /**
  126087. * Gets the left trigger value
  126088. */
  126089. get leftTrigger(): number;
  126090. /**
  126091. * Sets the left trigger value
  126092. */
  126093. set leftTrigger(newValue: number);
  126094. /**
  126095. * Gets the right trigger value
  126096. */
  126097. get rightTrigger(): number;
  126098. /**
  126099. * Sets the right trigger value
  126100. */
  126101. set rightTrigger(newValue: number);
  126102. /**
  126103. * Defines the callback to call when a button is pressed
  126104. * @param callback defines the callback to use
  126105. */
  126106. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  126107. /**
  126108. * Defines the callback to call when a button is released
  126109. * @param callback defines the callback to use
  126110. */
  126111. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  126112. /**
  126113. * Defines the callback to call when a pad is pressed
  126114. * @param callback defines the callback to use
  126115. */
  126116. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  126117. /**
  126118. * Defines the callback to call when a pad is released
  126119. * @param callback defines the callback to use
  126120. */
  126121. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  126122. private _setButtonValue;
  126123. private _setDPadValue;
  126124. /**
  126125. * Gets the value of the `Cross` button
  126126. */
  126127. get buttonCross(): number;
  126128. /**
  126129. * Sets the value of the `Cross` button
  126130. */
  126131. set buttonCross(value: number);
  126132. /**
  126133. * Gets the value of the `Circle` button
  126134. */
  126135. get buttonCircle(): number;
  126136. /**
  126137. * Sets the value of the `Circle` button
  126138. */
  126139. set buttonCircle(value: number);
  126140. /**
  126141. * Gets the value of the `Square` button
  126142. */
  126143. get buttonSquare(): number;
  126144. /**
  126145. * Sets the value of the `Square` button
  126146. */
  126147. set buttonSquare(value: number);
  126148. /**
  126149. * Gets the value of the `Triangle` button
  126150. */
  126151. get buttonTriangle(): number;
  126152. /**
  126153. * Sets the value of the `Triangle` button
  126154. */
  126155. set buttonTriangle(value: number);
  126156. /**
  126157. * Gets the value of the `Options` button
  126158. */
  126159. get buttonOptions(): number;
  126160. /**
  126161. * Sets the value of the `Options` button
  126162. */
  126163. set buttonOptions(value: number);
  126164. /**
  126165. * Gets the value of the `Share` button
  126166. */
  126167. get buttonShare(): number;
  126168. /**
  126169. * Sets the value of the `Share` button
  126170. */
  126171. set buttonShare(value: number);
  126172. /**
  126173. * Gets the value of the `L1` button
  126174. */
  126175. get buttonL1(): number;
  126176. /**
  126177. * Sets the value of the `L1` button
  126178. */
  126179. set buttonL1(value: number);
  126180. /**
  126181. * Gets the value of the `R1` button
  126182. */
  126183. get buttonR1(): number;
  126184. /**
  126185. * Sets the value of the `R1` button
  126186. */
  126187. set buttonR1(value: number);
  126188. /**
  126189. * Gets the value of the Left joystick
  126190. */
  126191. get buttonLeftStick(): number;
  126192. /**
  126193. * Sets the value of the Left joystick
  126194. */
  126195. set buttonLeftStick(value: number);
  126196. /**
  126197. * Gets the value of the Right joystick
  126198. */
  126199. get buttonRightStick(): number;
  126200. /**
  126201. * Sets the value of the Right joystick
  126202. */
  126203. set buttonRightStick(value: number);
  126204. /**
  126205. * Gets the value of D-pad up
  126206. */
  126207. get dPadUp(): number;
  126208. /**
  126209. * Sets the value of D-pad up
  126210. */
  126211. set dPadUp(value: number);
  126212. /**
  126213. * Gets the value of D-pad down
  126214. */
  126215. get dPadDown(): number;
  126216. /**
  126217. * Sets the value of D-pad down
  126218. */
  126219. set dPadDown(value: number);
  126220. /**
  126221. * Gets the value of D-pad left
  126222. */
  126223. get dPadLeft(): number;
  126224. /**
  126225. * Sets the value of D-pad left
  126226. */
  126227. set dPadLeft(value: number);
  126228. /**
  126229. * Gets the value of D-pad right
  126230. */
  126231. get dPadRight(): number;
  126232. /**
  126233. * Sets the value of D-pad right
  126234. */
  126235. set dPadRight(value: number);
  126236. /**
  126237. * Force the gamepad to synchronize with device values
  126238. */
  126239. update(): void;
  126240. /**
  126241. * Disposes the gamepad
  126242. */
  126243. dispose(): void;
  126244. }
  126245. }
  126246. declare module BABYLON {
  126247. /**
  126248. * Manager for handling gamepads
  126249. */
  126250. export class GamepadManager {
  126251. private _scene?;
  126252. private _babylonGamepads;
  126253. private _oneGamepadConnected;
  126254. /** @hidden */
  126255. _isMonitoring: boolean;
  126256. private _gamepadEventSupported;
  126257. private _gamepadSupport?;
  126258. /**
  126259. * observable to be triggered when the gamepad controller has been connected
  126260. */
  126261. onGamepadConnectedObservable: Observable<Gamepad>;
  126262. /**
  126263. * observable to be triggered when the gamepad controller has been disconnected
  126264. */
  126265. onGamepadDisconnectedObservable: Observable<Gamepad>;
  126266. private _onGamepadConnectedEvent;
  126267. private _onGamepadDisconnectedEvent;
  126268. /**
  126269. * Initializes the gamepad manager
  126270. * @param _scene BabylonJS scene
  126271. */
  126272. constructor(_scene?: Scene | undefined);
  126273. /**
  126274. * The gamepads in the game pad manager
  126275. */
  126276. get gamepads(): Gamepad[];
  126277. /**
  126278. * Get the gamepad controllers based on type
  126279. * @param type The type of gamepad controller
  126280. * @returns Nullable gamepad
  126281. */
  126282. getGamepadByType(type?: number): Nullable<Gamepad>;
  126283. /**
  126284. * Disposes the gamepad manager
  126285. */
  126286. dispose(): void;
  126287. private _addNewGamepad;
  126288. private _startMonitoringGamepads;
  126289. private _stopMonitoringGamepads;
  126290. /** @hidden */
  126291. _checkGamepadsStatus(): void;
  126292. private _updateGamepadObjects;
  126293. }
  126294. }
  126295. declare module BABYLON {
  126296. interface Scene {
  126297. /** @hidden */
  126298. _gamepadManager: Nullable<GamepadManager>;
  126299. /**
  126300. * Gets the gamepad manager associated with the scene
  126301. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  126302. */
  126303. gamepadManager: GamepadManager;
  126304. }
  126305. /**
  126306. * Interface representing a free camera inputs manager
  126307. */
  126308. interface FreeCameraInputsManager {
  126309. /**
  126310. * Adds gamepad input support to the FreeCameraInputsManager.
  126311. * @returns the FreeCameraInputsManager
  126312. */
  126313. addGamepad(): FreeCameraInputsManager;
  126314. }
  126315. /**
  126316. * Interface representing an arc rotate camera inputs manager
  126317. */
  126318. interface ArcRotateCameraInputsManager {
  126319. /**
  126320. * Adds gamepad input support to the ArcRotateCamera InputManager.
  126321. * @returns the camera inputs manager
  126322. */
  126323. addGamepad(): ArcRotateCameraInputsManager;
  126324. }
  126325. /**
  126326. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  126327. */
  126328. export class GamepadSystemSceneComponent implements ISceneComponent {
  126329. /**
  126330. * The component name helpfull to identify the component in the list of scene components.
  126331. */
  126332. readonly name: string;
  126333. /**
  126334. * The scene the component belongs to.
  126335. */
  126336. scene: Scene;
  126337. /**
  126338. * Creates a new instance of the component for the given scene
  126339. * @param scene Defines the scene to register the component in
  126340. */
  126341. constructor(scene: Scene);
  126342. /**
  126343. * Registers the component in a given scene
  126344. */
  126345. register(): void;
  126346. /**
  126347. * Rebuilds the elements related to this component in case of
  126348. * context lost for instance.
  126349. */
  126350. rebuild(): void;
  126351. /**
  126352. * Disposes the component and the associated ressources
  126353. */
  126354. dispose(): void;
  126355. private _beforeCameraUpdate;
  126356. }
  126357. }
  126358. declare module BABYLON {
  126359. /**
  126360. * 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,
  126361. * which still works and will still be found in many Playgrounds.
  126362. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126363. */
  126364. export class UniversalCamera extends TouchCamera {
  126365. /**
  126366. * Defines the gamepad rotation sensiblity.
  126367. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  126368. */
  126369. get gamepadAngularSensibility(): number;
  126370. set gamepadAngularSensibility(value: number);
  126371. /**
  126372. * Defines the gamepad move sensiblity.
  126373. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  126374. */
  126375. get gamepadMoveSensibility(): number;
  126376. set gamepadMoveSensibility(value: number);
  126377. /**
  126378. * 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,
  126379. * which still works and will still be found in many Playgrounds.
  126380. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126381. * @param name Define the name of the camera in the scene
  126382. * @param position Define the start position of the camera in the scene
  126383. * @param scene Define the scene the camera belongs to
  126384. */
  126385. constructor(name: string, position: Vector3, scene: Scene);
  126386. /**
  126387. * Gets the current object class name.
  126388. * @return the class name
  126389. */
  126390. getClassName(): string;
  126391. }
  126392. }
  126393. declare module BABYLON {
  126394. /**
  126395. * This represents a FPS type of camera. This is only here for back compat purpose.
  126396. * Please use the UniversalCamera instead as both are identical.
  126397. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126398. */
  126399. export class GamepadCamera extends UniversalCamera {
  126400. /**
  126401. * Instantiates a new Gamepad Camera
  126402. * This represents a FPS type of camera. This is only here for back compat purpose.
  126403. * Please use the UniversalCamera instead as both are identical.
  126404. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126405. * @param name Define the name of the camera in the scene
  126406. * @param position Define the start position of the camera in the scene
  126407. * @param scene Define the scene the camera belongs to
  126408. */
  126409. constructor(name: string, position: Vector3, scene: Scene);
  126410. /**
  126411. * Gets the current object class name.
  126412. * @return the class name
  126413. */
  126414. getClassName(): string;
  126415. }
  126416. }
  126417. declare module BABYLON {
  126418. /** @hidden */
  126419. export var passPixelShader: {
  126420. name: string;
  126421. shader: string;
  126422. };
  126423. }
  126424. declare module BABYLON {
  126425. /** @hidden */
  126426. export var passCubePixelShader: {
  126427. name: string;
  126428. shader: string;
  126429. };
  126430. }
  126431. declare module BABYLON {
  126432. /**
  126433. * PassPostProcess which produces an output the same as it's input
  126434. */
  126435. export class PassPostProcess extends PostProcess {
  126436. /**
  126437. * Gets a string identifying the name of the class
  126438. * @returns "PassPostProcess" string
  126439. */
  126440. getClassName(): string;
  126441. /**
  126442. * Creates the PassPostProcess
  126443. * @param name The name of the effect.
  126444. * @param options The required width/height ratio to downsize to before computing the render pass.
  126445. * @param camera The camera to apply the render pass to.
  126446. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  126447. * @param engine The engine which the post process will be applied. (default: current engine)
  126448. * @param reusable If the post process can be reused on the same frame. (default: false)
  126449. * @param textureType The type of texture to be used when performing the post processing.
  126450. * @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)
  126451. */
  126452. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  126453. /** @hidden */
  126454. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  126455. }
  126456. /**
  126457. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  126458. */
  126459. export class PassCubePostProcess extends PostProcess {
  126460. private _face;
  126461. /**
  126462. * Gets or sets the cube face to display.
  126463. * * 0 is +X
  126464. * * 1 is -X
  126465. * * 2 is +Y
  126466. * * 3 is -Y
  126467. * * 4 is +Z
  126468. * * 5 is -Z
  126469. */
  126470. get face(): number;
  126471. set face(value: number);
  126472. /**
  126473. * Gets a string identifying the name of the class
  126474. * @returns "PassCubePostProcess" string
  126475. */
  126476. getClassName(): string;
  126477. /**
  126478. * Creates the PassCubePostProcess
  126479. * @param name The name of the effect.
  126480. * @param options The required width/height ratio to downsize to before computing the render pass.
  126481. * @param camera The camera to apply the render pass to.
  126482. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  126483. * @param engine The engine which the post process will be applied. (default: current engine)
  126484. * @param reusable If the post process can be reused on the same frame. (default: false)
  126485. * @param textureType The type of texture to be used when performing the post processing.
  126486. * @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)
  126487. */
  126488. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  126489. /** @hidden */
  126490. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  126491. }
  126492. }
  126493. declare module BABYLON {
  126494. /** @hidden */
  126495. export var anaglyphPixelShader: {
  126496. name: string;
  126497. shader: string;
  126498. };
  126499. }
  126500. declare module BABYLON {
  126501. /**
  126502. * Postprocess used to generate anaglyphic rendering
  126503. */
  126504. export class AnaglyphPostProcess extends PostProcess {
  126505. private _passedProcess;
  126506. /**
  126507. * Gets a string identifying the name of the class
  126508. * @returns "AnaglyphPostProcess" string
  126509. */
  126510. getClassName(): string;
  126511. /**
  126512. * Creates a new AnaglyphPostProcess
  126513. * @param name defines postprocess name
  126514. * @param options defines creation options or target ratio scale
  126515. * @param rigCameras defines cameras using this postprocess
  126516. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  126517. * @param engine defines hosting engine
  126518. * @param reusable defines if the postprocess will be reused multiple times per frame
  126519. */
  126520. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  126521. }
  126522. }
  126523. declare module BABYLON {
  126524. /**
  126525. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  126526. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126527. */
  126528. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  126529. /**
  126530. * Creates a new AnaglyphArcRotateCamera
  126531. * @param name defines camera name
  126532. * @param alpha defines alpha angle (in radians)
  126533. * @param beta defines beta angle (in radians)
  126534. * @param radius defines radius
  126535. * @param target defines camera target
  126536. * @param interaxialDistance defines distance between each color axis
  126537. * @param scene defines the hosting scene
  126538. */
  126539. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  126540. /**
  126541. * Gets camera class name
  126542. * @returns AnaglyphArcRotateCamera
  126543. */
  126544. getClassName(): string;
  126545. }
  126546. }
  126547. declare module BABYLON {
  126548. /**
  126549. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  126550. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126551. */
  126552. export class AnaglyphFreeCamera extends FreeCamera {
  126553. /**
  126554. * Creates a new AnaglyphFreeCamera
  126555. * @param name defines camera name
  126556. * @param position defines initial position
  126557. * @param interaxialDistance defines distance between each color axis
  126558. * @param scene defines the hosting scene
  126559. */
  126560. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  126561. /**
  126562. * Gets camera class name
  126563. * @returns AnaglyphFreeCamera
  126564. */
  126565. getClassName(): string;
  126566. }
  126567. }
  126568. declare module BABYLON {
  126569. /**
  126570. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  126571. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126572. */
  126573. export class AnaglyphGamepadCamera extends GamepadCamera {
  126574. /**
  126575. * Creates a new AnaglyphGamepadCamera
  126576. * @param name defines camera name
  126577. * @param position defines initial position
  126578. * @param interaxialDistance defines distance between each color axis
  126579. * @param scene defines the hosting scene
  126580. */
  126581. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  126582. /**
  126583. * Gets camera class name
  126584. * @returns AnaglyphGamepadCamera
  126585. */
  126586. getClassName(): string;
  126587. }
  126588. }
  126589. declare module BABYLON {
  126590. /**
  126591. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  126592. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126593. */
  126594. export class AnaglyphUniversalCamera extends UniversalCamera {
  126595. /**
  126596. * Creates a new AnaglyphUniversalCamera
  126597. * @param name defines camera name
  126598. * @param position defines initial position
  126599. * @param interaxialDistance defines distance between each color axis
  126600. * @param scene defines the hosting scene
  126601. */
  126602. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  126603. /**
  126604. * Gets camera class name
  126605. * @returns AnaglyphUniversalCamera
  126606. */
  126607. getClassName(): string;
  126608. }
  126609. }
  126610. declare module BABYLON {
  126611. /**
  126612. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  126613. * @see https://doc.babylonjs.com/features/cameras
  126614. */
  126615. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  126616. /**
  126617. * Creates a new StereoscopicArcRotateCamera
  126618. * @param name defines camera name
  126619. * @param alpha defines alpha angle (in radians)
  126620. * @param beta defines beta angle (in radians)
  126621. * @param radius defines radius
  126622. * @param target defines camera target
  126623. * @param interaxialDistance defines distance between each color axis
  126624. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126625. * @param scene defines the hosting scene
  126626. */
  126627. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126628. /**
  126629. * Gets camera class name
  126630. * @returns StereoscopicArcRotateCamera
  126631. */
  126632. getClassName(): string;
  126633. }
  126634. }
  126635. declare module BABYLON {
  126636. /**
  126637. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  126638. * @see https://doc.babylonjs.com/features/cameras
  126639. */
  126640. export class StereoscopicFreeCamera extends FreeCamera {
  126641. /**
  126642. * Creates a new StereoscopicFreeCamera
  126643. * @param name defines camera name
  126644. * @param position defines initial position
  126645. * @param interaxialDistance defines distance between each color axis
  126646. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126647. * @param scene defines the hosting scene
  126648. */
  126649. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126650. /**
  126651. * Gets camera class name
  126652. * @returns StereoscopicFreeCamera
  126653. */
  126654. getClassName(): string;
  126655. }
  126656. }
  126657. declare module BABYLON {
  126658. /**
  126659. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  126660. * @see https://doc.babylonjs.com/features/cameras
  126661. */
  126662. export class StereoscopicGamepadCamera extends GamepadCamera {
  126663. /**
  126664. * Creates a new StereoscopicGamepadCamera
  126665. * @param name defines camera name
  126666. * @param position defines initial position
  126667. * @param interaxialDistance defines distance between each color axis
  126668. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126669. * @param scene defines the hosting scene
  126670. */
  126671. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126672. /**
  126673. * Gets camera class name
  126674. * @returns StereoscopicGamepadCamera
  126675. */
  126676. getClassName(): string;
  126677. }
  126678. }
  126679. declare module BABYLON {
  126680. /**
  126681. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  126682. * @see https://doc.babylonjs.com/features/cameras
  126683. */
  126684. export class StereoscopicUniversalCamera extends UniversalCamera {
  126685. /**
  126686. * Creates a new StereoscopicUniversalCamera
  126687. * @param name defines camera name
  126688. * @param position defines initial position
  126689. * @param interaxialDistance defines distance between each color axis
  126690. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126691. * @param scene defines the hosting scene
  126692. */
  126693. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126694. /**
  126695. * Gets camera class name
  126696. * @returns StereoscopicUniversalCamera
  126697. */
  126698. getClassName(): string;
  126699. }
  126700. }
  126701. declare module BABYLON {
  126702. /**
  126703. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  126704. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126705. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126706. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126707. */
  126708. export class VirtualJoysticksCamera extends FreeCamera {
  126709. /**
  126710. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  126711. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126712. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126713. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126714. * @param name Define the name of the camera in the scene
  126715. * @param position Define the start position of the camera in the scene
  126716. * @param scene Define the scene the camera belongs to
  126717. */
  126718. constructor(name: string, position: Vector3, scene: Scene);
  126719. /**
  126720. * Gets the current object class name.
  126721. * @return the class name
  126722. */
  126723. getClassName(): string;
  126724. }
  126725. }
  126726. declare module BABYLON {
  126727. /**
  126728. * This represents all the required metrics to create a VR camera.
  126729. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  126730. */
  126731. export class VRCameraMetrics {
  126732. /**
  126733. * Define the horizontal resolution off the screen.
  126734. */
  126735. hResolution: number;
  126736. /**
  126737. * Define the vertical resolution off the screen.
  126738. */
  126739. vResolution: number;
  126740. /**
  126741. * Define the horizontal screen size.
  126742. */
  126743. hScreenSize: number;
  126744. /**
  126745. * Define the vertical screen size.
  126746. */
  126747. vScreenSize: number;
  126748. /**
  126749. * Define the vertical screen center position.
  126750. */
  126751. vScreenCenter: number;
  126752. /**
  126753. * Define the distance of the eyes to the screen.
  126754. */
  126755. eyeToScreenDistance: number;
  126756. /**
  126757. * Define the distance between both lenses
  126758. */
  126759. lensSeparationDistance: number;
  126760. /**
  126761. * Define the distance between both viewer's eyes.
  126762. */
  126763. interpupillaryDistance: number;
  126764. /**
  126765. * Define the distortion factor of the VR postprocess.
  126766. * Please, touch with care.
  126767. */
  126768. distortionK: number[];
  126769. /**
  126770. * Define the chromatic aberration correction factors for the VR post process.
  126771. */
  126772. chromaAbCorrection: number[];
  126773. /**
  126774. * Define the scale factor of the post process.
  126775. * The smaller the better but the slower.
  126776. */
  126777. postProcessScaleFactor: number;
  126778. /**
  126779. * Define an offset for the lens center.
  126780. */
  126781. lensCenterOffset: number;
  126782. /**
  126783. * Define if the current vr camera should compensate the distortion of the lense or not.
  126784. */
  126785. compensateDistortion: boolean;
  126786. /**
  126787. * Defines if multiview should be enabled when rendering (Default: false)
  126788. */
  126789. multiviewEnabled: boolean;
  126790. /**
  126791. * Gets the rendering aspect ratio based on the provided resolutions.
  126792. */
  126793. get aspectRatio(): number;
  126794. /**
  126795. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126796. */
  126797. get aspectRatioFov(): number;
  126798. /**
  126799. * @hidden
  126800. */
  126801. get leftHMatrix(): Matrix;
  126802. /**
  126803. * @hidden
  126804. */
  126805. get rightHMatrix(): Matrix;
  126806. /**
  126807. * @hidden
  126808. */
  126809. get leftPreViewMatrix(): Matrix;
  126810. /**
  126811. * @hidden
  126812. */
  126813. get rightPreViewMatrix(): Matrix;
  126814. /**
  126815. * Get the default VRMetrics based on the most generic setup.
  126816. * @returns the default vr metrics
  126817. */
  126818. static GetDefault(): VRCameraMetrics;
  126819. }
  126820. }
  126821. declare module BABYLON {
  126822. /** @hidden */
  126823. export var vrDistortionCorrectionPixelShader: {
  126824. name: string;
  126825. shader: string;
  126826. };
  126827. }
  126828. declare module BABYLON {
  126829. /**
  126830. * VRDistortionCorrectionPostProcess used for mobile VR
  126831. */
  126832. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126833. private _isRightEye;
  126834. private _distortionFactors;
  126835. private _postProcessScaleFactor;
  126836. private _lensCenterOffset;
  126837. private _scaleIn;
  126838. private _scaleFactor;
  126839. private _lensCenter;
  126840. /**
  126841. * Gets a string identifying the name of the class
  126842. * @returns "VRDistortionCorrectionPostProcess" string
  126843. */
  126844. getClassName(): string;
  126845. /**
  126846. * Initializes the VRDistortionCorrectionPostProcess
  126847. * @param name The name of the effect.
  126848. * @param camera The camera to apply the render pass to.
  126849. * @param isRightEye If this is for the right eye distortion
  126850. * @param vrMetrics All the required metrics for the VR camera
  126851. */
  126852. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126853. }
  126854. }
  126855. declare module BABYLON {
  126856. /**
  126857. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126858. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126859. */
  126860. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126861. /**
  126862. * Creates a new VRDeviceOrientationArcRotateCamera
  126863. * @param name defines camera name
  126864. * @param alpha defines the camera rotation along the logitudinal axis
  126865. * @param beta defines the camera rotation along the latitudinal axis
  126866. * @param radius defines the camera distance from its target
  126867. * @param target defines the camera target
  126868. * @param scene defines the scene the camera belongs to
  126869. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126870. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126871. */
  126872. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126873. /**
  126874. * Gets camera class name
  126875. * @returns VRDeviceOrientationArcRotateCamera
  126876. */
  126877. getClassName(): string;
  126878. }
  126879. }
  126880. declare module BABYLON {
  126881. /**
  126882. * Camera used to simulate VR rendering (based on FreeCamera)
  126883. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126884. */
  126885. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126886. /**
  126887. * Creates a new VRDeviceOrientationFreeCamera
  126888. * @param name defines camera name
  126889. * @param position defines the start position of the camera
  126890. * @param scene defines the scene the camera belongs to
  126891. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126892. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126893. */
  126894. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126895. /**
  126896. * Gets camera class name
  126897. * @returns VRDeviceOrientationFreeCamera
  126898. */
  126899. getClassName(): string;
  126900. }
  126901. }
  126902. declare module BABYLON {
  126903. /**
  126904. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126905. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126906. */
  126907. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126908. /**
  126909. * Creates a new VRDeviceOrientationGamepadCamera
  126910. * @param name defines camera name
  126911. * @param position defines the start position of the camera
  126912. * @param scene defines the scene the camera belongs to
  126913. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126914. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126915. */
  126916. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126917. /**
  126918. * Gets camera class name
  126919. * @returns VRDeviceOrientationGamepadCamera
  126920. */
  126921. getClassName(): string;
  126922. }
  126923. }
  126924. declare module BABYLON {
  126925. /**
  126926. * A class extending Texture allowing drawing on a texture
  126927. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126928. */
  126929. export class DynamicTexture extends Texture {
  126930. private _generateMipMaps;
  126931. private _canvas;
  126932. private _context;
  126933. /**
  126934. * Creates a DynamicTexture
  126935. * @param name defines the name of the texture
  126936. * @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
  126937. * @param scene defines the scene where you want the texture
  126938. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126939. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126940. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126941. */
  126942. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126943. /**
  126944. * Get the current class name of the texture useful for serialization or dynamic coding.
  126945. * @returns "DynamicTexture"
  126946. */
  126947. getClassName(): string;
  126948. /**
  126949. * Gets the current state of canRescale
  126950. */
  126951. get canRescale(): boolean;
  126952. private _recreate;
  126953. /**
  126954. * Scales the texture
  126955. * @param ratio the scale factor to apply to both width and height
  126956. */
  126957. scale(ratio: number): void;
  126958. /**
  126959. * Resizes the texture
  126960. * @param width the new width
  126961. * @param height the new height
  126962. */
  126963. scaleTo(width: number, height: number): void;
  126964. /**
  126965. * Gets the context of the canvas used by the texture
  126966. * @returns the canvas context of the dynamic texture
  126967. */
  126968. getContext(): CanvasRenderingContext2D;
  126969. /**
  126970. * Clears the texture
  126971. */
  126972. clear(): void;
  126973. /**
  126974. * Updates the texture
  126975. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126976. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126977. */
  126978. update(invertY?: boolean, premulAlpha?: boolean): void;
  126979. /**
  126980. * Draws text onto the texture
  126981. * @param text defines the text to be drawn
  126982. * @param x defines the placement of the text from the left
  126983. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126984. * @param font defines the font to be used with font-style, font-size, font-name
  126985. * @param color defines the color used for the text
  126986. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126987. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126988. * @param update defines whether texture is immediately update (default is true)
  126989. */
  126990. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126991. /**
  126992. * Clones the texture
  126993. * @returns the clone of the texture.
  126994. */
  126995. clone(): DynamicTexture;
  126996. /**
  126997. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126998. * @returns a serialized dynamic texture object
  126999. */
  127000. serialize(): any;
  127001. private _IsCanvasElement;
  127002. /** @hidden */
  127003. _rebuild(): void;
  127004. }
  127005. }
  127006. declare module BABYLON {
  127007. /**
  127008. * Class containing static functions to help procedurally build meshes
  127009. */
  127010. export class GroundBuilder {
  127011. /**
  127012. * Creates a ground mesh
  127013. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  127014. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  127015. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127016. * @param name defines the name of the mesh
  127017. * @param options defines the options used to create the mesh
  127018. * @param scene defines the hosting scene
  127019. * @returns the ground mesh
  127020. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  127021. */
  127022. static CreateGround(name: string, options: {
  127023. width?: number;
  127024. height?: number;
  127025. subdivisions?: number;
  127026. subdivisionsX?: number;
  127027. subdivisionsY?: number;
  127028. updatable?: boolean;
  127029. }, scene: any): Mesh;
  127030. /**
  127031. * Creates a tiled ground mesh
  127032. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  127033. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  127034. * * 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
  127035. * * 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
  127036. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127037. * @param name defines the name of the mesh
  127038. * @param options defines the options used to create the mesh
  127039. * @param scene defines the hosting scene
  127040. * @returns the tiled ground mesh
  127041. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  127042. */
  127043. static CreateTiledGround(name: string, options: {
  127044. xmin: number;
  127045. zmin: number;
  127046. xmax: number;
  127047. zmax: number;
  127048. subdivisions?: {
  127049. w: number;
  127050. h: number;
  127051. };
  127052. precision?: {
  127053. w: number;
  127054. h: number;
  127055. };
  127056. updatable?: boolean;
  127057. }, scene?: Nullable<Scene>): Mesh;
  127058. /**
  127059. * Creates a ground mesh from a height map
  127060. * * The parameter `url` sets the URL of the height map image resource.
  127061. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  127062. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  127063. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  127064. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  127065. * * 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.
  127066. * * 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).
  127067. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  127068. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127069. * @param name defines the name of the mesh
  127070. * @param url defines the url to the height map
  127071. * @param options defines the options used to create the mesh
  127072. * @param scene defines the hosting scene
  127073. * @returns the ground mesh
  127074. * @see https://doc.babylonjs.com/babylon101/height_map
  127075. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  127076. */
  127077. static CreateGroundFromHeightMap(name: string, url: string, options: {
  127078. width?: number;
  127079. height?: number;
  127080. subdivisions?: number;
  127081. minHeight?: number;
  127082. maxHeight?: number;
  127083. colorFilter?: Color3;
  127084. alphaFilter?: number;
  127085. updatable?: boolean;
  127086. onReady?: (mesh: GroundMesh) => void;
  127087. }, scene?: Nullable<Scene>): GroundMesh;
  127088. }
  127089. }
  127090. declare module BABYLON {
  127091. /**
  127092. * Class containing static functions to help procedurally build meshes
  127093. */
  127094. export class TorusBuilder {
  127095. /**
  127096. * Creates a torus mesh
  127097. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  127098. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  127099. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  127100. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127101. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127102. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127103. * @param name defines the name of the mesh
  127104. * @param options defines the options used to create the mesh
  127105. * @param scene defines the hosting scene
  127106. * @returns the torus mesh
  127107. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  127108. */
  127109. static CreateTorus(name: string, options: {
  127110. diameter?: number;
  127111. thickness?: number;
  127112. tessellation?: number;
  127113. updatable?: boolean;
  127114. sideOrientation?: number;
  127115. frontUVs?: Vector4;
  127116. backUVs?: Vector4;
  127117. }, scene: any): Mesh;
  127118. }
  127119. }
  127120. declare module BABYLON {
  127121. /**
  127122. * Class containing static functions to help procedurally build meshes
  127123. */
  127124. export class CylinderBuilder {
  127125. /**
  127126. * Creates a cylinder or a cone mesh
  127127. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  127128. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  127129. * * 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.
  127130. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  127131. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  127132. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  127133. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  127134. * * 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).
  127135. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  127136. * * 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).
  127137. * * 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
  127138. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  127139. * * 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
  127140. * * 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.
  127141. * * If `enclose` is false, a ring surface is one element.
  127142. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  127143. * * 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
  127144. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127145. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127146. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127147. * @param name defines the name of the mesh
  127148. * @param options defines the options used to create the mesh
  127149. * @param scene defines the hosting scene
  127150. * @returns the cylinder mesh
  127151. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  127152. */
  127153. static CreateCylinder(name: string, options: {
  127154. height?: number;
  127155. diameterTop?: number;
  127156. diameterBottom?: number;
  127157. diameter?: number;
  127158. tessellation?: number;
  127159. subdivisions?: number;
  127160. arc?: number;
  127161. faceColors?: Color4[];
  127162. faceUV?: Vector4[];
  127163. updatable?: boolean;
  127164. hasRings?: boolean;
  127165. enclose?: boolean;
  127166. cap?: number;
  127167. sideOrientation?: number;
  127168. frontUVs?: Vector4;
  127169. backUVs?: Vector4;
  127170. }, scene: any): Mesh;
  127171. }
  127172. }
  127173. declare module BABYLON {
  127174. /**
  127175. * States of the webXR experience
  127176. */
  127177. export enum WebXRState {
  127178. /**
  127179. * Transitioning to being in XR mode
  127180. */
  127181. ENTERING_XR = 0,
  127182. /**
  127183. * Transitioning to non XR mode
  127184. */
  127185. EXITING_XR = 1,
  127186. /**
  127187. * In XR mode and presenting
  127188. */
  127189. IN_XR = 2,
  127190. /**
  127191. * Not entered XR mode
  127192. */
  127193. NOT_IN_XR = 3
  127194. }
  127195. /**
  127196. * Abstraction of the XR render target
  127197. */
  127198. export interface WebXRRenderTarget extends IDisposable {
  127199. /**
  127200. * xrpresent context of the canvas which can be used to display/mirror xr content
  127201. */
  127202. canvasContext: WebGLRenderingContext;
  127203. /**
  127204. * xr layer for the canvas
  127205. */
  127206. xrLayer: Nullable<XRWebGLLayer>;
  127207. /**
  127208. * Initializes the xr layer for the session
  127209. * @param xrSession xr session
  127210. * @returns a promise that will resolve once the XR Layer has been created
  127211. */
  127212. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  127213. }
  127214. }
  127215. declare module BABYLON {
  127216. /**
  127217. * COnfiguration object for WebXR output canvas
  127218. */
  127219. export class WebXRManagedOutputCanvasOptions {
  127220. /**
  127221. * An optional canvas in case you wish to create it yourself and provide it here.
  127222. * If not provided, a new canvas will be created
  127223. */
  127224. canvasElement?: HTMLCanvasElement;
  127225. /**
  127226. * Options for this XR Layer output
  127227. */
  127228. canvasOptions?: XRWebGLLayerOptions;
  127229. /**
  127230. * CSS styling for a newly created canvas (if not provided)
  127231. */
  127232. newCanvasCssStyle?: string;
  127233. /**
  127234. * Get the default values of the configuration object
  127235. * @param engine defines the engine to use (can be null)
  127236. * @returns default values of this configuration object
  127237. */
  127238. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  127239. }
  127240. /**
  127241. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  127242. */
  127243. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  127244. private _options;
  127245. private _canvas;
  127246. private _engine;
  127247. private _originalCanvasSize;
  127248. /**
  127249. * Rendering context of the canvas which can be used to display/mirror xr content
  127250. */
  127251. canvasContext: WebGLRenderingContext;
  127252. /**
  127253. * xr layer for the canvas
  127254. */
  127255. xrLayer: Nullable<XRWebGLLayer>;
  127256. /**
  127257. * Obseervers registered here will be triggered when the xr layer was initialized
  127258. */
  127259. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  127260. /**
  127261. * Initializes the canvas to be added/removed upon entering/exiting xr
  127262. * @param _xrSessionManager The XR Session manager
  127263. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  127264. */
  127265. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  127266. /**
  127267. * Disposes of the object
  127268. */
  127269. dispose(): void;
  127270. /**
  127271. * Initializes the xr layer for the session
  127272. * @param xrSession xr session
  127273. * @returns a promise that will resolve once the XR Layer has been created
  127274. */
  127275. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  127276. private _addCanvas;
  127277. private _removeCanvas;
  127278. private _setCanvasSize;
  127279. private _setManagedOutputCanvas;
  127280. }
  127281. }
  127282. declare module BABYLON {
  127283. /**
  127284. * Manages an XRSession to work with Babylon's engine
  127285. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  127286. */
  127287. export class WebXRSessionManager implements IDisposable {
  127288. /** The scene which the session should be created for */
  127289. scene: Scene;
  127290. private _referenceSpace;
  127291. private _rttProvider;
  127292. private _sessionEnded;
  127293. private _xrNavigator;
  127294. private baseLayer;
  127295. /**
  127296. * The base reference space from which the session started. good if you want to reset your
  127297. * reference space
  127298. */
  127299. baseReferenceSpace: XRReferenceSpace;
  127300. /**
  127301. * Current XR frame
  127302. */
  127303. currentFrame: Nullable<XRFrame>;
  127304. /** WebXR timestamp updated every frame */
  127305. currentTimestamp: number;
  127306. /**
  127307. * Used just in case of a failure to initialize an immersive session.
  127308. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  127309. */
  127310. defaultHeightCompensation: number;
  127311. /**
  127312. * Fires every time a new xrFrame arrives which can be used to update the camera
  127313. */
  127314. onXRFrameObservable: Observable<XRFrame>;
  127315. /**
  127316. * Fires when the reference space changed
  127317. */
  127318. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  127319. /**
  127320. * Fires when the xr session is ended either by the device or manually done
  127321. */
  127322. onXRSessionEnded: Observable<any>;
  127323. /**
  127324. * Fires when the xr session is ended either by the device or manually done
  127325. */
  127326. onXRSessionInit: Observable<XRSession>;
  127327. /**
  127328. * Underlying xr session
  127329. */
  127330. session: XRSession;
  127331. /**
  127332. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  127333. * or get the offset the player is currently at.
  127334. */
  127335. viewerReferenceSpace: XRReferenceSpace;
  127336. /**
  127337. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  127338. * @param scene The scene which the session should be created for
  127339. */
  127340. constructor(
  127341. /** The scene which the session should be created for */
  127342. scene: Scene);
  127343. /**
  127344. * The current reference space used in this session. This reference space can constantly change!
  127345. * It is mainly used to offset the camera's position.
  127346. */
  127347. get referenceSpace(): XRReferenceSpace;
  127348. /**
  127349. * Set a new reference space and triggers the observable
  127350. */
  127351. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  127352. /**
  127353. * Disposes of the session manager
  127354. */
  127355. dispose(): void;
  127356. /**
  127357. * Stops the xrSession and restores the render loop
  127358. * @returns Promise which resolves after it exits XR
  127359. */
  127360. exitXRAsync(): Promise<void>;
  127361. /**
  127362. * Gets the correct render target texture to be rendered this frame for this eye
  127363. * @param eye the eye for which to get the render target
  127364. * @returns the render target for the specified eye
  127365. */
  127366. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  127367. /**
  127368. * Creates a WebXRRenderTarget object for the XR session
  127369. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  127370. * @param options optional options to provide when creating a new render target
  127371. * @returns a WebXR render target to which the session can render
  127372. */
  127373. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  127374. /**
  127375. * Initializes the manager
  127376. * After initialization enterXR can be called to start an XR session
  127377. * @returns Promise which resolves after it is initialized
  127378. */
  127379. initializeAsync(): Promise<void>;
  127380. /**
  127381. * Initializes an xr session
  127382. * @param xrSessionMode mode to initialize
  127383. * @param xrSessionInit defines optional and required values to pass to the session builder
  127384. * @returns a promise which will resolve once the session has been initialized
  127385. */
  127386. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  127387. /**
  127388. * Checks if a session would be supported for the creation options specified
  127389. * @param sessionMode session mode to check if supported eg. immersive-vr
  127390. * @returns A Promise that resolves to true if supported and false if not
  127391. */
  127392. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  127393. /**
  127394. * Resets the reference space to the one started the session
  127395. */
  127396. resetReferenceSpace(): void;
  127397. /**
  127398. * Starts rendering to the xr layer
  127399. */
  127400. runXRRenderLoop(): void;
  127401. /**
  127402. * Sets the reference space on the xr session
  127403. * @param referenceSpaceType space to set
  127404. * @returns a promise that will resolve once the reference space has been set
  127405. */
  127406. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  127407. /**
  127408. * Updates the render state of the session
  127409. * @param state state to set
  127410. * @returns a promise that resolves once the render state has been updated
  127411. */
  127412. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  127413. /**
  127414. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  127415. * @param sessionMode defines the session to test
  127416. * @returns a promise with boolean as final value
  127417. */
  127418. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  127419. private _createRenderTargetTexture;
  127420. }
  127421. }
  127422. declare module BABYLON {
  127423. /**
  127424. * WebXR Camera which holds the views for the xrSession
  127425. * @see https://doc.babylonjs.com/how_to/webxr_camera
  127426. */
  127427. export class WebXRCamera extends FreeCamera {
  127428. private _xrSessionManager;
  127429. private _firstFrame;
  127430. private _referenceQuaternion;
  127431. private _referencedPosition;
  127432. private _xrInvPositionCache;
  127433. private _xrInvQuaternionCache;
  127434. /**
  127435. * Observable raised before camera teleportation
  127436. */
  127437. onBeforeCameraTeleport: Observable<Vector3>;
  127438. /**
  127439. * Observable raised after camera teleportation
  127440. */
  127441. onAfterCameraTeleport: Observable<Vector3>;
  127442. /**
  127443. * Should position compensation execute on first frame.
  127444. * This is used when copying the position from a native (non XR) camera
  127445. */
  127446. compensateOnFirstFrame: boolean;
  127447. /**
  127448. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  127449. * @param name the name of the camera
  127450. * @param scene the scene to add the camera to
  127451. * @param _xrSessionManager a constructed xr session manager
  127452. */
  127453. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  127454. /**
  127455. * Return the user's height, unrelated to the current ground.
  127456. * This will be the y position of this camera, when ground level is 0.
  127457. */
  127458. get realWorldHeight(): number;
  127459. /** @hidden */
  127460. _updateForDualEyeDebugging(): void;
  127461. /**
  127462. * Sets this camera's transformation based on a non-vr camera
  127463. * @param otherCamera the non-vr camera to copy the transformation from
  127464. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  127465. */
  127466. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  127467. /**
  127468. * Gets the current instance class name ("WebXRCamera").
  127469. * @returns the class name
  127470. */
  127471. getClassName(): string;
  127472. private _rotate180;
  127473. private _updateFromXRSession;
  127474. private _updateNumberOfRigCameras;
  127475. private _updateReferenceSpace;
  127476. private _updateReferenceSpaceOffset;
  127477. }
  127478. }
  127479. declare module BABYLON {
  127480. /**
  127481. * Defining the interface required for a (webxr) feature
  127482. */
  127483. export interface IWebXRFeature extends IDisposable {
  127484. /**
  127485. * Is this feature attached
  127486. */
  127487. attached: boolean;
  127488. /**
  127489. * Should auto-attach be disabled?
  127490. */
  127491. disableAutoAttach: boolean;
  127492. /**
  127493. * Attach the feature to the session
  127494. * Will usually be called by the features manager
  127495. *
  127496. * @param force should attachment be forced (even when already attached)
  127497. * @returns true if successful.
  127498. */
  127499. attach(force?: boolean): boolean;
  127500. /**
  127501. * Detach the feature from the session
  127502. * Will usually be called by the features manager
  127503. *
  127504. * @returns true if successful.
  127505. */
  127506. detach(): boolean;
  127507. /**
  127508. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  127509. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  127510. *
  127511. * @returns whether or not the feature is compatible in this environment
  127512. */
  127513. isCompatible(): boolean;
  127514. /**
  127515. * Was this feature disposed;
  127516. */
  127517. isDisposed: boolean;
  127518. /**
  127519. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  127520. */
  127521. xrNativeFeatureName?: string;
  127522. /**
  127523. * A list of (Babylon WebXR) features this feature depends on
  127524. */
  127525. dependsOn?: string[];
  127526. }
  127527. /**
  127528. * A list of the currently available features without referencing them
  127529. */
  127530. export class WebXRFeatureName {
  127531. /**
  127532. * The name of the anchor system feature
  127533. */
  127534. static readonly ANCHOR_SYSTEM: string;
  127535. /**
  127536. * The name of the background remover feature
  127537. */
  127538. static readonly BACKGROUND_REMOVER: string;
  127539. /**
  127540. * The name of the hit test feature
  127541. */
  127542. static readonly HIT_TEST: string;
  127543. /**
  127544. * physics impostors for xr controllers feature
  127545. */
  127546. static readonly PHYSICS_CONTROLLERS: string;
  127547. /**
  127548. * The name of the plane detection feature
  127549. */
  127550. static readonly PLANE_DETECTION: string;
  127551. /**
  127552. * The name of the pointer selection feature
  127553. */
  127554. static readonly POINTER_SELECTION: string;
  127555. /**
  127556. * The name of the teleportation feature
  127557. */
  127558. static readonly TELEPORTATION: string;
  127559. /**
  127560. * The name of the feature points feature.
  127561. */
  127562. static readonly FEATURE_POINTS: string;
  127563. /**
  127564. * The name of the hand tracking feature.
  127565. */
  127566. static readonly HAND_TRACKING: string;
  127567. }
  127568. /**
  127569. * Defining the constructor of a feature. Used to register the modules.
  127570. */
  127571. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  127572. /**
  127573. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  127574. * It is mainly used in AR sessions.
  127575. *
  127576. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  127577. */
  127578. export class WebXRFeaturesManager implements IDisposable {
  127579. private _xrSessionManager;
  127580. private static readonly _AvailableFeatures;
  127581. private _features;
  127582. /**
  127583. * constructs a new features manages.
  127584. *
  127585. * @param _xrSessionManager an instance of WebXRSessionManager
  127586. */
  127587. constructor(_xrSessionManager: WebXRSessionManager);
  127588. /**
  127589. * Used to register a module. After calling this function a developer can use this feature in the scene.
  127590. * Mainly used internally.
  127591. *
  127592. * @param featureName the name of the feature to register
  127593. * @param constructorFunction the function used to construct the module
  127594. * @param version the (babylon) version of the module
  127595. * @param stable is that a stable version of this module
  127596. */
  127597. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  127598. /**
  127599. * Returns a constructor of a specific feature.
  127600. *
  127601. * @param featureName the name of the feature to construct
  127602. * @param version the version of the feature to load
  127603. * @param xrSessionManager the xrSessionManager. Used to construct the module
  127604. * @param options optional options provided to the module.
  127605. * @returns a function that, when called, will return a new instance of this feature
  127606. */
  127607. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  127608. /**
  127609. * Can be used to return the list of features currently registered
  127610. *
  127611. * @returns an Array of available features
  127612. */
  127613. static GetAvailableFeatures(): string[];
  127614. /**
  127615. * Gets the versions available for a specific feature
  127616. * @param featureName the name of the feature
  127617. * @returns an array with the available versions
  127618. */
  127619. static GetAvailableVersions(featureName: string): string[];
  127620. /**
  127621. * Return the latest unstable version of this feature
  127622. * @param featureName the name of the feature to search
  127623. * @returns the version number. if not found will return -1
  127624. */
  127625. static GetLatestVersionOfFeature(featureName: string): number;
  127626. /**
  127627. * Return the latest stable version of this feature
  127628. * @param featureName the name of the feature to search
  127629. * @returns the version number. if not found will return -1
  127630. */
  127631. static GetStableVersionOfFeature(featureName: string): number;
  127632. /**
  127633. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  127634. * Can be used during a session to start a feature
  127635. * @param featureName the name of feature to attach
  127636. */
  127637. attachFeature(featureName: string): void;
  127638. /**
  127639. * Can be used inside a session or when the session ends to detach a specific feature
  127640. * @param featureName the name of the feature to detach
  127641. */
  127642. detachFeature(featureName: string): void;
  127643. /**
  127644. * Used to disable an already-enabled feature
  127645. * The feature will be disposed and will be recreated once enabled.
  127646. * @param featureName the feature to disable
  127647. * @returns true if disable was successful
  127648. */
  127649. disableFeature(featureName: string | {
  127650. Name: string;
  127651. }): boolean;
  127652. /**
  127653. * dispose this features manager
  127654. */
  127655. dispose(): void;
  127656. /**
  127657. * 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.
  127658. * 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.
  127659. *
  127660. * @param featureName the name of the feature to load or the class of the feature
  127661. * @param version optional version to load. if not provided the latest version will be enabled
  127662. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  127663. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  127664. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  127665. * @returns a new constructed feature or throws an error if feature not found.
  127666. */
  127667. enableFeature(featureName: string | {
  127668. Name: string;
  127669. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  127670. /**
  127671. * get the implementation of an enabled feature.
  127672. * @param featureName the name of the feature to load
  127673. * @returns the feature class, if found
  127674. */
  127675. getEnabledFeature(featureName: string): IWebXRFeature;
  127676. /**
  127677. * Get the list of enabled features
  127678. * @returns an array of enabled features
  127679. */
  127680. getEnabledFeatures(): string[];
  127681. /**
  127682. * This function will exten the session creation configuration object with enabled features.
  127683. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  127684. * according to the defined "required" variable, provided during enableFeature call
  127685. * @param xrSessionInit the xr Session init object to extend
  127686. *
  127687. * @returns an extended XRSessionInit object
  127688. */
  127689. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  127690. }
  127691. }
  127692. declare module BABYLON {
  127693. /**
  127694. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  127695. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  127696. */
  127697. export class WebXRExperienceHelper implements IDisposable {
  127698. private scene;
  127699. private _nonVRCamera;
  127700. private _originalSceneAutoClear;
  127701. private _supported;
  127702. /**
  127703. * Camera used to render xr content
  127704. */
  127705. camera: WebXRCamera;
  127706. /** A features manager for this xr session */
  127707. featuresManager: WebXRFeaturesManager;
  127708. /**
  127709. * Observers registered here will be triggered after the camera's initial transformation is set
  127710. * This can be used to set a different ground level or an extra rotation.
  127711. *
  127712. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  127713. * to the position set after this observable is done executing.
  127714. */
  127715. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  127716. /**
  127717. * Fires when the state of the experience helper has changed
  127718. */
  127719. onStateChangedObservable: Observable<WebXRState>;
  127720. /** Session manager used to keep track of xr session */
  127721. sessionManager: WebXRSessionManager;
  127722. /**
  127723. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  127724. */
  127725. state: WebXRState;
  127726. /**
  127727. * Creates a WebXRExperienceHelper
  127728. * @param scene The scene the helper should be created in
  127729. */
  127730. private constructor();
  127731. /**
  127732. * Creates the experience helper
  127733. * @param scene the scene to attach the experience helper to
  127734. * @returns a promise for the experience helper
  127735. */
  127736. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  127737. /**
  127738. * Disposes of the experience helper
  127739. */
  127740. dispose(): void;
  127741. /**
  127742. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  127743. * @param sessionMode options for the XR session
  127744. * @param referenceSpaceType frame of reference of the XR session
  127745. * @param renderTarget the output canvas that will be used to enter XR mode
  127746. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  127747. * @returns promise that resolves after xr mode has entered
  127748. */
  127749. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  127750. /**
  127751. * Exits XR mode and returns the scene to its original state
  127752. * @returns promise that resolves after xr mode has exited
  127753. */
  127754. exitXRAsync(): Promise<void>;
  127755. private _nonXRToXRCamera;
  127756. private _setState;
  127757. }
  127758. }
  127759. declare module BABYLON {
  127760. /**
  127761. * X-Y values for axes in WebXR
  127762. */
  127763. export interface IWebXRMotionControllerAxesValue {
  127764. /**
  127765. * The value of the x axis
  127766. */
  127767. x: number;
  127768. /**
  127769. * The value of the y-axis
  127770. */
  127771. y: number;
  127772. }
  127773. /**
  127774. * changed / previous values for the values of this component
  127775. */
  127776. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127777. /**
  127778. * current (this frame) value
  127779. */
  127780. current: T;
  127781. /**
  127782. * previous (last change) value
  127783. */
  127784. previous: T;
  127785. }
  127786. /**
  127787. * Represents changes in the component between current frame and last values recorded
  127788. */
  127789. export interface IWebXRMotionControllerComponentChanges {
  127790. /**
  127791. * will be populated with previous and current values if axes changed
  127792. */
  127793. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127794. /**
  127795. * will be populated with previous and current values if pressed changed
  127796. */
  127797. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127798. /**
  127799. * will be populated with previous and current values if touched changed
  127800. */
  127801. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127802. /**
  127803. * will be populated with previous and current values if value changed
  127804. */
  127805. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127806. }
  127807. /**
  127808. * This class represents a single component (for example button or thumbstick) of a motion controller
  127809. */
  127810. export class WebXRControllerComponent implements IDisposable {
  127811. /**
  127812. * the id of this component
  127813. */
  127814. id: string;
  127815. /**
  127816. * the type of the component
  127817. */
  127818. type: MotionControllerComponentType;
  127819. private _buttonIndex;
  127820. private _axesIndices;
  127821. private _axes;
  127822. private _changes;
  127823. private _currentValue;
  127824. private _hasChanges;
  127825. private _pressed;
  127826. private _touched;
  127827. /**
  127828. * button component type
  127829. */
  127830. static BUTTON_TYPE: MotionControllerComponentType;
  127831. /**
  127832. * squeeze component type
  127833. */
  127834. static SQUEEZE_TYPE: MotionControllerComponentType;
  127835. /**
  127836. * Thumbstick component type
  127837. */
  127838. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127839. /**
  127840. * Touchpad component type
  127841. */
  127842. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127843. /**
  127844. * trigger component type
  127845. */
  127846. static TRIGGER_TYPE: MotionControllerComponentType;
  127847. /**
  127848. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127849. * the axes data changes
  127850. */
  127851. onAxisValueChangedObservable: Observable<{
  127852. x: number;
  127853. y: number;
  127854. }>;
  127855. /**
  127856. * Observers registered here will be triggered when the state of a button changes
  127857. * State change is either pressed / touched / value
  127858. */
  127859. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127860. /**
  127861. * Creates a new component for a motion controller.
  127862. * It is created by the motion controller itself
  127863. *
  127864. * @param id the id of this component
  127865. * @param type the type of the component
  127866. * @param _buttonIndex index in the buttons array of the gamepad
  127867. * @param _axesIndices indices of the values in the axes array of the gamepad
  127868. */
  127869. constructor(
  127870. /**
  127871. * the id of this component
  127872. */
  127873. id: string,
  127874. /**
  127875. * the type of the component
  127876. */
  127877. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127878. /**
  127879. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127880. */
  127881. get axes(): IWebXRMotionControllerAxesValue;
  127882. /**
  127883. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127884. */
  127885. get changes(): IWebXRMotionControllerComponentChanges;
  127886. /**
  127887. * Return whether or not the component changed the last frame
  127888. */
  127889. get hasChanges(): boolean;
  127890. /**
  127891. * is the button currently pressed
  127892. */
  127893. get pressed(): boolean;
  127894. /**
  127895. * is the button currently touched
  127896. */
  127897. get touched(): boolean;
  127898. /**
  127899. * Get the current value of this component
  127900. */
  127901. get value(): number;
  127902. /**
  127903. * Dispose this component
  127904. */
  127905. dispose(): void;
  127906. /**
  127907. * Are there axes correlating to this component
  127908. * @return true is axes data is available
  127909. */
  127910. isAxes(): boolean;
  127911. /**
  127912. * Is this component a button (hence - pressable)
  127913. * @returns true if can be pressed
  127914. */
  127915. isButton(): boolean;
  127916. /**
  127917. * update this component using the gamepad object it is in. Called on every frame
  127918. * @param nativeController the native gamepad controller object
  127919. */
  127920. update(nativeController: IMinimalMotionControllerObject): void;
  127921. }
  127922. }
  127923. declare module BABYLON {
  127924. /**
  127925. * Interface used to represent data loading progression
  127926. */
  127927. export interface ISceneLoaderProgressEvent {
  127928. /**
  127929. * Defines if data length to load can be evaluated
  127930. */
  127931. readonly lengthComputable: boolean;
  127932. /**
  127933. * Defines the loaded data length
  127934. */
  127935. readonly loaded: number;
  127936. /**
  127937. * Defines the data length to load
  127938. */
  127939. readonly total: number;
  127940. }
  127941. /**
  127942. * Interface used by SceneLoader plugins to define supported file extensions
  127943. */
  127944. export interface ISceneLoaderPluginExtensions {
  127945. /**
  127946. * Defines the list of supported extensions
  127947. */
  127948. [extension: string]: {
  127949. isBinary: boolean;
  127950. };
  127951. }
  127952. /**
  127953. * Interface used by SceneLoader plugin factory
  127954. */
  127955. export interface ISceneLoaderPluginFactory {
  127956. /**
  127957. * Defines the name of the factory
  127958. */
  127959. name: string;
  127960. /**
  127961. * Function called to create a new plugin
  127962. * @return the new plugin
  127963. */
  127964. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127965. /**
  127966. * The callback that returns true if the data can be directly loaded.
  127967. * @param data string containing the file data
  127968. * @returns if the data can be loaded directly
  127969. */
  127970. canDirectLoad?(data: string): boolean;
  127971. }
  127972. /**
  127973. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127974. */
  127975. export interface ISceneLoaderPluginBase {
  127976. /**
  127977. * The friendly name of this plugin.
  127978. */
  127979. name: string;
  127980. /**
  127981. * The file extensions supported by this plugin.
  127982. */
  127983. extensions: string | ISceneLoaderPluginExtensions;
  127984. /**
  127985. * The callback called when loading from a url.
  127986. * @param scene scene loading this url
  127987. * @param url url to load
  127988. * @param onSuccess callback called when the file successfully loads
  127989. * @param onProgress callback called while file is loading (if the server supports this mode)
  127990. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127991. * @param onError callback called when the file fails to load
  127992. * @returns a file request object
  127993. */
  127994. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127995. /**
  127996. * The callback called when loading from a file object.
  127997. * @param scene scene loading this file
  127998. * @param file defines the file to load
  127999. * @param onSuccess defines the callback to call when data is loaded
  128000. * @param onProgress defines the callback to call during loading process
  128001. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  128002. * @param onError defines the callback to call when an error occurs
  128003. * @returns a file request object
  128004. */
  128005. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  128006. /**
  128007. * The callback that returns true if the data can be directly loaded.
  128008. * @param data string containing the file data
  128009. * @returns if the data can be loaded directly
  128010. */
  128011. canDirectLoad?(data: string): boolean;
  128012. /**
  128013. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  128014. * @param scene scene loading this data
  128015. * @param data string containing the data
  128016. * @returns data to pass to the plugin
  128017. */
  128018. directLoad?(scene: Scene, data: string): any;
  128019. /**
  128020. * The callback that allows custom handling of the root url based on the response url.
  128021. * @param rootUrl the original root url
  128022. * @param responseURL the response url if available
  128023. * @returns the new root url
  128024. */
  128025. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  128026. }
  128027. /**
  128028. * Interface used to define a SceneLoader plugin
  128029. */
  128030. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  128031. /**
  128032. * Import meshes into a scene.
  128033. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128034. * @param scene The scene to import into
  128035. * @param data The data to import
  128036. * @param rootUrl The root url for scene and resources
  128037. * @param meshes The meshes array to import into
  128038. * @param particleSystems The particle systems array to import into
  128039. * @param skeletons The skeletons array to import into
  128040. * @param onError The callback when import fails
  128041. * @returns True if successful or false otherwise
  128042. */
  128043. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  128044. /**
  128045. * Load into a scene.
  128046. * @param scene The scene to load into
  128047. * @param data The data to import
  128048. * @param rootUrl The root url for scene and resources
  128049. * @param onError The callback when import fails
  128050. * @returns True if successful or false otherwise
  128051. */
  128052. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  128053. /**
  128054. * Load into an asset container.
  128055. * @param scene The scene to load into
  128056. * @param data The data to import
  128057. * @param rootUrl The root url for scene and resources
  128058. * @param onError The callback when import fails
  128059. * @returns The loaded asset container
  128060. */
  128061. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  128062. }
  128063. /**
  128064. * Interface used to define an async SceneLoader plugin
  128065. */
  128066. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  128067. /**
  128068. * Import meshes into a scene.
  128069. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128070. * @param scene The scene to import into
  128071. * @param data The data to import
  128072. * @param rootUrl The root url for scene and resources
  128073. * @param onProgress The callback when the load progresses
  128074. * @param fileName Defines the name of the file to load
  128075. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  128076. */
  128077. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  128078. meshes: AbstractMesh[];
  128079. particleSystems: IParticleSystem[];
  128080. skeletons: Skeleton[];
  128081. animationGroups: AnimationGroup[];
  128082. }>;
  128083. /**
  128084. * Load into a scene.
  128085. * @param scene The scene to load into
  128086. * @param data The data to import
  128087. * @param rootUrl The root url for scene and resources
  128088. * @param onProgress The callback when the load progresses
  128089. * @param fileName Defines the name of the file to load
  128090. * @returns Nothing
  128091. */
  128092. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  128093. /**
  128094. * Load into an asset container.
  128095. * @param scene The scene to load into
  128096. * @param data The data to import
  128097. * @param rootUrl The root url for scene and resources
  128098. * @param onProgress The callback when the load progresses
  128099. * @param fileName Defines the name of the file to load
  128100. * @returns The loaded asset container
  128101. */
  128102. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  128103. }
  128104. /**
  128105. * Mode that determines how to handle old animation groups before loading new ones.
  128106. */
  128107. export enum SceneLoaderAnimationGroupLoadingMode {
  128108. /**
  128109. * Reset all old animations to initial state then dispose them.
  128110. */
  128111. Clean = 0,
  128112. /**
  128113. * Stop all old animations.
  128114. */
  128115. Stop = 1,
  128116. /**
  128117. * Restart old animations from first frame.
  128118. */
  128119. Sync = 2,
  128120. /**
  128121. * Old animations remains untouched.
  128122. */
  128123. NoSync = 3
  128124. }
  128125. /**
  128126. * Defines a plugin registered by the SceneLoader
  128127. */
  128128. interface IRegisteredPlugin {
  128129. /**
  128130. * Defines the plugin to use
  128131. */
  128132. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  128133. /**
  128134. * Defines if the plugin supports binary data
  128135. */
  128136. isBinary: boolean;
  128137. }
  128138. /**
  128139. * Class used to load scene from various file formats using registered plugins
  128140. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  128141. */
  128142. export class SceneLoader {
  128143. /**
  128144. * No logging while loading
  128145. */
  128146. static readonly NO_LOGGING: number;
  128147. /**
  128148. * Minimal logging while loading
  128149. */
  128150. static readonly MINIMAL_LOGGING: number;
  128151. /**
  128152. * Summary logging while loading
  128153. */
  128154. static readonly SUMMARY_LOGGING: number;
  128155. /**
  128156. * Detailled logging while loading
  128157. */
  128158. static readonly DETAILED_LOGGING: number;
  128159. /**
  128160. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  128161. */
  128162. static get ForceFullSceneLoadingForIncremental(): boolean;
  128163. static set ForceFullSceneLoadingForIncremental(value: boolean);
  128164. /**
  128165. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  128166. */
  128167. static get ShowLoadingScreen(): boolean;
  128168. static set ShowLoadingScreen(value: boolean);
  128169. /**
  128170. * Defines the current logging level (while loading the scene)
  128171. * @ignorenaming
  128172. */
  128173. static get loggingLevel(): number;
  128174. static set loggingLevel(value: number);
  128175. /**
  128176. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  128177. */
  128178. static get CleanBoneMatrixWeights(): boolean;
  128179. static set CleanBoneMatrixWeights(value: boolean);
  128180. /**
  128181. * Event raised when a plugin is used to load a scene
  128182. */
  128183. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  128184. private static _registeredPlugins;
  128185. private static _showingLoadingScreen;
  128186. /**
  128187. * Gets the default plugin (used to load Babylon files)
  128188. * @returns the .babylon plugin
  128189. */
  128190. static GetDefaultPlugin(): IRegisteredPlugin;
  128191. private static _GetPluginForExtension;
  128192. private static _GetPluginForDirectLoad;
  128193. private static _GetPluginForFilename;
  128194. private static _GetDirectLoad;
  128195. private static _LoadData;
  128196. private static _GetFileInfo;
  128197. /**
  128198. * Gets a plugin that can load the given extension
  128199. * @param extension defines the extension to load
  128200. * @returns a plugin or null if none works
  128201. */
  128202. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  128203. /**
  128204. * Gets a boolean indicating that the given extension can be loaded
  128205. * @param extension defines the extension to load
  128206. * @returns true if the extension is supported
  128207. */
  128208. static IsPluginForExtensionAvailable(extension: string): boolean;
  128209. /**
  128210. * Adds a new plugin to the list of registered plugins
  128211. * @param plugin defines the plugin to add
  128212. */
  128213. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  128214. /**
  128215. * Import meshes into a scene
  128216. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128217. * @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)
  128218. * @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)
  128219. * @param scene the instance of BABYLON.Scene to append to
  128220. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  128221. * @param onProgress a callback with a progress event for each file being loaded
  128222. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128223. * @param pluginExtension the extension used to determine the plugin
  128224. * @returns The loaded plugin
  128225. */
  128226. 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>;
  128227. /**
  128228. * Import meshes into a scene
  128229. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128230. * @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)
  128231. * @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)
  128232. * @param scene the instance of BABYLON.Scene to append to
  128233. * @param onProgress a callback with a progress event for each file being loaded
  128234. * @param pluginExtension the extension used to determine the plugin
  128235. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  128236. */
  128237. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  128238. meshes: AbstractMesh[];
  128239. particleSystems: IParticleSystem[];
  128240. skeletons: Skeleton[];
  128241. animationGroups: AnimationGroup[];
  128242. }>;
  128243. /**
  128244. * Load a scene
  128245. * @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)
  128246. * @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)
  128247. * @param engine is the instance of BABYLON.Engine to use to create the scene
  128248. * @param onSuccess a callback with the scene when import succeeds
  128249. * @param onProgress a callback with a progress event for each file being loaded
  128250. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128251. * @param pluginExtension the extension used to determine the plugin
  128252. * @returns The loaded plugin
  128253. */
  128254. 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>;
  128255. /**
  128256. * Load a scene
  128257. * @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)
  128258. * @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)
  128259. * @param engine is the instance of BABYLON.Engine to use to create the scene
  128260. * @param onProgress a callback with a progress event for each file being loaded
  128261. * @param pluginExtension the extension used to determine the plugin
  128262. * @returns The loaded scene
  128263. */
  128264. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  128265. /**
  128266. * Append a scene
  128267. * @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)
  128268. * @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)
  128269. * @param scene is the instance of BABYLON.Scene to append to
  128270. * @param onSuccess a callback with the scene when import succeeds
  128271. * @param onProgress a callback with a progress event for each file being loaded
  128272. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128273. * @param pluginExtension the extension used to determine the plugin
  128274. * @returns The loaded plugin
  128275. */
  128276. 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>;
  128277. /**
  128278. * Append a scene
  128279. * @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)
  128280. * @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)
  128281. * @param scene is the instance of BABYLON.Scene to append to
  128282. * @param onProgress a callback with a progress event for each file being loaded
  128283. * @param pluginExtension the extension used to determine the plugin
  128284. * @returns The given scene
  128285. */
  128286. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  128287. /**
  128288. * Load a scene into an asset container
  128289. * @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)
  128290. * @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)
  128291. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  128292. * @param onSuccess a callback with the scene when import succeeds
  128293. * @param onProgress a callback with a progress event for each file being loaded
  128294. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128295. * @param pluginExtension the extension used to determine the plugin
  128296. * @returns The loaded plugin
  128297. */
  128298. 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>;
  128299. /**
  128300. * Load a scene into an asset container
  128301. * @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)
  128302. * @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)
  128303. * @param scene is the instance of Scene to append to
  128304. * @param onProgress a callback with a progress event for each file being loaded
  128305. * @param pluginExtension the extension used to determine the plugin
  128306. * @returns The loaded asset container
  128307. */
  128308. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  128309. /**
  128310. * Import animations from a file into a scene
  128311. * @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)
  128312. * @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)
  128313. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  128314. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  128315. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  128316. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  128317. * @param onSuccess a callback with the scene when import succeeds
  128318. * @param onProgress a callback with a progress event for each file being loaded
  128319. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128320. * @param pluginExtension the extension used to determine the plugin
  128321. */
  128322. 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;
  128323. /**
  128324. * Import animations from a file into a scene
  128325. * @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)
  128326. * @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)
  128327. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  128328. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  128329. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  128330. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  128331. * @param onSuccess a callback with the scene when import succeeds
  128332. * @param onProgress a callback with a progress event for each file being loaded
  128333. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128334. * @param pluginExtension the extension used to determine the plugin
  128335. * @returns the updated scene with imported animations
  128336. */
  128337. 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>;
  128338. }
  128339. }
  128340. declare module BABYLON {
  128341. /**
  128342. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  128343. */
  128344. export type MotionControllerHandedness = "none" | "left" | "right";
  128345. /**
  128346. * The type of components available in motion controllers.
  128347. * This is not the name of the component.
  128348. */
  128349. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  128350. /**
  128351. * The state of a controller component
  128352. */
  128353. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  128354. /**
  128355. * The schema of motion controller layout.
  128356. * No object will be initialized using this interface
  128357. * This is used just to define the profile.
  128358. */
  128359. export interface IMotionControllerLayout {
  128360. /**
  128361. * Path to load the assets. Usually relative to the base path
  128362. */
  128363. assetPath: string;
  128364. /**
  128365. * Available components (unsorted)
  128366. */
  128367. components: {
  128368. /**
  128369. * A map of component Ids
  128370. */
  128371. [componentId: string]: {
  128372. /**
  128373. * The type of input the component outputs
  128374. */
  128375. type: MotionControllerComponentType;
  128376. /**
  128377. * The indices of this component in the gamepad object
  128378. */
  128379. gamepadIndices: {
  128380. /**
  128381. * Index of button
  128382. */
  128383. button?: number;
  128384. /**
  128385. * If available, index of x-axis
  128386. */
  128387. xAxis?: number;
  128388. /**
  128389. * If available, index of y-axis
  128390. */
  128391. yAxis?: number;
  128392. };
  128393. /**
  128394. * The mesh's root node name
  128395. */
  128396. rootNodeName: string;
  128397. /**
  128398. * Animation definitions for this model
  128399. */
  128400. visualResponses: {
  128401. [stateKey: string]: {
  128402. /**
  128403. * What property will be animated
  128404. */
  128405. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  128406. /**
  128407. * What states influence this visual response
  128408. */
  128409. states: MotionControllerComponentStateType[];
  128410. /**
  128411. * Type of animation - movement or visibility
  128412. */
  128413. valueNodeProperty: "transform" | "visibility";
  128414. /**
  128415. * Base node name to move. Its position will be calculated according to the min and max nodes
  128416. */
  128417. valueNodeName?: string;
  128418. /**
  128419. * Minimum movement node
  128420. */
  128421. minNodeName?: string;
  128422. /**
  128423. * Max movement node
  128424. */
  128425. maxNodeName?: string;
  128426. };
  128427. };
  128428. /**
  128429. * If touch enabled, what is the name of node to display user feedback
  128430. */
  128431. touchPointNodeName?: string;
  128432. };
  128433. };
  128434. /**
  128435. * Is it xr standard mapping or not
  128436. */
  128437. gamepadMapping: "" | "xr-standard";
  128438. /**
  128439. * Base root node of this entire model
  128440. */
  128441. rootNodeName: string;
  128442. /**
  128443. * Defines the main button component id
  128444. */
  128445. selectComponentId: string;
  128446. }
  128447. /**
  128448. * A definition for the layout map in the input profile
  128449. */
  128450. export interface IMotionControllerLayoutMap {
  128451. /**
  128452. * Layouts with handedness type as a key
  128453. */
  128454. [handedness: string]: IMotionControllerLayout;
  128455. }
  128456. /**
  128457. * The XR Input profile schema
  128458. * Profiles can be found here:
  128459. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  128460. */
  128461. export interface IMotionControllerProfile {
  128462. /**
  128463. * fallback profiles for this profileId
  128464. */
  128465. fallbackProfileIds: string[];
  128466. /**
  128467. * The layout map, with handedness as key
  128468. */
  128469. layouts: IMotionControllerLayoutMap;
  128470. /**
  128471. * The id of this profile
  128472. * correlates to the profile(s) in the xrInput.profiles array
  128473. */
  128474. profileId: string;
  128475. }
  128476. /**
  128477. * A helper-interface for the 3 meshes needed for controller button animation
  128478. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  128479. */
  128480. export interface IMotionControllerButtonMeshMap {
  128481. /**
  128482. * the mesh that defines the pressed value mesh position.
  128483. * This is used to find the max-position of this button
  128484. */
  128485. pressedMesh: AbstractMesh;
  128486. /**
  128487. * the mesh that defines the unpressed value mesh position.
  128488. * This is used to find the min (or initial) position of this button
  128489. */
  128490. unpressedMesh: AbstractMesh;
  128491. /**
  128492. * The mesh that will be changed when value changes
  128493. */
  128494. valueMesh: AbstractMesh;
  128495. }
  128496. /**
  128497. * A helper-interface for the 3 meshes needed for controller axis animation.
  128498. * This will be expanded when touchpad animations are fully supported
  128499. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  128500. */
  128501. export interface IMotionControllerMeshMap {
  128502. /**
  128503. * the mesh that defines the maximum value mesh position.
  128504. */
  128505. maxMesh?: AbstractMesh;
  128506. /**
  128507. * the mesh that defines the minimum value mesh position.
  128508. */
  128509. minMesh?: AbstractMesh;
  128510. /**
  128511. * The mesh that will be changed when axis value changes
  128512. */
  128513. valueMesh?: AbstractMesh;
  128514. }
  128515. /**
  128516. * The elements needed for change-detection of the gamepad objects in motion controllers
  128517. */
  128518. export interface IMinimalMotionControllerObject {
  128519. /**
  128520. * Available axes of this controller
  128521. */
  128522. axes: number[];
  128523. /**
  128524. * An array of available buttons
  128525. */
  128526. buttons: Array<{
  128527. /**
  128528. * Value of the button/trigger
  128529. */
  128530. value: number;
  128531. /**
  128532. * If the button/trigger is currently touched
  128533. */
  128534. touched: boolean;
  128535. /**
  128536. * If the button/trigger is currently pressed
  128537. */
  128538. pressed: boolean;
  128539. }>;
  128540. /**
  128541. * EXPERIMENTAL haptic support.
  128542. */
  128543. hapticActuators?: Array<{
  128544. pulse: (value: number, duration: number) => Promise<boolean>;
  128545. }>;
  128546. }
  128547. /**
  128548. * An Abstract Motion controller
  128549. * This class receives an xrInput and a profile layout and uses those to initialize the components
  128550. * Each component has an observable to check for changes in value and state
  128551. */
  128552. export abstract class WebXRAbstractMotionController implements IDisposable {
  128553. protected scene: Scene;
  128554. protected layout: IMotionControllerLayout;
  128555. /**
  128556. * The gamepad object correlating to this controller
  128557. */
  128558. gamepadObject: IMinimalMotionControllerObject;
  128559. /**
  128560. * handedness (left/right/none) of this controller
  128561. */
  128562. handedness: MotionControllerHandedness;
  128563. private _initComponent;
  128564. private _modelReady;
  128565. /**
  128566. * A map of components (WebXRControllerComponent) in this motion controller
  128567. * Components have a ComponentType and can also have both button and axis definitions
  128568. */
  128569. readonly components: {
  128570. [id: string]: WebXRControllerComponent;
  128571. };
  128572. /**
  128573. * Disable the model's animation. Can be set at any time.
  128574. */
  128575. disableAnimation: boolean;
  128576. /**
  128577. * Observers registered here will be triggered when the model of this controller is done loading
  128578. */
  128579. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  128580. /**
  128581. * The profile id of this motion controller
  128582. */
  128583. abstract profileId: string;
  128584. /**
  128585. * The root mesh of the model. It is null if the model was not yet initialized
  128586. */
  128587. rootMesh: Nullable<AbstractMesh>;
  128588. /**
  128589. * constructs a new abstract motion controller
  128590. * @param scene the scene to which the model of the controller will be added
  128591. * @param layout The profile layout to load
  128592. * @param gamepadObject The gamepad object correlating to this controller
  128593. * @param handedness handedness (left/right/none) of this controller
  128594. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  128595. */
  128596. constructor(scene: Scene, layout: IMotionControllerLayout,
  128597. /**
  128598. * The gamepad object correlating to this controller
  128599. */
  128600. gamepadObject: IMinimalMotionControllerObject,
  128601. /**
  128602. * handedness (left/right/none) of this controller
  128603. */
  128604. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  128605. /**
  128606. * Dispose this controller, the model mesh and all its components
  128607. */
  128608. dispose(): void;
  128609. /**
  128610. * Returns all components of specific type
  128611. * @param type the type to search for
  128612. * @return an array of components with this type
  128613. */
  128614. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  128615. /**
  128616. * get a component based an its component id as defined in layout.components
  128617. * @param id the id of the component
  128618. * @returns the component correlates to the id or undefined if not found
  128619. */
  128620. getComponent(id: string): WebXRControllerComponent;
  128621. /**
  128622. * Get the list of components available in this motion controller
  128623. * @returns an array of strings correlating to available components
  128624. */
  128625. getComponentIds(): string[];
  128626. /**
  128627. * Get the first component of specific type
  128628. * @param type type of component to find
  128629. * @return a controller component or null if not found
  128630. */
  128631. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  128632. /**
  128633. * Get the main (Select) component of this controller as defined in the layout
  128634. * @returns the main component of this controller
  128635. */
  128636. getMainComponent(): WebXRControllerComponent;
  128637. /**
  128638. * Loads the model correlating to this controller
  128639. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  128640. * @returns A promise fulfilled with the result of the model loading
  128641. */
  128642. loadModel(): Promise<boolean>;
  128643. /**
  128644. * Update this model using the current XRFrame
  128645. * @param xrFrame the current xr frame to use and update the model
  128646. */
  128647. updateFromXRFrame(xrFrame: XRFrame): void;
  128648. /**
  128649. * Backwards compatibility due to a deeply-integrated typo
  128650. */
  128651. get handness(): XREye;
  128652. /**
  128653. * Pulse (vibrate) this controller
  128654. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  128655. * Consecutive calls to this function will cancel the last pulse call
  128656. *
  128657. * @param value the strength of the pulse in 0.0...1.0 range
  128658. * @param duration Duration of the pulse in milliseconds
  128659. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  128660. * @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
  128661. */
  128662. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  128663. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128664. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128665. /**
  128666. * Moves the axis on the controller mesh based on its current state
  128667. * @param axis the index of the axis
  128668. * @param axisValue the value of the axis which determines the meshes new position
  128669. * @hidden
  128670. */
  128671. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  128672. /**
  128673. * Update the model itself with the current frame data
  128674. * @param xrFrame the frame to use for updating the model mesh
  128675. */
  128676. protected updateModel(xrFrame: XRFrame): void;
  128677. /**
  128678. * Get the filename and path for this controller's model
  128679. * @returns a map of filename and path
  128680. */
  128681. protected abstract _getFilenameAndPath(): {
  128682. filename: string;
  128683. path: string;
  128684. };
  128685. /**
  128686. * This function is called before the mesh is loaded. It checks for loading constraints.
  128687. * For example, this function can check if the GLB loader is available
  128688. * If this function returns false, the generic controller will be loaded instead
  128689. * @returns Is the client ready to load the mesh
  128690. */
  128691. protected abstract _getModelLoadingConstraints(): boolean;
  128692. /**
  128693. * This function will be called after the model was successfully loaded and can be used
  128694. * for mesh transformations before it is available for the user
  128695. * @param meshes the loaded meshes
  128696. */
  128697. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  128698. /**
  128699. * Set the root mesh for this controller. Important for the WebXR controller class
  128700. * @param meshes the loaded meshes
  128701. */
  128702. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  128703. /**
  128704. * A function executed each frame that updates the mesh (if needed)
  128705. * @param xrFrame the current xrFrame
  128706. */
  128707. protected abstract _updateModel(xrFrame: XRFrame): void;
  128708. private _getGenericFilenameAndPath;
  128709. private _getGenericParentMesh;
  128710. }
  128711. }
  128712. declare module BABYLON {
  128713. /**
  128714. * A generic trigger-only motion controller for WebXR
  128715. */
  128716. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  128717. /**
  128718. * Static version of the profile id of this controller
  128719. */
  128720. static ProfileId: string;
  128721. profileId: string;
  128722. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  128723. protected _getFilenameAndPath(): {
  128724. filename: string;
  128725. path: string;
  128726. };
  128727. protected _getModelLoadingConstraints(): boolean;
  128728. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  128729. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128730. protected _updateModel(): void;
  128731. }
  128732. }
  128733. declare module BABYLON {
  128734. /**
  128735. * Class containing static functions to help procedurally build meshes
  128736. */
  128737. export class SphereBuilder {
  128738. /**
  128739. * Creates a sphere mesh
  128740. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  128741. * * 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`)
  128742. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  128743. * * 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
  128744. * * 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)
  128745. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  128746. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  128747. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128748. * @param name defines the name of the mesh
  128749. * @param options defines the options used to create the mesh
  128750. * @param scene defines the hosting scene
  128751. * @returns the sphere mesh
  128752. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  128753. */
  128754. static CreateSphere(name: string, options: {
  128755. segments?: number;
  128756. diameter?: number;
  128757. diameterX?: number;
  128758. diameterY?: number;
  128759. diameterZ?: number;
  128760. arc?: number;
  128761. slice?: number;
  128762. sideOrientation?: number;
  128763. frontUVs?: Vector4;
  128764. backUVs?: Vector4;
  128765. updatable?: boolean;
  128766. }, scene?: Nullable<Scene>): Mesh;
  128767. }
  128768. }
  128769. declare module BABYLON {
  128770. /**
  128771. * A profiled motion controller has its profile loaded from an online repository.
  128772. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128773. */
  128774. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128775. private _repositoryUrl;
  128776. private _buttonMeshMapping;
  128777. private _touchDots;
  128778. /**
  128779. * The profile ID of this controller. Will be populated when the controller initializes.
  128780. */
  128781. profileId: string;
  128782. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128783. dispose(): void;
  128784. protected _getFilenameAndPath(): {
  128785. filename: string;
  128786. path: string;
  128787. };
  128788. protected _getModelLoadingConstraints(): boolean;
  128789. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128790. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128791. protected _updateModel(_xrFrame: XRFrame): void;
  128792. }
  128793. }
  128794. declare module BABYLON {
  128795. /**
  128796. * A construction function type to create a new controller based on an xrInput object
  128797. */
  128798. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128799. /**
  128800. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128801. *
  128802. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128803. * it should be replaced with auto-loaded controllers.
  128804. *
  128805. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128806. */
  128807. export class WebXRMotionControllerManager {
  128808. private static _AvailableControllers;
  128809. private static _Fallbacks;
  128810. private static _ProfileLoadingPromises;
  128811. private static _ProfilesList;
  128812. /**
  128813. * The base URL of the online controller repository. Can be changed at any time.
  128814. */
  128815. static BaseRepositoryUrl: string;
  128816. /**
  128817. * Which repository gets priority - local or online
  128818. */
  128819. static PrioritizeOnlineRepository: boolean;
  128820. /**
  128821. * Use the online repository, or use only locally-defined controllers
  128822. */
  128823. static UseOnlineRepository: boolean;
  128824. /**
  128825. * Clear the cache used for profile loading and reload when requested again
  128826. */
  128827. static ClearProfilesCache(): void;
  128828. /**
  128829. * Register the default fallbacks.
  128830. * This function is called automatically when this file is imported.
  128831. */
  128832. static DefaultFallbacks(): void;
  128833. /**
  128834. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128835. * @param profileId the profile to which a fallback needs to be found
  128836. * @return an array with corresponding fallback profiles
  128837. */
  128838. static FindFallbackWithProfileId(profileId: string): string[];
  128839. /**
  128840. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128841. * The order of search:
  128842. *
  128843. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128844. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128845. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128846. * 4) return the generic trigger controller if none were found
  128847. *
  128848. * @param xrInput the xrInput to which a new controller is initialized
  128849. * @param scene the scene to which the model will be added
  128850. * @param forceProfile force a certain profile for this controller
  128851. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128852. */
  128853. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128854. /**
  128855. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128856. *
  128857. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128858. *
  128859. * @param type the profile type to register
  128860. * @param constructFunction the function to be called when loading this profile
  128861. */
  128862. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128863. /**
  128864. * Register a fallback to a specific profile.
  128865. * @param profileId the profileId that will receive the fallbacks
  128866. * @param fallbacks A list of fallback profiles
  128867. */
  128868. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128869. /**
  128870. * Will update the list of profiles available in the repository
  128871. * @return a promise that resolves to a map of profiles available online
  128872. */
  128873. static UpdateProfilesList(): Promise<{
  128874. [profile: string]: string;
  128875. }>;
  128876. private static _LoadProfileFromRepository;
  128877. private static _LoadProfilesFromAvailableControllers;
  128878. }
  128879. }
  128880. declare module BABYLON {
  128881. /**
  128882. * Configuration options for the WebXR controller creation
  128883. */
  128884. export interface IWebXRControllerOptions {
  128885. /**
  128886. * Should the controller mesh be animated when a user interacts with it
  128887. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128888. */
  128889. disableMotionControllerAnimation?: boolean;
  128890. /**
  128891. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128892. */
  128893. doNotLoadControllerMesh?: boolean;
  128894. /**
  128895. * Force a specific controller type for this controller.
  128896. * This can be used when creating your own profile or when testing different controllers
  128897. */
  128898. forceControllerProfile?: string;
  128899. /**
  128900. * Defines a rendering group ID for meshes that will be loaded.
  128901. * This is for the default controllers only.
  128902. */
  128903. renderingGroupId?: number;
  128904. }
  128905. /**
  128906. * Represents an XR controller
  128907. */
  128908. export class WebXRInputSource {
  128909. private _scene;
  128910. /** The underlying input source for the controller */
  128911. inputSource: XRInputSource;
  128912. private _options;
  128913. private _tmpVector;
  128914. private _uniqueId;
  128915. private _disposed;
  128916. /**
  128917. * 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
  128918. */
  128919. grip?: AbstractMesh;
  128920. /**
  128921. * If available, this is the gamepad object related to this controller.
  128922. * Using this object it is possible to get click events and trackpad changes of the
  128923. * webxr controller that is currently being used.
  128924. */
  128925. motionController?: WebXRAbstractMotionController;
  128926. /**
  128927. * Event that fires when the controller is removed/disposed.
  128928. * The object provided as event data is this controller, after associated assets were disposed.
  128929. * uniqueId is still available.
  128930. */
  128931. onDisposeObservable: Observable<WebXRInputSource>;
  128932. /**
  128933. * Will be triggered when the mesh associated with the motion controller is done loading.
  128934. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128935. * A shortened version of controller -> motion controller -> on mesh loaded.
  128936. */
  128937. onMeshLoadedObservable: Observable<AbstractMesh>;
  128938. /**
  128939. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128940. */
  128941. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128942. /**
  128943. * Pointer which can be used to select objects or attach a visible laser to
  128944. */
  128945. pointer: AbstractMesh;
  128946. /**
  128947. * Creates the input source object
  128948. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128949. * @param _scene the scene which the controller should be associated to
  128950. * @param inputSource the underlying input source for the controller
  128951. * @param _options options for this controller creation
  128952. */
  128953. constructor(_scene: Scene,
  128954. /** The underlying input source for the controller */
  128955. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128956. /**
  128957. * Get this controllers unique id
  128958. */
  128959. get uniqueId(): string;
  128960. /**
  128961. * Disposes of the object
  128962. */
  128963. dispose(): void;
  128964. /**
  128965. * Gets a world space ray coming from the pointer or grip
  128966. * @param result the resulting ray
  128967. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128968. */
  128969. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128970. /**
  128971. * Updates the controller pose based on the given XRFrame
  128972. * @param xrFrame xr frame to update the pose with
  128973. * @param referenceSpace reference space to use
  128974. */
  128975. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128976. }
  128977. }
  128978. declare module BABYLON {
  128979. /**
  128980. * The schema for initialization options of the XR Input class
  128981. */
  128982. export interface IWebXRInputOptions {
  128983. /**
  128984. * If set to true no model will be automatically loaded
  128985. */
  128986. doNotLoadControllerMeshes?: boolean;
  128987. /**
  128988. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128989. * If not found, the xr input profile data will be used.
  128990. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128991. */
  128992. forceInputProfile?: string;
  128993. /**
  128994. * Do not send a request to the controller repository to load the profile.
  128995. *
  128996. * Instead, use the controllers available in babylon itself.
  128997. */
  128998. disableOnlineControllerRepository?: boolean;
  128999. /**
  129000. * A custom URL for the controllers repository
  129001. */
  129002. customControllersRepositoryURL?: string;
  129003. /**
  129004. * Should the controller model's components not move according to the user input
  129005. */
  129006. disableControllerAnimation?: boolean;
  129007. /**
  129008. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  129009. */
  129010. controllerOptions?: IWebXRControllerOptions;
  129011. }
  129012. /**
  129013. * XR input used to track XR inputs such as controllers/rays
  129014. */
  129015. export class WebXRInput implements IDisposable {
  129016. /**
  129017. * the xr session manager for this session
  129018. */
  129019. xrSessionManager: WebXRSessionManager;
  129020. /**
  129021. * the WebXR camera for this session. Mainly used for teleportation
  129022. */
  129023. xrCamera: WebXRCamera;
  129024. private readonly options;
  129025. /**
  129026. * XR controllers being tracked
  129027. */
  129028. controllers: Array<WebXRInputSource>;
  129029. private _frameObserver;
  129030. private _sessionEndedObserver;
  129031. private _sessionInitObserver;
  129032. /**
  129033. * Event when a controller has been connected/added
  129034. */
  129035. onControllerAddedObservable: Observable<WebXRInputSource>;
  129036. /**
  129037. * Event when a controller has been removed/disconnected
  129038. */
  129039. onControllerRemovedObservable: Observable<WebXRInputSource>;
  129040. /**
  129041. * Initializes the WebXRInput
  129042. * @param xrSessionManager the xr session manager for this session
  129043. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  129044. * @param options = initialization options for this xr input
  129045. */
  129046. constructor(
  129047. /**
  129048. * the xr session manager for this session
  129049. */
  129050. xrSessionManager: WebXRSessionManager,
  129051. /**
  129052. * the WebXR camera for this session. Mainly used for teleportation
  129053. */
  129054. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  129055. private _onInputSourcesChange;
  129056. private _addAndRemoveControllers;
  129057. /**
  129058. * Disposes of the object
  129059. */
  129060. dispose(): void;
  129061. }
  129062. }
  129063. declare module BABYLON {
  129064. /**
  129065. * This is the base class for all WebXR features.
  129066. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  129067. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  129068. */
  129069. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  129070. protected _xrSessionManager: WebXRSessionManager;
  129071. private _attached;
  129072. private _removeOnDetach;
  129073. /**
  129074. * Is this feature disposed?
  129075. */
  129076. isDisposed: boolean;
  129077. /**
  129078. * Should auto-attach be disabled?
  129079. */
  129080. disableAutoAttach: boolean;
  129081. /**
  129082. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  129083. */
  129084. xrNativeFeatureName: string;
  129085. /**
  129086. * Construct a new (abstract) WebXR feature
  129087. * @param _xrSessionManager the xr session manager for this feature
  129088. */
  129089. constructor(_xrSessionManager: WebXRSessionManager);
  129090. /**
  129091. * Is this feature attached
  129092. */
  129093. get attached(): boolean;
  129094. /**
  129095. * attach this feature
  129096. *
  129097. * @param force should attachment be forced (even when already attached)
  129098. * @returns true if successful, false is failed or already attached
  129099. */
  129100. attach(force?: boolean): boolean;
  129101. /**
  129102. * detach this feature.
  129103. *
  129104. * @returns true if successful, false if failed or already detached
  129105. */
  129106. detach(): boolean;
  129107. /**
  129108. * Dispose this feature and all of the resources attached
  129109. */
  129110. dispose(): void;
  129111. /**
  129112. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  129113. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  129114. *
  129115. * @returns whether or not the feature is compatible in this environment
  129116. */
  129117. isCompatible(): boolean;
  129118. /**
  129119. * This is used to register callbacks that will automatically be removed when detach is called.
  129120. * @param observable the observable to which the observer will be attached
  129121. * @param callback the callback to register
  129122. */
  129123. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  129124. /**
  129125. * Code in this function will be executed on each xrFrame received from the browser.
  129126. * This function will not execute after the feature is detached.
  129127. * @param _xrFrame the current frame
  129128. */
  129129. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  129130. }
  129131. }
  129132. declare module BABYLON {
  129133. /**
  129134. * Renders a layer on top of an existing scene
  129135. */
  129136. export class UtilityLayerRenderer implements IDisposable {
  129137. /** the original scene that will be rendered on top of */
  129138. originalScene: Scene;
  129139. private _pointerCaptures;
  129140. private _lastPointerEvents;
  129141. private static _DefaultUtilityLayer;
  129142. private static _DefaultKeepDepthUtilityLayer;
  129143. private _sharedGizmoLight;
  129144. private _renderCamera;
  129145. /**
  129146. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  129147. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  129148. * @returns the camera that is used when rendering the utility layer
  129149. */
  129150. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  129151. /**
  129152. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  129153. * @param cam the camera that should be used when rendering the utility layer
  129154. */
  129155. setRenderCamera(cam: Nullable<Camera>): void;
  129156. /**
  129157. * @hidden
  129158. * Light which used by gizmos to get light shading
  129159. */
  129160. _getSharedGizmoLight(): HemisphericLight;
  129161. /**
  129162. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  129163. */
  129164. pickUtilitySceneFirst: boolean;
  129165. /**
  129166. * 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)
  129167. */
  129168. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  129169. /**
  129170. * 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)
  129171. */
  129172. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  129173. /**
  129174. * The scene that is rendered on top of the original scene
  129175. */
  129176. utilityLayerScene: Scene;
  129177. /**
  129178. * If the utility layer should automatically be rendered on top of existing scene
  129179. */
  129180. shouldRender: boolean;
  129181. /**
  129182. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  129183. */
  129184. onlyCheckPointerDownEvents: boolean;
  129185. /**
  129186. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  129187. */
  129188. processAllEvents: boolean;
  129189. /**
  129190. * Observable raised when the pointer move from the utility layer scene to the main scene
  129191. */
  129192. onPointerOutObservable: Observable<number>;
  129193. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  129194. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  129195. private _afterRenderObserver;
  129196. private _sceneDisposeObserver;
  129197. private _originalPointerObserver;
  129198. /**
  129199. * Instantiates a UtilityLayerRenderer
  129200. * @param originalScene the original scene that will be rendered on top of
  129201. * @param handleEvents boolean indicating if the utility layer should handle events
  129202. */
  129203. constructor(
  129204. /** the original scene that will be rendered on top of */
  129205. originalScene: Scene, handleEvents?: boolean);
  129206. private _notifyObservers;
  129207. /**
  129208. * Renders the utility layers scene on top of the original scene
  129209. */
  129210. render(): void;
  129211. /**
  129212. * Disposes of the renderer
  129213. */
  129214. dispose(): void;
  129215. private _updateCamera;
  129216. }
  129217. }
  129218. declare module BABYLON {
  129219. /**
  129220. * Options interface for the pointer selection module
  129221. */
  129222. export interface IWebXRControllerPointerSelectionOptions {
  129223. /**
  129224. * if provided, this scene will be used to render meshes.
  129225. */
  129226. customUtilityLayerScene?: Scene;
  129227. /**
  129228. * 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)
  129229. * If not disabled, the last picked point will be used to execute a pointer up event
  129230. * If disabled, pointer up event will be triggered right after the pointer down event.
  129231. * Used in screen and gaze target ray mode only
  129232. */
  129233. disablePointerUpOnTouchOut: boolean;
  129234. /**
  129235. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  129236. */
  129237. forceGazeMode: boolean;
  129238. /**
  129239. * 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
  129240. * to start a new countdown to the pointer down event.
  129241. * Defaults to 1.
  129242. */
  129243. gazeModePointerMovedFactor?: number;
  129244. /**
  129245. * Different button type to use instead of the main component
  129246. */
  129247. overrideButtonId?: string;
  129248. /**
  129249. * use this rendering group id for the meshes (optional)
  129250. */
  129251. renderingGroupId?: number;
  129252. /**
  129253. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  129254. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  129255. * 3000 means 3 seconds between pointing at something and selecting it
  129256. */
  129257. timeToSelect?: number;
  129258. /**
  129259. * Should meshes created here be added to a utility layer or the main scene
  129260. */
  129261. useUtilityLayer?: boolean;
  129262. /**
  129263. * Optional WebXR camera to be used for gaze selection
  129264. */
  129265. gazeCamera?: WebXRCamera;
  129266. /**
  129267. * the xr input to use with this pointer selection
  129268. */
  129269. xrInput: WebXRInput;
  129270. }
  129271. /**
  129272. * A module that will enable pointer selection for motion controllers of XR Input Sources
  129273. */
  129274. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  129275. private readonly _options;
  129276. private static _idCounter;
  129277. private _attachController;
  129278. private _controllers;
  129279. private _scene;
  129280. private _tmpVectorForPickCompare;
  129281. /**
  129282. * The module's name
  129283. */
  129284. static readonly Name: string;
  129285. /**
  129286. * The (Babylon) version of this module.
  129287. * This is an integer representing the implementation version.
  129288. * This number does not correspond to the WebXR specs version
  129289. */
  129290. static readonly Version: number;
  129291. /**
  129292. * Disable lighting on the laser pointer (so it will always be visible)
  129293. */
  129294. disablePointerLighting: boolean;
  129295. /**
  129296. * Disable lighting on the selection mesh (so it will always be visible)
  129297. */
  129298. disableSelectionMeshLighting: boolean;
  129299. /**
  129300. * Should the laser pointer be displayed
  129301. */
  129302. displayLaserPointer: boolean;
  129303. /**
  129304. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  129305. */
  129306. displaySelectionMesh: boolean;
  129307. /**
  129308. * This color will be set to the laser pointer when selection is triggered
  129309. */
  129310. laserPointerPickedColor: Color3;
  129311. /**
  129312. * Default color of the laser pointer
  129313. */
  129314. laserPointerDefaultColor: Color3;
  129315. /**
  129316. * default color of the selection ring
  129317. */
  129318. selectionMeshDefaultColor: Color3;
  129319. /**
  129320. * This color will be applied to the selection ring when selection is triggered
  129321. */
  129322. selectionMeshPickedColor: Color3;
  129323. /**
  129324. * Optional filter to be used for ray selection. This predicate shares behavior with
  129325. * scene.pointerMovePredicate which takes priority if it is also assigned.
  129326. */
  129327. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129328. /**
  129329. * constructs a new background remover module
  129330. * @param _xrSessionManager the session manager for this module
  129331. * @param _options read-only options to be used in this module
  129332. */
  129333. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  129334. /**
  129335. * attach this feature
  129336. * Will usually be called by the features manager
  129337. *
  129338. * @returns true if successful.
  129339. */
  129340. attach(): boolean;
  129341. /**
  129342. * detach this feature.
  129343. * Will usually be called by the features manager
  129344. *
  129345. * @returns true if successful.
  129346. */
  129347. detach(): boolean;
  129348. /**
  129349. * Will get the mesh under a specific pointer.
  129350. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  129351. * @param controllerId the controllerId to check
  129352. * @returns The mesh under pointer or null if no mesh is under the pointer
  129353. */
  129354. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  129355. /**
  129356. * Get the xr controller that correlates to the pointer id in the pointer event
  129357. *
  129358. * @param id the pointer id to search for
  129359. * @returns the controller that correlates to this id or null if not found
  129360. */
  129361. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  129362. protected _onXRFrame(_xrFrame: XRFrame): void;
  129363. private _attachGazeMode;
  129364. private _attachScreenRayMode;
  129365. private _attachTrackedPointerRayMode;
  129366. private _convertNormalToDirectionOfRay;
  129367. private _detachController;
  129368. private _generateNewMeshPair;
  129369. private _pickingMoved;
  129370. private _updatePointerDistance;
  129371. /** @hidden */
  129372. get lasterPointerDefaultColor(): Color3;
  129373. }
  129374. }
  129375. declare module BABYLON {
  129376. /**
  129377. * Button which can be used to enter a different mode of XR
  129378. */
  129379. export class WebXREnterExitUIButton {
  129380. /** button element */
  129381. element: HTMLElement;
  129382. /** XR initialization options for the button */
  129383. sessionMode: XRSessionMode;
  129384. /** Reference space type */
  129385. referenceSpaceType: XRReferenceSpaceType;
  129386. /**
  129387. * Creates a WebXREnterExitUIButton
  129388. * @param element button element
  129389. * @param sessionMode XR initialization session mode
  129390. * @param referenceSpaceType the type of reference space to be used
  129391. */
  129392. constructor(
  129393. /** button element */
  129394. element: HTMLElement,
  129395. /** XR initialization options for the button */
  129396. sessionMode: XRSessionMode,
  129397. /** Reference space type */
  129398. referenceSpaceType: XRReferenceSpaceType);
  129399. /**
  129400. * Extendable function which can be used to update the button's visuals when the state changes
  129401. * @param activeButton the current active button in the UI
  129402. */
  129403. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  129404. }
  129405. /**
  129406. * Options to create the webXR UI
  129407. */
  129408. export class WebXREnterExitUIOptions {
  129409. /**
  129410. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  129411. */
  129412. customButtons?: Array<WebXREnterExitUIButton>;
  129413. /**
  129414. * A reference space type to use when creating the default button.
  129415. * Default is local-floor
  129416. */
  129417. referenceSpaceType?: XRReferenceSpaceType;
  129418. /**
  129419. * Context to enter xr with
  129420. */
  129421. renderTarget?: Nullable<WebXRRenderTarget>;
  129422. /**
  129423. * A session mode to use when creating the default button.
  129424. * Default is immersive-vr
  129425. */
  129426. sessionMode?: XRSessionMode;
  129427. /**
  129428. * A list of optional features to init the session with
  129429. */
  129430. optionalFeatures?: string[];
  129431. /**
  129432. * A list of optional features to init the session with
  129433. */
  129434. requiredFeatures?: string[];
  129435. }
  129436. /**
  129437. * UI to allow the user to enter/exit XR mode
  129438. */
  129439. export class WebXREnterExitUI implements IDisposable {
  129440. private scene;
  129441. /** version of the options passed to this UI */
  129442. options: WebXREnterExitUIOptions;
  129443. private _activeButton;
  129444. private _buttons;
  129445. /**
  129446. * The HTML Div Element to which buttons are added.
  129447. */
  129448. readonly overlay: HTMLDivElement;
  129449. /**
  129450. * Fired every time the active button is changed.
  129451. *
  129452. * When xr is entered via a button that launches xr that button will be the callback parameter
  129453. *
  129454. * When exiting xr the callback parameter will be null)
  129455. */
  129456. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  129457. /**
  129458. *
  129459. * @param scene babylon scene object to use
  129460. * @param options (read-only) version of the options passed to this UI
  129461. */
  129462. private constructor();
  129463. /**
  129464. * Creates UI to allow the user to enter/exit XR mode
  129465. * @param scene the scene to add the ui to
  129466. * @param helper the xr experience helper to enter/exit xr with
  129467. * @param options options to configure the UI
  129468. * @returns the created ui
  129469. */
  129470. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  129471. /**
  129472. * Disposes of the XR UI component
  129473. */
  129474. dispose(): void;
  129475. private _updateButtons;
  129476. }
  129477. }
  129478. declare module BABYLON {
  129479. /**
  129480. * Class containing static functions to help procedurally build meshes
  129481. */
  129482. export class LinesBuilder {
  129483. /**
  129484. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  129485. * * 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
  129486. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  129487. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  129488. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  129489. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  129490. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  129491. * * 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
  129492. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  129493. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129494. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  129495. * @param name defines the name of the new line system
  129496. * @param options defines the options used to create the line system
  129497. * @param scene defines the hosting scene
  129498. * @returns a new line system mesh
  129499. */
  129500. static CreateLineSystem(name: string, options: {
  129501. lines: Vector3[][];
  129502. updatable?: boolean;
  129503. instance?: Nullable<LinesMesh>;
  129504. colors?: Nullable<Color4[][]>;
  129505. useVertexAlpha?: boolean;
  129506. }, scene: Nullable<Scene>): LinesMesh;
  129507. /**
  129508. * Creates a line mesh
  129509. * 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
  129510. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  129511. * * The parameter `points` is an array successive Vector3
  129512. * * 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
  129513. * * The optional parameter `colors` is an array of successive Color4, one per line point
  129514. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  129515. * * When updating an instance, remember that only point positions can change, not the number of points
  129516. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129517. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  129518. * @param name defines the name of the new line system
  129519. * @param options defines the options used to create the line system
  129520. * @param scene defines the hosting scene
  129521. * @returns a new line mesh
  129522. */
  129523. static CreateLines(name: string, options: {
  129524. points: Vector3[];
  129525. updatable?: boolean;
  129526. instance?: Nullable<LinesMesh>;
  129527. colors?: Color4[];
  129528. useVertexAlpha?: boolean;
  129529. }, scene?: Nullable<Scene>): LinesMesh;
  129530. /**
  129531. * Creates a dashed line mesh
  129532. * * 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
  129533. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  129534. * * The parameter `points` is an array successive Vector3
  129535. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  129536. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  129537. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  129538. * * 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
  129539. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  129540. * * When updating an instance, remember that only point positions can change, not the number of points
  129541. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129542. * @param name defines the name of the mesh
  129543. * @param options defines the options used to create the mesh
  129544. * @param scene defines the hosting scene
  129545. * @returns the dashed line mesh
  129546. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  129547. */
  129548. static CreateDashedLines(name: string, options: {
  129549. points: Vector3[];
  129550. dashSize?: number;
  129551. gapSize?: number;
  129552. dashNb?: number;
  129553. updatable?: boolean;
  129554. instance?: LinesMesh;
  129555. useVertexAlpha?: boolean;
  129556. }, scene?: Nullable<Scene>): LinesMesh;
  129557. }
  129558. }
  129559. declare module BABYLON {
  129560. /**
  129561. * Construction options for a timer
  129562. */
  129563. export interface ITimerOptions<T> {
  129564. /**
  129565. * Time-to-end
  129566. */
  129567. timeout: number;
  129568. /**
  129569. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  129570. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  129571. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  129572. */
  129573. contextObservable: Observable<T>;
  129574. /**
  129575. * Optional parameters when adding an observer to the observable
  129576. */
  129577. observableParameters?: {
  129578. mask?: number;
  129579. insertFirst?: boolean;
  129580. scope?: any;
  129581. };
  129582. /**
  129583. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  129584. */
  129585. breakCondition?: (data?: ITimerData<T>) => boolean;
  129586. /**
  129587. * Will be triggered when the time condition has met
  129588. */
  129589. onEnded?: (data: ITimerData<any>) => void;
  129590. /**
  129591. * Will be triggered when the break condition has met (prematurely ended)
  129592. */
  129593. onAborted?: (data: ITimerData<any>) => void;
  129594. /**
  129595. * Optional function to execute on each tick (or count)
  129596. */
  129597. onTick?: (data: ITimerData<any>) => void;
  129598. }
  129599. /**
  129600. * An interface defining the data sent by the timer
  129601. */
  129602. export interface ITimerData<T> {
  129603. /**
  129604. * When did it start
  129605. */
  129606. startTime: number;
  129607. /**
  129608. * Time now
  129609. */
  129610. currentTime: number;
  129611. /**
  129612. * Time passed since started
  129613. */
  129614. deltaTime: number;
  129615. /**
  129616. * How much is completed, in [0.0...1.0].
  129617. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  129618. */
  129619. completeRate: number;
  129620. /**
  129621. * What the registered observable sent in the last count
  129622. */
  129623. payload: T;
  129624. }
  129625. /**
  129626. * The current state of the timer
  129627. */
  129628. export enum TimerState {
  129629. /**
  129630. * Timer initialized, not yet started
  129631. */
  129632. INIT = 0,
  129633. /**
  129634. * Timer started and counting
  129635. */
  129636. STARTED = 1,
  129637. /**
  129638. * Timer ended (whether aborted or time reached)
  129639. */
  129640. ENDED = 2
  129641. }
  129642. /**
  129643. * A simple version of the timer. Will take options and start the timer immediately after calling it
  129644. *
  129645. * @param options options with which to initialize this timer
  129646. */
  129647. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  129648. /**
  129649. * An advanced implementation of a timer class
  129650. */
  129651. export class AdvancedTimer<T = any> implements IDisposable {
  129652. /**
  129653. * Will notify each time the timer calculates the remaining time
  129654. */
  129655. onEachCountObservable: Observable<ITimerData<T>>;
  129656. /**
  129657. * Will trigger when the timer was aborted due to the break condition
  129658. */
  129659. onTimerAbortedObservable: Observable<ITimerData<T>>;
  129660. /**
  129661. * Will trigger when the timer ended successfully
  129662. */
  129663. onTimerEndedObservable: Observable<ITimerData<T>>;
  129664. /**
  129665. * Will trigger when the timer state has changed
  129666. */
  129667. onStateChangedObservable: Observable<TimerState>;
  129668. private _observer;
  129669. private _contextObservable;
  129670. private _observableParameters;
  129671. private _startTime;
  129672. private _timer;
  129673. private _state;
  129674. private _breakCondition;
  129675. private _timeToEnd;
  129676. private _breakOnNextTick;
  129677. /**
  129678. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  129679. * @param options construction options for this advanced timer
  129680. */
  129681. constructor(options: ITimerOptions<T>);
  129682. /**
  129683. * set a breaking condition for this timer. Default is to never break during count
  129684. * @param predicate the new break condition. Returns true to break, false otherwise
  129685. */
  129686. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  129687. /**
  129688. * Reset ALL associated observables in this advanced timer
  129689. */
  129690. clearObservables(): void;
  129691. /**
  129692. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  129693. *
  129694. * @param timeToEnd how much time to measure until timer ended
  129695. */
  129696. start(timeToEnd?: number): void;
  129697. /**
  129698. * Will force a stop on the next tick.
  129699. */
  129700. stop(): void;
  129701. /**
  129702. * Dispose this timer, clearing all resources
  129703. */
  129704. dispose(): void;
  129705. private _setState;
  129706. private _tick;
  129707. private _stop;
  129708. }
  129709. }
  129710. declare module BABYLON {
  129711. /**
  129712. * The options container for the teleportation module
  129713. */
  129714. export interface IWebXRTeleportationOptions {
  129715. /**
  129716. * if provided, this scene will be used to render meshes.
  129717. */
  129718. customUtilityLayerScene?: Scene;
  129719. /**
  129720. * Values to configure the default target mesh
  129721. */
  129722. defaultTargetMeshOptions?: {
  129723. /**
  129724. * Fill color of the teleportation area
  129725. */
  129726. teleportationFillColor?: string;
  129727. /**
  129728. * Border color for the teleportation area
  129729. */
  129730. teleportationBorderColor?: string;
  129731. /**
  129732. * Disable the mesh's animation sequence
  129733. */
  129734. disableAnimation?: boolean;
  129735. /**
  129736. * Disable lighting on the material or the ring and arrow
  129737. */
  129738. disableLighting?: boolean;
  129739. /**
  129740. * Override the default material of the torus and arrow
  129741. */
  129742. torusArrowMaterial?: Material;
  129743. };
  129744. /**
  129745. * A list of meshes to use as floor meshes.
  129746. * Meshes can be added and removed after initializing the feature using the
  129747. * addFloorMesh and removeFloorMesh functions
  129748. * If empty, rotation will still work
  129749. */
  129750. floorMeshes?: AbstractMesh[];
  129751. /**
  129752. * use this rendering group id for the meshes (optional)
  129753. */
  129754. renderingGroupId?: number;
  129755. /**
  129756. * Should teleportation move only to snap points
  129757. */
  129758. snapPointsOnly?: boolean;
  129759. /**
  129760. * An array of points to which the teleportation will snap to.
  129761. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129762. */
  129763. snapPositions?: Vector3[];
  129764. /**
  129765. * How close should the teleportation ray be in order to snap to position.
  129766. * Default to 0.8 units (meters)
  129767. */
  129768. snapToPositionRadius?: number;
  129769. /**
  129770. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129771. * If you want to support rotation, make sure your mesh has a direction indicator.
  129772. *
  129773. * When left untouched, the default mesh will be initialized.
  129774. */
  129775. teleportationTargetMesh?: AbstractMesh;
  129776. /**
  129777. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129778. */
  129779. timeToTeleport?: number;
  129780. /**
  129781. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129782. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129783. */
  129784. useMainComponentOnly?: boolean;
  129785. /**
  129786. * Should meshes created here be added to a utility layer or the main scene
  129787. */
  129788. useUtilityLayer?: boolean;
  129789. /**
  129790. * Babylon XR Input class for controller
  129791. */
  129792. xrInput: WebXRInput;
  129793. /**
  129794. * Meshes that the teleportation ray cannot go through
  129795. */
  129796. pickBlockerMeshes?: AbstractMesh[];
  129797. }
  129798. /**
  129799. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129800. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129801. * the input of the attached controllers.
  129802. */
  129803. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129804. private _options;
  129805. private _controllers;
  129806. private _currentTeleportationControllerId;
  129807. private _floorMeshes;
  129808. private _quadraticBezierCurve;
  129809. private _selectionFeature;
  129810. private _snapToPositions;
  129811. private _snappedToPoint;
  129812. private _teleportationRingMaterial?;
  129813. private _tmpRay;
  129814. private _tmpVector;
  129815. private _tmpQuaternion;
  129816. /**
  129817. * The module's name
  129818. */
  129819. static readonly Name: string;
  129820. /**
  129821. * The (Babylon) version of this module.
  129822. * This is an integer representing the implementation version.
  129823. * This number does not correspond to the webxr specs version
  129824. */
  129825. static readonly Version: number;
  129826. /**
  129827. * Is movement backwards enabled
  129828. */
  129829. backwardsMovementEnabled: boolean;
  129830. /**
  129831. * Distance to travel when moving backwards
  129832. */
  129833. backwardsTeleportationDistance: number;
  129834. /**
  129835. * The distance from the user to the inspection point in the direction of the controller
  129836. * A higher number will allow the user to move further
  129837. * defaults to 5 (meters, in xr units)
  129838. */
  129839. parabolicCheckRadius: number;
  129840. /**
  129841. * Should the module support parabolic ray on top of direct ray
  129842. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129843. * Very helpful when moving between floors / different heights
  129844. */
  129845. parabolicRayEnabled: boolean;
  129846. /**
  129847. * How much rotation should be applied when rotating right and left
  129848. */
  129849. rotationAngle: number;
  129850. /**
  129851. * Is rotation enabled when moving forward?
  129852. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129853. */
  129854. rotationEnabled: boolean;
  129855. /**
  129856. * constructs a new anchor system
  129857. * @param _xrSessionManager an instance of WebXRSessionManager
  129858. * @param _options configuration object for this feature
  129859. */
  129860. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129861. /**
  129862. * Get the snapPointsOnly flag
  129863. */
  129864. get snapPointsOnly(): boolean;
  129865. /**
  129866. * Sets the snapPointsOnly flag
  129867. * @param snapToPoints should teleportation be exclusively to snap points
  129868. */
  129869. set snapPointsOnly(snapToPoints: boolean);
  129870. /**
  129871. * Add a new mesh to the floor meshes array
  129872. * @param mesh the mesh to use as floor mesh
  129873. */
  129874. addFloorMesh(mesh: AbstractMesh): void;
  129875. /**
  129876. * Add a new snap-to point to fix teleportation to this position
  129877. * @param newSnapPoint The new Snap-To point
  129878. */
  129879. addSnapPoint(newSnapPoint: Vector3): void;
  129880. attach(): boolean;
  129881. detach(): boolean;
  129882. dispose(): void;
  129883. /**
  129884. * Remove a mesh from the floor meshes array
  129885. * @param mesh the mesh to remove
  129886. */
  129887. removeFloorMesh(mesh: AbstractMesh): void;
  129888. /**
  129889. * Remove a mesh from the floor meshes array using its name
  129890. * @param name the mesh name to remove
  129891. */
  129892. removeFloorMeshByName(name: string): void;
  129893. /**
  129894. * 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
  129895. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129896. * @returns was the point found and removed or not
  129897. */
  129898. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129899. /**
  129900. * This function sets a selection feature that will be disabled when
  129901. * the forward ray is shown and will be reattached when hidden.
  129902. * This is used to remove the selection rays when moving.
  129903. * @param selectionFeature the feature to disable when forward movement is enabled
  129904. */
  129905. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  129906. protected _onXRFrame(_xrFrame: XRFrame): void;
  129907. private _attachController;
  129908. private _createDefaultTargetMesh;
  129909. private _detachController;
  129910. private _findClosestSnapPointWithRadius;
  129911. private _setTargetMeshPosition;
  129912. private _setTargetMeshVisibility;
  129913. private _showParabolicPath;
  129914. private _teleportForward;
  129915. }
  129916. }
  129917. declare module BABYLON {
  129918. /**
  129919. * Options for the default xr helper
  129920. */
  129921. export class WebXRDefaultExperienceOptions {
  129922. /**
  129923. * Enable or disable default UI to enter XR
  129924. */
  129925. disableDefaultUI?: boolean;
  129926. /**
  129927. * Should teleportation not initialize. defaults to false.
  129928. */
  129929. disableTeleportation?: boolean;
  129930. /**
  129931. * Floor meshes that will be used for teleport
  129932. */
  129933. floorMeshes?: Array<AbstractMesh>;
  129934. /**
  129935. * If set to true, the first frame will not be used to reset position
  129936. * The first frame is mainly used when copying transformation from the old camera
  129937. * Mainly used in AR
  129938. */
  129939. ignoreNativeCameraTransformation?: boolean;
  129940. /**
  129941. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129942. */
  129943. inputOptions?: IWebXRInputOptions;
  129944. /**
  129945. * optional configuration for the output canvas
  129946. */
  129947. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129948. /**
  129949. * optional UI options. This can be used among other to change session mode and reference space type
  129950. */
  129951. uiOptions?: WebXREnterExitUIOptions;
  129952. /**
  129953. * When loading teleportation and pointer select, use stable versions instead of latest.
  129954. */
  129955. useStablePlugins?: boolean;
  129956. /**
  129957. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129958. */
  129959. renderingGroupId?: number;
  129960. /**
  129961. * A list of optional features to init the session with
  129962. * If set to true, all features we support will be added
  129963. */
  129964. optionalFeatures?: boolean | string[];
  129965. }
  129966. /**
  129967. * Default experience which provides a similar setup to the previous webVRExperience
  129968. */
  129969. export class WebXRDefaultExperience {
  129970. /**
  129971. * Base experience
  129972. */
  129973. baseExperience: WebXRExperienceHelper;
  129974. /**
  129975. * Enables ui for entering/exiting xr
  129976. */
  129977. enterExitUI: WebXREnterExitUI;
  129978. /**
  129979. * Input experience extension
  129980. */
  129981. input: WebXRInput;
  129982. /**
  129983. * Enables laser pointer and selection
  129984. */
  129985. pointerSelection: WebXRControllerPointerSelection;
  129986. /**
  129987. * Default target xr should render to
  129988. */
  129989. renderTarget: WebXRRenderTarget;
  129990. /**
  129991. * Enables teleportation
  129992. */
  129993. teleportation: WebXRMotionControllerTeleportation;
  129994. private constructor();
  129995. /**
  129996. * Creates the default xr experience
  129997. * @param scene scene
  129998. * @param options options for basic configuration
  129999. * @returns resulting WebXRDefaultExperience
  130000. */
  130001. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  130002. /**
  130003. * DIsposes of the experience helper
  130004. */
  130005. dispose(): void;
  130006. }
  130007. }
  130008. declare module BABYLON {
  130009. /**
  130010. * Options to modify the vr teleportation behavior.
  130011. */
  130012. export interface VRTeleportationOptions {
  130013. /**
  130014. * The name of the mesh which should be used as the teleportation floor. (default: null)
  130015. */
  130016. floorMeshName?: string;
  130017. /**
  130018. * A list of meshes to be used as the teleportation floor. (default: empty)
  130019. */
  130020. floorMeshes?: Mesh[];
  130021. /**
  130022. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  130023. */
  130024. teleportationMode?: number;
  130025. /**
  130026. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  130027. */
  130028. teleportationTime?: number;
  130029. /**
  130030. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  130031. */
  130032. teleportationSpeed?: number;
  130033. /**
  130034. * The easing function used in the animation or null for Linear. (default CircleEase)
  130035. */
  130036. easingFunction?: EasingFunction;
  130037. }
  130038. /**
  130039. * Options to modify the vr experience helper's behavior.
  130040. */
  130041. export interface VRExperienceHelperOptions extends WebVROptions {
  130042. /**
  130043. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  130044. */
  130045. createDeviceOrientationCamera?: boolean;
  130046. /**
  130047. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  130048. */
  130049. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  130050. /**
  130051. * Uses the main button on the controller to toggle the laser casted. (default: true)
  130052. */
  130053. laserToggle?: boolean;
  130054. /**
  130055. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  130056. */
  130057. floorMeshes?: Mesh[];
  130058. /**
  130059. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  130060. */
  130061. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  130062. /**
  130063. * Defines if WebXR should be used instead of WebVR (if available)
  130064. */
  130065. useXR?: boolean;
  130066. }
  130067. /**
  130068. * Event containing information after VR has been entered
  130069. */
  130070. export class OnAfterEnteringVRObservableEvent {
  130071. /**
  130072. * If entering vr was successful
  130073. */
  130074. success: boolean;
  130075. }
  130076. /**
  130077. * Helps to quickly add VR support to an existing scene.
  130078. * See https://doc.babylonjs.com/how_to/webvr_helper
  130079. */
  130080. export class VRExperienceHelper {
  130081. /** Options to modify the vr experience helper's behavior. */
  130082. webVROptions: VRExperienceHelperOptions;
  130083. private _scene;
  130084. private _position;
  130085. private _btnVR;
  130086. private _btnVRDisplayed;
  130087. private _webVRsupported;
  130088. private _webVRready;
  130089. private _webVRrequesting;
  130090. private _webVRpresenting;
  130091. private _hasEnteredVR;
  130092. private _fullscreenVRpresenting;
  130093. private _inputElement;
  130094. private _webVRCamera;
  130095. private _vrDeviceOrientationCamera;
  130096. private _deviceOrientationCamera;
  130097. private _existingCamera;
  130098. private _onKeyDown;
  130099. private _onVrDisplayPresentChange;
  130100. private _onVRDisplayChanged;
  130101. private _onVRRequestPresentStart;
  130102. private _onVRRequestPresentComplete;
  130103. /**
  130104. * 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)
  130105. */
  130106. enableGazeEvenWhenNoPointerLock: boolean;
  130107. /**
  130108. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  130109. */
  130110. exitVROnDoubleTap: boolean;
  130111. /**
  130112. * Observable raised right before entering VR.
  130113. */
  130114. onEnteringVRObservable: Observable<VRExperienceHelper>;
  130115. /**
  130116. * Observable raised when entering VR has completed.
  130117. */
  130118. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  130119. /**
  130120. * Observable raised when exiting VR.
  130121. */
  130122. onExitingVRObservable: Observable<VRExperienceHelper>;
  130123. /**
  130124. * Observable raised when controller mesh is loaded.
  130125. */
  130126. onControllerMeshLoadedObservable: Observable<WebVRController>;
  130127. /** Return this.onEnteringVRObservable
  130128. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  130129. */
  130130. get onEnteringVR(): Observable<VRExperienceHelper>;
  130131. /** Return this.onExitingVRObservable
  130132. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  130133. */
  130134. get onExitingVR(): Observable<VRExperienceHelper>;
  130135. /** Return this.onControllerMeshLoadedObservable
  130136. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  130137. */
  130138. get onControllerMeshLoaded(): Observable<WebVRController>;
  130139. private _rayLength;
  130140. private _useCustomVRButton;
  130141. private _teleportationRequested;
  130142. private _teleportActive;
  130143. private _floorMeshName;
  130144. private _floorMeshesCollection;
  130145. private _teleportationMode;
  130146. private _teleportationTime;
  130147. private _teleportationSpeed;
  130148. private _teleportationEasing;
  130149. private _rotationAllowed;
  130150. private _teleportBackwardsVector;
  130151. private _teleportationTarget;
  130152. private _isDefaultTeleportationTarget;
  130153. private _postProcessMove;
  130154. private _teleportationFillColor;
  130155. private _teleportationBorderColor;
  130156. private _rotationAngle;
  130157. private _haloCenter;
  130158. private _cameraGazer;
  130159. private _padSensibilityUp;
  130160. private _padSensibilityDown;
  130161. private _leftController;
  130162. private _rightController;
  130163. private _gazeColor;
  130164. private _laserColor;
  130165. private _pickedLaserColor;
  130166. private _pickedGazeColor;
  130167. /**
  130168. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  130169. */
  130170. onNewMeshSelected: Observable<AbstractMesh>;
  130171. /**
  130172. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  130173. * This observable will provide the mesh and the controller used to select the mesh
  130174. */
  130175. onMeshSelectedWithController: Observable<{
  130176. mesh: AbstractMesh;
  130177. controller: WebVRController;
  130178. }>;
  130179. /**
  130180. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  130181. */
  130182. onNewMeshPicked: Observable<PickingInfo>;
  130183. private _circleEase;
  130184. /**
  130185. * Observable raised before camera teleportation
  130186. */
  130187. onBeforeCameraTeleport: Observable<Vector3>;
  130188. /**
  130189. * Observable raised after camera teleportation
  130190. */
  130191. onAfterCameraTeleport: Observable<Vector3>;
  130192. /**
  130193. * Observable raised when current selected mesh gets unselected
  130194. */
  130195. onSelectedMeshUnselected: Observable<AbstractMesh>;
  130196. private _raySelectionPredicate;
  130197. /**
  130198. * To be optionaly changed by user to define custom ray selection
  130199. */
  130200. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  130201. /**
  130202. * To be optionaly changed by user to define custom selection logic (after ray selection)
  130203. */
  130204. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  130205. /**
  130206. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  130207. */
  130208. teleportationEnabled: boolean;
  130209. private _defaultHeight;
  130210. private _teleportationInitialized;
  130211. private _interactionsEnabled;
  130212. private _interactionsRequested;
  130213. private _displayGaze;
  130214. private _displayLaserPointer;
  130215. /**
  130216. * The mesh used to display where the user is going to teleport.
  130217. */
  130218. get teleportationTarget(): Mesh;
  130219. /**
  130220. * Sets the mesh to be used to display where the user is going to teleport.
  130221. */
  130222. set teleportationTarget(value: Mesh);
  130223. /**
  130224. * 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
  130225. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  130226. * See https://doc.babylonjs.com/resources/baking_transformations
  130227. */
  130228. get gazeTrackerMesh(): Mesh;
  130229. set gazeTrackerMesh(value: Mesh);
  130230. /**
  130231. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  130232. */
  130233. updateGazeTrackerScale: boolean;
  130234. /**
  130235. * If the gaze trackers color should be updated when selecting meshes
  130236. */
  130237. updateGazeTrackerColor: boolean;
  130238. /**
  130239. * If the controller laser color should be updated when selecting meshes
  130240. */
  130241. updateControllerLaserColor: boolean;
  130242. /**
  130243. * The gaze tracking mesh corresponding to the left controller
  130244. */
  130245. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  130246. /**
  130247. * The gaze tracking mesh corresponding to the right controller
  130248. */
  130249. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  130250. /**
  130251. * If the ray of the gaze should be displayed.
  130252. */
  130253. get displayGaze(): boolean;
  130254. /**
  130255. * Sets if the ray of the gaze should be displayed.
  130256. */
  130257. set displayGaze(value: boolean);
  130258. /**
  130259. * If the ray of the LaserPointer should be displayed.
  130260. */
  130261. get displayLaserPointer(): boolean;
  130262. /**
  130263. * Sets if the ray of the LaserPointer should be displayed.
  130264. */
  130265. set displayLaserPointer(value: boolean);
  130266. /**
  130267. * The deviceOrientationCamera used as the camera when not in VR.
  130268. */
  130269. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  130270. /**
  130271. * Based on the current WebVR support, returns the current VR camera used.
  130272. */
  130273. get currentVRCamera(): Nullable<Camera>;
  130274. /**
  130275. * The webVRCamera which is used when in VR.
  130276. */
  130277. get webVRCamera(): WebVRFreeCamera;
  130278. /**
  130279. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  130280. */
  130281. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  130282. /**
  130283. * The html button that is used to trigger entering into VR.
  130284. */
  130285. get vrButton(): Nullable<HTMLButtonElement>;
  130286. private get _teleportationRequestInitiated();
  130287. /**
  130288. * Defines whether or not Pointer lock should be requested when switching to
  130289. * full screen.
  130290. */
  130291. requestPointerLockOnFullScreen: boolean;
  130292. /**
  130293. * If asking to force XR, this will be populated with the default xr experience
  130294. */
  130295. xr: WebXRDefaultExperience;
  130296. /**
  130297. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  130298. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  130299. */
  130300. xrTestDone: boolean;
  130301. /**
  130302. * Instantiates a VRExperienceHelper.
  130303. * Helps to quickly add VR support to an existing scene.
  130304. * @param scene The scene the VRExperienceHelper belongs to.
  130305. * @param webVROptions Options to modify the vr experience helper's behavior.
  130306. */
  130307. constructor(scene: Scene,
  130308. /** Options to modify the vr experience helper's behavior. */
  130309. webVROptions?: VRExperienceHelperOptions);
  130310. private completeVRInit;
  130311. private _onDefaultMeshLoaded;
  130312. private _onResize;
  130313. private _onFullscreenChange;
  130314. /**
  130315. * Gets a value indicating if we are currently in VR mode.
  130316. */
  130317. get isInVRMode(): boolean;
  130318. private onVrDisplayPresentChange;
  130319. private onVRDisplayChanged;
  130320. private moveButtonToBottomRight;
  130321. private displayVRButton;
  130322. private updateButtonVisibility;
  130323. private _cachedAngularSensibility;
  130324. /**
  130325. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  130326. * Otherwise, will use the fullscreen API.
  130327. */
  130328. enterVR(): void;
  130329. /**
  130330. * Attempt to exit VR, or fullscreen.
  130331. */
  130332. exitVR(): void;
  130333. /**
  130334. * The position of the vr experience helper.
  130335. */
  130336. get position(): Vector3;
  130337. /**
  130338. * Sets the position of the vr experience helper.
  130339. */
  130340. set position(value: Vector3);
  130341. /**
  130342. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  130343. */
  130344. enableInteractions(): void;
  130345. private get _noControllerIsActive();
  130346. private beforeRender;
  130347. private _isTeleportationFloor;
  130348. /**
  130349. * Adds a floor mesh to be used for teleportation.
  130350. * @param floorMesh the mesh to be used for teleportation.
  130351. */
  130352. addFloorMesh(floorMesh: Mesh): void;
  130353. /**
  130354. * Removes a floor mesh from being used for teleportation.
  130355. * @param floorMesh the mesh to be removed.
  130356. */
  130357. removeFloorMesh(floorMesh: Mesh): void;
  130358. /**
  130359. * Enables interactions and teleportation using the VR controllers and gaze.
  130360. * @param vrTeleportationOptions options to modify teleportation behavior.
  130361. */
  130362. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  130363. private _onNewGamepadConnected;
  130364. private _tryEnableInteractionOnController;
  130365. private _onNewGamepadDisconnected;
  130366. private _enableInteractionOnController;
  130367. private _checkTeleportWithRay;
  130368. private _checkRotate;
  130369. private _checkTeleportBackwards;
  130370. private _enableTeleportationOnController;
  130371. private _createTeleportationCircles;
  130372. private _displayTeleportationTarget;
  130373. private _hideTeleportationTarget;
  130374. private _rotateCamera;
  130375. private _moveTeleportationSelectorTo;
  130376. private _workingVector;
  130377. private _workingQuaternion;
  130378. private _workingMatrix;
  130379. /**
  130380. * Time Constant Teleportation Mode
  130381. */
  130382. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  130383. /**
  130384. * Speed Constant Teleportation Mode
  130385. */
  130386. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  130387. /**
  130388. * Teleports the users feet to the desired location
  130389. * @param location The location where the user's feet should be placed
  130390. */
  130391. teleportCamera(location: Vector3): void;
  130392. private _convertNormalToDirectionOfRay;
  130393. private _castRayAndSelectObject;
  130394. private _notifySelectedMeshUnselected;
  130395. /**
  130396. * Permanently set new colors for the laser pointer
  130397. * @param color the new laser color
  130398. * @param pickedColor the new laser color when picked mesh detected
  130399. */
  130400. setLaserColor(color: Color3, pickedColor?: Color3): void;
  130401. /**
  130402. * Set lighting enabled / disabled on the laser pointer of both controllers
  130403. * @param enabled should the lighting be enabled on the laser pointer
  130404. */
  130405. setLaserLightingState(enabled?: boolean): void;
  130406. /**
  130407. * Permanently set new colors for the gaze pointer
  130408. * @param color the new gaze color
  130409. * @param pickedColor the new gaze color when picked mesh detected
  130410. */
  130411. setGazeColor(color: Color3, pickedColor?: Color3): void;
  130412. /**
  130413. * Sets the color of the laser ray from the vr controllers.
  130414. * @param color new color for the ray.
  130415. */
  130416. changeLaserColor(color: Color3): void;
  130417. /**
  130418. * Sets the color of the ray from the vr headsets gaze.
  130419. * @param color new color for the ray.
  130420. */
  130421. changeGazeColor(color: Color3): void;
  130422. /**
  130423. * Exits VR and disposes of the vr experience helper
  130424. */
  130425. dispose(): void;
  130426. /**
  130427. * Gets the name of the VRExperienceHelper class
  130428. * @returns "VRExperienceHelper"
  130429. */
  130430. getClassName(): string;
  130431. }
  130432. }
  130433. declare module BABYLON {
  130434. /**
  130435. * Contains an array of blocks representing the octree
  130436. */
  130437. export interface IOctreeContainer<T> {
  130438. /**
  130439. * Blocks within the octree
  130440. */
  130441. blocks: Array<OctreeBlock<T>>;
  130442. }
  130443. /**
  130444. * Class used to store a cell in an octree
  130445. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130446. */
  130447. export class OctreeBlock<T> {
  130448. /**
  130449. * Gets the content of the current block
  130450. */
  130451. entries: T[];
  130452. /**
  130453. * Gets the list of block children
  130454. */
  130455. blocks: Array<OctreeBlock<T>>;
  130456. private _depth;
  130457. private _maxDepth;
  130458. private _capacity;
  130459. private _minPoint;
  130460. private _maxPoint;
  130461. private _boundingVectors;
  130462. private _creationFunc;
  130463. /**
  130464. * Creates a new block
  130465. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  130466. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  130467. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  130468. * @param depth defines the current depth of this block in the octree
  130469. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  130470. * @param creationFunc defines a callback to call when an element is added to the block
  130471. */
  130472. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  130473. /**
  130474. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  130475. */
  130476. get capacity(): number;
  130477. /**
  130478. * Gets the minimum vector (in world space) of the block's bounding box
  130479. */
  130480. get minPoint(): Vector3;
  130481. /**
  130482. * Gets the maximum vector (in world space) of the block's bounding box
  130483. */
  130484. get maxPoint(): Vector3;
  130485. /**
  130486. * Add a new element to this block
  130487. * @param entry defines the element to add
  130488. */
  130489. addEntry(entry: T): void;
  130490. /**
  130491. * Remove an element from this block
  130492. * @param entry defines the element to remove
  130493. */
  130494. removeEntry(entry: T): void;
  130495. /**
  130496. * Add an array of elements to this block
  130497. * @param entries defines the array of elements to add
  130498. */
  130499. addEntries(entries: T[]): void;
  130500. /**
  130501. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  130502. * @param frustumPlanes defines the frustum planes to test
  130503. * @param selection defines the array to store current content if selection is positive
  130504. * @param allowDuplicate defines if the selection array can contains duplicated entries
  130505. */
  130506. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  130507. /**
  130508. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  130509. * @param sphereCenter defines the bounding sphere center
  130510. * @param sphereRadius defines the bounding sphere radius
  130511. * @param selection defines the array to store current content if selection is positive
  130512. * @param allowDuplicate defines if the selection array can contains duplicated entries
  130513. */
  130514. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  130515. /**
  130516. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  130517. * @param ray defines the ray to test with
  130518. * @param selection defines the array to store current content if selection is positive
  130519. */
  130520. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  130521. /**
  130522. * Subdivide the content into child blocks (this block will then be empty)
  130523. */
  130524. createInnerBlocks(): void;
  130525. /**
  130526. * @hidden
  130527. */
  130528. 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;
  130529. }
  130530. }
  130531. declare module BABYLON {
  130532. /**
  130533. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  130534. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130535. */
  130536. export class Octree<T> {
  130537. /** 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.) */
  130538. maxDepth: number;
  130539. /**
  130540. * Blocks within the octree containing objects
  130541. */
  130542. blocks: Array<OctreeBlock<T>>;
  130543. /**
  130544. * Content stored in the octree
  130545. */
  130546. dynamicContent: T[];
  130547. private _maxBlockCapacity;
  130548. private _selectionContent;
  130549. private _creationFunc;
  130550. /**
  130551. * Creates a octree
  130552. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130553. * @param creationFunc function to be used to instatiate the octree
  130554. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  130555. * @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.)
  130556. */
  130557. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  130558. /** 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.) */
  130559. maxDepth?: number);
  130560. /**
  130561. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  130562. * @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);
  130563. * @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);
  130564. * @param entries meshes to be added to the octree blocks
  130565. */
  130566. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  130567. /**
  130568. * Adds a mesh to the octree
  130569. * @param entry Mesh to add to the octree
  130570. */
  130571. addMesh(entry: T): void;
  130572. /**
  130573. * Remove an element from the octree
  130574. * @param entry defines the element to remove
  130575. */
  130576. removeMesh(entry: T): void;
  130577. /**
  130578. * Selects an array of meshes within the frustum
  130579. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  130580. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  130581. * @returns array of meshes within the frustum
  130582. */
  130583. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  130584. /**
  130585. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  130586. * @param sphereCenter defines the bounding sphere center
  130587. * @param sphereRadius defines the bounding sphere radius
  130588. * @param allowDuplicate defines if the selection array can contains duplicated entries
  130589. * @returns an array of objects that intersect the sphere
  130590. */
  130591. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  130592. /**
  130593. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  130594. * @param ray defines the ray to test with
  130595. * @returns array of intersected objects
  130596. */
  130597. intersectsRay(ray: Ray): SmartArray<T>;
  130598. /**
  130599. * Adds a mesh into the octree block if it intersects the block
  130600. */
  130601. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  130602. /**
  130603. * Adds a submesh into the octree block if it intersects the block
  130604. */
  130605. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  130606. }
  130607. }
  130608. declare module BABYLON {
  130609. interface Scene {
  130610. /**
  130611. * @hidden
  130612. * Backing Filed
  130613. */
  130614. _selectionOctree: Octree<AbstractMesh>;
  130615. /**
  130616. * Gets the octree used to boost mesh selection (picking)
  130617. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130618. */
  130619. selectionOctree: Octree<AbstractMesh>;
  130620. /**
  130621. * Creates or updates the octree used to boost selection (picking)
  130622. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130623. * @param maxCapacity defines the maximum capacity per leaf
  130624. * @param maxDepth defines the maximum depth of the octree
  130625. * @returns an octree of AbstractMesh
  130626. */
  130627. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  130628. }
  130629. interface AbstractMesh {
  130630. /**
  130631. * @hidden
  130632. * Backing Field
  130633. */
  130634. _submeshesOctree: Octree<SubMesh>;
  130635. /**
  130636. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  130637. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  130638. * @param maxCapacity defines the maximum size of each block (64 by default)
  130639. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  130640. * @returns the new octree
  130641. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  130642. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130643. */
  130644. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  130645. }
  130646. /**
  130647. * Defines the octree scene component responsible to manage any octrees
  130648. * in a given scene.
  130649. */
  130650. export class OctreeSceneComponent {
  130651. /**
  130652. * The component name help to identify the component in the list of scene components.
  130653. */
  130654. readonly name: string;
  130655. /**
  130656. * The scene the component belongs to.
  130657. */
  130658. scene: Scene;
  130659. /**
  130660. * Indicates if the meshes have been checked to make sure they are isEnabled()
  130661. */
  130662. readonly checksIsEnabled: boolean;
  130663. /**
  130664. * Creates a new instance of the component for the given scene
  130665. * @param scene Defines the scene to register the component in
  130666. */
  130667. constructor(scene: Scene);
  130668. /**
  130669. * Registers the component in a given scene
  130670. */
  130671. register(): void;
  130672. /**
  130673. * Return the list of active meshes
  130674. * @returns the list of active meshes
  130675. */
  130676. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  130677. /**
  130678. * Return the list of active sub meshes
  130679. * @param mesh The mesh to get the candidates sub meshes from
  130680. * @returns the list of active sub meshes
  130681. */
  130682. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  130683. private _tempRay;
  130684. /**
  130685. * Return the list of sub meshes intersecting with a given local ray
  130686. * @param mesh defines the mesh to find the submesh for
  130687. * @param localRay defines the ray in local space
  130688. * @returns the list of intersecting sub meshes
  130689. */
  130690. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  130691. /**
  130692. * Return the list of sub meshes colliding with a collider
  130693. * @param mesh defines the mesh to find the submesh for
  130694. * @param collider defines the collider to evaluate the collision against
  130695. * @returns the list of colliding sub meshes
  130696. */
  130697. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  130698. /**
  130699. * Rebuilds the elements related to this component in case of
  130700. * context lost for instance.
  130701. */
  130702. rebuild(): void;
  130703. /**
  130704. * Disposes the component and the associated ressources.
  130705. */
  130706. dispose(): void;
  130707. }
  130708. }
  130709. declare module BABYLON {
  130710. /**
  130711. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  130712. */
  130713. export class Gizmo implements IDisposable {
  130714. /** The utility layer the gizmo will be added to */
  130715. gizmoLayer: UtilityLayerRenderer;
  130716. /**
  130717. * The root mesh of the gizmo
  130718. */
  130719. _rootMesh: Mesh;
  130720. private _attachedMesh;
  130721. private _attachedNode;
  130722. /**
  130723. * Ratio for the scale of the gizmo (Default: 1)
  130724. */
  130725. protected _scaleRatio: number;
  130726. /**
  130727. * boolean updated by pointermove when a gizmo mesh is hovered
  130728. */
  130729. protected _isHovered: boolean;
  130730. /**
  130731. * Ratio for the scale of the gizmo (Default: 1)
  130732. */
  130733. set scaleRatio(value: number);
  130734. get scaleRatio(): number;
  130735. /**
  130736. * True when the mouse pointer is hovered a gizmo mesh
  130737. */
  130738. get isHovered(): boolean;
  130739. /**
  130740. * If a custom mesh has been set (Default: false)
  130741. */
  130742. protected _customMeshSet: boolean;
  130743. /**
  130744. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  130745. * * When set, interactions will be enabled
  130746. */
  130747. get attachedMesh(): Nullable<AbstractMesh>;
  130748. set attachedMesh(value: Nullable<AbstractMesh>);
  130749. /**
  130750. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  130751. * * When set, interactions will be enabled
  130752. */
  130753. get attachedNode(): Nullable<Node>;
  130754. set attachedNode(value: Nullable<Node>);
  130755. /**
  130756. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  130757. * @param mesh The mesh to replace the default mesh of the gizmo
  130758. */
  130759. setCustomMesh(mesh: Mesh): void;
  130760. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  130761. /**
  130762. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  130763. */
  130764. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130765. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130766. /**
  130767. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  130768. */
  130769. updateGizmoPositionToMatchAttachedMesh: boolean;
  130770. /**
  130771. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  130772. */
  130773. updateScale: boolean;
  130774. protected _interactionsEnabled: boolean;
  130775. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130776. private _beforeRenderObserver;
  130777. private _tempQuaternion;
  130778. private _tempVector;
  130779. private _tempVector2;
  130780. private _tempMatrix1;
  130781. private _tempMatrix2;
  130782. private _rightHandtoLeftHandMatrix;
  130783. /**
  130784. * Creates a gizmo
  130785. * @param gizmoLayer The utility layer the gizmo will be added to
  130786. */
  130787. constructor(
  130788. /** The utility layer the gizmo will be added to */
  130789. gizmoLayer?: UtilityLayerRenderer);
  130790. /**
  130791. * Updates the gizmo to match the attached mesh's position/rotation
  130792. */
  130793. protected _update(): void;
  130794. /**
  130795. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130796. * @param value Node, TransformNode or mesh
  130797. */
  130798. protected _matrixChanged(): void;
  130799. /**
  130800. * Disposes of the gizmo
  130801. */
  130802. dispose(): void;
  130803. }
  130804. }
  130805. declare module BABYLON {
  130806. /**
  130807. * Single plane drag gizmo
  130808. */
  130809. export class PlaneDragGizmo extends Gizmo {
  130810. /**
  130811. * Drag behavior responsible for the gizmos dragging interactions
  130812. */
  130813. dragBehavior: PointerDragBehavior;
  130814. private _pointerObserver;
  130815. /**
  130816. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130817. */
  130818. snapDistance: number;
  130819. /**
  130820. * Event that fires each time the gizmo snaps to a new location.
  130821. * * snapDistance is the the change in distance
  130822. */
  130823. onSnapObservable: Observable<{
  130824. snapDistance: number;
  130825. }>;
  130826. private _plane;
  130827. private _coloredMaterial;
  130828. private _hoverMaterial;
  130829. private _isEnabled;
  130830. private _parent;
  130831. /** @hidden */
  130832. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130833. /** @hidden */
  130834. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130835. /**
  130836. * Creates a PlaneDragGizmo
  130837. * @param gizmoLayer The utility layer the gizmo will be added to
  130838. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130839. * @param color The color of the gizmo
  130840. */
  130841. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130842. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130843. /**
  130844. * If the gizmo is enabled
  130845. */
  130846. set isEnabled(value: boolean);
  130847. get isEnabled(): boolean;
  130848. /**
  130849. * Disposes of the gizmo
  130850. */
  130851. dispose(): void;
  130852. }
  130853. }
  130854. declare module BABYLON {
  130855. /**
  130856. * Gizmo that enables dragging a mesh along 3 axis
  130857. */
  130858. export class PositionGizmo extends Gizmo {
  130859. /**
  130860. * Internal gizmo used for interactions on the x axis
  130861. */
  130862. xGizmo: AxisDragGizmo;
  130863. /**
  130864. * Internal gizmo used for interactions on the y axis
  130865. */
  130866. yGizmo: AxisDragGizmo;
  130867. /**
  130868. * Internal gizmo used for interactions on the z axis
  130869. */
  130870. zGizmo: AxisDragGizmo;
  130871. /**
  130872. * Internal gizmo used for interactions on the yz plane
  130873. */
  130874. xPlaneGizmo: PlaneDragGizmo;
  130875. /**
  130876. * Internal gizmo used for interactions on the xz plane
  130877. */
  130878. yPlaneGizmo: PlaneDragGizmo;
  130879. /**
  130880. * Internal gizmo used for interactions on the xy plane
  130881. */
  130882. zPlaneGizmo: PlaneDragGizmo;
  130883. /**
  130884. * private variables
  130885. */
  130886. private _meshAttached;
  130887. private _nodeAttached;
  130888. private _snapDistance;
  130889. /** Fires an event when any of it's sub gizmos are dragged */
  130890. onDragStartObservable: Observable<unknown>;
  130891. /** Fires an event when any of it's sub gizmos are released from dragging */
  130892. onDragEndObservable: Observable<unknown>;
  130893. /**
  130894. * If set to true, planar drag is enabled
  130895. */
  130896. private _planarGizmoEnabled;
  130897. get attachedMesh(): Nullable<AbstractMesh>;
  130898. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130899. get attachedNode(): Nullable<Node>;
  130900. set attachedNode(node: Nullable<Node>);
  130901. /**
  130902. * True when the mouse pointer is hovering a gizmo mesh
  130903. */
  130904. get isHovered(): boolean;
  130905. /**
  130906. * Creates a PositionGizmo
  130907. * @param gizmoLayer The utility layer the gizmo will be added to
  130908. @param thickness display gizmo axis thickness
  130909. */
  130910. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130911. /**
  130912. * If the planar drag gizmo is enabled
  130913. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130914. */
  130915. set planarGizmoEnabled(value: boolean);
  130916. get planarGizmoEnabled(): boolean;
  130917. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130918. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130919. /**
  130920. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130921. */
  130922. set snapDistance(value: number);
  130923. get snapDistance(): number;
  130924. /**
  130925. * Ratio for the scale of the gizmo (Default: 1)
  130926. */
  130927. set scaleRatio(value: number);
  130928. get scaleRatio(): number;
  130929. /**
  130930. * Disposes of the gizmo
  130931. */
  130932. dispose(): void;
  130933. /**
  130934. * CustomMeshes are not supported by this gizmo
  130935. * @param mesh The mesh to replace the default mesh of the gizmo
  130936. */
  130937. setCustomMesh(mesh: Mesh): void;
  130938. }
  130939. }
  130940. declare module BABYLON {
  130941. /**
  130942. * Single axis drag gizmo
  130943. */
  130944. export class AxisDragGizmo extends Gizmo {
  130945. /**
  130946. * Drag behavior responsible for the gizmos dragging interactions
  130947. */
  130948. dragBehavior: PointerDragBehavior;
  130949. private _pointerObserver;
  130950. /**
  130951. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130952. */
  130953. snapDistance: number;
  130954. /**
  130955. * Event that fires each time the gizmo snaps to a new location.
  130956. * * snapDistance is the the change in distance
  130957. */
  130958. onSnapObservable: Observable<{
  130959. snapDistance: number;
  130960. }>;
  130961. private _isEnabled;
  130962. private _parent;
  130963. private _arrow;
  130964. private _coloredMaterial;
  130965. private _hoverMaterial;
  130966. /** @hidden */
  130967. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130968. /** @hidden */
  130969. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130970. /**
  130971. * Creates an AxisDragGizmo
  130972. * @param gizmoLayer The utility layer the gizmo will be added to
  130973. * @param dragAxis The axis which the gizmo will be able to drag on
  130974. * @param color The color of the gizmo
  130975. * @param thickness display gizmo axis thickness
  130976. */
  130977. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130978. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130979. /**
  130980. * If the gizmo is enabled
  130981. */
  130982. set isEnabled(value: boolean);
  130983. get isEnabled(): boolean;
  130984. /**
  130985. * Disposes of the gizmo
  130986. */
  130987. dispose(): void;
  130988. }
  130989. }
  130990. declare module BABYLON.Debug {
  130991. /**
  130992. * The Axes viewer will show 3 axes in a specific point in space
  130993. */
  130994. export class AxesViewer {
  130995. private _xAxis;
  130996. private _yAxis;
  130997. private _zAxis;
  130998. private _scaleLinesFactor;
  130999. private _instanced;
  131000. /**
  131001. * Gets the hosting scene
  131002. */
  131003. scene: Nullable<Scene>;
  131004. /**
  131005. * Gets or sets a number used to scale line length
  131006. */
  131007. scaleLines: number;
  131008. /** Gets the node hierarchy used to render x-axis */
  131009. get xAxis(): TransformNode;
  131010. /** Gets the node hierarchy used to render y-axis */
  131011. get yAxis(): TransformNode;
  131012. /** Gets the node hierarchy used to render z-axis */
  131013. get zAxis(): TransformNode;
  131014. /**
  131015. * Creates a new AxesViewer
  131016. * @param scene defines the hosting scene
  131017. * @param scaleLines defines a number used to scale line length (1 by default)
  131018. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  131019. * @param xAxis defines the node hierarchy used to render the x-axis
  131020. * @param yAxis defines the node hierarchy used to render the y-axis
  131021. * @param zAxis defines the node hierarchy used to render the z-axis
  131022. */
  131023. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  131024. /**
  131025. * Force the viewer to update
  131026. * @param position defines the position of the viewer
  131027. * @param xaxis defines the x axis of the viewer
  131028. * @param yaxis defines the y axis of the viewer
  131029. * @param zaxis defines the z axis of the viewer
  131030. */
  131031. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  131032. /**
  131033. * Creates an instance of this axes viewer.
  131034. * @returns a new axes viewer with instanced meshes
  131035. */
  131036. createInstance(): AxesViewer;
  131037. /** Releases resources */
  131038. dispose(): void;
  131039. private static _SetRenderingGroupId;
  131040. }
  131041. }
  131042. declare module BABYLON.Debug {
  131043. /**
  131044. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  131045. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  131046. */
  131047. export class BoneAxesViewer extends AxesViewer {
  131048. /**
  131049. * Gets or sets the target mesh where to display the axes viewer
  131050. */
  131051. mesh: Nullable<Mesh>;
  131052. /**
  131053. * Gets or sets the target bone where to display the axes viewer
  131054. */
  131055. bone: Nullable<Bone>;
  131056. /** Gets current position */
  131057. pos: Vector3;
  131058. /** Gets direction of X axis */
  131059. xaxis: Vector3;
  131060. /** Gets direction of Y axis */
  131061. yaxis: Vector3;
  131062. /** Gets direction of Z axis */
  131063. zaxis: Vector3;
  131064. /**
  131065. * Creates a new BoneAxesViewer
  131066. * @param scene defines the hosting scene
  131067. * @param bone defines the target bone
  131068. * @param mesh defines the target mesh
  131069. * @param scaleLines defines a scaling factor for line length (1 by default)
  131070. */
  131071. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  131072. /**
  131073. * Force the viewer to update
  131074. */
  131075. update(): void;
  131076. /** Releases resources */
  131077. dispose(): void;
  131078. }
  131079. }
  131080. declare module BABYLON {
  131081. /**
  131082. * Interface used to define scene explorer extensibility option
  131083. */
  131084. export interface IExplorerExtensibilityOption {
  131085. /**
  131086. * Define the option label
  131087. */
  131088. label: string;
  131089. /**
  131090. * Defines the action to execute on click
  131091. */
  131092. action: (entity: any) => void;
  131093. }
  131094. /**
  131095. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  131096. */
  131097. export interface IExplorerExtensibilityGroup {
  131098. /**
  131099. * Defines a predicate to test if a given type mut be extended
  131100. */
  131101. predicate: (entity: any) => boolean;
  131102. /**
  131103. * Gets the list of options added to a type
  131104. */
  131105. entries: IExplorerExtensibilityOption[];
  131106. }
  131107. /**
  131108. * Interface used to define the options to use to create the Inspector
  131109. */
  131110. export interface IInspectorOptions {
  131111. /**
  131112. * Display in overlay mode (default: false)
  131113. */
  131114. overlay?: boolean;
  131115. /**
  131116. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  131117. */
  131118. globalRoot?: HTMLElement;
  131119. /**
  131120. * Display the Scene explorer
  131121. */
  131122. showExplorer?: boolean;
  131123. /**
  131124. * Display the property inspector
  131125. */
  131126. showInspector?: boolean;
  131127. /**
  131128. * Display in embed mode (both panes on the right)
  131129. */
  131130. embedMode?: boolean;
  131131. /**
  131132. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  131133. */
  131134. handleResize?: boolean;
  131135. /**
  131136. * Allow the panes to popup (default: true)
  131137. */
  131138. enablePopup?: boolean;
  131139. /**
  131140. * Allow the panes to be closed by users (default: true)
  131141. */
  131142. enableClose?: boolean;
  131143. /**
  131144. * Optional list of extensibility entries
  131145. */
  131146. explorerExtensibility?: IExplorerExtensibilityGroup[];
  131147. /**
  131148. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  131149. */
  131150. inspectorURL?: string;
  131151. /**
  131152. * Optional initial tab (default to DebugLayerTab.Properties)
  131153. */
  131154. initialTab?: DebugLayerTab;
  131155. }
  131156. interface Scene {
  131157. /**
  131158. * @hidden
  131159. * Backing field
  131160. */
  131161. _debugLayer: DebugLayer;
  131162. /**
  131163. * Gets the debug layer (aka Inspector) associated with the scene
  131164. * @see https://doc.babylonjs.com/features/playground_debuglayer
  131165. */
  131166. debugLayer: DebugLayer;
  131167. }
  131168. /**
  131169. * Enum of inspector action tab
  131170. */
  131171. export enum DebugLayerTab {
  131172. /**
  131173. * Properties tag (default)
  131174. */
  131175. Properties = 0,
  131176. /**
  131177. * Debug tab
  131178. */
  131179. Debug = 1,
  131180. /**
  131181. * Statistics tab
  131182. */
  131183. Statistics = 2,
  131184. /**
  131185. * Tools tab
  131186. */
  131187. Tools = 3,
  131188. /**
  131189. * Settings tab
  131190. */
  131191. Settings = 4
  131192. }
  131193. /**
  131194. * The debug layer (aka Inspector) is the go to tool in order to better understand
  131195. * what is happening in your scene
  131196. * @see https://doc.babylonjs.com/features/playground_debuglayer
  131197. */
  131198. export class DebugLayer {
  131199. /**
  131200. * Define the url to get the inspector script from.
  131201. * By default it uses the babylonjs CDN.
  131202. * @ignoreNaming
  131203. */
  131204. static InspectorURL: string;
  131205. private _scene;
  131206. private BJSINSPECTOR;
  131207. private _onPropertyChangedObservable?;
  131208. /**
  131209. * Observable triggered when a property is changed through the inspector.
  131210. */
  131211. get onPropertyChangedObservable(): any;
  131212. /**
  131213. * Instantiates a new debug layer.
  131214. * The debug layer (aka Inspector) is the go to tool in order to better understand
  131215. * what is happening in your scene
  131216. * @see https://doc.babylonjs.com/features/playground_debuglayer
  131217. * @param scene Defines the scene to inspect
  131218. */
  131219. constructor(scene: Scene);
  131220. /** Creates the inspector window. */
  131221. private _createInspector;
  131222. /**
  131223. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  131224. * @param entity defines the entity to select
  131225. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  131226. */
  131227. select(entity: any, lineContainerTitles?: string | string[]): void;
  131228. /** Get the inspector from bundle or global */
  131229. private _getGlobalInspector;
  131230. /**
  131231. * Get if the inspector is visible or not.
  131232. * @returns true if visible otherwise, false
  131233. */
  131234. isVisible(): boolean;
  131235. /**
  131236. * Hide the inspector and close its window.
  131237. */
  131238. hide(): void;
  131239. /**
  131240. * Update the scene in the inspector
  131241. */
  131242. setAsActiveScene(): void;
  131243. /**
  131244. * Launch the debugLayer.
  131245. * @param config Define the configuration of the inspector
  131246. * @return a promise fulfilled when the debug layer is visible
  131247. */
  131248. show(config?: IInspectorOptions): Promise<DebugLayer>;
  131249. }
  131250. }
  131251. declare module BABYLON {
  131252. /**
  131253. * Class containing static functions to help procedurally build meshes
  131254. */
  131255. export class BoxBuilder {
  131256. /**
  131257. * Creates a box mesh
  131258. * * The parameter `size` sets the size (float) of each box side (default 1)
  131259. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  131260. * * 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)
  131261. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  131262. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131263. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131264. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131265. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  131266. * @param name defines the name of the mesh
  131267. * @param options defines the options used to create the mesh
  131268. * @param scene defines the hosting scene
  131269. * @returns the box mesh
  131270. */
  131271. static CreateBox(name: string, options: {
  131272. size?: number;
  131273. width?: number;
  131274. height?: number;
  131275. depth?: number;
  131276. faceUV?: Vector4[];
  131277. faceColors?: Color4[];
  131278. sideOrientation?: number;
  131279. frontUVs?: Vector4;
  131280. backUVs?: Vector4;
  131281. wrap?: boolean;
  131282. topBaseAt?: number;
  131283. bottomBaseAt?: number;
  131284. updatable?: boolean;
  131285. }, scene?: Nullable<Scene>): Mesh;
  131286. }
  131287. }
  131288. declare module BABYLON.Debug {
  131289. /**
  131290. * Used to show the physics impostor around the specific mesh
  131291. */
  131292. export class PhysicsViewer {
  131293. /** @hidden */
  131294. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  131295. /** @hidden */
  131296. protected _meshes: Array<Nullable<AbstractMesh>>;
  131297. /** @hidden */
  131298. protected _scene: Nullable<Scene>;
  131299. /** @hidden */
  131300. protected _numMeshes: number;
  131301. /** @hidden */
  131302. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  131303. private _renderFunction;
  131304. private _utilityLayer;
  131305. private _debugBoxMesh;
  131306. private _debugSphereMesh;
  131307. private _debugCylinderMesh;
  131308. private _debugMaterial;
  131309. private _debugMeshMeshes;
  131310. /**
  131311. * Creates a new PhysicsViewer
  131312. * @param scene defines the hosting scene
  131313. */
  131314. constructor(scene: Scene);
  131315. /** @hidden */
  131316. protected _updateDebugMeshes(): void;
  131317. /**
  131318. * Renders a specified physic impostor
  131319. * @param impostor defines the impostor to render
  131320. * @param targetMesh defines the mesh represented by the impostor
  131321. * @returns the new debug mesh used to render the impostor
  131322. */
  131323. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  131324. /**
  131325. * Hides a specified physic impostor
  131326. * @param impostor defines the impostor to hide
  131327. */
  131328. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  131329. private _getDebugMaterial;
  131330. private _getDebugBoxMesh;
  131331. private _getDebugSphereMesh;
  131332. private _getDebugCylinderMesh;
  131333. private _getDebugMeshMesh;
  131334. private _getDebugMesh;
  131335. /** Releases all resources */
  131336. dispose(): void;
  131337. }
  131338. }
  131339. declare module BABYLON {
  131340. /**
  131341. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  131342. * in order to better appreciate the issue one might have.
  131343. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  131344. */
  131345. export class RayHelper {
  131346. /**
  131347. * Defines the ray we are currently tryin to visualize.
  131348. */
  131349. ray: Nullable<Ray>;
  131350. private _renderPoints;
  131351. private _renderLine;
  131352. private _renderFunction;
  131353. private _scene;
  131354. private _onAfterRenderObserver;
  131355. private _onAfterStepObserver;
  131356. private _attachedToMesh;
  131357. private _meshSpaceDirection;
  131358. private _meshSpaceOrigin;
  131359. /**
  131360. * Helper function to create a colored helper in a scene in one line.
  131361. * @param ray Defines the ray we are currently tryin to visualize
  131362. * @param scene Defines the scene the ray is used in
  131363. * @param color Defines the color we want to see the ray in
  131364. * @returns The newly created ray helper.
  131365. */
  131366. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  131367. /**
  131368. * Instantiate a new ray helper.
  131369. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  131370. * in order to better appreciate the issue one might have.
  131371. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  131372. * @param ray Defines the ray we are currently tryin to visualize
  131373. */
  131374. constructor(ray: Ray);
  131375. /**
  131376. * Shows the ray we are willing to debug.
  131377. * @param scene Defines the scene the ray needs to be rendered in
  131378. * @param color Defines the color the ray needs to be rendered in
  131379. */
  131380. show(scene: Scene, color?: Color3): void;
  131381. /**
  131382. * Hides the ray we are debugging.
  131383. */
  131384. hide(): void;
  131385. private _render;
  131386. /**
  131387. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  131388. * @param mesh Defines the mesh we want the helper attached to
  131389. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  131390. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  131391. * @param length Defines the length of the ray
  131392. */
  131393. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  131394. /**
  131395. * Detach the ray helper from the mesh it has previously been attached to.
  131396. */
  131397. detachFromMesh(): void;
  131398. private _updateToMesh;
  131399. /**
  131400. * Dispose the helper and release its associated resources.
  131401. */
  131402. dispose(): void;
  131403. }
  131404. }
  131405. declare module BABYLON {
  131406. /**
  131407. * Defines the options associated with the creation of a SkeletonViewer.
  131408. */
  131409. export interface ISkeletonViewerOptions {
  131410. /** Should the system pause animations before building the Viewer? */
  131411. pauseAnimations: boolean;
  131412. /** Should the system return the skeleton to rest before building? */
  131413. returnToRest: boolean;
  131414. /** public Display Mode of the Viewer */
  131415. displayMode: number;
  131416. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  131417. displayOptions: ISkeletonViewerDisplayOptions;
  131418. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  131419. computeBonesUsingShaders: boolean;
  131420. /** Flag ignore non weighted bones */
  131421. useAllBones: boolean;
  131422. }
  131423. /**
  131424. * Defines how to display the various bone meshes for the viewer.
  131425. */
  131426. export interface ISkeletonViewerDisplayOptions {
  131427. /** How far down to start tapering the bone spurs */
  131428. midStep?: number;
  131429. /** How big is the midStep? */
  131430. midStepFactor?: number;
  131431. /** Base for the Sphere Size */
  131432. sphereBaseSize?: number;
  131433. /** The ratio of the sphere to the longest bone in units */
  131434. sphereScaleUnit?: number;
  131435. /** Ratio for the Sphere Size */
  131436. sphereFactor?: number;
  131437. /** Whether to show local axes or not */
  131438. showLocalAxes?: boolean;
  131439. /** Length of each local axis */
  131440. localAxesSize?: number;
  131441. }
  131442. /**
  131443. * Defines the constructor options for the BoneWeight Shader.
  131444. */
  131445. export interface IBoneWeightShaderOptions {
  131446. /** Skeleton to Map */
  131447. skeleton: Skeleton;
  131448. /** Colors for Uninfluenced bones */
  131449. colorBase?: Color3;
  131450. /** Colors for 0.0-0.25 Weight bones */
  131451. colorZero?: Color3;
  131452. /** Color for 0.25-0.5 Weight Influence */
  131453. colorQuarter?: Color3;
  131454. /** Color for 0.5-0.75 Weight Influence */
  131455. colorHalf?: Color3;
  131456. /** Color for 0.75-1 Weight Influence */
  131457. colorFull?: Color3;
  131458. /** Color for Zero Weight Influence */
  131459. targetBoneIndex?: number;
  131460. }
  131461. /**
  131462. * Simple structure of the gradient steps for the Color Map.
  131463. */
  131464. export interface ISkeletonMapShaderColorMapKnot {
  131465. /** Color of the Knot */
  131466. color: Color3;
  131467. /** Location of the Knot */
  131468. location: number;
  131469. }
  131470. /**
  131471. * Defines the constructor options for the SkeletonMap Shader.
  131472. */
  131473. export interface ISkeletonMapShaderOptions {
  131474. /** Skeleton to Map */
  131475. skeleton: Skeleton;
  131476. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  131477. colorMap?: ISkeletonMapShaderColorMapKnot[];
  131478. }
  131479. }
  131480. declare module BABYLON {
  131481. /**
  131482. * Class containing static functions to help procedurally build meshes
  131483. */
  131484. export class RibbonBuilder {
  131485. /**
  131486. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  131487. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  131488. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  131489. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  131490. * * 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
  131491. * * 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
  131492. * * 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
  131493. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131494. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131495. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  131496. * * 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
  131497. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  131498. * * 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
  131499. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  131500. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131501. * @param name defines the name of the mesh
  131502. * @param options defines the options used to create the mesh
  131503. * @param scene defines the hosting scene
  131504. * @returns the ribbon mesh
  131505. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  131506. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  131507. */
  131508. static CreateRibbon(name: string, options: {
  131509. pathArray: Vector3[][];
  131510. closeArray?: boolean;
  131511. closePath?: boolean;
  131512. offset?: number;
  131513. updatable?: boolean;
  131514. sideOrientation?: number;
  131515. frontUVs?: Vector4;
  131516. backUVs?: Vector4;
  131517. instance?: Mesh;
  131518. invertUV?: boolean;
  131519. uvs?: Vector2[];
  131520. colors?: Color4[];
  131521. }, scene?: Nullable<Scene>): Mesh;
  131522. }
  131523. }
  131524. declare module BABYLON {
  131525. /**
  131526. * Class containing static functions to help procedurally build meshes
  131527. */
  131528. export class ShapeBuilder {
  131529. /**
  131530. * 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.
  131531. * * 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.
  131532. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  131533. * * 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.
  131534. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  131535. * * 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
  131536. * * 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
  131537. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  131538. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131539. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131540. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  131541. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  131542. * @param name defines the name of the mesh
  131543. * @param options defines the options used to create the mesh
  131544. * @param scene defines the hosting scene
  131545. * @returns the extruded shape mesh
  131546. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  131547. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  131548. */
  131549. static ExtrudeShape(name: string, options: {
  131550. shape: Vector3[];
  131551. path: Vector3[];
  131552. scale?: number;
  131553. rotation?: number;
  131554. cap?: number;
  131555. updatable?: boolean;
  131556. sideOrientation?: number;
  131557. frontUVs?: Vector4;
  131558. backUVs?: Vector4;
  131559. instance?: Mesh;
  131560. invertUV?: boolean;
  131561. }, scene?: Nullable<Scene>): Mesh;
  131562. /**
  131563. * Creates an custom extruded shape mesh.
  131564. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  131565. * * 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.
  131566. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  131567. * * 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
  131568. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  131569. * * 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
  131570. * * It must returns a float value that will be the scale value applied to the shape on each path point
  131571. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  131572. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  131573. * * 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
  131574. * * 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
  131575. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  131576. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131577. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131578. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  131579. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131580. * @param name defines the name of the mesh
  131581. * @param options defines the options used to create the mesh
  131582. * @param scene defines the hosting scene
  131583. * @returns the custom extruded shape mesh
  131584. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  131585. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  131586. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  131587. */
  131588. static ExtrudeShapeCustom(name: string, options: {
  131589. shape: Vector3[];
  131590. path: Vector3[];
  131591. scaleFunction?: any;
  131592. rotationFunction?: any;
  131593. ribbonCloseArray?: boolean;
  131594. ribbonClosePath?: boolean;
  131595. cap?: number;
  131596. updatable?: boolean;
  131597. sideOrientation?: number;
  131598. frontUVs?: Vector4;
  131599. backUVs?: Vector4;
  131600. instance?: Mesh;
  131601. invertUV?: boolean;
  131602. }, scene?: Nullable<Scene>): Mesh;
  131603. private static _ExtrudeShapeGeneric;
  131604. }
  131605. }
  131606. declare module BABYLON.Debug {
  131607. /**
  131608. * Class used to render a debug view of a given skeleton
  131609. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  131610. */
  131611. export class SkeletonViewer {
  131612. /** defines the skeleton to render */
  131613. skeleton: Skeleton;
  131614. /** defines the mesh attached to the skeleton */
  131615. mesh: AbstractMesh;
  131616. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  131617. autoUpdateBonesMatrices: boolean;
  131618. /** defines the rendering group id to use with the viewer */
  131619. renderingGroupId: number;
  131620. /** is the options for the viewer */
  131621. options: Partial<ISkeletonViewerOptions>;
  131622. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  131623. static readonly DISPLAY_LINES: number;
  131624. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  131625. static readonly DISPLAY_SPHERES: number;
  131626. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  131627. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  131628. /** public static method to create a BoneWeight Shader
  131629. * @param options The constructor options
  131630. * @param scene The scene that the shader is scoped to
  131631. * @returns The created ShaderMaterial
  131632. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  131633. */
  131634. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  131635. /** public static method to create a BoneWeight Shader
  131636. * @param options The constructor options
  131637. * @param scene The scene that the shader is scoped to
  131638. * @returns The created ShaderMaterial
  131639. */
  131640. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  131641. /** private static method to create a BoneWeight Shader
  131642. * @param size The size of the buffer to create (usually the bone count)
  131643. * @param colorMap The gradient data to generate
  131644. * @param scene The scene that the shader is scoped to
  131645. * @returns an Array of floats from the color gradient values
  131646. */
  131647. private static _CreateBoneMapColorBuffer;
  131648. /** If SkeletonViewer scene scope. */
  131649. private _scene;
  131650. /** Gets or sets the color used to render the skeleton */
  131651. color: Color3;
  131652. /** Array of the points of the skeleton fo the line view. */
  131653. private _debugLines;
  131654. /** The SkeletonViewers Mesh. */
  131655. private _debugMesh;
  131656. /** The local axes Meshes. */
  131657. private _localAxes;
  131658. /** If SkeletonViewer is enabled. */
  131659. private _isEnabled;
  131660. /** If SkeletonViewer is ready. */
  131661. private _ready;
  131662. /** SkeletonViewer render observable. */
  131663. private _obs;
  131664. /** The Utility Layer to render the gizmos in. */
  131665. private _utilityLayer;
  131666. private _boneIndices;
  131667. /** Gets the Scene. */
  131668. get scene(): Scene;
  131669. /** Gets the utilityLayer. */
  131670. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  131671. /** Checks Ready Status. */
  131672. get isReady(): Boolean;
  131673. /** Sets Ready Status. */
  131674. set ready(value: boolean);
  131675. /** Gets the debugMesh */
  131676. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  131677. /** Sets the debugMesh */
  131678. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  131679. /** Gets the displayMode */
  131680. get displayMode(): number;
  131681. /** Sets the displayMode */
  131682. set displayMode(value: number);
  131683. /**
  131684. * Creates a new SkeletonViewer
  131685. * @param skeleton defines the skeleton to render
  131686. * @param mesh defines the mesh attached to the skeleton
  131687. * @param scene defines the hosting scene
  131688. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  131689. * @param renderingGroupId defines the rendering group id to use with the viewer
  131690. * @param options All of the extra constructor options for the SkeletonViewer
  131691. */
  131692. constructor(
  131693. /** defines the skeleton to render */
  131694. skeleton: Skeleton,
  131695. /** defines the mesh attached to the skeleton */
  131696. mesh: AbstractMesh,
  131697. /** The Scene scope*/
  131698. scene: Scene,
  131699. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  131700. autoUpdateBonesMatrices?: boolean,
  131701. /** defines the rendering group id to use with the viewer */
  131702. renderingGroupId?: number,
  131703. /** is the options for the viewer */
  131704. options?: Partial<ISkeletonViewerOptions>);
  131705. /** The Dynamic bindings for the update functions */
  131706. private _bindObs;
  131707. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  131708. update(): void;
  131709. /** Gets or sets a boolean indicating if the viewer is enabled */
  131710. set isEnabled(value: boolean);
  131711. get isEnabled(): boolean;
  131712. private _getBonePosition;
  131713. private _getLinesForBonesWithLength;
  131714. private _getLinesForBonesNoLength;
  131715. /** function to revert the mesh and scene back to the initial state. */
  131716. private _revert;
  131717. private getAbsoluteRestPose;
  131718. /** function to build and bind sphere joint points and spur bone representations. */
  131719. private _buildSpheresAndSpurs;
  131720. private _buildLocalAxes;
  131721. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  131722. private _displayLinesUpdate;
  131723. /** Changes the displayMode of the skeleton viewer
  131724. * @param mode The displayMode numerical value
  131725. */
  131726. changeDisplayMode(mode: number): void;
  131727. /** Sets a display option of the skeleton viewer
  131728. *
  131729. * | Option | Type | Default | Description |
  131730. * | --------------- | ------- | ------- | ----------- |
  131731. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  131732. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  131733. *
  131734. * @param option String of the option name
  131735. * @param value The numerical option value
  131736. */
  131737. changeDisplayOptions(option: string, value: number): void;
  131738. /** Release associated resources */
  131739. dispose(): void;
  131740. }
  131741. }
  131742. declare module BABYLON {
  131743. /**
  131744. * Enum for Device Types
  131745. */
  131746. export enum DeviceType {
  131747. /** Generic */
  131748. Generic = 0,
  131749. /** Keyboard */
  131750. Keyboard = 1,
  131751. /** Mouse */
  131752. Mouse = 2,
  131753. /** Touch Pointers */
  131754. Touch = 3,
  131755. /** PS4 Dual Shock */
  131756. DualShock = 4,
  131757. /** Xbox */
  131758. Xbox = 5,
  131759. /** Switch Controller */
  131760. Switch = 6
  131761. }
  131762. /**
  131763. * Enum for All Pointers (Touch/Mouse)
  131764. */
  131765. export enum PointerInput {
  131766. /** Horizontal Axis */
  131767. Horizontal = 0,
  131768. /** Vertical Axis */
  131769. Vertical = 1,
  131770. /** Left Click or Touch */
  131771. LeftClick = 2,
  131772. /** Middle Click */
  131773. MiddleClick = 3,
  131774. /** Right Click */
  131775. RightClick = 4,
  131776. /** Browser Back */
  131777. BrowserBack = 5,
  131778. /** Browser Forward */
  131779. BrowserForward = 6
  131780. }
  131781. /**
  131782. * Enum for Dual Shock Gamepad
  131783. */
  131784. export enum DualShockInput {
  131785. /** Cross */
  131786. Cross = 0,
  131787. /** Circle */
  131788. Circle = 1,
  131789. /** Square */
  131790. Square = 2,
  131791. /** Triangle */
  131792. Triangle = 3,
  131793. /** L1 */
  131794. L1 = 4,
  131795. /** R1 */
  131796. R1 = 5,
  131797. /** L2 */
  131798. L2 = 6,
  131799. /** R2 */
  131800. R2 = 7,
  131801. /** Share */
  131802. Share = 8,
  131803. /** Options */
  131804. Options = 9,
  131805. /** L3 */
  131806. L3 = 10,
  131807. /** R3 */
  131808. R3 = 11,
  131809. /** DPadUp */
  131810. DPadUp = 12,
  131811. /** DPadDown */
  131812. DPadDown = 13,
  131813. /** DPadLeft */
  131814. DPadLeft = 14,
  131815. /** DRight */
  131816. DPadRight = 15,
  131817. /** Home */
  131818. Home = 16,
  131819. /** TouchPad */
  131820. TouchPad = 17,
  131821. /** LStickXAxis */
  131822. LStickXAxis = 18,
  131823. /** LStickYAxis */
  131824. LStickYAxis = 19,
  131825. /** RStickXAxis */
  131826. RStickXAxis = 20,
  131827. /** RStickYAxis */
  131828. RStickYAxis = 21
  131829. }
  131830. /**
  131831. * Enum for Xbox Gamepad
  131832. */
  131833. export enum XboxInput {
  131834. /** A */
  131835. A = 0,
  131836. /** B */
  131837. B = 1,
  131838. /** X */
  131839. X = 2,
  131840. /** Y */
  131841. Y = 3,
  131842. /** LB */
  131843. LB = 4,
  131844. /** RB */
  131845. RB = 5,
  131846. /** LT */
  131847. LT = 6,
  131848. /** RT */
  131849. RT = 7,
  131850. /** Back */
  131851. Back = 8,
  131852. /** Start */
  131853. Start = 9,
  131854. /** LS */
  131855. LS = 10,
  131856. /** RS */
  131857. RS = 11,
  131858. /** DPadUp */
  131859. DPadUp = 12,
  131860. /** DPadDown */
  131861. DPadDown = 13,
  131862. /** DPadLeft */
  131863. DPadLeft = 14,
  131864. /** DRight */
  131865. DPadRight = 15,
  131866. /** Home */
  131867. Home = 16,
  131868. /** LStickXAxis */
  131869. LStickXAxis = 17,
  131870. /** LStickYAxis */
  131871. LStickYAxis = 18,
  131872. /** RStickXAxis */
  131873. RStickXAxis = 19,
  131874. /** RStickYAxis */
  131875. RStickYAxis = 20
  131876. }
  131877. /**
  131878. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131879. */
  131880. export enum SwitchInput {
  131881. /** B */
  131882. B = 0,
  131883. /** A */
  131884. A = 1,
  131885. /** Y */
  131886. Y = 2,
  131887. /** X */
  131888. X = 3,
  131889. /** L */
  131890. L = 4,
  131891. /** R */
  131892. R = 5,
  131893. /** ZL */
  131894. ZL = 6,
  131895. /** ZR */
  131896. ZR = 7,
  131897. /** Minus */
  131898. Minus = 8,
  131899. /** Plus */
  131900. Plus = 9,
  131901. /** LS */
  131902. LS = 10,
  131903. /** RS */
  131904. RS = 11,
  131905. /** DPadUp */
  131906. DPadUp = 12,
  131907. /** DPadDown */
  131908. DPadDown = 13,
  131909. /** DPadLeft */
  131910. DPadLeft = 14,
  131911. /** DRight */
  131912. DPadRight = 15,
  131913. /** Home */
  131914. Home = 16,
  131915. /** Capture */
  131916. Capture = 17,
  131917. /** LStickXAxis */
  131918. LStickXAxis = 18,
  131919. /** LStickYAxis */
  131920. LStickYAxis = 19,
  131921. /** RStickXAxis */
  131922. RStickXAxis = 20,
  131923. /** RStickYAxis */
  131924. RStickYAxis = 21
  131925. }
  131926. }
  131927. declare module BABYLON {
  131928. /**
  131929. * This class will take all inputs from Keyboard, Pointer, and
  131930. * any Gamepads and provide a polling system that all devices
  131931. * will use. This class assumes that there will only be one
  131932. * pointer device and one keyboard.
  131933. */
  131934. export class DeviceInputSystem implements IDisposable {
  131935. /**
  131936. * Callback to be triggered when a device is connected
  131937. */
  131938. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131939. /**
  131940. * Callback to be triggered when a device is disconnected
  131941. */
  131942. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131943. /**
  131944. * Callback to be triggered when event driven input is updated
  131945. */
  131946. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131947. private _inputs;
  131948. private _gamepads;
  131949. private _keyboardActive;
  131950. private _pointerActive;
  131951. private _elementToAttachTo;
  131952. private _keyboardDownEvent;
  131953. private _keyboardUpEvent;
  131954. private _pointerMoveEvent;
  131955. private _pointerDownEvent;
  131956. private _pointerUpEvent;
  131957. private _gamepadConnectedEvent;
  131958. private _gamepadDisconnectedEvent;
  131959. private static _MAX_KEYCODES;
  131960. private static _MAX_POINTER_INPUTS;
  131961. private constructor();
  131962. /**
  131963. * Creates a new DeviceInputSystem instance
  131964. * @param engine Engine to pull input element from
  131965. * @returns The new instance
  131966. */
  131967. static Create(engine: Engine): DeviceInputSystem;
  131968. /**
  131969. * Checks for current device input value, given an id and input index
  131970. * @param deviceName Id of connected device
  131971. * @param inputIndex Index of device input
  131972. * @returns Current value of input
  131973. */
  131974. /**
  131975. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131976. * @param deviceType Enum specifiying device type
  131977. * @param deviceSlot "Slot" or index that device is referenced in
  131978. * @param inputIndex Id of input to be checked
  131979. * @returns Current value of input
  131980. */
  131981. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131982. /**
  131983. * Dispose of all the eventlisteners
  131984. */
  131985. dispose(): void;
  131986. /**
  131987. * Add device and inputs to device array
  131988. * @param deviceType Enum specifiying device type
  131989. * @param deviceSlot "Slot" or index that device is referenced in
  131990. * @param numberOfInputs Number of input entries to create for given device
  131991. */
  131992. private _registerDevice;
  131993. /**
  131994. * Given a specific device name, remove that device from the device map
  131995. * @param deviceType Enum specifiying device type
  131996. * @param deviceSlot "Slot" or index that device is referenced in
  131997. */
  131998. private _unregisterDevice;
  131999. /**
  132000. * Handle all actions that come from keyboard interaction
  132001. */
  132002. private _handleKeyActions;
  132003. /**
  132004. * Handle all actions that come from pointer interaction
  132005. */
  132006. private _handlePointerActions;
  132007. /**
  132008. * Handle all actions that come from gamepad interaction
  132009. */
  132010. private _handleGamepadActions;
  132011. /**
  132012. * Update all non-event based devices with each frame
  132013. * @param deviceType Enum specifiying device type
  132014. * @param deviceSlot "Slot" or index that device is referenced in
  132015. * @param inputIndex Id of input to be checked
  132016. */
  132017. private _updateDevice;
  132018. /**
  132019. * Gets DeviceType from the device name
  132020. * @param deviceName Name of Device from DeviceInputSystem
  132021. * @returns DeviceType enum value
  132022. */
  132023. private _getGamepadDeviceType;
  132024. }
  132025. }
  132026. declare module BABYLON {
  132027. /**
  132028. * Type to handle enforcement of inputs
  132029. */
  132030. 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;
  132031. }
  132032. declare module BABYLON {
  132033. /**
  132034. * Class that handles all input for a specific device
  132035. */
  132036. export class DeviceSource<T extends DeviceType> {
  132037. /** Type of device */
  132038. readonly deviceType: DeviceType;
  132039. /** "Slot" or index that device is referenced in */
  132040. readonly deviceSlot: number;
  132041. /**
  132042. * Observable to handle device input changes per device
  132043. */
  132044. readonly onInputChangedObservable: Observable<{
  132045. inputIndex: DeviceInput<T>;
  132046. previousState: Nullable<number>;
  132047. currentState: Nullable<number>;
  132048. }>;
  132049. private readonly _deviceInputSystem;
  132050. /**
  132051. * Default Constructor
  132052. * @param deviceInputSystem Reference to DeviceInputSystem
  132053. * @param deviceType Type of device
  132054. * @param deviceSlot "Slot" or index that device is referenced in
  132055. */
  132056. constructor(deviceInputSystem: DeviceInputSystem,
  132057. /** Type of device */
  132058. deviceType: DeviceType,
  132059. /** "Slot" or index that device is referenced in */
  132060. deviceSlot?: number);
  132061. /**
  132062. * Get input for specific input
  132063. * @param inputIndex index of specific input on device
  132064. * @returns Input value from DeviceInputSystem
  132065. */
  132066. getInput(inputIndex: DeviceInput<T>): number;
  132067. }
  132068. /**
  132069. * Class to keep track of devices
  132070. */
  132071. export class DeviceSourceManager implements IDisposable {
  132072. /**
  132073. * Observable to be triggered when before a device is connected
  132074. */
  132075. readonly onBeforeDeviceConnectedObservable: Observable<{
  132076. deviceType: DeviceType;
  132077. deviceSlot: number;
  132078. }>;
  132079. /**
  132080. * Observable to be triggered when before a device is disconnected
  132081. */
  132082. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  132083. deviceType: DeviceType;
  132084. deviceSlot: number;
  132085. }>;
  132086. /**
  132087. * Observable to be triggered when after a device is connected
  132088. */
  132089. readonly onAfterDeviceConnectedObservable: Observable<{
  132090. deviceType: DeviceType;
  132091. deviceSlot: number;
  132092. }>;
  132093. /**
  132094. * Observable to be triggered when after a device is disconnected
  132095. */
  132096. readonly onAfterDeviceDisconnectedObservable: Observable<{
  132097. deviceType: DeviceType;
  132098. deviceSlot: number;
  132099. }>;
  132100. private readonly _devices;
  132101. private readonly _firstDevice;
  132102. private readonly _deviceInputSystem;
  132103. /**
  132104. * Default Constructor
  132105. * @param engine engine to pull input element from
  132106. */
  132107. constructor(engine: Engine);
  132108. /**
  132109. * Gets a DeviceSource, given a type and slot
  132110. * @param deviceType Enum specifying device type
  132111. * @param deviceSlot "Slot" or index that device is referenced in
  132112. * @returns DeviceSource object
  132113. */
  132114. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  132115. /**
  132116. * Gets an array of DeviceSource objects for a given device type
  132117. * @param deviceType Enum specifying device type
  132118. * @returns Array of DeviceSource objects
  132119. */
  132120. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  132121. /**
  132122. * Dispose of DeviceInputSystem and other parts
  132123. */
  132124. dispose(): void;
  132125. /**
  132126. * Function to add device name to device list
  132127. * @param deviceType Enum specifying device type
  132128. * @param deviceSlot "Slot" or index that device is referenced in
  132129. */
  132130. private _addDevice;
  132131. /**
  132132. * Function to remove device name to device list
  132133. * @param deviceType Enum specifying device type
  132134. * @param deviceSlot "Slot" or index that device is referenced in
  132135. */
  132136. private _removeDevice;
  132137. /**
  132138. * Updates array storing first connected device of each type
  132139. * @param type Type of Device
  132140. */
  132141. private _updateFirstDevices;
  132142. }
  132143. }
  132144. declare module BABYLON {
  132145. /**
  132146. * Options to create the null engine
  132147. */
  132148. export class NullEngineOptions {
  132149. /**
  132150. * Render width (Default: 512)
  132151. */
  132152. renderWidth: number;
  132153. /**
  132154. * Render height (Default: 256)
  132155. */
  132156. renderHeight: number;
  132157. /**
  132158. * Texture size (Default: 512)
  132159. */
  132160. textureSize: number;
  132161. /**
  132162. * If delta time between frames should be constant
  132163. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132164. */
  132165. deterministicLockstep: boolean;
  132166. /**
  132167. * Maximum about of steps between frames (Default: 4)
  132168. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132169. */
  132170. lockstepMaxSteps: number;
  132171. /**
  132172. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  132173. */
  132174. useHighPrecisionMatrix?: boolean;
  132175. }
  132176. /**
  132177. * The null engine class provides support for headless version of babylon.js.
  132178. * This can be used in server side scenario or for testing purposes
  132179. */
  132180. export class NullEngine extends Engine {
  132181. private _options;
  132182. /**
  132183. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  132184. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132185. * @returns true if engine is in deterministic lock step mode
  132186. */
  132187. isDeterministicLockStep(): boolean;
  132188. /**
  132189. * Gets the max steps when engine is running in deterministic lock step
  132190. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132191. * @returns the max steps
  132192. */
  132193. getLockstepMaxSteps(): number;
  132194. /**
  132195. * Gets the current hardware scaling level.
  132196. * By default the hardware scaling level is computed from the window device ratio.
  132197. * 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.
  132198. * @returns a number indicating the current hardware scaling level
  132199. */
  132200. getHardwareScalingLevel(): number;
  132201. constructor(options?: NullEngineOptions);
  132202. /**
  132203. * Creates a vertex buffer
  132204. * @param vertices the data for the vertex buffer
  132205. * @returns the new WebGL static buffer
  132206. */
  132207. createVertexBuffer(vertices: FloatArray): DataBuffer;
  132208. /**
  132209. * Creates a new index buffer
  132210. * @param indices defines the content of the index buffer
  132211. * @param updatable defines if the index buffer must be updatable
  132212. * @returns a new webGL buffer
  132213. */
  132214. createIndexBuffer(indices: IndicesArray): DataBuffer;
  132215. /**
  132216. * Clear the current render buffer or the current render target (if any is set up)
  132217. * @param color defines the color to use
  132218. * @param backBuffer defines if the back buffer must be cleared
  132219. * @param depth defines if the depth buffer must be cleared
  132220. * @param stencil defines if the stencil buffer must be cleared
  132221. */
  132222. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132223. /**
  132224. * Gets the current render width
  132225. * @param useScreen defines if screen size must be used (or the current render target if any)
  132226. * @returns a number defining the current render width
  132227. */
  132228. getRenderWidth(useScreen?: boolean): number;
  132229. /**
  132230. * Gets the current render height
  132231. * @param useScreen defines if screen size must be used (or the current render target if any)
  132232. * @returns a number defining the current render height
  132233. */
  132234. getRenderHeight(useScreen?: boolean): number;
  132235. /**
  132236. * Set the WebGL's viewport
  132237. * @param viewport defines the viewport element to be used
  132238. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  132239. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  132240. */
  132241. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  132242. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  132243. /**
  132244. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  132245. * @param pipelineContext defines the pipeline context to use
  132246. * @param uniformsNames defines the list of uniform names
  132247. * @returns an array of webGL uniform locations
  132248. */
  132249. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  132250. /**
  132251. * Gets the lsit of active attributes for a given webGL program
  132252. * @param pipelineContext defines the pipeline context to use
  132253. * @param attributesNames defines the list of attribute names to get
  132254. * @returns an array of indices indicating the offset of each attribute
  132255. */
  132256. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132257. /**
  132258. * Binds an effect to the webGL context
  132259. * @param effect defines the effect to bind
  132260. */
  132261. bindSamplers(effect: Effect): void;
  132262. /**
  132263. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  132264. * @param effect defines the effect to activate
  132265. */
  132266. enableEffect(effect: Effect): void;
  132267. /**
  132268. * Set various states to the webGL context
  132269. * @param culling defines backface culling state
  132270. * @param zOffset defines the value to apply to zOffset (0 by default)
  132271. * @param force defines if states must be applied even if cache is up to date
  132272. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  132273. */
  132274. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132275. /**
  132276. * Set the value of an uniform to an array of int32
  132277. * @param uniform defines the webGL uniform location where to store the value
  132278. * @param array defines the array of int32 to store
  132279. * @returns true if value was set
  132280. */
  132281. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132282. /**
  132283. * Set the value of an uniform to an array of int32 (stored as vec2)
  132284. * @param uniform defines the webGL uniform location where to store the value
  132285. * @param array defines the array of int32 to store
  132286. * @returns true if value was set
  132287. */
  132288. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132289. /**
  132290. * Set the value of an uniform to an array of int32 (stored as vec3)
  132291. * @param uniform defines the webGL uniform location where to store the value
  132292. * @param array defines the array of int32 to store
  132293. * @returns true if value was set
  132294. */
  132295. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132296. /**
  132297. * Set the value of an uniform to an array of int32 (stored as vec4)
  132298. * @param uniform defines the webGL uniform location where to store the value
  132299. * @param array defines the array of int32 to store
  132300. * @returns true if value was set
  132301. */
  132302. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132303. /**
  132304. * Set the value of an uniform to an array of float32
  132305. * @param uniform defines the webGL uniform location where to store the value
  132306. * @param array defines the array of float32 to store
  132307. * @returns true if value was set
  132308. */
  132309. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132310. /**
  132311. * Set the value of an uniform to an array of float32 (stored as vec2)
  132312. * @param uniform defines the webGL uniform location where to store the value
  132313. * @param array defines the array of float32 to store
  132314. * @returns true if value was set
  132315. */
  132316. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132317. /**
  132318. * Set the value of an uniform to an array of float32 (stored as vec3)
  132319. * @param uniform defines the webGL uniform location where to store the value
  132320. * @param array defines the array of float32 to store
  132321. * @returns true if value was set
  132322. */
  132323. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132324. /**
  132325. * Set the value of an uniform to an array of float32 (stored as vec4)
  132326. * @param uniform defines the webGL uniform location where to store the value
  132327. * @param array defines the array of float32 to store
  132328. * @returns true if value was set
  132329. */
  132330. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132331. /**
  132332. * Set the value of an uniform to an array of number
  132333. * @param uniform defines the webGL uniform location where to store the value
  132334. * @param array defines the array of number to store
  132335. * @returns true if value was set
  132336. */
  132337. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  132338. /**
  132339. * Set the value of an uniform to an array of number (stored as vec2)
  132340. * @param uniform defines the webGL uniform location where to store the value
  132341. * @param array defines the array of number to store
  132342. * @returns true if value was set
  132343. */
  132344. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  132345. /**
  132346. * Set the value of an uniform to an array of number (stored as vec3)
  132347. * @param uniform defines the webGL uniform location where to store the value
  132348. * @param array defines the array of number to store
  132349. * @returns true if value was set
  132350. */
  132351. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  132352. /**
  132353. * Set the value of an uniform to an array of number (stored as vec4)
  132354. * @param uniform defines the webGL uniform location where to store the value
  132355. * @param array defines the array of number to store
  132356. * @returns true if value was set
  132357. */
  132358. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  132359. /**
  132360. * Set the value of an uniform to an array of float32 (stored as matrices)
  132361. * @param uniform defines the webGL uniform location where to store the value
  132362. * @param matrices defines the array of float32 to store
  132363. * @returns true if value was set
  132364. */
  132365. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  132366. /**
  132367. * Set the value of an uniform to a matrix (3x3)
  132368. * @param uniform defines the webGL uniform location where to store the value
  132369. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  132370. * @returns true if value was set
  132371. */
  132372. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  132373. /**
  132374. * Set the value of an uniform to a matrix (2x2)
  132375. * @param uniform defines the webGL uniform location where to store the value
  132376. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  132377. * @returns true if value was set
  132378. */
  132379. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  132380. /**
  132381. * Set the value of an uniform to a number (float)
  132382. * @param uniform defines the webGL uniform location where to store the value
  132383. * @param value defines the float number to store
  132384. * @returns true if value was set
  132385. */
  132386. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  132387. /**
  132388. * Set the value of an uniform to a vec2
  132389. * @param uniform defines the webGL uniform location where to store the value
  132390. * @param x defines the 1st component of the value
  132391. * @param y defines the 2nd component of the value
  132392. * @returns true if value was set
  132393. */
  132394. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  132395. /**
  132396. * Set the value of an uniform to a vec3
  132397. * @param uniform defines the webGL uniform location where to store the value
  132398. * @param x defines the 1st component of the value
  132399. * @param y defines the 2nd component of the value
  132400. * @param z defines the 3rd component of the value
  132401. * @returns true if value was set
  132402. */
  132403. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  132404. /**
  132405. * Set the value of an uniform to a boolean
  132406. * @param uniform defines the webGL uniform location where to store the value
  132407. * @param bool defines the boolean to store
  132408. * @returns true if value was set
  132409. */
  132410. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  132411. /**
  132412. * Set the value of an uniform to a vec4
  132413. * @param uniform defines the webGL uniform location where to store the value
  132414. * @param x defines the 1st component of the value
  132415. * @param y defines the 2nd component of the value
  132416. * @param z defines the 3rd component of the value
  132417. * @param w defines the 4th component of the value
  132418. * @returns true if value was set
  132419. */
  132420. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  132421. /**
  132422. * Sets the current alpha mode
  132423. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  132424. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132425. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132426. */
  132427. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132428. /**
  132429. * Bind webGl buffers directly to the webGL context
  132430. * @param vertexBuffers defines the vertex buffer to bind
  132431. * @param indexBuffer defines the index buffer to bind
  132432. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  132433. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  132434. * @param effect defines the effect associated with the vertex buffer
  132435. */
  132436. bindBuffers(vertexBuffers: {
  132437. [key: string]: VertexBuffer;
  132438. }, indexBuffer: DataBuffer, effect: Effect): void;
  132439. /**
  132440. * Force the entire cache to be cleared
  132441. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  132442. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  132443. */
  132444. wipeCaches(bruteForce?: boolean): void;
  132445. /**
  132446. * Send a draw order
  132447. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  132448. * @param indexStart defines the starting index
  132449. * @param indexCount defines the number of index to draw
  132450. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132451. */
  132452. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  132453. /**
  132454. * Draw a list of indexed primitives
  132455. * @param fillMode defines the primitive to use
  132456. * @param indexStart defines the starting index
  132457. * @param indexCount defines the number of index to draw
  132458. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132459. */
  132460. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132461. /**
  132462. * Draw a list of unindexed primitives
  132463. * @param fillMode defines the primitive to use
  132464. * @param verticesStart defines the index of first vertex to draw
  132465. * @param verticesCount defines the count of vertices to draw
  132466. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132467. */
  132468. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132469. /** @hidden */
  132470. _createTexture(): WebGLTexture;
  132471. /** @hidden */
  132472. _releaseTexture(texture: InternalTexture): void;
  132473. /**
  132474. * Usually called from Texture.ts.
  132475. * Passed information to create a WebGLTexture
  132476. * @param urlArg defines a value which contains one of the following:
  132477. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132478. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132479. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132480. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132481. * @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)
  132482. * @param scene needed for loading to the correct scene
  132483. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132484. * @param onLoad optional callback to be called upon successful completion
  132485. * @param onError optional callback to be called upon failure
  132486. * @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
  132487. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132488. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132489. * @param forcedExtension defines the extension to use to pick the right loader
  132490. * @param mimeType defines an optional mime type
  132491. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132492. */
  132493. 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;
  132494. /**
  132495. * Creates a new render target texture
  132496. * @param size defines the size of the texture
  132497. * @param options defines the options used to create the texture
  132498. * @returns a new render target texture stored in an InternalTexture
  132499. */
  132500. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  132501. /**
  132502. * Update the sampling mode of a given texture
  132503. * @param samplingMode defines the required sampling mode
  132504. * @param texture defines the texture to update
  132505. */
  132506. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132507. /**
  132508. * Binds the frame buffer to the specified texture.
  132509. * @param texture The texture to render to or null for the default canvas
  132510. * @param faceIndex The face of the texture to render to in case of cube texture
  132511. * @param requiredWidth The width of the target to render to
  132512. * @param requiredHeight The height of the target to render to
  132513. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  132514. * @param lodLevel defines le lod level to bind to the frame buffer
  132515. */
  132516. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132517. /**
  132518. * Unbind the current render target texture from the webGL context
  132519. * @param texture defines the render target texture to unbind
  132520. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  132521. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  132522. */
  132523. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132524. /**
  132525. * Creates a dynamic vertex buffer
  132526. * @param vertices the data for the dynamic vertex buffer
  132527. * @returns the new WebGL dynamic buffer
  132528. */
  132529. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  132530. /**
  132531. * Update the content of a dynamic texture
  132532. * @param texture defines the texture to update
  132533. * @param canvas defines the canvas containing the source
  132534. * @param invertY defines if data must be stored with Y axis inverted
  132535. * @param premulAlpha defines if alpha is stored as premultiplied
  132536. * @param format defines the format of the data
  132537. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  132538. */
  132539. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  132540. /**
  132541. * Gets a boolean indicating if all created effects are ready
  132542. * @returns true if all effects are ready
  132543. */
  132544. areAllEffectsReady(): boolean;
  132545. /**
  132546. * @hidden
  132547. * Get the current error code of the webGL context
  132548. * @returns the error code
  132549. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  132550. */
  132551. getError(): number;
  132552. /** @hidden */
  132553. _getUnpackAlignement(): number;
  132554. /** @hidden */
  132555. _unpackFlipY(value: boolean): void;
  132556. /**
  132557. * Update a dynamic index buffer
  132558. * @param indexBuffer defines the target index buffer
  132559. * @param indices defines the data to update
  132560. * @param offset defines the offset in the target index buffer where update should start
  132561. */
  132562. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  132563. /**
  132564. * Updates a dynamic vertex buffer.
  132565. * @param vertexBuffer the vertex buffer to update
  132566. * @param vertices the data used to update the vertex buffer
  132567. * @param byteOffset the byte offset of the data (optional)
  132568. * @param byteLength the byte length of the data (optional)
  132569. */
  132570. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  132571. /** @hidden */
  132572. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  132573. /** @hidden */
  132574. _bindTexture(channel: number, texture: InternalTexture): void;
  132575. protected _deleteBuffer(buffer: WebGLBuffer): void;
  132576. /**
  132577. * 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
  132578. */
  132579. releaseEffects(): void;
  132580. displayLoadingUI(): void;
  132581. hideLoadingUI(): void;
  132582. /** @hidden */
  132583. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132584. /** @hidden */
  132585. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132586. /** @hidden */
  132587. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132588. /** @hidden */
  132589. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132590. }
  132591. }
  132592. declare module BABYLON {
  132593. /**
  132594. * @hidden
  132595. **/
  132596. export class _TimeToken {
  132597. _startTimeQuery: Nullable<WebGLQuery>;
  132598. _endTimeQuery: Nullable<WebGLQuery>;
  132599. _timeElapsedQuery: Nullable<WebGLQuery>;
  132600. _timeElapsedQueryEnded: boolean;
  132601. }
  132602. }
  132603. declare module BABYLON {
  132604. /** @hidden */
  132605. export class _OcclusionDataStorage {
  132606. /** @hidden */
  132607. occlusionInternalRetryCounter: number;
  132608. /** @hidden */
  132609. isOcclusionQueryInProgress: boolean;
  132610. /** @hidden */
  132611. isOccluded: boolean;
  132612. /** @hidden */
  132613. occlusionRetryCount: number;
  132614. /** @hidden */
  132615. occlusionType: number;
  132616. /** @hidden */
  132617. occlusionQueryAlgorithmType: number;
  132618. }
  132619. interface Engine {
  132620. /**
  132621. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  132622. * @return the new query
  132623. */
  132624. createQuery(): WebGLQuery;
  132625. /**
  132626. * Delete and release a webGL query
  132627. * @param query defines the query to delete
  132628. * @return the current engine
  132629. */
  132630. deleteQuery(query: WebGLQuery): Engine;
  132631. /**
  132632. * Check if a given query has resolved and got its value
  132633. * @param query defines the query to check
  132634. * @returns true if the query got its value
  132635. */
  132636. isQueryResultAvailable(query: WebGLQuery): boolean;
  132637. /**
  132638. * Gets the value of a given query
  132639. * @param query defines the query to check
  132640. * @returns the value of the query
  132641. */
  132642. getQueryResult(query: WebGLQuery): number;
  132643. /**
  132644. * Initiates an occlusion query
  132645. * @param algorithmType defines the algorithm to use
  132646. * @param query defines the query to use
  132647. * @returns the current engine
  132648. * @see https://doc.babylonjs.com/features/occlusionquery
  132649. */
  132650. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  132651. /**
  132652. * Ends an occlusion query
  132653. * @see https://doc.babylonjs.com/features/occlusionquery
  132654. * @param algorithmType defines the algorithm to use
  132655. * @returns the current engine
  132656. */
  132657. endOcclusionQuery(algorithmType: number): Engine;
  132658. /**
  132659. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  132660. * Please note that only one query can be issued at a time
  132661. * @returns a time token used to track the time span
  132662. */
  132663. startTimeQuery(): Nullable<_TimeToken>;
  132664. /**
  132665. * Ends a time query
  132666. * @param token defines the token used to measure the time span
  132667. * @returns the time spent (in ns)
  132668. */
  132669. endTimeQuery(token: _TimeToken): int;
  132670. /** @hidden */
  132671. _currentNonTimestampToken: Nullable<_TimeToken>;
  132672. /** @hidden */
  132673. _createTimeQuery(): WebGLQuery;
  132674. /** @hidden */
  132675. _deleteTimeQuery(query: WebGLQuery): void;
  132676. /** @hidden */
  132677. _getGlAlgorithmType(algorithmType: number): number;
  132678. /** @hidden */
  132679. _getTimeQueryResult(query: WebGLQuery): any;
  132680. /** @hidden */
  132681. _getTimeQueryAvailability(query: WebGLQuery): any;
  132682. }
  132683. interface AbstractMesh {
  132684. /**
  132685. * Backing filed
  132686. * @hidden
  132687. */
  132688. __occlusionDataStorage: _OcclusionDataStorage;
  132689. /**
  132690. * Access property
  132691. * @hidden
  132692. */
  132693. _occlusionDataStorage: _OcclusionDataStorage;
  132694. /**
  132695. * 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.
  132696. * The default value is -1 which means don't break the query and wait till the result
  132697. * @see https://doc.babylonjs.com/features/occlusionquery
  132698. */
  132699. occlusionRetryCount: number;
  132700. /**
  132701. * 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:
  132702. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  132703. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  132704. * * 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.
  132705. * @see https://doc.babylonjs.com/features/occlusionquery
  132706. */
  132707. occlusionType: number;
  132708. /**
  132709. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  132710. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  132711. * * 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.
  132712. * @see https://doc.babylonjs.com/features/occlusionquery
  132713. */
  132714. occlusionQueryAlgorithmType: number;
  132715. /**
  132716. * 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
  132717. * @see https://doc.babylonjs.com/features/occlusionquery
  132718. */
  132719. isOccluded: boolean;
  132720. /**
  132721. * Flag to check the progress status of the query
  132722. * @see https://doc.babylonjs.com/features/occlusionquery
  132723. */
  132724. isOcclusionQueryInProgress: boolean;
  132725. }
  132726. }
  132727. declare module BABYLON {
  132728. /** @hidden */
  132729. export var _forceTransformFeedbackToBundle: boolean;
  132730. interface Engine {
  132731. /**
  132732. * Creates a webGL transform feedback object
  132733. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  132734. * @returns the webGL transform feedback object
  132735. */
  132736. createTransformFeedback(): WebGLTransformFeedback;
  132737. /**
  132738. * Delete a webGL transform feedback object
  132739. * @param value defines the webGL transform feedback object to delete
  132740. */
  132741. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  132742. /**
  132743. * Bind a webGL transform feedback object to the webgl context
  132744. * @param value defines the webGL transform feedback object to bind
  132745. */
  132746. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  132747. /**
  132748. * Begins a transform feedback operation
  132749. * @param usePoints defines if points or triangles must be used
  132750. */
  132751. beginTransformFeedback(usePoints: boolean): void;
  132752. /**
  132753. * Ends a transform feedback operation
  132754. */
  132755. endTransformFeedback(): void;
  132756. /**
  132757. * Specify the varyings to use with transform feedback
  132758. * @param program defines the associated webGL program
  132759. * @param value defines the list of strings representing the varying names
  132760. */
  132761. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  132762. /**
  132763. * Bind a webGL buffer for a transform feedback operation
  132764. * @param value defines the webGL buffer to bind
  132765. */
  132766. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  132767. }
  132768. }
  132769. declare module BABYLON {
  132770. /**
  132771. * Class used to define an additional view for the engine
  132772. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132773. */
  132774. export class EngineView {
  132775. /** Defines the canvas where to render the view */
  132776. target: HTMLCanvasElement;
  132777. /** Defines an optional camera used to render the view (will use active camera else) */
  132778. camera?: Camera;
  132779. }
  132780. interface Engine {
  132781. /**
  132782. * Gets or sets the HTML element to use for attaching events
  132783. */
  132784. inputElement: Nullable<HTMLElement>;
  132785. /**
  132786. * Gets the current engine view
  132787. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132788. */
  132789. activeView: Nullable<EngineView>;
  132790. /** Gets or sets the list of views */
  132791. views: EngineView[];
  132792. /**
  132793. * Register a new child canvas
  132794. * @param canvas defines the canvas to register
  132795. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  132796. * @returns the associated view
  132797. */
  132798. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  132799. /**
  132800. * Remove a registered child canvas
  132801. * @param canvas defines the canvas to remove
  132802. * @returns the current engine
  132803. */
  132804. unRegisterView(canvas: HTMLCanvasElement): Engine;
  132805. }
  132806. }
  132807. declare module BABYLON {
  132808. interface Engine {
  132809. /** @hidden */
  132810. _excludedCompressedTextures: string[];
  132811. /** @hidden */
  132812. _textureFormatInUse: string;
  132813. /**
  132814. * Gets the list of texture formats supported
  132815. */
  132816. readonly texturesSupported: Array<string>;
  132817. /**
  132818. * Gets the texture format in use
  132819. */
  132820. readonly textureFormatInUse: Nullable<string>;
  132821. /**
  132822. * Set the compressed texture extensions or file names to skip.
  132823. *
  132824. * @param skippedFiles defines the list of those texture files you want to skip
  132825. * Example: [".dds", ".env", "myfile.png"]
  132826. */
  132827. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  132828. /**
  132829. * Set the compressed texture format to use, based on the formats you have, and the formats
  132830. * supported by the hardware / browser.
  132831. *
  132832. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  132833. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  132834. * to API arguments needed to compressed textures. This puts the burden on the container
  132835. * generator to house the arcane code for determining these for current & future formats.
  132836. *
  132837. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  132838. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  132839. *
  132840. * Note: The result of this call is not taken into account when a texture is base64.
  132841. *
  132842. * @param formatsAvailable defines the list of those format families you have created
  132843. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  132844. *
  132845. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  132846. * @returns The extension selected.
  132847. */
  132848. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  132849. }
  132850. }
  132851. declare module BABYLON {
  132852. /**
  132853. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  132854. */
  132855. export interface CubeMapInfo {
  132856. /**
  132857. * The pixel array for the front face.
  132858. * This is stored in format, left to right, up to down format.
  132859. */
  132860. front: Nullable<ArrayBufferView>;
  132861. /**
  132862. * The pixel array for the back face.
  132863. * This is stored in format, left to right, up to down format.
  132864. */
  132865. back: Nullable<ArrayBufferView>;
  132866. /**
  132867. * The pixel array for the left face.
  132868. * This is stored in format, left to right, up to down format.
  132869. */
  132870. left: Nullable<ArrayBufferView>;
  132871. /**
  132872. * The pixel array for the right face.
  132873. * This is stored in format, left to right, up to down format.
  132874. */
  132875. right: Nullable<ArrayBufferView>;
  132876. /**
  132877. * The pixel array for the up face.
  132878. * This is stored in format, left to right, up to down format.
  132879. */
  132880. up: Nullable<ArrayBufferView>;
  132881. /**
  132882. * The pixel array for the down face.
  132883. * This is stored in format, left to right, up to down format.
  132884. */
  132885. down: Nullable<ArrayBufferView>;
  132886. /**
  132887. * The size of the cubemap stored.
  132888. *
  132889. * Each faces will be size * size pixels.
  132890. */
  132891. size: number;
  132892. /**
  132893. * The format of the texture.
  132894. *
  132895. * RGBA, RGB.
  132896. */
  132897. format: number;
  132898. /**
  132899. * The type of the texture data.
  132900. *
  132901. * UNSIGNED_INT, FLOAT.
  132902. */
  132903. type: number;
  132904. /**
  132905. * Specifies whether the texture is in gamma space.
  132906. */
  132907. gammaSpace: boolean;
  132908. }
  132909. /**
  132910. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132911. */
  132912. export class PanoramaToCubeMapTools {
  132913. private static FACE_LEFT;
  132914. private static FACE_RIGHT;
  132915. private static FACE_FRONT;
  132916. private static FACE_BACK;
  132917. private static FACE_DOWN;
  132918. private static FACE_UP;
  132919. /**
  132920. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132921. *
  132922. * @param float32Array The source data.
  132923. * @param inputWidth The width of the input panorama.
  132924. * @param inputHeight The height of the input panorama.
  132925. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132926. * @return The cubemap data
  132927. */
  132928. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132929. private static CreateCubemapTexture;
  132930. private static CalcProjectionSpherical;
  132931. }
  132932. }
  132933. declare module BABYLON {
  132934. /**
  132935. * Helper class dealing with the extraction of spherical polynomial dataArray
  132936. * from a cube map.
  132937. */
  132938. export class CubeMapToSphericalPolynomialTools {
  132939. private static FileFaces;
  132940. /**
  132941. * Converts a texture to the according Spherical Polynomial data.
  132942. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132943. *
  132944. * @param texture The texture to extract the information from.
  132945. * @return The Spherical Polynomial data.
  132946. */
  132947. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132948. /**
  132949. * Converts a cubemap to the according Spherical Polynomial data.
  132950. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132951. *
  132952. * @param cubeInfo The Cube map to extract the information from.
  132953. * @return The Spherical Polynomial data.
  132954. */
  132955. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132956. }
  132957. }
  132958. declare module BABYLON {
  132959. interface BaseTexture {
  132960. /**
  132961. * Get the polynomial representation of the texture data.
  132962. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132963. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132964. */
  132965. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132966. }
  132967. }
  132968. declare module BABYLON {
  132969. /** @hidden */
  132970. export var rgbdEncodePixelShader: {
  132971. name: string;
  132972. shader: string;
  132973. };
  132974. }
  132975. declare module BABYLON {
  132976. /** @hidden */
  132977. export var rgbdDecodePixelShader: {
  132978. name: string;
  132979. shader: string;
  132980. };
  132981. }
  132982. declare module BABYLON {
  132983. /**
  132984. * Raw texture data and descriptor sufficient for WebGL texture upload
  132985. */
  132986. export interface EnvironmentTextureInfo {
  132987. /**
  132988. * Version of the environment map
  132989. */
  132990. version: number;
  132991. /**
  132992. * Width of image
  132993. */
  132994. width: number;
  132995. /**
  132996. * Irradiance information stored in the file.
  132997. */
  132998. irradiance: any;
  132999. /**
  133000. * Specular information stored in the file.
  133001. */
  133002. specular: any;
  133003. }
  133004. /**
  133005. * Defines One Image in the file. It requires only the position in the file
  133006. * as well as the length.
  133007. */
  133008. interface BufferImageData {
  133009. /**
  133010. * Length of the image data.
  133011. */
  133012. length: number;
  133013. /**
  133014. * Position of the data from the null terminator delimiting the end of the JSON.
  133015. */
  133016. position: number;
  133017. }
  133018. /**
  133019. * Defines the specular data enclosed in the file.
  133020. * This corresponds to the version 1 of the data.
  133021. */
  133022. export interface EnvironmentTextureSpecularInfoV1 {
  133023. /**
  133024. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  133025. */
  133026. specularDataPosition?: number;
  133027. /**
  133028. * This contains all the images data needed to reconstruct the cubemap.
  133029. */
  133030. mipmaps: Array<BufferImageData>;
  133031. /**
  133032. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  133033. */
  133034. lodGenerationScale: number;
  133035. }
  133036. /**
  133037. * Sets of helpers addressing the serialization and deserialization of environment texture
  133038. * stored in a BabylonJS env file.
  133039. * Those files are usually stored as .env files.
  133040. */
  133041. export class EnvironmentTextureTools {
  133042. /**
  133043. * Magic number identifying the env file.
  133044. */
  133045. private static _MagicBytes;
  133046. /**
  133047. * Gets the environment info from an env file.
  133048. * @param data The array buffer containing the .env bytes.
  133049. * @returns the environment file info (the json header) if successfully parsed.
  133050. */
  133051. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  133052. /**
  133053. * Creates an environment texture from a loaded cube texture.
  133054. * @param texture defines the cube texture to convert in env file
  133055. * @return a promise containing the environment data if succesfull.
  133056. */
  133057. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  133058. /**
  133059. * Creates a JSON representation of the spherical data.
  133060. * @param texture defines the texture containing the polynomials
  133061. * @return the JSON representation of the spherical info
  133062. */
  133063. private static _CreateEnvTextureIrradiance;
  133064. /**
  133065. * Creates the ArrayBufferViews used for initializing environment texture image data.
  133066. * @param data the image data
  133067. * @param info parameters that determine what views will be created for accessing the underlying buffer
  133068. * @return the views described by info providing access to the underlying buffer
  133069. */
  133070. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  133071. /**
  133072. * Uploads the texture info contained in the env file to the GPU.
  133073. * @param texture defines the internal texture to upload to
  133074. * @param data defines the data to load
  133075. * @param info defines the texture info retrieved through the GetEnvInfo method
  133076. * @returns a promise
  133077. */
  133078. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  133079. private static _OnImageReadyAsync;
  133080. /**
  133081. * Uploads the levels of image data to the GPU.
  133082. * @param texture defines the internal texture to upload to
  133083. * @param imageData defines the array buffer views of image data [mipmap][face]
  133084. * @returns a promise
  133085. */
  133086. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  133087. /**
  133088. * Uploads spherical polynomials information to the texture.
  133089. * @param texture defines the texture we are trying to upload the information to
  133090. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  133091. */
  133092. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  133093. /** @hidden */
  133094. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  133095. }
  133096. }
  133097. declare module BABYLON {
  133098. /**
  133099. * Class used to inline functions in shader code
  133100. */
  133101. export class ShaderCodeInliner {
  133102. private static readonly _RegexpFindFunctionNameAndType;
  133103. private _sourceCode;
  133104. private _functionDescr;
  133105. private _numMaxIterations;
  133106. /** Gets or sets the token used to mark the functions to inline */
  133107. inlineToken: string;
  133108. /** Gets or sets the debug mode */
  133109. debug: boolean;
  133110. /** Gets the code after the inlining process */
  133111. get code(): string;
  133112. /**
  133113. * Initializes the inliner
  133114. * @param sourceCode shader code source to inline
  133115. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  133116. */
  133117. constructor(sourceCode: string, numMaxIterations?: number);
  133118. /**
  133119. * Start the processing of the shader code
  133120. */
  133121. processCode(): void;
  133122. private _collectFunctions;
  133123. private _processInlining;
  133124. private _extractBetweenMarkers;
  133125. private _skipWhitespaces;
  133126. private _removeComments;
  133127. private _replaceFunctionCallsByCode;
  133128. private _findBackward;
  133129. private _escapeRegExp;
  133130. private _replaceNames;
  133131. }
  133132. }
  133133. declare module BABYLON {
  133134. /**
  133135. * Container for accessors for natively-stored mesh data buffers.
  133136. */
  133137. class NativeDataBuffer extends DataBuffer {
  133138. /**
  133139. * Accessor value used to identify/retrieve a natively-stored index buffer.
  133140. */
  133141. nativeIndexBuffer?: any;
  133142. /**
  133143. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  133144. */
  133145. nativeVertexBuffer?: any;
  133146. }
  133147. /** @hidden */
  133148. class NativeTexture extends InternalTexture {
  133149. getInternalTexture(): InternalTexture;
  133150. getViewCount(): number;
  133151. }
  133152. /** @hidden */
  133153. export class NativeEngine extends Engine {
  133154. private readonly _native;
  133155. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  133156. private readonly INVALID_HANDLE;
  133157. private _boundBuffersVertexArray;
  133158. getHardwareScalingLevel(): number;
  133159. constructor();
  133160. dispose(): void;
  133161. /**
  133162. * Can be used to override the current requestAnimationFrame requester.
  133163. * @hidden
  133164. */
  133165. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  133166. /**
  133167. * Override default engine behavior.
  133168. * @param color
  133169. * @param backBuffer
  133170. * @param depth
  133171. * @param stencil
  133172. */
  133173. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  133174. /**
  133175. * Gets host document
  133176. * @returns the host document object
  133177. */
  133178. getHostDocument(): Nullable<Document>;
  133179. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  133180. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  133181. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  133182. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  133183. [key: string]: VertexBuffer;
  133184. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  133185. bindBuffers(vertexBuffers: {
  133186. [key: string]: VertexBuffer;
  133187. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  133188. recordVertexArrayObject(vertexBuffers: {
  133189. [key: string]: VertexBuffer;
  133190. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  133191. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  133192. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  133193. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  133194. /**
  133195. * Draw a list of indexed primitives
  133196. * @param fillMode defines the primitive to use
  133197. * @param indexStart defines the starting index
  133198. * @param indexCount defines the number of index to draw
  133199. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  133200. */
  133201. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  133202. /**
  133203. * Draw a list of unindexed primitives
  133204. * @param fillMode defines the primitive to use
  133205. * @param verticesStart defines the index of first vertex to draw
  133206. * @param verticesCount defines the count of vertices to draw
  133207. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  133208. */
  133209. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  133210. createPipelineContext(): IPipelineContext;
  133211. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  133212. /** @hidden */
  133213. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  133214. /** @hidden */
  133215. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  133216. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  133217. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  133218. protected _setProgram(program: WebGLProgram): void;
  133219. _releaseEffect(effect: Effect): void;
  133220. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  133221. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  133222. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  133223. bindSamplers(effect: Effect): void;
  133224. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  133225. getRenderWidth(useScreen?: boolean): number;
  133226. getRenderHeight(useScreen?: boolean): number;
  133227. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  133228. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  133229. /**
  133230. * Set the z offset to apply to current rendering
  133231. * @param value defines the offset to apply
  133232. */
  133233. setZOffset(value: number): void;
  133234. /**
  133235. * Gets the current value of the zOffset
  133236. * @returns the current zOffset state
  133237. */
  133238. getZOffset(): number;
  133239. /**
  133240. * Enable or disable depth buffering
  133241. * @param enable defines the state to set
  133242. */
  133243. setDepthBuffer(enable: boolean): void;
  133244. /**
  133245. * Gets a boolean indicating if depth writing is enabled
  133246. * @returns the current depth writing state
  133247. */
  133248. getDepthWrite(): boolean;
  133249. /**
  133250. * Enable or disable depth writing
  133251. * @param enable defines the state to set
  133252. */
  133253. setDepthWrite(enable: boolean): void;
  133254. /**
  133255. * Enable or disable color writing
  133256. * @param enable defines the state to set
  133257. */
  133258. setColorWrite(enable: boolean): void;
  133259. /**
  133260. * Gets a boolean indicating if color writing is enabled
  133261. * @returns the current color writing state
  133262. */
  133263. getColorWrite(): boolean;
  133264. /**
  133265. * Sets alpha constants used by some alpha blending modes
  133266. * @param r defines the red component
  133267. * @param g defines the green component
  133268. * @param b defines the blue component
  133269. * @param a defines the alpha component
  133270. */
  133271. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  133272. /**
  133273. * Sets the current alpha mode
  133274. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  133275. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  133276. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  133277. */
  133278. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  133279. /**
  133280. * Gets the current alpha mode
  133281. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  133282. * @returns the current alpha mode
  133283. */
  133284. getAlphaMode(): number;
  133285. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  133286. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133287. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133288. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133289. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133290. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133291. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133292. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133293. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133294. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  133295. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  133296. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  133297. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  133298. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  133299. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  133300. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  133301. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  133302. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  133303. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  133304. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  133305. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  133306. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  133307. wipeCaches(bruteForce?: boolean): void;
  133308. _createTexture(): WebGLTexture;
  133309. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  133310. /**
  133311. * Usually called from Texture.ts.
  133312. * Passed information to create a WebGLTexture
  133313. * @param url defines a value which contains one of the following:
  133314. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  133315. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  133316. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  133317. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  133318. * @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)
  133319. * @param scene needed for loading to the correct scene
  133320. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  133321. * @param onLoad optional callback to be called upon successful completion
  133322. * @param onError optional callback to be called upon failure
  133323. * @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
  133324. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  133325. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  133326. * @param forcedExtension defines the extension to use to pick the right loader
  133327. * @param mimeType defines an optional mime type
  133328. * @returns a InternalTexture for assignment back into BABYLON.Texture
  133329. */
  133330. 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;
  133331. /**
  133332. * Creates a cube texture
  133333. * @param rootUrl defines the url where the files to load is located
  133334. * @param scene defines the current scene
  133335. * @param files defines the list of files to load (1 per face)
  133336. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  133337. * @param onLoad defines an optional callback raised when the texture is loaded
  133338. * @param onError defines an optional callback raised if there is an issue to load the texture
  133339. * @param format defines the format of the data
  133340. * @param forcedExtension defines the extension to use to pick the right loader
  133341. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  133342. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  133343. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  133344. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  133345. * @returns the cube texture as an InternalTexture
  133346. */
  133347. 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;
  133348. private _getSamplingFilter;
  133349. private static _GetNativeTextureFormat;
  133350. createRenderTargetTexture(size: number | {
  133351. width: number;
  133352. height: number;
  133353. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  133354. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  133355. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  133356. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  133357. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  133358. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  133359. /**
  133360. * Updates a dynamic vertex buffer.
  133361. * @param vertexBuffer the vertex buffer to update
  133362. * @param data the data used to update the vertex buffer
  133363. * @param byteOffset the byte offset of the data (optional)
  133364. * @param byteLength the byte length of the data (optional)
  133365. */
  133366. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  133367. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  133368. private _updateAnisotropicLevel;
  133369. private _getAddressMode;
  133370. /** @hidden */
  133371. _bindTexture(channel: number, texture: InternalTexture): void;
  133372. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  133373. releaseEffects(): void;
  133374. /** @hidden */
  133375. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  133376. /** @hidden */
  133377. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  133378. /** @hidden */
  133379. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  133380. /** @hidden */
  133381. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  133382. }
  133383. }
  133384. declare module BABYLON {
  133385. /**
  133386. * Gather the list of clipboard event types as constants.
  133387. */
  133388. export class ClipboardEventTypes {
  133389. /**
  133390. * The clipboard event is fired when a copy command is active (pressed).
  133391. */
  133392. static readonly COPY: number;
  133393. /**
  133394. * The clipboard event is fired when a cut command is active (pressed).
  133395. */
  133396. static readonly CUT: number;
  133397. /**
  133398. * The clipboard event is fired when a paste command is active (pressed).
  133399. */
  133400. static readonly PASTE: number;
  133401. }
  133402. /**
  133403. * This class is used to store clipboard related info for the onClipboardObservable event.
  133404. */
  133405. export class ClipboardInfo {
  133406. /**
  133407. * Defines the type of event (BABYLON.ClipboardEventTypes)
  133408. */
  133409. type: number;
  133410. /**
  133411. * Defines the related dom event
  133412. */
  133413. event: ClipboardEvent;
  133414. /**
  133415. *Creates an instance of ClipboardInfo.
  133416. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  133417. * @param event Defines the related dom event
  133418. */
  133419. constructor(
  133420. /**
  133421. * Defines the type of event (BABYLON.ClipboardEventTypes)
  133422. */
  133423. type: number,
  133424. /**
  133425. * Defines the related dom event
  133426. */
  133427. event: ClipboardEvent);
  133428. /**
  133429. * Get the clipboard event's type from the keycode.
  133430. * @param keyCode Defines the keyCode for the current keyboard event.
  133431. * @return {number}
  133432. */
  133433. static GetTypeFromCharacter(keyCode: number): number;
  133434. }
  133435. }
  133436. declare module BABYLON {
  133437. /**
  133438. * Google Daydream controller
  133439. */
  133440. export class DaydreamController extends WebVRController {
  133441. /**
  133442. * Base Url for the controller model.
  133443. */
  133444. static MODEL_BASE_URL: string;
  133445. /**
  133446. * File name for the controller model.
  133447. */
  133448. static MODEL_FILENAME: string;
  133449. /**
  133450. * Gamepad Id prefix used to identify Daydream Controller.
  133451. */
  133452. static readonly GAMEPAD_ID_PREFIX: string;
  133453. /**
  133454. * Creates a new DaydreamController from a gamepad
  133455. * @param vrGamepad the gamepad that the controller should be created from
  133456. */
  133457. constructor(vrGamepad: any);
  133458. /**
  133459. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133460. * @param scene scene in which to add meshes
  133461. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133462. */
  133463. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133464. /**
  133465. * Called once for each button that changed state since the last frame
  133466. * @param buttonIdx Which button index changed
  133467. * @param state New state of the button
  133468. * @param changes Which properties on the state changed since last frame
  133469. */
  133470. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133471. }
  133472. }
  133473. declare module BABYLON {
  133474. /**
  133475. * Gear VR Controller
  133476. */
  133477. export class GearVRController extends WebVRController {
  133478. /**
  133479. * Base Url for the controller model.
  133480. */
  133481. static MODEL_BASE_URL: string;
  133482. /**
  133483. * File name for the controller model.
  133484. */
  133485. static MODEL_FILENAME: string;
  133486. /**
  133487. * Gamepad Id prefix used to identify this controller.
  133488. */
  133489. static readonly GAMEPAD_ID_PREFIX: string;
  133490. private readonly _buttonIndexToObservableNameMap;
  133491. /**
  133492. * Creates a new GearVRController from a gamepad
  133493. * @param vrGamepad the gamepad that the controller should be created from
  133494. */
  133495. constructor(vrGamepad: any);
  133496. /**
  133497. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133498. * @param scene scene in which to add meshes
  133499. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133500. */
  133501. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133502. /**
  133503. * Called once for each button that changed state since the last frame
  133504. * @param buttonIdx Which button index changed
  133505. * @param state New state of the button
  133506. * @param changes Which properties on the state changed since last frame
  133507. */
  133508. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133509. }
  133510. }
  133511. declare module BABYLON {
  133512. /**
  133513. * Generic Controller
  133514. */
  133515. export class GenericController extends WebVRController {
  133516. /**
  133517. * Base Url for the controller model.
  133518. */
  133519. static readonly MODEL_BASE_URL: string;
  133520. /**
  133521. * File name for the controller model.
  133522. */
  133523. static readonly MODEL_FILENAME: string;
  133524. /**
  133525. * Creates a new GenericController from a gamepad
  133526. * @param vrGamepad the gamepad that the controller should be created from
  133527. */
  133528. constructor(vrGamepad: any);
  133529. /**
  133530. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133531. * @param scene scene in which to add meshes
  133532. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133533. */
  133534. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133535. /**
  133536. * Called once for each button that changed state since the last frame
  133537. * @param buttonIdx Which button index changed
  133538. * @param state New state of the button
  133539. * @param changes Which properties on the state changed since last frame
  133540. */
  133541. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133542. }
  133543. }
  133544. declare module BABYLON {
  133545. /**
  133546. * Oculus Touch Controller
  133547. */
  133548. export class OculusTouchController extends WebVRController {
  133549. /**
  133550. * Base Url for the controller model.
  133551. */
  133552. static MODEL_BASE_URL: string;
  133553. /**
  133554. * File name for the left controller model.
  133555. */
  133556. static MODEL_LEFT_FILENAME: string;
  133557. /**
  133558. * File name for the right controller model.
  133559. */
  133560. static MODEL_RIGHT_FILENAME: string;
  133561. /**
  133562. * Base Url for the Quest controller model.
  133563. */
  133564. static QUEST_MODEL_BASE_URL: string;
  133565. /**
  133566. * @hidden
  133567. * If the controllers are running on a device that needs the updated Quest controller models
  133568. */
  133569. static _IsQuest: boolean;
  133570. /**
  133571. * Fired when the secondary trigger on this controller is modified
  133572. */
  133573. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  133574. /**
  133575. * Fired when the thumb rest on this controller is modified
  133576. */
  133577. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  133578. /**
  133579. * Creates a new OculusTouchController from a gamepad
  133580. * @param vrGamepad the gamepad that the controller should be created from
  133581. */
  133582. constructor(vrGamepad: any);
  133583. /**
  133584. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133585. * @param scene scene in which to add meshes
  133586. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133587. */
  133588. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133589. /**
  133590. * Fired when the A button on this controller is modified
  133591. */
  133592. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133593. /**
  133594. * Fired when the B button on this controller is modified
  133595. */
  133596. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133597. /**
  133598. * Fired when the X button on this controller is modified
  133599. */
  133600. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133601. /**
  133602. * Fired when the Y button on this controller is modified
  133603. */
  133604. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133605. /**
  133606. * Called once for each button that changed state since the last frame
  133607. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  133608. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  133609. * 2) secondary trigger (same)
  133610. * 3) A (right) X (left), touch, pressed = value
  133611. * 4) B / Y
  133612. * 5) thumb rest
  133613. * @param buttonIdx Which button index changed
  133614. * @param state New state of the button
  133615. * @param changes Which properties on the state changed since last frame
  133616. */
  133617. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133618. }
  133619. }
  133620. declare module BABYLON {
  133621. /**
  133622. * Vive Controller
  133623. */
  133624. export class ViveController extends WebVRController {
  133625. /**
  133626. * Base Url for the controller model.
  133627. */
  133628. static MODEL_BASE_URL: string;
  133629. /**
  133630. * File name for the controller model.
  133631. */
  133632. static MODEL_FILENAME: string;
  133633. /**
  133634. * Creates a new ViveController from a gamepad
  133635. * @param vrGamepad the gamepad that the controller should be created from
  133636. */
  133637. constructor(vrGamepad: any);
  133638. /**
  133639. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133640. * @param scene scene in which to add meshes
  133641. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133642. */
  133643. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133644. /**
  133645. * Fired when the left button on this controller is modified
  133646. */
  133647. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133648. /**
  133649. * Fired when the right button on this controller is modified
  133650. */
  133651. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133652. /**
  133653. * Fired when the menu button on this controller is modified
  133654. */
  133655. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133656. /**
  133657. * Called once for each button that changed state since the last frame
  133658. * Vive mapping:
  133659. * 0: touchpad
  133660. * 1: trigger
  133661. * 2: left AND right buttons
  133662. * 3: menu button
  133663. * @param buttonIdx Which button index changed
  133664. * @param state New state of the button
  133665. * @param changes Which properties on the state changed since last frame
  133666. */
  133667. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133668. }
  133669. }
  133670. declare module BABYLON {
  133671. /**
  133672. * Defines the WindowsMotionController object that the state of the windows motion controller
  133673. */
  133674. export class WindowsMotionController extends WebVRController {
  133675. /**
  133676. * The base url used to load the left and right controller models
  133677. */
  133678. static MODEL_BASE_URL: string;
  133679. /**
  133680. * The name of the left controller model file
  133681. */
  133682. static MODEL_LEFT_FILENAME: string;
  133683. /**
  133684. * The name of the right controller model file
  133685. */
  133686. static MODEL_RIGHT_FILENAME: string;
  133687. /**
  133688. * The controller name prefix for this controller type
  133689. */
  133690. static readonly GAMEPAD_ID_PREFIX: string;
  133691. /**
  133692. * The controller id pattern for this controller type
  133693. */
  133694. private static readonly GAMEPAD_ID_PATTERN;
  133695. private _loadedMeshInfo;
  133696. protected readonly _mapping: {
  133697. buttons: string[];
  133698. buttonMeshNames: {
  133699. trigger: string;
  133700. menu: string;
  133701. grip: string;
  133702. thumbstick: string;
  133703. trackpad: string;
  133704. };
  133705. buttonObservableNames: {
  133706. trigger: string;
  133707. menu: string;
  133708. grip: string;
  133709. thumbstick: string;
  133710. trackpad: string;
  133711. };
  133712. axisMeshNames: string[];
  133713. pointingPoseMeshName: string;
  133714. };
  133715. /**
  133716. * Fired when the trackpad on this controller is clicked
  133717. */
  133718. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133719. /**
  133720. * Fired when the trackpad on this controller is modified
  133721. */
  133722. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133723. /**
  133724. * The current x and y values of this controller's trackpad
  133725. */
  133726. trackpad: StickValues;
  133727. /**
  133728. * Creates a new WindowsMotionController from a gamepad
  133729. * @param vrGamepad the gamepad that the controller should be created from
  133730. */
  133731. constructor(vrGamepad: any);
  133732. /**
  133733. * Fired when the trigger on this controller is modified
  133734. */
  133735. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133736. /**
  133737. * Fired when the menu button on this controller is modified
  133738. */
  133739. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133740. /**
  133741. * Fired when the grip button on this controller is modified
  133742. */
  133743. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133744. /**
  133745. * Fired when the thumbstick button on this controller is modified
  133746. */
  133747. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133748. /**
  133749. * Fired when the touchpad button on this controller is modified
  133750. */
  133751. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133752. /**
  133753. * Fired when the touchpad values on this controller are modified
  133754. */
  133755. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  133756. protected _updateTrackpad(): void;
  133757. /**
  133758. * Called once per frame by the engine.
  133759. */
  133760. update(): void;
  133761. /**
  133762. * Called once for each button that changed state since the last frame
  133763. * @param buttonIdx Which button index changed
  133764. * @param state New state of the button
  133765. * @param changes Which properties on the state changed since last frame
  133766. */
  133767. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133768. /**
  133769. * Moves the buttons on the controller mesh based on their current state
  133770. * @param buttonName the name of the button to move
  133771. * @param buttonValue the value of the button which determines the buttons new position
  133772. */
  133773. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  133774. /**
  133775. * Moves the axis on the controller mesh based on its current state
  133776. * @param axis the index of the axis
  133777. * @param axisValue the value of the axis which determines the meshes new position
  133778. * @hidden
  133779. */
  133780. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  133781. /**
  133782. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133783. * @param scene scene in which to add meshes
  133784. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133785. */
  133786. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  133787. /**
  133788. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  133789. * can be transformed by button presses and axes values, based on this._mapping.
  133790. *
  133791. * @param scene scene in which the meshes exist
  133792. * @param meshes list of meshes that make up the controller model to process
  133793. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  133794. */
  133795. private processModel;
  133796. private createMeshInfo;
  133797. /**
  133798. * Gets the ray of the controller in the direction the controller is pointing
  133799. * @param length the length the resulting ray should be
  133800. * @returns a ray in the direction the controller is pointing
  133801. */
  133802. getForwardRay(length?: number): Ray;
  133803. /**
  133804. * Disposes of the controller
  133805. */
  133806. dispose(): void;
  133807. }
  133808. /**
  133809. * This class represents a new windows motion controller in XR.
  133810. */
  133811. export class XRWindowsMotionController extends WindowsMotionController {
  133812. /**
  133813. * Changing the original WIndowsMotionController mapping to fir the new mapping
  133814. */
  133815. protected readonly _mapping: {
  133816. buttons: string[];
  133817. buttonMeshNames: {
  133818. trigger: string;
  133819. menu: string;
  133820. grip: string;
  133821. thumbstick: string;
  133822. trackpad: string;
  133823. };
  133824. buttonObservableNames: {
  133825. trigger: string;
  133826. menu: string;
  133827. grip: string;
  133828. thumbstick: string;
  133829. trackpad: string;
  133830. };
  133831. axisMeshNames: string[];
  133832. pointingPoseMeshName: string;
  133833. };
  133834. /**
  133835. * Construct a new XR-Based windows motion controller
  133836. *
  133837. * @param gamepadInfo the gamepad object from the browser
  133838. */
  133839. constructor(gamepadInfo: any);
  133840. /**
  133841. * holds the thumbstick values (X,Y)
  133842. */
  133843. thumbstickValues: StickValues;
  133844. /**
  133845. * Fired when the thumbstick on this controller is clicked
  133846. */
  133847. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  133848. /**
  133849. * Fired when the thumbstick on this controller is modified
  133850. */
  133851. onThumbstickValuesChangedObservable: Observable<StickValues>;
  133852. /**
  133853. * Fired when the touchpad button on this controller is modified
  133854. */
  133855. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133856. /**
  133857. * Fired when the touchpad values on this controller are modified
  133858. */
  133859. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133860. /**
  133861. * Fired when the thumbstick button on this controller is modified
  133862. * here to prevent breaking changes
  133863. */
  133864. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133865. /**
  133866. * updating the thumbstick(!) and not the trackpad.
  133867. * This is named this way due to the difference between WebVR and XR and to avoid
  133868. * changing the parent class.
  133869. */
  133870. protected _updateTrackpad(): void;
  133871. /**
  133872. * Disposes the class with joy
  133873. */
  133874. dispose(): void;
  133875. }
  133876. }
  133877. declare module BABYLON {
  133878. /**
  133879. * Class containing static functions to help procedurally build meshes
  133880. */
  133881. export class PolyhedronBuilder {
  133882. /**
  133883. * Creates a polyhedron mesh
  133884. * * 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
  133885. * * The parameter `size` (positive float, default 1) sets the polygon size
  133886. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133887. * * 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`
  133888. * * 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
  133889. * * 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)`)
  133890. * * 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
  133891. * * 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
  133892. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133893. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  133894. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133895. * @param name defines the name of the mesh
  133896. * @param options defines the options used to create the mesh
  133897. * @param scene defines the hosting scene
  133898. * @returns the polyhedron mesh
  133899. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133900. */
  133901. static CreatePolyhedron(name: string, options: {
  133902. type?: number;
  133903. size?: number;
  133904. sizeX?: number;
  133905. sizeY?: number;
  133906. sizeZ?: number;
  133907. custom?: any;
  133908. faceUV?: Vector4[];
  133909. faceColors?: Color4[];
  133910. flat?: boolean;
  133911. updatable?: boolean;
  133912. sideOrientation?: number;
  133913. frontUVs?: Vector4;
  133914. backUVs?: Vector4;
  133915. }, scene?: Nullable<Scene>): Mesh;
  133916. }
  133917. }
  133918. declare module BABYLON {
  133919. /**
  133920. * Gizmo that enables scaling a mesh along 3 axis
  133921. */
  133922. export class ScaleGizmo extends Gizmo {
  133923. /**
  133924. * Internal gizmo used for interactions on the x axis
  133925. */
  133926. xGizmo: AxisScaleGizmo;
  133927. /**
  133928. * Internal gizmo used for interactions on the y axis
  133929. */
  133930. yGizmo: AxisScaleGizmo;
  133931. /**
  133932. * Internal gizmo used for interactions on the z axis
  133933. */
  133934. zGizmo: AxisScaleGizmo;
  133935. /**
  133936. * Internal gizmo used to scale all axis equally
  133937. */
  133938. uniformScaleGizmo: AxisScaleGizmo;
  133939. private _meshAttached;
  133940. private _nodeAttached;
  133941. private _snapDistance;
  133942. private _uniformScalingMesh;
  133943. private _octahedron;
  133944. private _sensitivity;
  133945. /** Fires an event when any of it's sub gizmos are dragged */
  133946. onDragStartObservable: Observable<unknown>;
  133947. /** Fires an event when any of it's sub gizmos are released from dragging */
  133948. onDragEndObservable: Observable<unknown>;
  133949. get attachedMesh(): Nullable<AbstractMesh>;
  133950. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133951. get attachedNode(): Nullable<Node>;
  133952. set attachedNode(node: Nullable<Node>);
  133953. /**
  133954. * True when the mouse pointer is hovering a gizmo mesh
  133955. */
  133956. get isHovered(): boolean;
  133957. /**
  133958. * Creates a ScaleGizmo
  133959. * @param gizmoLayer The utility layer the gizmo will be added to
  133960. * @param thickness display gizmo axis thickness
  133961. */
  133962. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133963. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133964. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133965. /**
  133966. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133967. */
  133968. set snapDistance(value: number);
  133969. get snapDistance(): number;
  133970. /**
  133971. * Ratio for the scale of the gizmo (Default: 1)
  133972. */
  133973. set scaleRatio(value: number);
  133974. get scaleRatio(): number;
  133975. /**
  133976. * Sensitivity factor for dragging (Default: 1)
  133977. */
  133978. set sensitivity(value: number);
  133979. get sensitivity(): number;
  133980. /**
  133981. * Disposes of the gizmo
  133982. */
  133983. dispose(): void;
  133984. }
  133985. }
  133986. declare module BABYLON {
  133987. /**
  133988. * Single axis scale gizmo
  133989. */
  133990. export class AxisScaleGizmo extends Gizmo {
  133991. /**
  133992. * Drag behavior responsible for the gizmos dragging interactions
  133993. */
  133994. dragBehavior: PointerDragBehavior;
  133995. private _pointerObserver;
  133996. /**
  133997. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133998. */
  133999. snapDistance: number;
  134000. /**
  134001. * Event that fires each time the gizmo snaps to a new location.
  134002. * * snapDistance is the the change in distance
  134003. */
  134004. onSnapObservable: Observable<{
  134005. snapDistance: number;
  134006. }>;
  134007. /**
  134008. * If the scaling operation should be done on all axis (default: false)
  134009. */
  134010. uniformScaling: boolean;
  134011. /**
  134012. * Custom sensitivity value for the drag strength
  134013. */
  134014. sensitivity: number;
  134015. private _isEnabled;
  134016. private _parent;
  134017. private _arrow;
  134018. private _coloredMaterial;
  134019. private _hoverMaterial;
  134020. /**
  134021. * Creates an AxisScaleGizmo
  134022. * @param gizmoLayer The utility layer the gizmo will be added to
  134023. * @param dragAxis The axis which the gizmo will be able to scale on
  134024. * @param color The color of the gizmo
  134025. * @param thickness display gizmo axis thickness
  134026. */
  134027. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  134028. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134029. /**
  134030. * If the gizmo is enabled
  134031. */
  134032. set isEnabled(value: boolean);
  134033. get isEnabled(): boolean;
  134034. /**
  134035. * Disposes of the gizmo
  134036. */
  134037. dispose(): void;
  134038. /**
  134039. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  134040. * @param mesh The mesh to replace the default mesh of the gizmo
  134041. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  134042. */
  134043. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  134044. }
  134045. }
  134046. declare module BABYLON {
  134047. /**
  134048. * Bounding box gizmo
  134049. */
  134050. export class BoundingBoxGizmo extends Gizmo {
  134051. private _lineBoundingBox;
  134052. private _rotateSpheresParent;
  134053. private _scaleBoxesParent;
  134054. private _boundingDimensions;
  134055. private _renderObserver;
  134056. private _pointerObserver;
  134057. private _scaleDragSpeed;
  134058. private _tmpQuaternion;
  134059. private _tmpVector;
  134060. private _tmpRotationMatrix;
  134061. /**
  134062. * 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)
  134063. */
  134064. ignoreChildren: boolean;
  134065. /**
  134066. * 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)
  134067. */
  134068. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  134069. /**
  134070. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  134071. */
  134072. rotationSphereSize: number;
  134073. /**
  134074. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  134075. */
  134076. scaleBoxSize: number;
  134077. /**
  134078. * 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)
  134079. */
  134080. fixedDragMeshScreenSize: boolean;
  134081. /**
  134082. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  134083. */
  134084. fixedDragMeshScreenSizeDistanceFactor: number;
  134085. /**
  134086. * Fired when a rotation sphere or scale box is dragged
  134087. */
  134088. onDragStartObservable: Observable<{}>;
  134089. /**
  134090. * Fired when a scale box is dragged
  134091. */
  134092. onScaleBoxDragObservable: Observable<{}>;
  134093. /**
  134094. * Fired when a scale box drag is ended
  134095. */
  134096. onScaleBoxDragEndObservable: Observable<{}>;
  134097. /**
  134098. * Fired when a rotation sphere is dragged
  134099. */
  134100. onRotationSphereDragObservable: Observable<{}>;
  134101. /**
  134102. * Fired when a rotation sphere drag is ended
  134103. */
  134104. onRotationSphereDragEndObservable: Observable<{}>;
  134105. /**
  134106. * 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)
  134107. */
  134108. scalePivot: Nullable<Vector3>;
  134109. /**
  134110. * Mesh used as a pivot to rotate the attached node
  134111. */
  134112. private _anchorMesh;
  134113. private _existingMeshScale;
  134114. private _dragMesh;
  134115. private pointerDragBehavior;
  134116. private coloredMaterial;
  134117. private hoverColoredMaterial;
  134118. /**
  134119. * Sets the color of the bounding box gizmo
  134120. * @param color the color to set
  134121. */
  134122. setColor(color: Color3): void;
  134123. /**
  134124. * Creates an BoundingBoxGizmo
  134125. * @param gizmoLayer The utility layer the gizmo will be added to
  134126. * @param color The color of the gizmo
  134127. */
  134128. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  134129. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  134130. private _selectNode;
  134131. /**
  134132. * Updates the bounding box information for the Gizmo
  134133. */
  134134. updateBoundingBox(): void;
  134135. private _updateRotationSpheres;
  134136. private _updateScaleBoxes;
  134137. /**
  134138. * Enables rotation on the specified axis and disables rotation on the others
  134139. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  134140. */
  134141. setEnabledRotationAxis(axis: string): void;
  134142. /**
  134143. * Enables/disables scaling
  134144. * @param enable if scaling should be enabled
  134145. * @param homogeneousScaling defines if scaling should only be homogeneous
  134146. */
  134147. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  134148. private _updateDummy;
  134149. /**
  134150. * Enables a pointer drag behavior on the bounding box of the gizmo
  134151. */
  134152. enableDragBehavior(): void;
  134153. /**
  134154. * Disposes of the gizmo
  134155. */
  134156. dispose(): void;
  134157. /**
  134158. * 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)
  134159. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  134160. * @returns the bounding box mesh with the passed in mesh as a child
  134161. */
  134162. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  134163. /**
  134164. * CustomMeshes are not supported by this gizmo
  134165. * @param mesh The mesh to replace the default mesh of the gizmo
  134166. */
  134167. setCustomMesh(mesh: Mesh): void;
  134168. }
  134169. }
  134170. declare module BABYLON {
  134171. /**
  134172. * Single plane rotation gizmo
  134173. */
  134174. export class PlaneRotationGizmo extends Gizmo {
  134175. /**
  134176. * Drag behavior responsible for the gizmos dragging interactions
  134177. */
  134178. dragBehavior: PointerDragBehavior;
  134179. private _pointerObserver;
  134180. /**
  134181. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  134182. */
  134183. snapDistance: number;
  134184. /**
  134185. * Event that fires each time the gizmo snaps to a new location.
  134186. * * snapDistance is the the change in distance
  134187. */
  134188. onSnapObservable: Observable<{
  134189. snapDistance: number;
  134190. }>;
  134191. private _isEnabled;
  134192. private _parent;
  134193. /**
  134194. * Creates a PlaneRotationGizmo
  134195. * @param gizmoLayer The utility layer the gizmo will be added to
  134196. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  134197. * @param color The color of the gizmo
  134198. * @param tessellation Amount of tessellation to be used when creating rotation circles
  134199. * @param useEulerRotation Use and update Euler angle instead of quaternion
  134200. * @param thickness display gizmo axis thickness
  134201. */
  134202. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  134203. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134204. /**
  134205. * If the gizmo is enabled
  134206. */
  134207. set isEnabled(value: boolean);
  134208. get isEnabled(): boolean;
  134209. /**
  134210. * Disposes of the gizmo
  134211. */
  134212. dispose(): void;
  134213. }
  134214. }
  134215. declare module BABYLON {
  134216. /**
  134217. * Gizmo that enables rotating a mesh along 3 axis
  134218. */
  134219. export class RotationGizmo extends Gizmo {
  134220. /**
  134221. * Internal gizmo used for interactions on the x axis
  134222. */
  134223. xGizmo: PlaneRotationGizmo;
  134224. /**
  134225. * Internal gizmo used for interactions on the y axis
  134226. */
  134227. yGizmo: PlaneRotationGizmo;
  134228. /**
  134229. * Internal gizmo used for interactions on the z axis
  134230. */
  134231. zGizmo: PlaneRotationGizmo;
  134232. /** Fires an event when any of it's sub gizmos are dragged */
  134233. onDragStartObservable: Observable<unknown>;
  134234. /** Fires an event when any of it's sub gizmos are released from dragging */
  134235. onDragEndObservable: Observable<unknown>;
  134236. private _meshAttached;
  134237. private _nodeAttached;
  134238. get attachedMesh(): Nullable<AbstractMesh>;
  134239. set attachedMesh(mesh: Nullable<AbstractMesh>);
  134240. get attachedNode(): Nullable<Node>;
  134241. set attachedNode(node: Nullable<Node>);
  134242. /**
  134243. * True when the mouse pointer is hovering a gizmo mesh
  134244. */
  134245. get isHovered(): boolean;
  134246. /**
  134247. * Creates a RotationGizmo
  134248. * @param gizmoLayer The utility layer the gizmo will be added to
  134249. * @param tessellation Amount of tessellation to be used when creating rotation circles
  134250. * @param useEulerRotation Use and update Euler angle instead of quaternion
  134251. * @param thickness display gizmo axis thickness
  134252. */
  134253. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  134254. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  134255. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  134256. /**
  134257. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  134258. */
  134259. set snapDistance(value: number);
  134260. get snapDistance(): number;
  134261. /**
  134262. * Ratio for the scale of the gizmo (Default: 1)
  134263. */
  134264. set scaleRatio(value: number);
  134265. get scaleRatio(): number;
  134266. /**
  134267. * Disposes of the gizmo
  134268. */
  134269. dispose(): void;
  134270. /**
  134271. * CustomMeshes are not supported by this gizmo
  134272. * @param mesh The mesh to replace the default mesh of the gizmo
  134273. */
  134274. setCustomMesh(mesh: Mesh): void;
  134275. }
  134276. }
  134277. declare module BABYLON {
  134278. /**
  134279. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  134280. */
  134281. export class GizmoManager implements IDisposable {
  134282. private scene;
  134283. /**
  134284. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  134285. */
  134286. gizmos: {
  134287. positionGizmo: Nullable<PositionGizmo>;
  134288. rotationGizmo: Nullable<RotationGizmo>;
  134289. scaleGizmo: Nullable<ScaleGizmo>;
  134290. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  134291. };
  134292. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  134293. clearGizmoOnEmptyPointerEvent: boolean;
  134294. /** Fires an event when the manager is attached to a mesh */
  134295. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  134296. /** Fires an event when the manager is attached to a node */
  134297. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  134298. private _gizmosEnabled;
  134299. private _pointerObserver;
  134300. private _attachedMesh;
  134301. private _attachedNode;
  134302. private _boundingBoxColor;
  134303. private _defaultUtilityLayer;
  134304. private _defaultKeepDepthUtilityLayer;
  134305. private _thickness;
  134306. /**
  134307. * When bounding box gizmo is enabled, this can be used to track drag/end events
  134308. */
  134309. boundingBoxDragBehavior: SixDofDragBehavior;
  134310. /**
  134311. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  134312. */
  134313. attachableMeshes: Nullable<Array<AbstractMesh>>;
  134314. /**
  134315. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  134316. */
  134317. attachableNodes: Nullable<Array<Node>>;
  134318. /**
  134319. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  134320. */
  134321. usePointerToAttachGizmos: boolean;
  134322. /**
  134323. * Utility layer that the bounding box gizmo belongs to
  134324. */
  134325. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  134326. /**
  134327. * Utility layer that all gizmos besides bounding box belong to
  134328. */
  134329. get utilityLayer(): UtilityLayerRenderer;
  134330. /**
  134331. * True when the mouse pointer is hovering a gizmo mesh
  134332. */
  134333. get isHovered(): boolean;
  134334. /**
  134335. * Instatiates a gizmo manager
  134336. * @param scene the scene to overlay the gizmos on top of
  134337. * @param thickness display gizmo axis thickness
  134338. */
  134339. constructor(scene: Scene, thickness?: number);
  134340. /**
  134341. * Attaches a set of gizmos to the specified mesh
  134342. * @param mesh The mesh the gizmo's should be attached to
  134343. */
  134344. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  134345. /**
  134346. * Attaches a set of gizmos to the specified node
  134347. * @param node The node the gizmo's should be attached to
  134348. */
  134349. attachToNode(node: Nullable<Node>): void;
  134350. /**
  134351. * If the position gizmo is enabled
  134352. */
  134353. set positionGizmoEnabled(value: boolean);
  134354. get positionGizmoEnabled(): boolean;
  134355. /**
  134356. * If the rotation gizmo is enabled
  134357. */
  134358. set rotationGizmoEnabled(value: boolean);
  134359. get rotationGizmoEnabled(): boolean;
  134360. /**
  134361. * If the scale gizmo is enabled
  134362. */
  134363. set scaleGizmoEnabled(value: boolean);
  134364. get scaleGizmoEnabled(): boolean;
  134365. /**
  134366. * If the boundingBox gizmo is enabled
  134367. */
  134368. set boundingBoxGizmoEnabled(value: boolean);
  134369. get boundingBoxGizmoEnabled(): boolean;
  134370. /**
  134371. * Disposes of the gizmo manager
  134372. */
  134373. dispose(): void;
  134374. }
  134375. }
  134376. declare module BABYLON {
  134377. /**
  134378. * A directional light is defined by a direction (what a surprise!).
  134379. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  134380. * 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.
  134381. * Documentation: https://doc.babylonjs.com/babylon101/lights
  134382. */
  134383. export class DirectionalLight extends ShadowLight {
  134384. private _shadowFrustumSize;
  134385. /**
  134386. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  134387. */
  134388. get shadowFrustumSize(): number;
  134389. /**
  134390. * Specifies a fix frustum size for the shadow generation.
  134391. */
  134392. set shadowFrustumSize(value: number);
  134393. private _shadowOrthoScale;
  134394. /**
  134395. * Gets the shadow projection scale against the optimal computed one.
  134396. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  134397. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  134398. */
  134399. get shadowOrthoScale(): number;
  134400. /**
  134401. * Sets the shadow projection scale against the optimal computed one.
  134402. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  134403. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  134404. */
  134405. set shadowOrthoScale(value: number);
  134406. /**
  134407. * Automatically compute the projection matrix to best fit (including all the casters)
  134408. * on each frame.
  134409. */
  134410. autoUpdateExtends: boolean;
  134411. /**
  134412. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  134413. * on each frame. autoUpdateExtends must be set to true for this to work
  134414. */
  134415. autoCalcShadowZBounds: boolean;
  134416. private _orthoLeft;
  134417. private _orthoRight;
  134418. private _orthoTop;
  134419. private _orthoBottom;
  134420. /**
  134421. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  134422. * The directional light is emitted from everywhere in the given direction.
  134423. * It can cast shadows.
  134424. * Documentation : https://doc.babylonjs.com/babylon101/lights
  134425. * @param name The friendly name of the light
  134426. * @param direction The direction of the light
  134427. * @param scene The scene the light belongs to
  134428. */
  134429. constructor(name: string, direction: Vector3, scene: Scene);
  134430. /**
  134431. * Returns the string "DirectionalLight".
  134432. * @return The class name
  134433. */
  134434. getClassName(): string;
  134435. /**
  134436. * Returns the integer 1.
  134437. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  134438. */
  134439. getTypeID(): number;
  134440. /**
  134441. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  134442. * Returns the DirectionalLight Shadow projection matrix.
  134443. */
  134444. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  134445. /**
  134446. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  134447. * Returns the DirectionalLight Shadow projection matrix.
  134448. */
  134449. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  134450. /**
  134451. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  134452. * Returns the DirectionalLight Shadow projection matrix.
  134453. */
  134454. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  134455. protected _buildUniformLayout(): void;
  134456. /**
  134457. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  134458. * @param effect The effect to update
  134459. * @param lightIndex The index of the light in the effect to update
  134460. * @returns The directional light
  134461. */
  134462. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  134463. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  134464. /**
  134465. * Gets the minZ used for shadow according to both the scene and the light.
  134466. *
  134467. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  134468. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  134469. * @param activeCamera The camera we are returning the min for
  134470. * @returns the depth min z
  134471. */
  134472. getDepthMinZ(activeCamera: Camera): number;
  134473. /**
  134474. * Gets the maxZ used for shadow according to both the scene and the light.
  134475. *
  134476. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  134477. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  134478. * @param activeCamera The camera we are returning the max for
  134479. * @returns the depth max z
  134480. */
  134481. getDepthMaxZ(activeCamera: Camera): number;
  134482. /**
  134483. * Prepares the list of defines specific to the light type.
  134484. * @param defines the list of defines
  134485. * @param lightIndex defines the index of the light for the effect
  134486. */
  134487. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  134488. }
  134489. }
  134490. declare module BABYLON {
  134491. /**
  134492. * Class containing static functions to help procedurally build meshes
  134493. */
  134494. export class HemisphereBuilder {
  134495. /**
  134496. * Creates a hemisphere mesh
  134497. * @param name defines the name of the mesh
  134498. * @param options defines the options used to create the mesh
  134499. * @param scene defines the hosting scene
  134500. * @returns the hemisphere mesh
  134501. */
  134502. static CreateHemisphere(name: string, options: {
  134503. segments?: number;
  134504. diameter?: number;
  134505. sideOrientation?: number;
  134506. }, scene: any): Mesh;
  134507. }
  134508. }
  134509. declare module BABYLON {
  134510. /**
  134511. * A spot light is defined by a position, a direction, an angle, and an exponent.
  134512. * These values define a cone of light starting from the position, emitting toward the direction.
  134513. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  134514. * and the exponent defines the speed of the decay of the light with distance (reach).
  134515. * Documentation: https://doc.babylonjs.com/babylon101/lights
  134516. */
  134517. export class SpotLight extends ShadowLight {
  134518. private _angle;
  134519. private _innerAngle;
  134520. private _cosHalfAngle;
  134521. private _lightAngleScale;
  134522. private _lightAngleOffset;
  134523. /**
  134524. * Gets the cone angle of the spot light in Radians.
  134525. */
  134526. get angle(): number;
  134527. /**
  134528. * Sets the cone angle of the spot light in Radians.
  134529. */
  134530. set angle(value: number);
  134531. /**
  134532. * Only used in gltf falloff mode, this defines the angle where
  134533. * the directional falloff will start before cutting at angle which could be seen
  134534. * as outer angle.
  134535. */
  134536. get innerAngle(): number;
  134537. /**
  134538. * Only used in gltf falloff mode, this defines the angle where
  134539. * the directional falloff will start before cutting at angle which could be seen
  134540. * as outer angle.
  134541. */
  134542. set innerAngle(value: number);
  134543. private _shadowAngleScale;
  134544. /**
  134545. * Allows scaling the angle of the light for shadow generation only.
  134546. */
  134547. get shadowAngleScale(): number;
  134548. /**
  134549. * Allows scaling the angle of the light for shadow generation only.
  134550. */
  134551. set shadowAngleScale(value: number);
  134552. /**
  134553. * The light decay speed with the distance from the emission spot.
  134554. */
  134555. exponent: number;
  134556. private _projectionTextureMatrix;
  134557. /**
  134558. * Allows reading the projecton texture
  134559. */
  134560. get projectionTextureMatrix(): Matrix;
  134561. protected _projectionTextureLightNear: number;
  134562. /**
  134563. * Gets the near clip of the Spotlight for texture projection.
  134564. */
  134565. get projectionTextureLightNear(): number;
  134566. /**
  134567. * Sets the near clip of the Spotlight for texture projection.
  134568. */
  134569. set projectionTextureLightNear(value: number);
  134570. protected _projectionTextureLightFar: number;
  134571. /**
  134572. * Gets the far clip of the Spotlight for texture projection.
  134573. */
  134574. get projectionTextureLightFar(): number;
  134575. /**
  134576. * Sets the far clip of the Spotlight for texture projection.
  134577. */
  134578. set projectionTextureLightFar(value: number);
  134579. protected _projectionTextureUpDirection: Vector3;
  134580. /**
  134581. * Gets the Up vector of the Spotlight for texture projection.
  134582. */
  134583. get projectionTextureUpDirection(): Vector3;
  134584. /**
  134585. * Sets the Up vector of the Spotlight for texture projection.
  134586. */
  134587. set projectionTextureUpDirection(value: Vector3);
  134588. private _projectionTexture;
  134589. /**
  134590. * Gets the projection texture of the light.
  134591. */
  134592. get projectionTexture(): Nullable<BaseTexture>;
  134593. /**
  134594. * Sets the projection texture of the light.
  134595. */
  134596. set projectionTexture(value: Nullable<BaseTexture>);
  134597. private _projectionTextureViewLightDirty;
  134598. private _projectionTextureProjectionLightDirty;
  134599. private _projectionTextureDirty;
  134600. private _projectionTextureViewTargetVector;
  134601. private _projectionTextureViewLightMatrix;
  134602. private _projectionTextureProjectionLightMatrix;
  134603. private _projectionTextureScalingMatrix;
  134604. /**
  134605. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  134606. * It can cast shadows.
  134607. * Documentation : https://doc.babylonjs.com/babylon101/lights
  134608. * @param name The light friendly name
  134609. * @param position The position of the spot light in the scene
  134610. * @param direction The direction of the light in the scene
  134611. * @param angle The cone angle of the light in Radians
  134612. * @param exponent The light decay speed with the distance from the emission spot
  134613. * @param scene The scene the lights belongs to
  134614. */
  134615. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  134616. /**
  134617. * Returns the string "SpotLight".
  134618. * @returns the class name
  134619. */
  134620. getClassName(): string;
  134621. /**
  134622. * Returns the integer 2.
  134623. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  134624. */
  134625. getTypeID(): number;
  134626. /**
  134627. * Overrides the direction setter to recompute the projection texture view light Matrix.
  134628. */
  134629. protected _setDirection(value: Vector3): void;
  134630. /**
  134631. * Overrides the position setter to recompute the projection texture view light Matrix.
  134632. */
  134633. protected _setPosition(value: Vector3): void;
  134634. /**
  134635. * 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.
  134636. * Returns the SpotLight.
  134637. */
  134638. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  134639. protected _computeProjectionTextureViewLightMatrix(): void;
  134640. protected _computeProjectionTextureProjectionLightMatrix(): void;
  134641. /**
  134642. * Main function for light texture projection matrix computing.
  134643. */
  134644. protected _computeProjectionTextureMatrix(): void;
  134645. protected _buildUniformLayout(): void;
  134646. private _computeAngleValues;
  134647. /**
  134648. * Sets the passed Effect "effect" with the Light textures.
  134649. * @param effect The effect to update
  134650. * @param lightIndex The index of the light in the effect to update
  134651. * @returns The light
  134652. */
  134653. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  134654. /**
  134655. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  134656. * @param effect The effect to update
  134657. * @param lightIndex The index of the light in the effect to update
  134658. * @returns The spot light
  134659. */
  134660. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  134661. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  134662. /**
  134663. * Disposes the light and the associated resources.
  134664. */
  134665. dispose(): void;
  134666. /**
  134667. * Prepares the list of defines specific to the light type.
  134668. * @param defines the list of defines
  134669. * @param lightIndex defines the index of the light for the effect
  134670. */
  134671. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  134672. }
  134673. }
  134674. declare module BABYLON {
  134675. /**
  134676. * Gizmo that enables viewing a light
  134677. */
  134678. export class LightGizmo extends Gizmo {
  134679. private _lightMesh;
  134680. private _material;
  134681. private _cachedPosition;
  134682. private _cachedForward;
  134683. private _attachedMeshParent;
  134684. private _pointerObserver;
  134685. /**
  134686. * Event that fires each time the gizmo is clicked
  134687. */
  134688. onClickedObservable: Observable<Light>;
  134689. /**
  134690. * Creates a LightGizmo
  134691. * @param gizmoLayer The utility layer the gizmo will be added to
  134692. */
  134693. constructor(gizmoLayer?: UtilityLayerRenderer);
  134694. private _light;
  134695. /**
  134696. * The light that the gizmo is attached to
  134697. */
  134698. set light(light: Nullable<Light>);
  134699. get light(): Nullable<Light>;
  134700. /**
  134701. * Gets the material used to render the light gizmo
  134702. */
  134703. get material(): StandardMaterial;
  134704. /**
  134705. * @hidden
  134706. * Updates the gizmo to match the attached mesh's position/rotation
  134707. */
  134708. protected _update(): void;
  134709. private static _Scale;
  134710. /**
  134711. * Creates the lines for a light mesh
  134712. */
  134713. private static _CreateLightLines;
  134714. /**
  134715. * Disposes of the light gizmo
  134716. */
  134717. dispose(): void;
  134718. private static _CreateHemisphericLightMesh;
  134719. private static _CreatePointLightMesh;
  134720. private static _CreateSpotLightMesh;
  134721. private static _CreateDirectionalLightMesh;
  134722. }
  134723. }
  134724. declare module BABYLON {
  134725. /**
  134726. * Gizmo that enables viewing a camera
  134727. */
  134728. export class CameraGizmo extends Gizmo {
  134729. private _cameraMesh;
  134730. private _cameraLinesMesh;
  134731. private _material;
  134732. private _pointerObserver;
  134733. /**
  134734. * Event that fires each time the gizmo is clicked
  134735. */
  134736. onClickedObservable: Observable<Camera>;
  134737. /**
  134738. * Creates a CameraGizmo
  134739. * @param gizmoLayer The utility layer the gizmo will be added to
  134740. */
  134741. constructor(gizmoLayer?: UtilityLayerRenderer);
  134742. private _camera;
  134743. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  134744. get displayFrustum(): boolean;
  134745. set displayFrustum(value: boolean);
  134746. /**
  134747. * The camera that the gizmo is attached to
  134748. */
  134749. set camera(camera: Nullable<Camera>);
  134750. get camera(): Nullable<Camera>;
  134751. /**
  134752. * Gets the material used to render the camera gizmo
  134753. */
  134754. get material(): StandardMaterial;
  134755. /**
  134756. * @hidden
  134757. * Updates the gizmo to match the attached mesh's position/rotation
  134758. */
  134759. protected _update(): void;
  134760. private static _Scale;
  134761. private _invProjection;
  134762. /**
  134763. * Disposes of the camera gizmo
  134764. */
  134765. dispose(): void;
  134766. private static _CreateCameraMesh;
  134767. private static _CreateCameraFrustum;
  134768. }
  134769. }
  134770. declare module BABYLON {
  134771. /** @hidden */
  134772. export var backgroundFragmentDeclaration: {
  134773. name: string;
  134774. shader: string;
  134775. };
  134776. }
  134777. declare module BABYLON {
  134778. /** @hidden */
  134779. export var backgroundUboDeclaration: {
  134780. name: string;
  134781. shader: string;
  134782. };
  134783. }
  134784. declare module BABYLON {
  134785. /** @hidden */
  134786. export var backgroundPixelShader: {
  134787. name: string;
  134788. shader: string;
  134789. };
  134790. }
  134791. declare module BABYLON {
  134792. /** @hidden */
  134793. export var backgroundVertexDeclaration: {
  134794. name: string;
  134795. shader: string;
  134796. };
  134797. }
  134798. declare module BABYLON {
  134799. /** @hidden */
  134800. export var backgroundVertexShader: {
  134801. name: string;
  134802. shader: string;
  134803. };
  134804. }
  134805. declare module BABYLON {
  134806. /**
  134807. * Background material used to create an efficient environement around your scene.
  134808. */
  134809. export class BackgroundMaterial extends PushMaterial {
  134810. /**
  134811. * Standard reflectance value at parallel view angle.
  134812. */
  134813. static StandardReflectance0: number;
  134814. /**
  134815. * Standard reflectance value at grazing angle.
  134816. */
  134817. static StandardReflectance90: number;
  134818. protected _primaryColor: Color3;
  134819. /**
  134820. * Key light Color (multiply against the environement texture)
  134821. */
  134822. primaryColor: Color3;
  134823. protected __perceptualColor: Nullable<Color3>;
  134824. /**
  134825. * Experimental Internal Use Only.
  134826. *
  134827. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  134828. * This acts as a helper to set the primary color to a more "human friendly" value.
  134829. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  134830. * output color as close as possible from the chosen value.
  134831. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  134832. * part of lighting setup.)
  134833. */
  134834. get _perceptualColor(): Nullable<Color3>;
  134835. set _perceptualColor(value: Nullable<Color3>);
  134836. protected _primaryColorShadowLevel: float;
  134837. /**
  134838. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  134839. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  134840. */
  134841. get primaryColorShadowLevel(): float;
  134842. set primaryColorShadowLevel(value: float);
  134843. protected _primaryColorHighlightLevel: float;
  134844. /**
  134845. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  134846. * The primary color is used at the level chosen to define what the white area would look.
  134847. */
  134848. get primaryColorHighlightLevel(): float;
  134849. set primaryColorHighlightLevel(value: float);
  134850. protected _reflectionTexture: Nullable<BaseTexture>;
  134851. /**
  134852. * Reflection Texture used in the material.
  134853. * Should be author in a specific way for the best result (refer to the documentation).
  134854. */
  134855. reflectionTexture: Nullable<BaseTexture>;
  134856. protected _reflectionBlur: float;
  134857. /**
  134858. * Reflection Texture level of blur.
  134859. *
  134860. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  134861. * texture twice.
  134862. */
  134863. reflectionBlur: float;
  134864. protected _diffuseTexture: Nullable<BaseTexture>;
  134865. /**
  134866. * Diffuse Texture used in the material.
  134867. * Should be author in a specific way for the best result (refer to the documentation).
  134868. */
  134869. diffuseTexture: Nullable<BaseTexture>;
  134870. protected _shadowLights: Nullable<IShadowLight[]>;
  134871. /**
  134872. * Specify the list of lights casting shadow on the material.
  134873. * All scene shadow lights will be included if null.
  134874. */
  134875. shadowLights: Nullable<IShadowLight[]>;
  134876. protected _shadowLevel: float;
  134877. /**
  134878. * Helps adjusting the shadow to a softer level if required.
  134879. * 0 means black shadows and 1 means no shadows.
  134880. */
  134881. shadowLevel: float;
  134882. protected _sceneCenter: Vector3;
  134883. /**
  134884. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  134885. * It is usually zero but might be interesting to modify according to your setup.
  134886. */
  134887. sceneCenter: Vector3;
  134888. protected _opacityFresnel: boolean;
  134889. /**
  134890. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134891. * This helps ensuring a nice transition when the camera goes under the ground.
  134892. */
  134893. opacityFresnel: boolean;
  134894. protected _reflectionFresnel: boolean;
  134895. /**
  134896. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134897. * This helps adding a mirror texture on the ground.
  134898. */
  134899. reflectionFresnel: boolean;
  134900. protected _reflectionFalloffDistance: number;
  134901. /**
  134902. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134903. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134904. */
  134905. reflectionFalloffDistance: number;
  134906. protected _reflectionAmount: number;
  134907. /**
  134908. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134909. */
  134910. reflectionAmount: number;
  134911. protected _reflectionReflectance0: number;
  134912. /**
  134913. * This specifies the weight of the reflection at grazing angle.
  134914. */
  134915. reflectionReflectance0: number;
  134916. protected _reflectionReflectance90: number;
  134917. /**
  134918. * This specifies the weight of the reflection at a perpendicular point of view.
  134919. */
  134920. reflectionReflectance90: number;
  134921. /**
  134922. * Sets the reflection reflectance fresnel values according to the default standard
  134923. * empirically know to work well :-)
  134924. */
  134925. set reflectionStandardFresnelWeight(value: number);
  134926. protected _useRGBColor: boolean;
  134927. /**
  134928. * Helps to directly use the maps channels instead of their level.
  134929. */
  134930. useRGBColor: boolean;
  134931. protected _enableNoise: boolean;
  134932. /**
  134933. * This helps reducing the banding effect that could occur on the background.
  134934. */
  134935. enableNoise: boolean;
  134936. /**
  134937. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134938. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134939. * Recommended to be keep at 1.0 except for special cases.
  134940. */
  134941. get fovMultiplier(): number;
  134942. set fovMultiplier(value: number);
  134943. private _fovMultiplier;
  134944. /**
  134945. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134946. */
  134947. useEquirectangularFOV: boolean;
  134948. private _maxSimultaneousLights;
  134949. /**
  134950. * Number of Simultaneous lights allowed on the material.
  134951. */
  134952. maxSimultaneousLights: int;
  134953. private _shadowOnly;
  134954. /**
  134955. * Make the material only render shadows
  134956. */
  134957. shadowOnly: boolean;
  134958. /**
  134959. * Default configuration related to image processing available in the Background Material.
  134960. */
  134961. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134962. /**
  134963. * Keep track of the image processing observer to allow dispose and replace.
  134964. */
  134965. private _imageProcessingObserver;
  134966. /**
  134967. * Attaches a new image processing configuration to the PBR Material.
  134968. * @param configuration (if null the scene configuration will be use)
  134969. */
  134970. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134971. /**
  134972. * Gets the image processing configuration used either in this material.
  134973. */
  134974. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134975. /**
  134976. * Sets the Default image processing configuration used either in the this material.
  134977. *
  134978. * If sets to null, the scene one is in use.
  134979. */
  134980. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134981. /**
  134982. * Gets wether the color curves effect is enabled.
  134983. */
  134984. get cameraColorCurvesEnabled(): boolean;
  134985. /**
  134986. * Sets wether the color curves effect is enabled.
  134987. */
  134988. set cameraColorCurvesEnabled(value: boolean);
  134989. /**
  134990. * Gets wether the color grading effect is enabled.
  134991. */
  134992. get cameraColorGradingEnabled(): boolean;
  134993. /**
  134994. * Gets wether the color grading effect is enabled.
  134995. */
  134996. set cameraColorGradingEnabled(value: boolean);
  134997. /**
  134998. * Gets wether tonemapping is enabled or not.
  134999. */
  135000. get cameraToneMappingEnabled(): boolean;
  135001. /**
  135002. * Sets wether tonemapping is enabled or not
  135003. */
  135004. set cameraToneMappingEnabled(value: boolean);
  135005. /**
  135006. * The camera exposure used on this material.
  135007. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135008. * This corresponds to a photographic exposure.
  135009. */
  135010. get cameraExposure(): float;
  135011. /**
  135012. * The camera exposure used on this material.
  135013. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135014. * This corresponds to a photographic exposure.
  135015. */
  135016. set cameraExposure(value: float);
  135017. /**
  135018. * Gets The camera contrast used on this material.
  135019. */
  135020. get cameraContrast(): float;
  135021. /**
  135022. * Sets The camera contrast used on this material.
  135023. */
  135024. set cameraContrast(value: float);
  135025. /**
  135026. * Gets the Color Grading 2D Lookup Texture.
  135027. */
  135028. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  135029. /**
  135030. * Sets the Color Grading 2D Lookup Texture.
  135031. */
  135032. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  135033. /**
  135034. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135035. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135036. * 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;
  135037. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135038. */
  135039. get cameraColorCurves(): Nullable<ColorCurves>;
  135040. /**
  135041. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135042. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135043. * 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;
  135044. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135045. */
  135046. set cameraColorCurves(value: Nullable<ColorCurves>);
  135047. /**
  135048. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  135049. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  135050. */
  135051. switchToBGR: boolean;
  135052. private _renderTargets;
  135053. private _reflectionControls;
  135054. private _white;
  135055. private _primaryShadowColor;
  135056. private _primaryHighlightColor;
  135057. /**
  135058. * Instantiates a Background Material in the given scene
  135059. * @param name The friendly name of the material
  135060. * @param scene The scene to add the material to
  135061. */
  135062. constructor(name: string, scene: Scene);
  135063. /**
  135064. * Gets a boolean indicating that current material needs to register RTT
  135065. */
  135066. get hasRenderTargetTextures(): boolean;
  135067. /**
  135068. * The entire material has been created in order to prevent overdraw.
  135069. * @returns false
  135070. */
  135071. needAlphaTesting(): boolean;
  135072. /**
  135073. * The entire material has been created in order to prevent overdraw.
  135074. * @returns true if blending is enable
  135075. */
  135076. needAlphaBlending(): boolean;
  135077. /**
  135078. * Checks wether the material is ready to be rendered for a given mesh.
  135079. * @param mesh The mesh to render
  135080. * @param subMesh The submesh to check against
  135081. * @param useInstances Specify wether or not the material is used with instances
  135082. * @returns true if all the dependencies are ready (Textures, Effects...)
  135083. */
  135084. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  135085. /**
  135086. * Compute the primary color according to the chosen perceptual color.
  135087. */
  135088. private _computePrimaryColorFromPerceptualColor;
  135089. /**
  135090. * Compute the highlights and shadow colors according to their chosen levels.
  135091. */
  135092. private _computePrimaryColors;
  135093. /**
  135094. * Build the uniform buffer used in the material.
  135095. */
  135096. buildUniformLayout(): void;
  135097. /**
  135098. * Unbind the material.
  135099. */
  135100. unbind(): void;
  135101. /**
  135102. * Bind only the world matrix to the material.
  135103. * @param world The world matrix to bind.
  135104. */
  135105. bindOnlyWorldMatrix(world: Matrix): void;
  135106. /**
  135107. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  135108. * @param world The world matrix to bind.
  135109. * @param subMesh The submesh to bind for.
  135110. */
  135111. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  135112. /**
  135113. * Checks to see if a texture is used in the material.
  135114. * @param texture - Base texture to use.
  135115. * @returns - Boolean specifying if a texture is used in the material.
  135116. */
  135117. hasTexture(texture: BaseTexture): boolean;
  135118. /**
  135119. * Dispose the material.
  135120. * @param forceDisposeEffect Force disposal of the associated effect.
  135121. * @param forceDisposeTextures Force disposal of the associated textures.
  135122. */
  135123. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  135124. /**
  135125. * Clones the material.
  135126. * @param name The cloned name.
  135127. * @returns The cloned material.
  135128. */
  135129. clone(name: string): BackgroundMaterial;
  135130. /**
  135131. * Serializes the current material to its JSON representation.
  135132. * @returns The JSON representation.
  135133. */
  135134. serialize(): any;
  135135. /**
  135136. * Gets the class name of the material
  135137. * @returns "BackgroundMaterial"
  135138. */
  135139. getClassName(): string;
  135140. /**
  135141. * Parse a JSON input to create back a background material.
  135142. * @param source The JSON data to parse
  135143. * @param scene The scene to create the parsed material in
  135144. * @param rootUrl The root url of the assets the material depends upon
  135145. * @returns the instantiated BackgroundMaterial.
  135146. */
  135147. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  135148. }
  135149. }
  135150. declare module BABYLON {
  135151. /**
  135152. * Represents the different options available during the creation of
  135153. * a Environment helper.
  135154. *
  135155. * This can control the default ground, skybox and image processing setup of your scene.
  135156. */
  135157. export interface IEnvironmentHelperOptions {
  135158. /**
  135159. * Specifies whether or not to create a ground.
  135160. * True by default.
  135161. */
  135162. createGround: boolean;
  135163. /**
  135164. * Specifies the ground size.
  135165. * 15 by default.
  135166. */
  135167. groundSize: number;
  135168. /**
  135169. * The texture used on the ground for the main color.
  135170. * Comes from the BabylonJS CDN by default.
  135171. *
  135172. * Remarks: Can be either a texture or a url.
  135173. */
  135174. groundTexture: string | BaseTexture;
  135175. /**
  135176. * The color mixed in the ground texture by default.
  135177. * BabylonJS clearColor by default.
  135178. */
  135179. groundColor: Color3;
  135180. /**
  135181. * Specifies the ground opacity.
  135182. * 1 by default.
  135183. */
  135184. groundOpacity: number;
  135185. /**
  135186. * Enables the ground to receive shadows.
  135187. * True by default.
  135188. */
  135189. enableGroundShadow: boolean;
  135190. /**
  135191. * Helps preventing the shadow to be fully black on the ground.
  135192. * 0.5 by default.
  135193. */
  135194. groundShadowLevel: number;
  135195. /**
  135196. * Creates a mirror texture attach to the ground.
  135197. * false by default.
  135198. */
  135199. enableGroundMirror: boolean;
  135200. /**
  135201. * Specifies the ground mirror size ratio.
  135202. * 0.3 by default as the default kernel is 64.
  135203. */
  135204. groundMirrorSizeRatio: number;
  135205. /**
  135206. * Specifies the ground mirror blur kernel size.
  135207. * 64 by default.
  135208. */
  135209. groundMirrorBlurKernel: number;
  135210. /**
  135211. * Specifies the ground mirror visibility amount.
  135212. * 1 by default
  135213. */
  135214. groundMirrorAmount: number;
  135215. /**
  135216. * Specifies the ground mirror reflectance weight.
  135217. * This uses the standard weight of the background material to setup the fresnel effect
  135218. * of the mirror.
  135219. * 1 by default.
  135220. */
  135221. groundMirrorFresnelWeight: number;
  135222. /**
  135223. * Specifies the ground mirror Falloff distance.
  135224. * This can helps reducing the size of the reflection.
  135225. * 0 by Default.
  135226. */
  135227. groundMirrorFallOffDistance: number;
  135228. /**
  135229. * Specifies the ground mirror texture type.
  135230. * Unsigned Int by Default.
  135231. */
  135232. groundMirrorTextureType: number;
  135233. /**
  135234. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  135235. * the shown objects.
  135236. */
  135237. groundYBias: number;
  135238. /**
  135239. * Specifies whether or not to create a skybox.
  135240. * True by default.
  135241. */
  135242. createSkybox: boolean;
  135243. /**
  135244. * Specifies the skybox size.
  135245. * 20 by default.
  135246. */
  135247. skyboxSize: number;
  135248. /**
  135249. * The texture used on the skybox for the main color.
  135250. * Comes from the BabylonJS CDN by default.
  135251. *
  135252. * Remarks: Can be either a texture or a url.
  135253. */
  135254. skyboxTexture: string | BaseTexture;
  135255. /**
  135256. * The color mixed in the skybox texture by default.
  135257. * BabylonJS clearColor by default.
  135258. */
  135259. skyboxColor: Color3;
  135260. /**
  135261. * The background rotation around the Y axis of the scene.
  135262. * This helps aligning the key lights of your scene with the background.
  135263. * 0 by default.
  135264. */
  135265. backgroundYRotation: number;
  135266. /**
  135267. * Compute automatically the size of the elements to best fit with the scene.
  135268. */
  135269. sizeAuto: boolean;
  135270. /**
  135271. * Default position of the rootMesh if autoSize is not true.
  135272. */
  135273. rootPosition: Vector3;
  135274. /**
  135275. * Sets up the image processing in the scene.
  135276. * true by default.
  135277. */
  135278. setupImageProcessing: boolean;
  135279. /**
  135280. * The texture used as your environment texture in the scene.
  135281. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  135282. *
  135283. * Remarks: Can be either a texture or a url.
  135284. */
  135285. environmentTexture: string | BaseTexture;
  135286. /**
  135287. * The value of the exposure to apply to the scene.
  135288. * 0.6 by default if setupImageProcessing is true.
  135289. */
  135290. cameraExposure: number;
  135291. /**
  135292. * The value of the contrast to apply to the scene.
  135293. * 1.6 by default if setupImageProcessing is true.
  135294. */
  135295. cameraContrast: number;
  135296. /**
  135297. * Specifies whether or not tonemapping should be enabled in the scene.
  135298. * true by default if setupImageProcessing is true.
  135299. */
  135300. toneMappingEnabled: boolean;
  135301. }
  135302. /**
  135303. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  135304. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  135305. * It also helps with the default setup of your imageProcessing configuration.
  135306. */
  135307. export class EnvironmentHelper {
  135308. /**
  135309. * Default ground texture URL.
  135310. */
  135311. private static _groundTextureCDNUrl;
  135312. /**
  135313. * Default skybox texture URL.
  135314. */
  135315. private static _skyboxTextureCDNUrl;
  135316. /**
  135317. * Default environment texture URL.
  135318. */
  135319. private static _environmentTextureCDNUrl;
  135320. /**
  135321. * Creates the default options for the helper.
  135322. */
  135323. private static _getDefaultOptions;
  135324. private _rootMesh;
  135325. /**
  135326. * Gets the root mesh created by the helper.
  135327. */
  135328. get rootMesh(): Mesh;
  135329. private _skybox;
  135330. /**
  135331. * Gets the skybox created by the helper.
  135332. */
  135333. get skybox(): Nullable<Mesh>;
  135334. private _skyboxTexture;
  135335. /**
  135336. * Gets the skybox texture created by the helper.
  135337. */
  135338. get skyboxTexture(): Nullable<BaseTexture>;
  135339. private _skyboxMaterial;
  135340. /**
  135341. * Gets the skybox material created by the helper.
  135342. */
  135343. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  135344. private _ground;
  135345. /**
  135346. * Gets the ground mesh created by the helper.
  135347. */
  135348. get ground(): Nullable<Mesh>;
  135349. private _groundTexture;
  135350. /**
  135351. * Gets the ground texture created by the helper.
  135352. */
  135353. get groundTexture(): Nullable<BaseTexture>;
  135354. private _groundMirror;
  135355. /**
  135356. * Gets the ground mirror created by the helper.
  135357. */
  135358. get groundMirror(): Nullable<MirrorTexture>;
  135359. /**
  135360. * Gets the ground mirror render list to helps pushing the meshes
  135361. * you wish in the ground reflection.
  135362. */
  135363. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  135364. private _groundMaterial;
  135365. /**
  135366. * Gets the ground material created by the helper.
  135367. */
  135368. get groundMaterial(): Nullable<BackgroundMaterial>;
  135369. /**
  135370. * Stores the creation options.
  135371. */
  135372. private readonly _scene;
  135373. private _options;
  135374. /**
  135375. * This observable will be notified with any error during the creation of the environment,
  135376. * mainly texture creation errors.
  135377. */
  135378. onErrorObservable: Observable<{
  135379. message?: string;
  135380. exception?: any;
  135381. }>;
  135382. /**
  135383. * constructor
  135384. * @param options Defines the options we want to customize the helper
  135385. * @param scene The scene to add the material to
  135386. */
  135387. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  135388. /**
  135389. * Updates the background according to the new options
  135390. * @param options
  135391. */
  135392. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  135393. /**
  135394. * Sets the primary color of all the available elements.
  135395. * @param color the main color to affect to the ground and the background
  135396. */
  135397. setMainColor(color: Color3): void;
  135398. /**
  135399. * Setup the image processing according to the specified options.
  135400. */
  135401. private _setupImageProcessing;
  135402. /**
  135403. * Setup the environment texture according to the specified options.
  135404. */
  135405. private _setupEnvironmentTexture;
  135406. /**
  135407. * Setup the background according to the specified options.
  135408. */
  135409. private _setupBackground;
  135410. /**
  135411. * Get the scene sizes according to the setup.
  135412. */
  135413. private _getSceneSize;
  135414. /**
  135415. * Setup the ground according to the specified options.
  135416. */
  135417. private _setupGround;
  135418. /**
  135419. * Setup the ground material according to the specified options.
  135420. */
  135421. private _setupGroundMaterial;
  135422. /**
  135423. * Setup the ground diffuse texture according to the specified options.
  135424. */
  135425. private _setupGroundDiffuseTexture;
  135426. /**
  135427. * Setup the ground mirror texture according to the specified options.
  135428. */
  135429. private _setupGroundMirrorTexture;
  135430. /**
  135431. * Setup the ground to receive the mirror texture.
  135432. */
  135433. private _setupMirrorInGroundMaterial;
  135434. /**
  135435. * Setup the skybox according to the specified options.
  135436. */
  135437. private _setupSkybox;
  135438. /**
  135439. * Setup the skybox material according to the specified options.
  135440. */
  135441. private _setupSkyboxMaterial;
  135442. /**
  135443. * Setup the skybox reflection texture according to the specified options.
  135444. */
  135445. private _setupSkyboxReflectionTexture;
  135446. private _errorHandler;
  135447. /**
  135448. * Dispose all the elements created by the Helper.
  135449. */
  135450. dispose(): void;
  135451. }
  135452. }
  135453. declare module BABYLON {
  135454. /**
  135455. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  135456. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  135457. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  135458. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  135459. */
  135460. export abstract class TextureDome<T extends Texture> extends TransformNode {
  135461. protected onError: Nullable<(message?: string, exception?: any) => void>;
  135462. /**
  135463. * Define the source as a Monoscopic panoramic 360/180.
  135464. */
  135465. static readonly MODE_MONOSCOPIC: number;
  135466. /**
  135467. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  135468. */
  135469. static readonly MODE_TOPBOTTOM: number;
  135470. /**
  135471. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  135472. */
  135473. static readonly MODE_SIDEBYSIDE: number;
  135474. private _halfDome;
  135475. protected _useDirectMapping: boolean;
  135476. /**
  135477. * The texture being displayed on the sphere
  135478. */
  135479. protected _texture: T;
  135480. /**
  135481. * Gets the texture being displayed on the sphere
  135482. */
  135483. get texture(): T;
  135484. /**
  135485. * Sets the texture being displayed on the sphere
  135486. */
  135487. set texture(newTexture: T);
  135488. /**
  135489. * The skybox material
  135490. */
  135491. protected _material: BackgroundMaterial;
  135492. /**
  135493. * The surface used for the dome
  135494. */
  135495. protected _mesh: Mesh;
  135496. /**
  135497. * Gets the mesh used for the dome.
  135498. */
  135499. get mesh(): Mesh;
  135500. /**
  135501. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  135502. */
  135503. private _halfDomeMask;
  135504. /**
  135505. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  135506. * Also see the options.resolution property.
  135507. */
  135508. get fovMultiplier(): number;
  135509. set fovMultiplier(value: number);
  135510. protected _textureMode: number;
  135511. /**
  135512. * Gets or set the current texture mode for the texture. It can be:
  135513. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135514. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135515. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135516. */
  135517. get textureMode(): number;
  135518. /**
  135519. * Sets the current texture mode for the texture. It can be:
  135520. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135521. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135522. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135523. */
  135524. set textureMode(value: number);
  135525. /**
  135526. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  135527. */
  135528. get halfDome(): boolean;
  135529. /**
  135530. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  135531. */
  135532. set halfDome(enabled: boolean);
  135533. /**
  135534. * Oberserver used in Stereoscopic VR Mode.
  135535. */
  135536. private _onBeforeCameraRenderObserver;
  135537. /**
  135538. * Observable raised when an error occured while loading the 360 image
  135539. */
  135540. onLoadErrorObservable: Observable<string>;
  135541. /**
  135542. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  135543. * @param name Element's name, child elements will append suffixes for their own names.
  135544. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  135545. * @param options An object containing optional or exposed sub element properties
  135546. */
  135547. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  135548. resolution?: number;
  135549. clickToPlay?: boolean;
  135550. autoPlay?: boolean;
  135551. loop?: boolean;
  135552. size?: number;
  135553. poster?: string;
  135554. faceForward?: boolean;
  135555. useDirectMapping?: boolean;
  135556. halfDomeMode?: boolean;
  135557. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  135558. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  135559. protected _changeTextureMode(value: number): void;
  135560. /**
  135561. * Releases resources associated with this node.
  135562. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  135563. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  135564. */
  135565. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  135566. }
  135567. }
  135568. declare module BABYLON {
  135569. /**
  135570. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  135571. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  135572. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  135573. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  135574. */
  135575. export class PhotoDome extends TextureDome<Texture> {
  135576. /**
  135577. * Define the image as a Monoscopic panoramic 360 image.
  135578. */
  135579. static readonly MODE_MONOSCOPIC: number;
  135580. /**
  135581. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  135582. */
  135583. static readonly MODE_TOPBOTTOM: number;
  135584. /**
  135585. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  135586. */
  135587. static readonly MODE_SIDEBYSIDE: number;
  135588. /**
  135589. * Gets or sets the texture being displayed on the sphere
  135590. */
  135591. get photoTexture(): Texture;
  135592. /**
  135593. * sets the texture being displayed on the sphere
  135594. */
  135595. set photoTexture(value: Texture);
  135596. /**
  135597. * Gets the current video mode for the video. It can be:
  135598. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135599. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135600. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135601. */
  135602. get imageMode(): number;
  135603. /**
  135604. * Sets the current video mode for the video. It can be:
  135605. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135606. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135607. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135608. */
  135609. set imageMode(value: number);
  135610. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  135611. }
  135612. }
  135613. declare module BABYLON {
  135614. /**
  135615. * Class used to host RGBD texture specific utilities
  135616. */
  135617. export class RGBDTextureTools {
  135618. /**
  135619. * Expand the RGBD Texture from RGBD to Half Float if possible.
  135620. * @param texture the texture to expand.
  135621. */
  135622. static ExpandRGBDTexture(texture: Texture): void;
  135623. }
  135624. }
  135625. declare module BABYLON {
  135626. /**
  135627. * Class used to host texture specific utilities
  135628. */
  135629. export class BRDFTextureTools {
  135630. /**
  135631. * Prevents texture cache collision
  135632. */
  135633. private static _instanceNumber;
  135634. /**
  135635. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  135636. * @param scene defines the hosting scene
  135637. * @returns the environment BRDF texture
  135638. */
  135639. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  135640. private static _environmentBRDFBase64Texture;
  135641. }
  135642. }
  135643. declare module BABYLON {
  135644. /**
  135645. * @hidden
  135646. */
  135647. export interface IMaterialClearCoatDefines {
  135648. CLEARCOAT: boolean;
  135649. CLEARCOAT_DEFAULTIOR: boolean;
  135650. CLEARCOAT_TEXTURE: boolean;
  135651. CLEARCOAT_TEXTUREDIRECTUV: number;
  135652. CLEARCOAT_BUMP: boolean;
  135653. CLEARCOAT_BUMPDIRECTUV: number;
  135654. CLEARCOAT_TINT: boolean;
  135655. CLEARCOAT_TINT_TEXTURE: boolean;
  135656. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135657. /** @hidden */
  135658. _areTexturesDirty: boolean;
  135659. }
  135660. /**
  135661. * Define the code related to the clear coat parameters of the pbr material.
  135662. */
  135663. export class PBRClearCoatConfiguration {
  135664. /**
  135665. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  135666. * The default fits with a polyurethane material.
  135667. */
  135668. private static readonly _DefaultIndexOfRefraction;
  135669. private _isEnabled;
  135670. /**
  135671. * Defines if the clear coat is enabled in the material.
  135672. */
  135673. isEnabled: boolean;
  135674. /**
  135675. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  135676. */
  135677. intensity: number;
  135678. /**
  135679. * Defines the clear coat layer roughness.
  135680. */
  135681. roughness: number;
  135682. private _indexOfRefraction;
  135683. /**
  135684. * Defines the index of refraction of the clear coat.
  135685. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  135686. * The default fits with a polyurethane material.
  135687. * Changing the default value is more performance intensive.
  135688. */
  135689. indexOfRefraction: number;
  135690. private _texture;
  135691. /**
  135692. * Stores the clear coat values in a texture.
  135693. */
  135694. texture: Nullable<BaseTexture>;
  135695. private _bumpTexture;
  135696. /**
  135697. * Define the clear coat specific bump texture.
  135698. */
  135699. bumpTexture: Nullable<BaseTexture>;
  135700. private _isTintEnabled;
  135701. /**
  135702. * Defines if the clear coat tint is enabled in the material.
  135703. */
  135704. isTintEnabled: boolean;
  135705. /**
  135706. * Defines the clear coat tint of the material.
  135707. * This is only use if tint is enabled
  135708. */
  135709. tintColor: Color3;
  135710. /**
  135711. * Defines the distance at which the tint color should be found in the
  135712. * clear coat media.
  135713. * This is only use if tint is enabled
  135714. */
  135715. tintColorAtDistance: number;
  135716. /**
  135717. * Defines the clear coat layer thickness.
  135718. * This is only use if tint is enabled
  135719. */
  135720. tintThickness: number;
  135721. private _tintTexture;
  135722. /**
  135723. * Stores the clear tint values in a texture.
  135724. * rgb is tint
  135725. * a is a thickness factor
  135726. */
  135727. tintTexture: Nullable<BaseTexture>;
  135728. /** @hidden */
  135729. private _internalMarkAllSubMeshesAsTexturesDirty;
  135730. /** @hidden */
  135731. _markAllSubMeshesAsTexturesDirty(): void;
  135732. /**
  135733. * Instantiate a new istance of clear coat configuration.
  135734. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135735. */
  135736. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135737. /**
  135738. * Gets wehter the submesh is ready to be used or not.
  135739. * @param defines the list of "defines" to update.
  135740. * @param scene defines the scene the material belongs to.
  135741. * @param engine defines the engine the material belongs to.
  135742. * @param disableBumpMap defines wether the material disables bump or not.
  135743. * @returns - boolean indicating that the submesh is ready or not.
  135744. */
  135745. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  135746. /**
  135747. * Checks to see if a texture is used in the material.
  135748. * @param defines the list of "defines" to update.
  135749. * @param scene defines the scene to the material belongs to.
  135750. */
  135751. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  135752. /**
  135753. * Binds the material data.
  135754. * @param uniformBuffer defines the Uniform buffer to fill in.
  135755. * @param scene defines the scene the material belongs to.
  135756. * @param engine defines the engine the material belongs to.
  135757. * @param disableBumpMap defines wether the material disables bump or not.
  135758. * @param isFrozen defines wether the material is frozen or not.
  135759. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  135760. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  135761. */
  135762. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  135763. /**
  135764. * Checks to see if a texture is used in the material.
  135765. * @param texture - Base texture to use.
  135766. * @returns - Boolean specifying if a texture is used in the material.
  135767. */
  135768. hasTexture(texture: BaseTexture): boolean;
  135769. /**
  135770. * Returns an array of the actively used textures.
  135771. * @param activeTextures Array of BaseTextures
  135772. */
  135773. getActiveTextures(activeTextures: BaseTexture[]): void;
  135774. /**
  135775. * Returns the animatable textures.
  135776. * @param animatables Array of animatable textures.
  135777. */
  135778. getAnimatables(animatables: IAnimatable[]): void;
  135779. /**
  135780. * Disposes the resources of the material.
  135781. * @param forceDisposeTextures - Forces the disposal of all textures.
  135782. */
  135783. dispose(forceDisposeTextures?: boolean): void;
  135784. /**
  135785. * Get the current class name of the texture useful for serialization or dynamic coding.
  135786. * @returns "PBRClearCoatConfiguration"
  135787. */
  135788. getClassName(): string;
  135789. /**
  135790. * Add fallbacks to the effect fallbacks list.
  135791. * @param defines defines the Base texture to use.
  135792. * @param fallbacks defines the current fallback list.
  135793. * @param currentRank defines the current fallback rank.
  135794. * @returns the new fallback rank.
  135795. */
  135796. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135797. /**
  135798. * Add the required uniforms to the current list.
  135799. * @param uniforms defines the current uniform list.
  135800. */
  135801. static AddUniforms(uniforms: string[]): void;
  135802. /**
  135803. * Add the required samplers to the current list.
  135804. * @param samplers defines the current sampler list.
  135805. */
  135806. static AddSamplers(samplers: string[]): void;
  135807. /**
  135808. * Add the required uniforms to the current buffer.
  135809. * @param uniformBuffer defines the current uniform buffer.
  135810. */
  135811. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135812. /**
  135813. * Makes a duplicate of the current configuration into another one.
  135814. * @param clearCoatConfiguration define the config where to copy the info
  135815. */
  135816. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  135817. /**
  135818. * Serializes this clear coat configuration.
  135819. * @returns - An object with the serialized config.
  135820. */
  135821. serialize(): any;
  135822. /**
  135823. * Parses a anisotropy Configuration from a serialized object.
  135824. * @param source - Serialized object.
  135825. * @param scene Defines the scene we are parsing for
  135826. * @param rootUrl Defines the rootUrl to load from
  135827. */
  135828. parse(source: any, scene: Scene, rootUrl: string): void;
  135829. }
  135830. }
  135831. declare module BABYLON {
  135832. /**
  135833. * @hidden
  135834. */
  135835. export interface IMaterialAnisotropicDefines {
  135836. ANISOTROPIC: boolean;
  135837. ANISOTROPIC_TEXTURE: boolean;
  135838. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135839. MAINUV1: boolean;
  135840. _areTexturesDirty: boolean;
  135841. _needUVs: boolean;
  135842. }
  135843. /**
  135844. * Define the code related to the anisotropic parameters of the pbr material.
  135845. */
  135846. export class PBRAnisotropicConfiguration {
  135847. private _isEnabled;
  135848. /**
  135849. * Defines if the anisotropy is enabled in the material.
  135850. */
  135851. isEnabled: boolean;
  135852. /**
  135853. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  135854. */
  135855. intensity: number;
  135856. /**
  135857. * Defines if the effect is along the tangents, bitangents or in between.
  135858. * By default, the effect is "strectching" the highlights along the tangents.
  135859. */
  135860. direction: Vector2;
  135861. private _texture;
  135862. /**
  135863. * Stores the anisotropy values in a texture.
  135864. * rg is direction (like normal from -1 to 1)
  135865. * b is a intensity
  135866. */
  135867. texture: Nullable<BaseTexture>;
  135868. /** @hidden */
  135869. private _internalMarkAllSubMeshesAsTexturesDirty;
  135870. /** @hidden */
  135871. _markAllSubMeshesAsTexturesDirty(): void;
  135872. /**
  135873. * Instantiate a new istance of anisotropy configuration.
  135874. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135875. */
  135876. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135877. /**
  135878. * Specifies that the submesh is ready to be used.
  135879. * @param defines the list of "defines" to update.
  135880. * @param scene defines the scene the material belongs to.
  135881. * @returns - boolean indicating that the submesh is ready or not.
  135882. */
  135883. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  135884. /**
  135885. * Checks to see if a texture is used in the material.
  135886. * @param defines the list of "defines" to update.
  135887. * @param mesh the mesh we are preparing the defines for.
  135888. * @param scene defines the scene the material belongs to.
  135889. */
  135890. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135891. /**
  135892. * Binds the material data.
  135893. * @param uniformBuffer defines the Uniform buffer to fill in.
  135894. * @param scene defines the scene the material belongs to.
  135895. * @param isFrozen defines wether the material is frozen or not.
  135896. */
  135897. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135898. /**
  135899. * Checks to see if a texture is used in the material.
  135900. * @param texture - Base texture to use.
  135901. * @returns - Boolean specifying if a texture is used in the material.
  135902. */
  135903. hasTexture(texture: BaseTexture): boolean;
  135904. /**
  135905. * Returns an array of the actively used textures.
  135906. * @param activeTextures Array of BaseTextures
  135907. */
  135908. getActiveTextures(activeTextures: BaseTexture[]): void;
  135909. /**
  135910. * Returns the animatable textures.
  135911. * @param animatables Array of animatable textures.
  135912. */
  135913. getAnimatables(animatables: IAnimatable[]): void;
  135914. /**
  135915. * Disposes the resources of the material.
  135916. * @param forceDisposeTextures - Forces the disposal of all textures.
  135917. */
  135918. dispose(forceDisposeTextures?: boolean): void;
  135919. /**
  135920. * Get the current class name of the texture useful for serialization or dynamic coding.
  135921. * @returns "PBRAnisotropicConfiguration"
  135922. */
  135923. getClassName(): string;
  135924. /**
  135925. * Add fallbacks to the effect fallbacks list.
  135926. * @param defines defines the Base texture to use.
  135927. * @param fallbacks defines the current fallback list.
  135928. * @param currentRank defines the current fallback rank.
  135929. * @returns the new fallback rank.
  135930. */
  135931. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135932. /**
  135933. * Add the required uniforms to the current list.
  135934. * @param uniforms defines the current uniform list.
  135935. */
  135936. static AddUniforms(uniforms: string[]): void;
  135937. /**
  135938. * Add the required uniforms to the current buffer.
  135939. * @param uniformBuffer defines the current uniform buffer.
  135940. */
  135941. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135942. /**
  135943. * Add the required samplers to the current list.
  135944. * @param samplers defines the current sampler list.
  135945. */
  135946. static AddSamplers(samplers: string[]): void;
  135947. /**
  135948. * Makes a duplicate of the current configuration into another one.
  135949. * @param anisotropicConfiguration define the config where to copy the info
  135950. */
  135951. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135952. /**
  135953. * Serializes this anisotropy configuration.
  135954. * @returns - An object with the serialized config.
  135955. */
  135956. serialize(): any;
  135957. /**
  135958. * Parses a anisotropy Configuration from a serialized object.
  135959. * @param source - Serialized object.
  135960. * @param scene Defines the scene we are parsing for
  135961. * @param rootUrl Defines the rootUrl to load from
  135962. */
  135963. parse(source: any, scene: Scene, rootUrl: string): void;
  135964. }
  135965. }
  135966. declare module BABYLON {
  135967. /**
  135968. * @hidden
  135969. */
  135970. export interface IMaterialBRDFDefines {
  135971. BRDF_V_HEIGHT_CORRELATED: boolean;
  135972. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135973. SPHERICAL_HARMONICS: boolean;
  135974. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135975. /** @hidden */
  135976. _areMiscDirty: boolean;
  135977. }
  135978. /**
  135979. * Define the code related to the BRDF parameters of the pbr material.
  135980. */
  135981. export class PBRBRDFConfiguration {
  135982. /**
  135983. * Default value used for the energy conservation.
  135984. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135985. */
  135986. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135987. /**
  135988. * Default value used for the Smith Visibility Height Correlated mode.
  135989. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135990. */
  135991. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135992. /**
  135993. * Default value used for the IBL diffuse part.
  135994. * This can help switching back to the polynomials mode globally which is a tiny bit
  135995. * less GPU intensive at the drawback of a lower quality.
  135996. */
  135997. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135998. /**
  135999. * Default value used for activating energy conservation for the specular workflow.
  136000. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  136001. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  136002. */
  136003. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  136004. private _useEnergyConservation;
  136005. /**
  136006. * Defines if the material uses energy conservation.
  136007. */
  136008. useEnergyConservation: boolean;
  136009. private _useSmithVisibilityHeightCorrelated;
  136010. /**
  136011. * LEGACY Mode set to false
  136012. * Defines if the material uses height smith correlated visibility term.
  136013. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  136014. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  136015. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  136016. * Not relying on height correlated will also disable energy conservation.
  136017. */
  136018. useSmithVisibilityHeightCorrelated: boolean;
  136019. private _useSphericalHarmonics;
  136020. /**
  136021. * LEGACY Mode set to false
  136022. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  136023. * diffuse part of the IBL.
  136024. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  136025. * to the ground truth.
  136026. */
  136027. useSphericalHarmonics: boolean;
  136028. private _useSpecularGlossinessInputEnergyConservation;
  136029. /**
  136030. * Defines if the material uses energy conservation, when the specular workflow is active.
  136031. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  136032. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  136033. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  136034. */
  136035. useSpecularGlossinessInputEnergyConservation: boolean;
  136036. /** @hidden */
  136037. private _internalMarkAllSubMeshesAsMiscDirty;
  136038. /** @hidden */
  136039. _markAllSubMeshesAsMiscDirty(): void;
  136040. /**
  136041. * Instantiate a new istance of clear coat configuration.
  136042. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  136043. */
  136044. constructor(markAllSubMeshesAsMiscDirty: () => void);
  136045. /**
  136046. * Checks to see if a texture is used in the material.
  136047. * @param defines the list of "defines" to update.
  136048. */
  136049. prepareDefines(defines: IMaterialBRDFDefines): void;
  136050. /**
  136051. * Get the current class name of the texture useful for serialization or dynamic coding.
  136052. * @returns "PBRClearCoatConfiguration"
  136053. */
  136054. getClassName(): string;
  136055. /**
  136056. * Makes a duplicate of the current configuration into another one.
  136057. * @param brdfConfiguration define the config where to copy the info
  136058. */
  136059. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  136060. /**
  136061. * Serializes this BRDF configuration.
  136062. * @returns - An object with the serialized config.
  136063. */
  136064. serialize(): any;
  136065. /**
  136066. * Parses a anisotropy Configuration from a serialized object.
  136067. * @param source - Serialized object.
  136068. * @param scene Defines the scene we are parsing for
  136069. * @param rootUrl Defines the rootUrl to load from
  136070. */
  136071. parse(source: any, scene: Scene, rootUrl: string): void;
  136072. }
  136073. }
  136074. declare module BABYLON {
  136075. /**
  136076. * @hidden
  136077. */
  136078. export interface IMaterialSheenDefines {
  136079. SHEEN: boolean;
  136080. SHEEN_TEXTURE: boolean;
  136081. SHEEN_TEXTUREDIRECTUV: number;
  136082. SHEEN_LINKWITHALBEDO: boolean;
  136083. SHEEN_ROUGHNESS: boolean;
  136084. SHEEN_ALBEDOSCALING: boolean;
  136085. /** @hidden */
  136086. _areTexturesDirty: boolean;
  136087. }
  136088. /**
  136089. * Define the code related to the Sheen parameters of the pbr material.
  136090. */
  136091. export class PBRSheenConfiguration {
  136092. private _isEnabled;
  136093. /**
  136094. * Defines if the material uses sheen.
  136095. */
  136096. isEnabled: boolean;
  136097. private _linkSheenWithAlbedo;
  136098. /**
  136099. * Defines if the sheen is linked to the sheen color.
  136100. */
  136101. linkSheenWithAlbedo: boolean;
  136102. /**
  136103. * Defines the sheen intensity.
  136104. */
  136105. intensity: number;
  136106. /**
  136107. * Defines the sheen color.
  136108. */
  136109. color: Color3;
  136110. private _texture;
  136111. /**
  136112. * Stores the sheen tint values in a texture.
  136113. * rgb is tint
  136114. * a is a intensity or roughness if roughness has been defined
  136115. */
  136116. texture: Nullable<BaseTexture>;
  136117. private _roughness;
  136118. /**
  136119. * Defines the sheen roughness.
  136120. * It is not taken into account if linkSheenWithAlbedo is true.
  136121. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  136122. */
  136123. roughness: Nullable<number>;
  136124. private _albedoScaling;
  136125. /**
  136126. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  136127. * It allows the strength of the sheen effect to not depend on the base color of the material,
  136128. * making it easier to setup and tweak the effect
  136129. */
  136130. albedoScaling: boolean;
  136131. /** @hidden */
  136132. private _internalMarkAllSubMeshesAsTexturesDirty;
  136133. /** @hidden */
  136134. _markAllSubMeshesAsTexturesDirty(): void;
  136135. /**
  136136. * Instantiate a new istance of clear coat configuration.
  136137. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  136138. */
  136139. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  136140. /**
  136141. * Specifies that the submesh is ready to be used.
  136142. * @param defines the list of "defines" to update.
  136143. * @param scene defines the scene the material belongs to.
  136144. * @returns - boolean indicating that the submesh is ready or not.
  136145. */
  136146. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  136147. /**
  136148. * Checks to see if a texture is used in the material.
  136149. * @param defines the list of "defines" to update.
  136150. * @param scene defines the scene the material belongs to.
  136151. */
  136152. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  136153. /**
  136154. * Binds the material data.
  136155. * @param uniformBuffer defines the Uniform buffer to fill in.
  136156. * @param scene defines the scene the material belongs to.
  136157. * @param isFrozen defines wether the material is frozen or not.
  136158. */
  136159. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  136160. /**
  136161. * Checks to see if a texture is used in the material.
  136162. * @param texture - Base texture to use.
  136163. * @returns - Boolean specifying if a texture is used in the material.
  136164. */
  136165. hasTexture(texture: BaseTexture): boolean;
  136166. /**
  136167. * Returns an array of the actively used textures.
  136168. * @param activeTextures Array of BaseTextures
  136169. */
  136170. getActiveTextures(activeTextures: BaseTexture[]): void;
  136171. /**
  136172. * Returns the animatable textures.
  136173. * @param animatables Array of animatable textures.
  136174. */
  136175. getAnimatables(animatables: IAnimatable[]): void;
  136176. /**
  136177. * Disposes the resources of the material.
  136178. * @param forceDisposeTextures - Forces the disposal of all textures.
  136179. */
  136180. dispose(forceDisposeTextures?: boolean): void;
  136181. /**
  136182. * Get the current class name of the texture useful for serialization or dynamic coding.
  136183. * @returns "PBRSheenConfiguration"
  136184. */
  136185. getClassName(): string;
  136186. /**
  136187. * Add fallbacks to the effect fallbacks list.
  136188. * @param defines defines the Base texture to use.
  136189. * @param fallbacks defines the current fallback list.
  136190. * @param currentRank defines the current fallback rank.
  136191. * @returns the new fallback rank.
  136192. */
  136193. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  136194. /**
  136195. * Add the required uniforms to the current list.
  136196. * @param uniforms defines the current uniform list.
  136197. */
  136198. static AddUniforms(uniforms: string[]): void;
  136199. /**
  136200. * Add the required uniforms to the current buffer.
  136201. * @param uniformBuffer defines the current uniform buffer.
  136202. */
  136203. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  136204. /**
  136205. * Add the required samplers to the current list.
  136206. * @param samplers defines the current sampler list.
  136207. */
  136208. static AddSamplers(samplers: string[]): void;
  136209. /**
  136210. * Makes a duplicate of the current configuration into another one.
  136211. * @param sheenConfiguration define the config where to copy the info
  136212. */
  136213. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  136214. /**
  136215. * Serializes this BRDF configuration.
  136216. * @returns - An object with the serialized config.
  136217. */
  136218. serialize(): any;
  136219. /**
  136220. * Parses a anisotropy Configuration from a serialized object.
  136221. * @param source - Serialized object.
  136222. * @param scene Defines the scene we are parsing for
  136223. * @param rootUrl Defines the rootUrl to load from
  136224. */
  136225. parse(source: any, scene: Scene, rootUrl: string): void;
  136226. }
  136227. }
  136228. declare module BABYLON {
  136229. /**
  136230. * @hidden
  136231. */
  136232. export interface IMaterialSubSurfaceDefines {
  136233. SUBSURFACE: boolean;
  136234. SS_REFRACTION: boolean;
  136235. SS_TRANSLUCENCY: boolean;
  136236. SS_SCATTERING: boolean;
  136237. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136238. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136239. SS_REFRACTIONMAP_3D: boolean;
  136240. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136241. SS_LODINREFRACTIONALPHA: boolean;
  136242. SS_GAMMAREFRACTION: boolean;
  136243. SS_RGBDREFRACTION: boolean;
  136244. SS_LINEARSPECULARREFRACTION: boolean;
  136245. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136246. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136247. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136248. /** @hidden */
  136249. _areTexturesDirty: boolean;
  136250. }
  136251. /**
  136252. * Define the code related to the sub surface parameters of the pbr material.
  136253. */
  136254. export class PBRSubSurfaceConfiguration {
  136255. private _isRefractionEnabled;
  136256. /**
  136257. * Defines if the refraction is enabled in the material.
  136258. */
  136259. isRefractionEnabled: boolean;
  136260. private _isTranslucencyEnabled;
  136261. /**
  136262. * Defines if the translucency is enabled in the material.
  136263. */
  136264. isTranslucencyEnabled: boolean;
  136265. private _isScatteringEnabled;
  136266. /**
  136267. * Defines if the sub surface scattering is enabled in the material.
  136268. */
  136269. isScatteringEnabled: boolean;
  136270. private _scatteringDiffusionProfileIndex;
  136271. /**
  136272. * Diffusion profile for subsurface scattering.
  136273. * Useful for better scattering in the skins or foliages.
  136274. */
  136275. get scatteringDiffusionProfile(): Nullable<Color3>;
  136276. set scatteringDiffusionProfile(c: Nullable<Color3>);
  136277. /**
  136278. * Defines the refraction intensity of the material.
  136279. * The refraction when enabled replaces the Diffuse part of the material.
  136280. * The intensity helps transitionning between diffuse and refraction.
  136281. */
  136282. refractionIntensity: number;
  136283. /**
  136284. * Defines the translucency intensity of the material.
  136285. * When translucency has been enabled, this defines how much of the "translucency"
  136286. * is addded to the diffuse part of the material.
  136287. */
  136288. translucencyIntensity: number;
  136289. /**
  136290. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  136291. */
  136292. useAlbedoToTintRefraction: boolean;
  136293. private _thicknessTexture;
  136294. /**
  136295. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  136296. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  136297. * 0 would mean minimumThickness
  136298. * 1 would mean maximumThickness
  136299. * The other channels might be use as a mask to vary the different effects intensity.
  136300. */
  136301. thicknessTexture: Nullable<BaseTexture>;
  136302. private _refractionTexture;
  136303. /**
  136304. * Defines the texture to use for refraction.
  136305. */
  136306. refractionTexture: Nullable<BaseTexture>;
  136307. private _indexOfRefraction;
  136308. /**
  136309. * Index of refraction of the material base layer.
  136310. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136311. *
  136312. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136313. *
  136314. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136315. */
  136316. indexOfRefraction: number;
  136317. private _volumeIndexOfRefraction;
  136318. /**
  136319. * Index of refraction of the material's volume.
  136320. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136321. *
  136322. * This ONLY impacts refraction. If not provided or given a non-valid value,
  136323. * the volume will use the same IOR as the surface.
  136324. */
  136325. get volumeIndexOfRefraction(): number;
  136326. set volumeIndexOfRefraction(value: number);
  136327. private _invertRefractionY;
  136328. /**
  136329. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136330. */
  136331. invertRefractionY: boolean;
  136332. private _linkRefractionWithTransparency;
  136333. /**
  136334. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136335. * Materials half opaque for instance using refraction could benefit from this control.
  136336. */
  136337. linkRefractionWithTransparency: boolean;
  136338. /**
  136339. * Defines the minimum thickness stored in the thickness map.
  136340. * If no thickness map is defined, this value will be used to simulate thickness.
  136341. */
  136342. minimumThickness: number;
  136343. /**
  136344. * Defines the maximum thickness stored in the thickness map.
  136345. */
  136346. maximumThickness: number;
  136347. /**
  136348. * Defines the volume tint of the material.
  136349. * This is used for both translucency and scattering.
  136350. */
  136351. tintColor: Color3;
  136352. /**
  136353. * Defines the distance at which the tint color should be found in the media.
  136354. * This is used for refraction only.
  136355. */
  136356. tintColorAtDistance: number;
  136357. /**
  136358. * Defines how far each channel transmit through the media.
  136359. * It is defined as a color to simplify it selection.
  136360. */
  136361. diffusionDistance: Color3;
  136362. private _useMaskFromThicknessTexture;
  136363. /**
  136364. * Stores the intensity of the different subsurface effects in the thickness texture.
  136365. * * the green channel is the translucency intensity.
  136366. * * the blue channel is the scattering intensity.
  136367. * * the alpha channel is the refraction intensity.
  136368. */
  136369. useMaskFromThicknessTexture: boolean;
  136370. private _scene;
  136371. /** @hidden */
  136372. private _internalMarkAllSubMeshesAsTexturesDirty;
  136373. private _internalMarkScenePrePassDirty;
  136374. /** @hidden */
  136375. _markAllSubMeshesAsTexturesDirty(): void;
  136376. /** @hidden */
  136377. _markScenePrePassDirty(): void;
  136378. /**
  136379. * Instantiate a new istance of sub surface configuration.
  136380. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  136381. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  136382. * @param scene The scene
  136383. */
  136384. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  136385. /**
  136386. * Gets wehter the submesh is ready to be used or not.
  136387. * @param defines the list of "defines" to update.
  136388. * @param scene defines the scene the material belongs to.
  136389. * @returns - boolean indicating that the submesh is ready or not.
  136390. */
  136391. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  136392. /**
  136393. * Checks to see if a texture is used in the material.
  136394. * @param defines the list of "defines" to update.
  136395. * @param scene defines the scene to the material belongs to.
  136396. */
  136397. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  136398. /**
  136399. * Binds the material data.
  136400. * @param uniformBuffer defines the Uniform buffer to fill in.
  136401. * @param scene defines the scene the material belongs to.
  136402. * @param engine defines the engine the material belongs to.
  136403. * @param isFrozen defines whether the material is frozen or not.
  136404. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  136405. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  136406. */
  136407. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  136408. /**
  136409. * Unbinds the material from the mesh.
  136410. * @param activeEffect defines the effect that should be unbound from.
  136411. * @returns true if unbound, otherwise false
  136412. */
  136413. unbind(activeEffect: Effect): boolean;
  136414. /**
  136415. * Returns the texture used for refraction or null if none is used.
  136416. * @param scene defines the scene the material belongs to.
  136417. * @returns - Refraction texture if present. If no refraction texture and refraction
  136418. * is linked with transparency, returns environment texture. Otherwise, returns null.
  136419. */
  136420. private _getRefractionTexture;
  136421. /**
  136422. * Returns true if alpha blending should be disabled.
  136423. */
  136424. get disableAlphaBlending(): boolean;
  136425. /**
  136426. * Fills the list of render target textures.
  136427. * @param renderTargets the list of render targets to update
  136428. */
  136429. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  136430. /**
  136431. * Checks to see if a texture is used in the material.
  136432. * @param texture - Base texture to use.
  136433. * @returns - Boolean specifying if a texture is used in the material.
  136434. */
  136435. hasTexture(texture: BaseTexture): boolean;
  136436. /**
  136437. * Gets a boolean indicating that current material needs to register RTT
  136438. * @returns true if this uses a render target otherwise false.
  136439. */
  136440. hasRenderTargetTextures(): boolean;
  136441. /**
  136442. * Returns an array of the actively used textures.
  136443. * @param activeTextures Array of BaseTextures
  136444. */
  136445. getActiveTextures(activeTextures: BaseTexture[]): void;
  136446. /**
  136447. * Returns the animatable textures.
  136448. * @param animatables Array of animatable textures.
  136449. */
  136450. getAnimatables(animatables: IAnimatable[]): void;
  136451. /**
  136452. * Disposes the resources of the material.
  136453. * @param forceDisposeTextures - Forces the disposal of all textures.
  136454. */
  136455. dispose(forceDisposeTextures?: boolean): void;
  136456. /**
  136457. * Get the current class name of the texture useful for serialization or dynamic coding.
  136458. * @returns "PBRSubSurfaceConfiguration"
  136459. */
  136460. getClassName(): string;
  136461. /**
  136462. * Add fallbacks to the effect fallbacks list.
  136463. * @param defines defines the Base texture to use.
  136464. * @param fallbacks defines the current fallback list.
  136465. * @param currentRank defines the current fallback rank.
  136466. * @returns the new fallback rank.
  136467. */
  136468. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  136469. /**
  136470. * Add the required uniforms to the current list.
  136471. * @param uniforms defines the current uniform list.
  136472. */
  136473. static AddUniforms(uniforms: string[]): void;
  136474. /**
  136475. * Add the required samplers to the current list.
  136476. * @param samplers defines the current sampler list.
  136477. */
  136478. static AddSamplers(samplers: string[]): void;
  136479. /**
  136480. * Add the required uniforms to the current buffer.
  136481. * @param uniformBuffer defines the current uniform buffer.
  136482. */
  136483. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  136484. /**
  136485. * Makes a duplicate of the current configuration into another one.
  136486. * @param configuration define the config where to copy the info
  136487. */
  136488. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  136489. /**
  136490. * Serializes this Sub Surface configuration.
  136491. * @returns - An object with the serialized config.
  136492. */
  136493. serialize(): any;
  136494. /**
  136495. * Parses a anisotropy Configuration from a serialized object.
  136496. * @param source - Serialized object.
  136497. * @param scene Defines the scene we are parsing for
  136498. * @param rootUrl Defines the rootUrl to load from
  136499. */
  136500. parse(source: any, scene: Scene, rootUrl: string): void;
  136501. }
  136502. }
  136503. declare module BABYLON {
  136504. /** @hidden */
  136505. export var pbrFragmentDeclaration: {
  136506. name: string;
  136507. shader: string;
  136508. };
  136509. }
  136510. declare module BABYLON {
  136511. /** @hidden */
  136512. export var pbrUboDeclaration: {
  136513. name: string;
  136514. shader: string;
  136515. };
  136516. }
  136517. declare module BABYLON {
  136518. /** @hidden */
  136519. export var pbrFragmentExtraDeclaration: {
  136520. name: string;
  136521. shader: string;
  136522. };
  136523. }
  136524. declare module BABYLON {
  136525. /** @hidden */
  136526. export var pbrFragmentSamplersDeclaration: {
  136527. name: string;
  136528. shader: string;
  136529. };
  136530. }
  136531. declare module BABYLON {
  136532. /** @hidden */
  136533. export var subSurfaceScatteringFunctions: {
  136534. name: string;
  136535. shader: string;
  136536. };
  136537. }
  136538. declare module BABYLON {
  136539. /** @hidden */
  136540. export var importanceSampling: {
  136541. name: string;
  136542. shader: string;
  136543. };
  136544. }
  136545. declare module BABYLON {
  136546. /** @hidden */
  136547. export var pbrHelperFunctions: {
  136548. name: string;
  136549. shader: string;
  136550. };
  136551. }
  136552. declare module BABYLON {
  136553. /** @hidden */
  136554. export var harmonicsFunctions: {
  136555. name: string;
  136556. shader: string;
  136557. };
  136558. }
  136559. declare module BABYLON {
  136560. /** @hidden */
  136561. export var pbrDirectLightingSetupFunctions: {
  136562. name: string;
  136563. shader: string;
  136564. };
  136565. }
  136566. declare module BABYLON {
  136567. /** @hidden */
  136568. export var pbrDirectLightingFalloffFunctions: {
  136569. name: string;
  136570. shader: string;
  136571. };
  136572. }
  136573. declare module BABYLON {
  136574. /** @hidden */
  136575. export var pbrBRDFFunctions: {
  136576. name: string;
  136577. shader: string;
  136578. };
  136579. }
  136580. declare module BABYLON {
  136581. /** @hidden */
  136582. export var hdrFilteringFunctions: {
  136583. name: string;
  136584. shader: string;
  136585. };
  136586. }
  136587. declare module BABYLON {
  136588. /** @hidden */
  136589. export var pbrDirectLightingFunctions: {
  136590. name: string;
  136591. shader: string;
  136592. };
  136593. }
  136594. declare module BABYLON {
  136595. /** @hidden */
  136596. export var pbrIBLFunctions: {
  136597. name: string;
  136598. shader: string;
  136599. };
  136600. }
  136601. declare module BABYLON {
  136602. /** @hidden */
  136603. export var pbrBlockAlbedoOpacity: {
  136604. name: string;
  136605. shader: string;
  136606. };
  136607. }
  136608. declare module BABYLON {
  136609. /** @hidden */
  136610. export var pbrBlockReflectivity: {
  136611. name: string;
  136612. shader: string;
  136613. };
  136614. }
  136615. declare module BABYLON {
  136616. /** @hidden */
  136617. export var pbrBlockAmbientOcclusion: {
  136618. name: string;
  136619. shader: string;
  136620. };
  136621. }
  136622. declare module BABYLON {
  136623. /** @hidden */
  136624. export var pbrBlockAlphaFresnel: {
  136625. name: string;
  136626. shader: string;
  136627. };
  136628. }
  136629. declare module BABYLON {
  136630. /** @hidden */
  136631. export var pbrBlockAnisotropic: {
  136632. name: string;
  136633. shader: string;
  136634. };
  136635. }
  136636. declare module BABYLON {
  136637. /** @hidden */
  136638. export var pbrBlockReflection: {
  136639. name: string;
  136640. shader: string;
  136641. };
  136642. }
  136643. declare module BABYLON {
  136644. /** @hidden */
  136645. export var pbrBlockSheen: {
  136646. name: string;
  136647. shader: string;
  136648. };
  136649. }
  136650. declare module BABYLON {
  136651. /** @hidden */
  136652. export var pbrBlockClearcoat: {
  136653. name: string;
  136654. shader: string;
  136655. };
  136656. }
  136657. declare module BABYLON {
  136658. /** @hidden */
  136659. export var pbrBlockSubSurface: {
  136660. name: string;
  136661. shader: string;
  136662. };
  136663. }
  136664. declare module BABYLON {
  136665. /** @hidden */
  136666. export var pbrBlockNormalGeometric: {
  136667. name: string;
  136668. shader: string;
  136669. };
  136670. }
  136671. declare module BABYLON {
  136672. /** @hidden */
  136673. export var pbrBlockNormalFinal: {
  136674. name: string;
  136675. shader: string;
  136676. };
  136677. }
  136678. declare module BABYLON {
  136679. /** @hidden */
  136680. export var pbrBlockLightmapInit: {
  136681. name: string;
  136682. shader: string;
  136683. };
  136684. }
  136685. declare module BABYLON {
  136686. /** @hidden */
  136687. export var pbrBlockGeometryInfo: {
  136688. name: string;
  136689. shader: string;
  136690. };
  136691. }
  136692. declare module BABYLON {
  136693. /** @hidden */
  136694. export var pbrBlockReflectance0: {
  136695. name: string;
  136696. shader: string;
  136697. };
  136698. }
  136699. declare module BABYLON {
  136700. /** @hidden */
  136701. export var pbrBlockReflectance: {
  136702. name: string;
  136703. shader: string;
  136704. };
  136705. }
  136706. declare module BABYLON {
  136707. /** @hidden */
  136708. export var pbrBlockDirectLighting: {
  136709. name: string;
  136710. shader: string;
  136711. };
  136712. }
  136713. declare module BABYLON {
  136714. /** @hidden */
  136715. export var pbrBlockFinalLitComponents: {
  136716. name: string;
  136717. shader: string;
  136718. };
  136719. }
  136720. declare module BABYLON {
  136721. /** @hidden */
  136722. export var pbrBlockFinalUnlitComponents: {
  136723. name: string;
  136724. shader: string;
  136725. };
  136726. }
  136727. declare module BABYLON {
  136728. /** @hidden */
  136729. export var pbrBlockFinalColorComposition: {
  136730. name: string;
  136731. shader: string;
  136732. };
  136733. }
  136734. declare module BABYLON {
  136735. /** @hidden */
  136736. export var pbrBlockImageProcessing: {
  136737. name: string;
  136738. shader: string;
  136739. };
  136740. }
  136741. declare module BABYLON {
  136742. /** @hidden */
  136743. export var pbrDebug: {
  136744. name: string;
  136745. shader: string;
  136746. };
  136747. }
  136748. declare module BABYLON {
  136749. /** @hidden */
  136750. export var pbrPixelShader: {
  136751. name: string;
  136752. shader: string;
  136753. };
  136754. }
  136755. declare module BABYLON {
  136756. /** @hidden */
  136757. export var pbrVertexDeclaration: {
  136758. name: string;
  136759. shader: string;
  136760. };
  136761. }
  136762. declare module BABYLON {
  136763. /** @hidden */
  136764. export var pbrVertexShader: {
  136765. name: string;
  136766. shader: string;
  136767. };
  136768. }
  136769. declare module BABYLON {
  136770. /**
  136771. * Manages the defines for the PBR Material.
  136772. * @hidden
  136773. */
  136774. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  136775. PBR: boolean;
  136776. NUM_SAMPLES: string;
  136777. REALTIME_FILTERING: boolean;
  136778. MAINUV1: boolean;
  136779. MAINUV2: boolean;
  136780. UV1: boolean;
  136781. UV2: boolean;
  136782. ALBEDO: boolean;
  136783. GAMMAALBEDO: boolean;
  136784. ALBEDODIRECTUV: number;
  136785. VERTEXCOLOR: boolean;
  136786. DETAIL: boolean;
  136787. DETAILDIRECTUV: number;
  136788. DETAIL_NORMALBLENDMETHOD: number;
  136789. AMBIENT: boolean;
  136790. AMBIENTDIRECTUV: number;
  136791. AMBIENTINGRAYSCALE: boolean;
  136792. OPACITY: boolean;
  136793. VERTEXALPHA: boolean;
  136794. OPACITYDIRECTUV: number;
  136795. OPACITYRGB: boolean;
  136796. ALPHATEST: boolean;
  136797. DEPTHPREPASS: boolean;
  136798. ALPHABLEND: boolean;
  136799. ALPHAFROMALBEDO: boolean;
  136800. ALPHATESTVALUE: string;
  136801. SPECULAROVERALPHA: boolean;
  136802. RADIANCEOVERALPHA: boolean;
  136803. ALPHAFRESNEL: boolean;
  136804. LINEARALPHAFRESNEL: boolean;
  136805. PREMULTIPLYALPHA: boolean;
  136806. EMISSIVE: boolean;
  136807. EMISSIVEDIRECTUV: number;
  136808. REFLECTIVITY: boolean;
  136809. REFLECTIVITYDIRECTUV: number;
  136810. SPECULARTERM: boolean;
  136811. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  136812. MICROSURFACEAUTOMATIC: boolean;
  136813. LODBASEDMICROSFURACE: boolean;
  136814. MICROSURFACEMAP: boolean;
  136815. MICROSURFACEMAPDIRECTUV: number;
  136816. METALLICWORKFLOW: boolean;
  136817. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  136818. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  136819. METALLNESSSTOREINMETALMAPBLUE: boolean;
  136820. AOSTOREINMETALMAPRED: boolean;
  136821. METALLIC_REFLECTANCE: boolean;
  136822. METALLIC_REFLECTANCEDIRECTUV: number;
  136823. ENVIRONMENTBRDF: boolean;
  136824. ENVIRONMENTBRDF_RGBD: boolean;
  136825. NORMAL: boolean;
  136826. TANGENT: boolean;
  136827. BUMP: boolean;
  136828. BUMPDIRECTUV: number;
  136829. OBJECTSPACE_NORMALMAP: boolean;
  136830. PARALLAX: boolean;
  136831. PARALLAXOCCLUSION: boolean;
  136832. NORMALXYSCALE: boolean;
  136833. LIGHTMAP: boolean;
  136834. LIGHTMAPDIRECTUV: number;
  136835. USELIGHTMAPASSHADOWMAP: boolean;
  136836. GAMMALIGHTMAP: boolean;
  136837. RGBDLIGHTMAP: boolean;
  136838. REFLECTION: boolean;
  136839. REFLECTIONMAP_3D: boolean;
  136840. REFLECTIONMAP_SPHERICAL: boolean;
  136841. REFLECTIONMAP_PLANAR: boolean;
  136842. REFLECTIONMAP_CUBIC: boolean;
  136843. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  136844. REFLECTIONMAP_PROJECTION: boolean;
  136845. REFLECTIONMAP_SKYBOX: boolean;
  136846. REFLECTIONMAP_EXPLICIT: boolean;
  136847. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  136848. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  136849. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  136850. INVERTCUBICMAP: boolean;
  136851. USESPHERICALFROMREFLECTIONMAP: boolean;
  136852. USEIRRADIANCEMAP: boolean;
  136853. SPHERICAL_HARMONICS: boolean;
  136854. USESPHERICALINVERTEX: boolean;
  136855. REFLECTIONMAP_OPPOSITEZ: boolean;
  136856. LODINREFLECTIONALPHA: boolean;
  136857. GAMMAREFLECTION: boolean;
  136858. RGBDREFLECTION: boolean;
  136859. LINEARSPECULARREFLECTION: boolean;
  136860. RADIANCEOCCLUSION: boolean;
  136861. HORIZONOCCLUSION: boolean;
  136862. INSTANCES: boolean;
  136863. THIN_INSTANCES: boolean;
  136864. PREPASS: boolean;
  136865. PREPASS_IRRADIANCE: boolean;
  136866. PREPASS_IRRADIANCE_INDEX: number;
  136867. PREPASS_ALBEDO: boolean;
  136868. PREPASS_ALBEDO_INDEX: number;
  136869. PREPASS_DEPTHNORMAL: boolean;
  136870. PREPASS_DEPTHNORMAL_INDEX: number;
  136871. SCENE_MRT_COUNT: number;
  136872. NUM_BONE_INFLUENCERS: number;
  136873. BonesPerMesh: number;
  136874. BONETEXTURE: boolean;
  136875. NONUNIFORMSCALING: boolean;
  136876. MORPHTARGETS: boolean;
  136877. MORPHTARGETS_NORMAL: boolean;
  136878. MORPHTARGETS_TANGENT: boolean;
  136879. MORPHTARGETS_UV: boolean;
  136880. NUM_MORPH_INFLUENCERS: number;
  136881. IMAGEPROCESSING: boolean;
  136882. VIGNETTE: boolean;
  136883. VIGNETTEBLENDMODEMULTIPLY: boolean;
  136884. VIGNETTEBLENDMODEOPAQUE: boolean;
  136885. TONEMAPPING: boolean;
  136886. TONEMAPPING_ACES: boolean;
  136887. CONTRAST: boolean;
  136888. COLORCURVES: boolean;
  136889. COLORGRADING: boolean;
  136890. COLORGRADING3D: boolean;
  136891. SAMPLER3DGREENDEPTH: boolean;
  136892. SAMPLER3DBGRMAP: boolean;
  136893. IMAGEPROCESSINGPOSTPROCESS: boolean;
  136894. EXPOSURE: boolean;
  136895. MULTIVIEW: boolean;
  136896. USEPHYSICALLIGHTFALLOFF: boolean;
  136897. USEGLTFLIGHTFALLOFF: boolean;
  136898. TWOSIDEDLIGHTING: boolean;
  136899. SHADOWFLOAT: boolean;
  136900. CLIPPLANE: boolean;
  136901. CLIPPLANE2: boolean;
  136902. CLIPPLANE3: boolean;
  136903. CLIPPLANE4: boolean;
  136904. CLIPPLANE5: boolean;
  136905. CLIPPLANE6: boolean;
  136906. POINTSIZE: boolean;
  136907. FOG: boolean;
  136908. LOGARITHMICDEPTH: boolean;
  136909. FORCENORMALFORWARD: boolean;
  136910. SPECULARAA: boolean;
  136911. CLEARCOAT: boolean;
  136912. CLEARCOAT_DEFAULTIOR: boolean;
  136913. CLEARCOAT_TEXTURE: boolean;
  136914. CLEARCOAT_TEXTUREDIRECTUV: number;
  136915. CLEARCOAT_BUMP: boolean;
  136916. CLEARCOAT_BUMPDIRECTUV: number;
  136917. CLEARCOAT_TINT: boolean;
  136918. CLEARCOAT_TINT_TEXTURE: boolean;
  136919. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136920. ANISOTROPIC: boolean;
  136921. ANISOTROPIC_TEXTURE: boolean;
  136922. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136923. BRDF_V_HEIGHT_CORRELATED: boolean;
  136924. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136925. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136926. SHEEN: boolean;
  136927. SHEEN_TEXTURE: boolean;
  136928. SHEEN_TEXTUREDIRECTUV: number;
  136929. SHEEN_LINKWITHALBEDO: boolean;
  136930. SHEEN_ROUGHNESS: boolean;
  136931. SHEEN_ALBEDOSCALING: boolean;
  136932. SUBSURFACE: boolean;
  136933. SS_REFRACTION: boolean;
  136934. SS_TRANSLUCENCY: boolean;
  136935. SS_SCATTERING: boolean;
  136936. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136937. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136938. SS_REFRACTIONMAP_3D: boolean;
  136939. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136940. SS_LODINREFRACTIONALPHA: boolean;
  136941. SS_GAMMAREFRACTION: boolean;
  136942. SS_RGBDREFRACTION: boolean;
  136943. SS_LINEARSPECULARREFRACTION: boolean;
  136944. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136945. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136946. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136947. UNLIT: boolean;
  136948. DEBUGMODE: number;
  136949. /**
  136950. * Initializes the PBR Material defines.
  136951. */
  136952. constructor();
  136953. /**
  136954. * Resets the PBR Material defines.
  136955. */
  136956. reset(): void;
  136957. }
  136958. /**
  136959. * The Physically based material base class of BJS.
  136960. *
  136961. * This offers the main features of a standard PBR material.
  136962. * For more information, please refer to the documentation :
  136963. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136964. */
  136965. export abstract class PBRBaseMaterial extends PushMaterial {
  136966. /**
  136967. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136968. */
  136969. static readonly PBRMATERIAL_OPAQUE: number;
  136970. /**
  136971. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136972. */
  136973. static readonly PBRMATERIAL_ALPHATEST: number;
  136974. /**
  136975. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136976. */
  136977. static readonly PBRMATERIAL_ALPHABLEND: number;
  136978. /**
  136979. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136980. * They are also discarded below the alpha cutoff threshold to improve performances.
  136981. */
  136982. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136983. /**
  136984. * Defines the default value of how much AO map is occluding the analytical lights
  136985. * (point spot...).
  136986. */
  136987. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136988. /**
  136989. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136990. */
  136991. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136992. /**
  136993. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136994. * to enhance interoperability with other engines.
  136995. */
  136996. static readonly LIGHTFALLOFF_GLTF: number;
  136997. /**
  136998. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136999. * to enhance interoperability with other materials.
  137000. */
  137001. static readonly LIGHTFALLOFF_STANDARD: number;
  137002. /**
  137003. * Intensity of the direct lights e.g. the four lights available in your scene.
  137004. * This impacts both the direct diffuse and specular highlights.
  137005. */
  137006. protected _directIntensity: number;
  137007. /**
  137008. * Intensity of the emissive part of the material.
  137009. * This helps controlling the emissive effect without modifying the emissive color.
  137010. */
  137011. protected _emissiveIntensity: number;
  137012. /**
  137013. * Intensity of the environment e.g. how much the environment will light the object
  137014. * either through harmonics for rough material or through the refelction for shiny ones.
  137015. */
  137016. protected _environmentIntensity: number;
  137017. /**
  137018. * This is a special control allowing the reduction of the specular highlights coming from the
  137019. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  137020. */
  137021. protected _specularIntensity: number;
  137022. /**
  137023. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  137024. */
  137025. private _lightingInfos;
  137026. /**
  137027. * Debug Control allowing disabling the bump map on this material.
  137028. */
  137029. protected _disableBumpMap: boolean;
  137030. /**
  137031. * AKA Diffuse Texture in standard nomenclature.
  137032. */
  137033. protected _albedoTexture: Nullable<BaseTexture>;
  137034. /**
  137035. * AKA Occlusion Texture in other nomenclature.
  137036. */
  137037. protected _ambientTexture: Nullable<BaseTexture>;
  137038. /**
  137039. * AKA Occlusion Texture Intensity in other nomenclature.
  137040. */
  137041. protected _ambientTextureStrength: number;
  137042. /**
  137043. * Defines how much the AO map is occluding the analytical lights (point spot...).
  137044. * 1 means it completely occludes it
  137045. * 0 mean it has no impact
  137046. */
  137047. protected _ambientTextureImpactOnAnalyticalLights: number;
  137048. /**
  137049. * Stores the alpha values in a texture.
  137050. */
  137051. protected _opacityTexture: Nullable<BaseTexture>;
  137052. /**
  137053. * Stores the reflection values in a texture.
  137054. */
  137055. protected _reflectionTexture: Nullable<BaseTexture>;
  137056. /**
  137057. * Stores the emissive values in a texture.
  137058. */
  137059. protected _emissiveTexture: Nullable<BaseTexture>;
  137060. /**
  137061. * AKA Specular texture in other nomenclature.
  137062. */
  137063. protected _reflectivityTexture: Nullable<BaseTexture>;
  137064. /**
  137065. * Used to switch from specular/glossiness to metallic/roughness workflow.
  137066. */
  137067. protected _metallicTexture: Nullable<BaseTexture>;
  137068. /**
  137069. * Specifies the metallic scalar of the metallic/roughness workflow.
  137070. * Can also be used to scale the metalness values of the metallic texture.
  137071. */
  137072. protected _metallic: Nullable<number>;
  137073. /**
  137074. * Specifies the roughness scalar of the metallic/roughness workflow.
  137075. * Can also be used to scale the roughness values of the metallic texture.
  137076. */
  137077. protected _roughness: Nullable<number>;
  137078. /**
  137079. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  137080. * By default the indexOfrefraction is used to compute F0;
  137081. *
  137082. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  137083. *
  137084. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  137085. * F90 = metallicReflectanceColor;
  137086. */
  137087. protected _metallicF0Factor: number;
  137088. /**
  137089. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  137090. * By default the F90 is always 1;
  137091. *
  137092. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  137093. *
  137094. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  137095. * F90 = metallicReflectanceColor;
  137096. */
  137097. protected _metallicReflectanceColor: Color3;
  137098. /**
  137099. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  137100. * This is multiply against the scalar values defined in the material.
  137101. */
  137102. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  137103. /**
  137104. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  137105. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  137106. */
  137107. protected _microSurfaceTexture: Nullable<BaseTexture>;
  137108. /**
  137109. * Stores surface normal data used to displace a mesh in a texture.
  137110. */
  137111. protected _bumpTexture: Nullable<BaseTexture>;
  137112. /**
  137113. * Stores the pre-calculated light information of a mesh in a texture.
  137114. */
  137115. protected _lightmapTexture: Nullable<BaseTexture>;
  137116. /**
  137117. * The color of a material in ambient lighting.
  137118. */
  137119. protected _ambientColor: Color3;
  137120. /**
  137121. * AKA Diffuse Color in other nomenclature.
  137122. */
  137123. protected _albedoColor: Color3;
  137124. /**
  137125. * AKA Specular Color in other nomenclature.
  137126. */
  137127. protected _reflectivityColor: Color3;
  137128. /**
  137129. * The color applied when light is reflected from a material.
  137130. */
  137131. protected _reflectionColor: Color3;
  137132. /**
  137133. * The color applied when light is emitted from a material.
  137134. */
  137135. protected _emissiveColor: Color3;
  137136. /**
  137137. * AKA Glossiness in other nomenclature.
  137138. */
  137139. protected _microSurface: number;
  137140. /**
  137141. * Specifies that the material will use the light map as a show map.
  137142. */
  137143. protected _useLightmapAsShadowmap: boolean;
  137144. /**
  137145. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  137146. * makes the reflect vector face the model (under horizon).
  137147. */
  137148. protected _useHorizonOcclusion: boolean;
  137149. /**
  137150. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  137151. * too much the area relying on ambient texture to define their ambient occlusion.
  137152. */
  137153. protected _useRadianceOcclusion: boolean;
  137154. /**
  137155. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  137156. */
  137157. protected _useAlphaFromAlbedoTexture: boolean;
  137158. /**
  137159. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  137160. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  137161. */
  137162. protected _useSpecularOverAlpha: boolean;
  137163. /**
  137164. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  137165. */
  137166. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  137167. /**
  137168. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  137169. */
  137170. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  137171. /**
  137172. * Specifies if the metallic texture contains the roughness information in its green channel.
  137173. */
  137174. protected _useRoughnessFromMetallicTextureGreen: boolean;
  137175. /**
  137176. * Specifies if the metallic texture contains the metallness information in its blue channel.
  137177. */
  137178. protected _useMetallnessFromMetallicTextureBlue: boolean;
  137179. /**
  137180. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  137181. */
  137182. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  137183. /**
  137184. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  137185. */
  137186. protected _useAmbientInGrayScale: boolean;
  137187. /**
  137188. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  137189. * The material will try to infer what glossiness each pixel should be.
  137190. */
  137191. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  137192. /**
  137193. * Defines the falloff type used in this material.
  137194. * It by default is Physical.
  137195. */
  137196. protected _lightFalloff: number;
  137197. /**
  137198. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  137199. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  137200. */
  137201. protected _useRadianceOverAlpha: boolean;
  137202. /**
  137203. * Allows using an object space normal map (instead of tangent space).
  137204. */
  137205. protected _useObjectSpaceNormalMap: boolean;
  137206. /**
  137207. * Allows using the bump map in parallax mode.
  137208. */
  137209. protected _useParallax: boolean;
  137210. /**
  137211. * Allows using the bump map in parallax occlusion mode.
  137212. */
  137213. protected _useParallaxOcclusion: boolean;
  137214. /**
  137215. * Controls the scale bias of the parallax mode.
  137216. */
  137217. protected _parallaxScaleBias: number;
  137218. /**
  137219. * If sets to true, disables all the lights affecting the material.
  137220. */
  137221. protected _disableLighting: boolean;
  137222. /**
  137223. * Number of Simultaneous lights allowed on the material.
  137224. */
  137225. protected _maxSimultaneousLights: number;
  137226. /**
  137227. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  137228. */
  137229. protected _invertNormalMapX: boolean;
  137230. /**
  137231. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  137232. */
  137233. protected _invertNormalMapY: boolean;
  137234. /**
  137235. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137236. */
  137237. protected _twoSidedLighting: boolean;
  137238. /**
  137239. * Defines the alpha limits in alpha test mode.
  137240. */
  137241. protected _alphaCutOff: number;
  137242. /**
  137243. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  137244. */
  137245. protected _forceAlphaTest: boolean;
  137246. /**
  137247. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137248. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  137249. */
  137250. protected _useAlphaFresnel: boolean;
  137251. /**
  137252. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137253. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  137254. */
  137255. protected _useLinearAlphaFresnel: boolean;
  137256. /**
  137257. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  137258. * from cos thetav and roughness:
  137259. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  137260. */
  137261. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  137262. /**
  137263. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  137264. */
  137265. protected _forceIrradianceInFragment: boolean;
  137266. private _realTimeFiltering;
  137267. /**
  137268. * Enables realtime filtering on the texture.
  137269. */
  137270. get realTimeFiltering(): boolean;
  137271. set realTimeFiltering(b: boolean);
  137272. private _realTimeFilteringQuality;
  137273. /**
  137274. * Quality switch for realtime filtering
  137275. */
  137276. get realTimeFilteringQuality(): number;
  137277. set realTimeFilteringQuality(n: number);
  137278. /**
  137279. * Can this material render to several textures at once
  137280. */
  137281. get canRenderToMRT(): boolean;
  137282. /**
  137283. * Force normal to face away from face.
  137284. */
  137285. protected _forceNormalForward: boolean;
  137286. /**
  137287. * Enables specular anti aliasing in the PBR shader.
  137288. * It will both interacts on the Geometry for analytical and IBL lighting.
  137289. * It also prefilter the roughness map based on the bump values.
  137290. */
  137291. protected _enableSpecularAntiAliasing: boolean;
  137292. /**
  137293. * Default configuration related to image processing available in the PBR Material.
  137294. */
  137295. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  137296. /**
  137297. * Keep track of the image processing observer to allow dispose and replace.
  137298. */
  137299. private _imageProcessingObserver;
  137300. /**
  137301. * Attaches a new image processing configuration to the PBR Material.
  137302. * @param configuration
  137303. */
  137304. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  137305. /**
  137306. * Stores the available render targets.
  137307. */
  137308. private _renderTargets;
  137309. /**
  137310. * Sets the global ambient color for the material used in lighting calculations.
  137311. */
  137312. private _globalAmbientColor;
  137313. /**
  137314. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  137315. */
  137316. private _useLogarithmicDepth;
  137317. /**
  137318. * If set to true, no lighting calculations will be applied.
  137319. */
  137320. private _unlit;
  137321. private _debugMode;
  137322. /**
  137323. * @hidden
  137324. * This is reserved for the inspector.
  137325. * Defines the material debug mode.
  137326. * It helps seeing only some components of the material while troubleshooting.
  137327. */
  137328. debugMode: number;
  137329. /**
  137330. * @hidden
  137331. * This is reserved for the inspector.
  137332. * Specify from where on screen the debug mode should start.
  137333. * The value goes from -1 (full screen) to 1 (not visible)
  137334. * It helps with side by side comparison against the final render
  137335. * This defaults to -1
  137336. */
  137337. private debugLimit;
  137338. /**
  137339. * @hidden
  137340. * This is reserved for the inspector.
  137341. * As the default viewing range might not be enough (if the ambient is really small for instance)
  137342. * You can use the factor to better multiply the final value.
  137343. */
  137344. private debugFactor;
  137345. /**
  137346. * Defines the clear coat layer parameters for the material.
  137347. */
  137348. readonly clearCoat: PBRClearCoatConfiguration;
  137349. /**
  137350. * Defines the anisotropic parameters for the material.
  137351. */
  137352. readonly anisotropy: PBRAnisotropicConfiguration;
  137353. /**
  137354. * Defines the BRDF parameters for the material.
  137355. */
  137356. readonly brdf: PBRBRDFConfiguration;
  137357. /**
  137358. * Defines the Sheen parameters for the material.
  137359. */
  137360. readonly sheen: PBRSheenConfiguration;
  137361. /**
  137362. * Defines the SubSurface parameters for the material.
  137363. */
  137364. readonly subSurface: PBRSubSurfaceConfiguration;
  137365. /**
  137366. * Defines the detail map parameters for the material.
  137367. */
  137368. readonly detailMap: DetailMapConfiguration;
  137369. protected _rebuildInParallel: boolean;
  137370. /**
  137371. * Instantiates a new PBRMaterial instance.
  137372. *
  137373. * @param name The material name
  137374. * @param scene The scene the material will be use in.
  137375. */
  137376. constructor(name: string, scene: Scene);
  137377. /**
  137378. * Gets a boolean indicating that current material needs to register RTT
  137379. */
  137380. get hasRenderTargetTextures(): boolean;
  137381. /**
  137382. * Gets the name of the material class.
  137383. */
  137384. getClassName(): string;
  137385. /**
  137386. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  137387. */
  137388. get useLogarithmicDepth(): boolean;
  137389. /**
  137390. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  137391. */
  137392. set useLogarithmicDepth(value: boolean);
  137393. /**
  137394. * Returns true if alpha blending should be disabled.
  137395. */
  137396. protected get _disableAlphaBlending(): boolean;
  137397. /**
  137398. * Specifies whether or not this material should be rendered in alpha blend mode.
  137399. */
  137400. needAlphaBlending(): boolean;
  137401. /**
  137402. * Specifies whether or not this material should be rendered in alpha test mode.
  137403. */
  137404. needAlphaTesting(): boolean;
  137405. /**
  137406. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  137407. */
  137408. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  137409. /**
  137410. * Gets the texture used for the alpha test.
  137411. */
  137412. getAlphaTestTexture(): Nullable<BaseTexture>;
  137413. /**
  137414. * Specifies that the submesh is ready to be used.
  137415. * @param mesh - BJS mesh.
  137416. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  137417. * @param useInstances - Specifies that instances should be used.
  137418. * @returns - boolean indicating that the submesh is ready or not.
  137419. */
  137420. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  137421. /**
  137422. * Specifies if the material uses metallic roughness workflow.
  137423. * @returns boolean specifiying if the material uses metallic roughness workflow.
  137424. */
  137425. isMetallicWorkflow(): boolean;
  137426. private _prepareEffect;
  137427. private _prepareDefines;
  137428. /**
  137429. * Force shader compilation
  137430. */
  137431. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  137432. /**
  137433. * Initializes the uniform buffer layout for the shader.
  137434. */
  137435. buildUniformLayout(): void;
  137436. /**
  137437. * Unbinds the material from the mesh
  137438. */
  137439. unbind(): void;
  137440. /**
  137441. * Binds the submesh data.
  137442. * @param world - The world matrix.
  137443. * @param mesh - The BJS mesh.
  137444. * @param subMesh - A submesh of the BJS mesh.
  137445. */
  137446. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  137447. /**
  137448. * Returns the animatable textures.
  137449. * @returns - Array of animatable textures.
  137450. */
  137451. getAnimatables(): IAnimatable[];
  137452. /**
  137453. * Returns the texture used for reflections.
  137454. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  137455. */
  137456. private _getReflectionTexture;
  137457. /**
  137458. * Returns an array of the actively used textures.
  137459. * @returns - Array of BaseTextures
  137460. */
  137461. getActiveTextures(): BaseTexture[];
  137462. /**
  137463. * Checks to see if a texture is used in the material.
  137464. * @param texture - Base texture to use.
  137465. * @returns - Boolean specifying if a texture is used in the material.
  137466. */
  137467. hasTexture(texture: BaseTexture): boolean;
  137468. /**
  137469. * Sets the required values to the prepass renderer.
  137470. * @param prePassRenderer defines the prepass renderer to setup
  137471. */
  137472. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  137473. /**
  137474. * Disposes the resources of the material.
  137475. * @param forceDisposeEffect - Forces the disposal of effects.
  137476. * @param forceDisposeTextures - Forces the disposal of all textures.
  137477. */
  137478. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  137479. }
  137480. }
  137481. declare module BABYLON {
  137482. /**
  137483. * The Physically based material of BJS.
  137484. *
  137485. * This offers the main features of a standard PBR material.
  137486. * For more information, please refer to the documentation :
  137487. * https://doc.babylonjs.com/how_to/physically_based_rendering
  137488. */
  137489. export class PBRMaterial extends PBRBaseMaterial {
  137490. /**
  137491. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  137492. */
  137493. static readonly PBRMATERIAL_OPAQUE: number;
  137494. /**
  137495. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  137496. */
  137497. static readonly PBRMATERIAL_ALPHATEST: number;
  137498. /**
  137499. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  137500. */
  137501. static readonly PBRMATERIAL_ALPHABLEND: number;
  137502. /**
  137503. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  137504. * They are also discarded below the alpha cutoff threshold to improve performances.
  137505. */
  137506. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  137507. /**
  137508. * Defines the default value of how much AO map is occluding the analytical lights
  137509. * (point spot...).
  137510. */
  137511. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  137512. /**
  137513. * Intensity of the direct lights e.g. the four lights available in your scene.
  137514. * This impacts both the direct diffuse and specular highlights.
  137515. */
  137516. directIntensity: number;
  137517. /**
  137518. * Intensity of the emissive part of the material.
  137519. * This helps controlling the emissive effect without modifying the emissive color.
  137520. */
  137521. emissiveIntensity: number;
  137522. /**
  137523. * Intensity of the environment e.g. how much the environment will light the object
  137524. * either through harmonics for rough material or through the refelction for shiny ones.
  137525. */
  137526. environmentIntensity: number;
  137527. /**
  137528. * This is a special control allowing the reduction of the specular highlights coming from the
  137529. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  137530. */
  137531. specularIntensity: number;
  137532. /**
  137533. * Debug Control allowing disabling the bump map on this material.
  137534. */
  137535. disableBumpMap: boolean;
  137536. /**
  137537. * AKA Diffuse Texture in standard nomenclature.
  137538. */
  137539. albedoTexture: BaseTexture;
  137540. /**
  137541. * AKA Occlusion Texture in other nomenclature.
  137542. */
  137543. ambientTexture: BaseTexture;
  137544. /**
  137545. * AKA Occlusion Texture Intensity in other nomenclature.
  137546. */
  137547. ambientTextureStrength: number;
  137548. /**
  137549. * Defines how much the AO map is occluding the analytical lights (point spot...).
  137550. * 1 means it completely occludes it
  137551. * 0 mean it has no impact
  137552. */
  137553. ambientTextureImpactOnAnalyticalLights: number;
  137554. /**
  137555. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  137556. */
  137557. opacityTexture: BaseTexture;
  137558. /**
  137559. * Stores the reflection values in a texture.
  137560. */
  137561. reflectionTexture: Nullable<BaseTexture>;
  137562. /**
  137563. * Stores the emissive values in a texture.
  137564. */
  137565. emissiveTexture: BaseTexture;
  137566. /**
  137567. * AKA Specular texture in other nomenclature.
  137568. */
  137569. reflectivityTexture: BaseTexture;
  137570. /**
  137571. * Used to switch from specular/glossiness to metallic/roughness workflow.
  137572. */
  137573. metallicTexture: BaseTexture;
  137574. /**
  137575. * Specifies the metallic scalar of the metallic/roughness workflow.
  137576. * Can also be used to scale the metalness values of the metallic texture.
  137577. */
  137578. metallic: Nullable<number>;
  137579. /**
  137580. * Specifies the roughness scalar of the metallic/roughness workflow.
  137581. * Can also be used to scale the roughness values of the metallic texture.
  137582. */
  137583. roughness: Nullable<number>;
  137584. /**
  137585. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  137586. * By default the indexOfrefraction is used to compute F0;
  137587. *
  137588. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  137589. *
  137590. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  137591. * F90 = metallicReflectanceColor;
  137592. */
  137593. metallicF0Factor: number;
  137594. /**
  137595. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  137596. * By default the F90 is always 1;
  137597. *
  137598. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  137599. *
  137600. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  137601. * F90 = metallicReflectanceColor;
  137602. */
  137603. metallicReflectanceColor: Color3;
  137604. /**
  137605. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  137606. * This is multiply against the scalar values defined in the material.
  137607. */
  137608. metallicReflectanceTexture: Nullable<BaseTexture>;
  137609. /**
  137610. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  137611. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  137612. */
  137613. microSurfaceTexture: BaseTexture;
  137614. /**
  137615. * Stores surface normal data used to displace a mesh in a texture.
  137616. */
  137617. bumpTexture: BaseTexture;
  137618. /**
  137619. * Stores the pre-calculated light information of a mesh in a texture.
  137620. */
  137621. lightmapTexture: BaseTexture;
  137622. /**
  137623. * Stores the refracted light information in a texture.
  137624. */
  137625. get refractionTexture(): Nullable<BaseTexture>;
  137626. set refractionTexture(value: Nullable<BaseTexture>);
  137627. /**
  137628. * The color of a material in ambient lighting.
  137629. */
  137630. ambientColor: Color3;
  137631. /**
  137632. * AKA Diffuse Color in other nomenclature.
  137633. */
  137634. albedoColor: Color3;
  137635. /**
  137636. * AKA Specular Color in other nomenclature.
  137637. */
  137638. reflectivityColor: Color3;
  137639. /**
  137640. * The color reflected from the material.
  137641. */
  137642. reflectionColor: Color3;
  137643. /**
  137644. * The color emitted from the material.
  137645. */
  137646. emissiveColor: Color3;
  137647. /**
  137648. * AKA Glossiness in other nomenclature.
  137649. */
  137650. microSurface: number;
  137651. /**
  137652. * Index of refraction of the material base layer.
  137653. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  137654. *
  137655. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  137656. *
  137657. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  137658. */
  137659. get indexOfRefraction(): number;
  137660. set indexOfRefraction(value: number);
  137661. /**
  137662. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  137663. */
  137664. get invertRefractionY(): boolean;
  137665. set invertRefractionY(value: boolean);
  137666. /**
  137667. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  137668. * Materials half opaque for instance using refraction could benefit from this control.
  137669. */
  137670. get linkRefractionWithTransparency(): boolean;
  137671. set linkRefractionWithTransparency(value: boolean);
  137672. /**
  137673. * If true, the light map contains occlusion information instead of lighting info.
  137674. */
  137675. useLightmapAsShadowmap: boolean;
  137676. /**
  137677. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  137678. */
  137679. useAlphaFromAlbedoTexture: boolean;
  137680. /**
  137681. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  137682. */
  137683. forceAlphaTest: boolean;
  137684. /**
  137685. * Defines the alpha limits in alpha test mode.
  137686. */
  137687. alphaCutOff: number;
  137688. /**
  137689. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  137690. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  137691. */
  137692. useSpecularOverAlpha: boolean;
  137693. /**
  137694. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  137695. */
  137696. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  137697. /**
  137698. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  137699. */
  137700. useRoughnessFromMetallicTextureAlpha: boolean;
  137701. /**
  137702. * Specifies if the metallic texture contains the roughness information in its green channel.
  137703. */
  137704. useRoughnessFromMetallicTextureGreen: boolean;
  137705. /**
  137706. * Specifies if the metallic texture contains the metallness information in its blue channel.
  137707. */
  137708. useMetallnessFromMetallicTextureBlue: boolean;
  137709. /**
  137710. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  137711. */
  137712. useAmbientOcclusionFromMetallicTextureRed: boolean;
  137713. /**
  137714. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  137715. */
  137716. useAmbientInGrayScale: boolean;
  137717. /**
  137718. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  137719. * The material will try to infer what glossiness each pixel should be.
  137720. */
  137721. useAutoMicroSurfaceFromReflectivityMap: boolean;
  137722. /**
  137723. * BJS is using an harcoded light falloff based on a manually sets up range.
  137724. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137725. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137726. */
  137727. get usePhysicalLightFalloff(): boolean;
  137728. /**
  137729. * BJS is using an harcoded light falloff based on a manually sets up range.
  137730. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137731. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137732. */
  137733. set usePhysicalLightFalloff(value: boolean);
  137734. /**
  137735. * In order to support the falloff compatibility with gltf, a special mode has been added
  137736. * to reproduce the gltf light falloff.
  137737. */
  137738. get useGLTFLightFalloff(): boolean;
  137739. /**
  137740. * In order to support the falloff compatibility with gltf, a special mode has been added
  137741. * to reproduce the gltf light falloff.
  137742. */
  137743. set useGLTFLightFalloff(value: boolean);
  137744. /**
  137745. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  137746. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  137747. */
  137748. useRadianceOverAlpha: boolean;
  137749. /**
  137750. * Allows using an object space normal map (instead of tangent space).
  137751. */
  137752. useObjectSpaceNormalMap: boolean;
  137753. /**
  137754. * Allows using the bump map in parallax mode.
  137755. */
  137756. useParallax: boolean;
  137757. /**
  137758. * Allows using the bump map in parallax occlusion mode.
  137759. */
  137760. useParallaxOcclusion: boolean;
  137761. /**
  137762. * Controls the scale bias of the parallax mode.
  137763. */
  137764. parallaxScaleBias: number;
  137765. /**
  137766. * If sets to true, disables all the lights affecting the material.
  137767. */
  137768. disableLighting: boolean;
  137769. /**
  137770. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  137771. */
  137772. forceIrradianceInFragment: boolean;
  137773. /**
  137774. * Number of Simultaneous lights allowed on the material.
  137775. */
  137776. maxSimultaneousLights: number;
  137777. /**
  137778. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  137779. */
  137780. invertNormalMapX: boolean;
  137781. /**
  137782. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  137783. */
  137784. invertNormalMapY: boolean;
  137785. /**
  137786. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137787. */
  137788. twoSidedLighting: boolean;
  137789. /**
  137790. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137791. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  137792. */
  137793. useAlphaFresnel: boolean;
  137794. /**
  137795. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137796. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  137797. */
  137798. useLinearAlphaFresnel: boolean;
  137799. /**
  137800. * Let user defines the brdf lookup texture used for IBL.
  137801. * A default 8bit version is embedded but you could point at :
  137802. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  137803. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  137804. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  137805. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  137806. */
  137807. environmentBRDFTexture: Nullable<BaseTexture>;
  137808. /**
  137809. * Force normal to face away from face.
  137810. */
  137811. forceNormalForward: boolean;
  137812. /**
  137813. * Enables specular anti aliasing in the PBR shader.
  137814. * It will both interacts on the Geometry for analytical and IBL lighting.
  137815. * It also prefilter the roughness map based on the bump values.
  137816. */
  137817. enableSpecularAntiAliasing: boolean;
  137818. /**
  137819. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  137820. * makes the reflect vector face the model (under horizon).
  137821. */
  137822. useHorizonOcclusion: boolean;
  137823. /**
  137824. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  137825. * too much the area relying on ambient texture to define their ambient occlusion.
  137826. */
  137827. useRadianceOcclusion: boolean;
  137828. /**
  137829. * If set to true, no lighting calculations will be applied.
  137830. */
  137831. unlit: boolean;
  137832. /**
  137833. * Gets the image processing configuration used either in this material.
  137834. */
  137835. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  137836. /**
  137837. * Sets the Default image processing configuration used either in the this material.
  137838. *
  137839. * If sets to null, the scene one is in use.
  137840. */
  137841. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  137842. /**
  137843. * Gets wether the color curves effect is enabled.
  137844. */
  137845. get cameraColorCurvesEnabled(): boolean;
  137846. /**
  137847. * Sets wether the color curves effect is enabled.
  137848. */
  137849. set cameraColorCurvesEnabled(value: boolean);
  137850. /**
  137851. * Gets wether the color grading effect is enabled.
  137852. */
  137853. get cameraColorGradingEnabled(): boolean;
  137854. /**
  137855. * Gets wether the color grading effect is enabled.
  137856. */
  137857. set cameraColorGradingEnabled(value: boolean);
  137858. /**
  137859. * Gets wether tonemapping is enabled or not.
  137860. */
  137861. get cameraToneMappingEnabled(): boolean;
  137862. /**
  137863. * Sets wether tonemapping is enabled or not
  137864. */
  137865. set cameraToneMappingEnabled(value: boolean);
  137866. /**
  137867. * The camera exposure used on this material.
  137868. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137869. * This corresponds to a photographic exposure.
  137870. */
  137871. get cameraExposure(): number;
  137872. /**
  137873. * The camera exposure used on this material.
  137874. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137875. * This corresponds to a photographic exposure.
  137876. */
  137877. set cameraExposure(value: number);
  137878. /**
  137879. * Gets The camera contrast used on this material.
  137880. */
  137881. get cameraContrast(): number;
  137882. /**
  137883. * Sets The camera contrast used on this material.
  137884. */
  137885. set cameraContrast(value: number);
  137886. /**
  137887. * Gets the Color Grading 2D Lookup Texture.
  137888. */
  137889. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  137890. /**
  137891. * Sets the Color Grading 2D Lookup Texture.
  137892. */
  137893. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  137894. /**
  137895. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137896. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137897. * 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;
  137898. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137899. */
  137900. get cameraColorCurves(): Nullable<ColorCurves>;
  137901. /**
  137902. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137903. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137904. * 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;
  137905. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137906. */
  137907. set cameraColorCurves(value: Nullable<ColorCurves>);
  137908. /**
  137909. * Instantiates a new PBRMaterial instance.
  137910. *
  137911. * @param name The material name
  137912. * @param scene The scene the material will be use in.
  137913. */
  137914. constructor(name: string, scene: Scene);
  137915. /**
  137916. * Returns the name of this material class.
  137917. */
  137918. getClassName(): string;
  137919. /**
  137920. * Makes a duplicate of the current material.
  137921. * @param name - name to use for the new material.
  137922. */
  137923. clone(name: string): PBRMaterial;
  137924. /**
  137925. * Serializes this PBR Material.
  137926. * @returns - An object with the serialized material.
  137927. */
  137928. serialize(): any;
  137929. /**
  137930. * Parses a PBR Material from a serialized object.
  137931. * @param source - Serialized object.
  137932. * @param scene - BJS scene instance.
  137933. * @param rootUrl - url for the scene object
  137934. * @returns - PBRMaterial
  137935. */
  137936. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137937. }
  137938. }
  137939. declare module BABYLON {
  137940. /**
  137941. * Direct draw surface info
  137942. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137943. */
  137944. export interface DDSInfo {
  137945. /**
  137946. * Width of the texture
  137947. */
  137948. width: number;
  137949. /**
  137950. * Width of the texture
  137951. */
  137952. height: number;
  137953. /**
  137954. * Number of Mipmaps for the texture
  137955. * @see https://en.wikipedia.org/wiki/Mipmap
  137956. */
  137957. mipmapCount: number;
  137958. /**
  137959. * If the textures format is a known fourCC format
  137960. * @see https://www.fourcc.org/
  137961. */
  137962. isFourCC: boolean;
  137963. /**
  137964. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137965. */
  137966. isRGB: boolean;
  137967. /**
  137968. * If the texture is a lumincance format
  137969. */
  137970. isLuminance: boolean;
  137971. /**
  137972. * If this is a cube texture
  137973. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137974. */
  137975. isCube: boolean;
  137976. /**
  137977. * If the texture is a compressed format eg. FOURCC_DXT1
  137978. */
  137979. isCompressed: boolean;
  137980. /**
  137981. * The dxgiFormat of the texture
  137982. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137983. */
  137984. dxgiFormat: number;
  137985. /**
  137986. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137987. */
  137988. textureType: number;
  137989. /**
  137990. * Sphericle polynomial created for the dds texture
  137991. */
  137992. sphericalPolynomial?: SphericalPolynomial;
  137993. }
  137994. /**
  137995. * Class used to provide DDS decompression tools
  137996. */
  137997. export class DDSTools {
  137998. /**
  137999. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  138000. */
  138001. static StoreLODInAlphaChannel: boolean;
  138002. /**
  138003. * Gets DDS information from an array buffer
  138004. * @param data defines the array buffer view to read data from
  138005. * @returns the DDS information
  138006. */
  138007. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  138008. private static _FloatView;
  138009. private static _Int32View;
  138010. private static _ToHalfFloat;
  138011. private static _FromHalfFloat;
  138012. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  138013. private static _GetHalfFloatRGBAArrayBuffer;
  138014. private static _GetFloatRGBAArrayBuffer;
  138015. private static _GetFloatAsUIntRGBAArrayBuffer;
  138016. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  138017. private static _GetRGBAArrayBuffer;
  138018. private static _ExtractLongWordOrder;
  138019. private static _GetRGBArrayBuffer;
  138020. private static _GetLuminanceArrayBuffer;
  138021. /**
  138022. * Uploads DDS Levels to a Babylon Texture
  138023. * @hidden
  138024. */
  138025. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  138026. }
  138027. interface ThinEngine {
  138028. /**
  138029. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  138030. * @param rootUrl defines the url where the file to load is located
  138031. * @param scene defines the current scene
  138032. * @param lodScale defines scale to apply to the mip map selection
  138033. * @param lodOffset defines offset to apply to the mip map selection
  138034. * @param onLoad defines an optional callback raised when the texture is loaded
  138035. * @param onError defines an optional callback raised if there is an issue to load the texture
  138036. * @param format defines the format of the data
  138037. * @param forcedExtension defines the extension to use to pick the right loader
  138038. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  138039. * @returns the cube texture as an InternalTexture
  138040. */
  138041. 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;
  138042. }
  138043. }
  138044. declare module BABYLON {
  138045. /**
  138046. * Implementation of the DDS Texture Loader.
  138047. * @hidden
  138048. */
  138049. export class _DDSTextureLoader implements IInternalTextureLoader {
  138050. /**
  138051. * Defines wether the loader supports cascade loading the different faces.
  138052. */
  138053. readonly supportCascades: boolean;
  138054. /**
  138055. * This returns if the loader support the current file information.
  138056. * @param extension defines the file extension of the file being loaded
  138057. * @returns true if the loader can load the specified file
  138058. */
  138059. canLoad(extension: string): boolean;
  138060. /**
  138061. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138062. * @param data contains the texture data
  138063. * @param texture defines the BabylonJS internal texture
  138064. * @param createPolynomials will be true if polynomials have been requested
  138065. * @param onLoad defines the callback to trigger once the texture is ready
  138066. * @param onError defines the callback to trigger in case of error
  138067. */
  138068. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138069. /**
  138070. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138071. * @param data contains the texture data
  138072. * @param texture defines the BabylonJS internal texture
  138073. * @param callback defines the method to call once ready to upload
  138074. */
  138075. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  138076. }
  138077. }
  138078. declare module BABYLON {
  138079. /**
  138080. * Implementation of the ENV Texture Loader.
  138081. * @hidden
  138082. */
  138083. export class _ENVTextureLoader implements IInternalTextureLoader {
  138084. /**
  138085. * Defines wether the loader supports cascade loading the different faces.
  138086. */
  138087. readonly supportCascades: boolean;
  138088. /**
  138089. * This returns if the loader support the current file information.
  138090. * @param extension defines the file extension of the file being loaded
  138091. * @returns true if the loader can load the specified file
  138092. */
  138093. canLoad(extension: string): boolean;
  138094. /**
  138095. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138096. * @param data contains the texture data
  138097. * @param texture defines the BabylonJS internal texture
  138098. * @param createPolynomials will be true if polynomials have been requested
  138099. * @param onLoad defines the callback to trigger once the texture is ready
  138100. * @param onError defines the callback to trigger in case of error
  138101. */
  138102. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138103. /**
  138104. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138105. * @param data contains the texture data
  138106. * @param texture defines the BabylonJS internal texture
  138107. * @param callback defines the method to call once ready to upload
  138108. */
  138109. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  138110. }
  138111. }
  138112. declare module BABYLON {
  138113. /**
  138114. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  138115. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  138116. */
  138117. export class KhronosTextureContainer {
  138118. /** contents of the KTX container file */
  138119. data: ArrayBufferView;
  138120. private static HEADER_LEN;
  138121. private static COMPRESSED_2D;
  138122. private static COMPRESSED_3D;
  138123. private static TEX_2D;
  138124. private static TEX_3D;
  138125. /**
  138126. * Gets the openGL type
  138127. */
  138128. glType: number;
  138129. /**
  138130. * Gets the openGL type size
  138131. */
  138132. glTypeSize: number;
  138133. /**
  138134. * Gets the openGL format
  138135. */
  138136. glFormat: number;
  138137. /**
  138138. * Gets the openGL internal format
  138139. */
  138140. glInternalFormat: number;
  138141. /**
  138142. * Gets the base internal format
  138143. */
  138144. glBaseInternalFormat: number;
  138145. /**
  138146. * Gets image width in pixel
  138147. */
  138148. pixelWidth: number;
  138149. /**
  138150. * Gets image height in pixel
  138151. */
  138152. pixelHeight: number;
  138153. /**
  138154. * Gets image depth in pixels
  138155. */
  138156. pixelDepth: number;
  138157. /**
  138158. * Gets the number of array elements
  138159. */
  138160. numberOfArrayElements: number;
  138161. /**
  138162. * Gets the number of faces
  138163. */
  138164. numberOfFaces: number;
  138165. /**
  138166. * Gets the number of mipmap levels
  138167. */
  138168. numberOfMipmapLevels: number;
  138169. /**
  138170. * Gets the bytes of key value data
  138171. */
  138172. bytesOfKeyValueData: number;
  138173. /**
  138174. * Gets the load type
  138175. */
  138176. loadType: number;
  138177. /**
  138178. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  138179. */
  138180. isInvalid: boolean;
  138181. /**
  138182. * Creates a new KhronosTextureContainer
  138183. * @param data contents of the KTX container file
  138184. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  138185. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  138186. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  138187. */
  138188. constructor(
  138189. /** contents of the KTX container file */
  138190. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  138191. /**
  138192. * Uploads KTX content to a Babylon Texture.
  138193. * It is assumed that the texture has already been created & is currently bound
  138194. * @hidden
  138195. */
  138196. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  138197. private _upload2DCompressedLevels;
  138198. /**
  138199. * Checks if the given data starts with a KTX file identifier.
  138200. * @param data the data to check
  138201. * @returns true if the data is a KTX file or false otherwise
  138202. */
  138203. static IsValid(data: ArrayBufferView): boolean;
  138204. }
  138205. }
  138206. declare module BABYLON {
  138207. /**
  138208. * Helper class to push actions to a pool of workers.
  138209. */
  138210. export class WorkerPool implements IDisposable {
  138211. private _workerInfos;
  138212. private _pendingActions;
  138213. /**
  138214. * Constructor
  138215. * @param workers Array of workers to use for actions
  138216. */
  138217. constructor(workers: Array<Worker>);
  138218. /**
  138219. * Terminates all workers and clears any pending actions.
  138220. */
  138221. dispose(): void;
  138222. /**
  138223. * Pushes an action to the worker pool. If all the workers are active, the action will be
  138224. * pended until a worker has completed its action.
  138225. * @param action The action to perform. Call onComplete when the action is complete.
  138226. */
  138227. push(action: (worker: Worker, onComplete: () => void) => void): void;
  138228. private _execute;
  138229. }
  138230. }
  138231. declare module BABYLON {
  138232. /**
  138233. * Class for loading KTX2 files
  138234. * @hidden
  138235. */
  138236. export class KhronosTextureContainer2 {
  138237. private static _WorkerPoolPromise?;
  138238. private static _Initialized;
  138239. private static _Ktx2Decoder;
  138240. /**
  138241. * URL to use when loading the KTX2 decoder module
  138242. */
  138243. static JSModuleURL: string;
  138244. /**
  138245. * Default number of workers used to handle data decoding
  138246. */
  138247. static DefaultNumWorkers: number;
  138248. private static GetDefaultNumWorkers;
  138249. private _engine;
  138250. private static _CreateWorkerPool;
  138251. /**
  138252. * Constructor
  138253. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  138254. */
  138255. constructor(engine: ThinEngine, numWorkers?: number);
  138256. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  138257. /**
  138258. * Stop all async operations and release resources.
  138259. */
  138260. dispose(): void;
  138261. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  138262. /**
  138263. * Checks if the given data starts with a KTX2 file identifier.
  138264. * @param data the data to check
  138265. * @returns true if the data is a KTX2 file or false otherwise
  138266. */
  138267. static IsValid(data: ArrayBufferView): boolean;
  138268. }
  138269. export function workerFunc(): void;
  138270. }
  138271. declare module BABYLON {
  138272. /**
  138273. * Implementation of the KTX Texture Loader.
  138274. * @hidden
  138275. */
  138276. export class _KTXTextureLoader implements IInternalTextureLoader {
  138277. /**
  138278. * Defines wether the loader supports cascade loading the different faces.
  138279. */
  138280. readonly supportCascades: boolean;
  138281. /**
  138282. * This returns if the loader support the current file information.
  138283. * @param extension defines the file extension of the file being loaded
  138284. * @param mimeType defines the optional mime type of the file being loaded
  138285. * @returns true if the loader can load the specified file
  138286. */
  138287. canLoad(extension: string, mimeType?: string): boolean;
  138288. /**
  138289. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138290. * @param data contains the texture data
  138291. * @param texture defines the BabylonJS internal texture
  138292. * @param createPolynomials will be true if polynomials have been requested
  138293. * @param onLoad defines the callback to trigger once the texture is ready
  138294. * @param onError defines the callback to trigger in case of error
  138295. */
  138296. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138297. /**
  138298. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138299. * @param data contains the texture data
  138300. * @param texture defines the BabylonJS internal texture
  138301. * @param callback defines the method to call once ready to upload
  138302. */
  138303. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  138304. }
  138305. }
  138306. declare module BABYLON {
  138307. /** @hidden */
  138308. export var _forceSceneHelpersToBundle: boolean;
  138309. interface Scene {
  138310. /**
  138311. * Creates a default light for the scene.
  138312. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  138313. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  138314. */
  138315. createDefaultLight(replace?: boolean): void;
  138316. /**
  138317. * Creates a default camera for the scene.
  138318. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  138319. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  138320. * @param replace has default false, when true replaces the active camera in the scene
  138321. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  138322. */
  138323. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  138324. /**
  138325. * Creates a default camera and a default light.
  138326. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  138327. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  138328. * @param replace has the default false, when true replaces the active camera/light in the scene
  138329. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  138330. */
  138331. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  138332. /**
  138333. * Creates a new sky box
  138334. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  138335. * @param environmentTexture defines the texture to use as environment texture
  138336. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  138337. * @param scale defines the overall scale of the skybox
  138338. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  138339. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  138340. * @returns a new mesh holding the sky box
  138341. */
  138342. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  138343. /**
  138344. * Creates a new environment
  138345. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  138346. * @param options defines the options you can use to configure the environment
  138347. * @returns the new EnvironmentHelper
  138348. */
  138349. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  138350. /**
  138351. * Creates a new VREXperienceHelper
  138352. * @see https://doc.babylonjs.com/how_to/webvr_helper
  138353. * @param webVROptions defines the options used to create the new VREXperienceHelper
  138354. * @returns a new VREXperienceHelper
  138355. */
  138356. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  138357. /**
  138358. * Creates a new WebXRDefaultExperience
  138359. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  138360. * @param options experience options
  138361. * @returns a promise for a new WebXRDefaultExperience
  138362. */
  138363. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  138364. }
  138365. }
  138366. declare module BABYLON {
  138367. /**
  138368. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  138369. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  138370. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  138371. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  138372. */
  138373. export class VideoDome extends TextureDome<VideoTexture> {
  138374. /**
  138375. * Define the video source as a Monoscopic panoramic 360 video.
  138376. */
  138377. static readonly MODE_MONOSCOPIC: number;
  138378. /**
  138379. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  138380. */
  138381. static readonly MODE_TOPBOTTOM: number;
  138382. /**
  138383. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  138384. */
  138385. static readonly MODE_SIDEBYSIDE: number;
  138386. /**
  138387. * Get the video texture associated with this video dome
  138388. */
  138389. get videoTexture(): VideoTexture;
  138390. /**
  138391. * Get the video mode of this dome
  138392. */
  138393. get videoMode(): number;
  138394. /**
  138395. * Set the video mode of this dome.
  138396. * @see textureMode
  138397. */
  138398. set videoMode(value: number);
  138399. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  138400. }
  138401. }
  138402. declare module BABYLON {
  138403. /**
  138404. * This class can be used to get instrumentation data from a Babylon engine
  138405. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  138406. */
  138407. export class EngineInstrumentation implements IDisposable {
  138408. /**
  138409. * Define the instrumented engine.
  138410. */
  138411. engine: Engine;
  138412. private _captureGPUFrameTime;
  138413. private _gpuFrameTimeToken;
  138414. private _gpuFrameTime;
  138415. private _captureShaderCompilationTime;
  138416. private _shaderCompilationTime;
  138417. private _onBeginFrameObserver;
  138418. private _onEndFrameObserver;
  138419. private _onBeforeShaderCompilationObserver;
  138420. private _onAfterShaderCompilationObserver;
  138421. /**
  138422. * Gets the perf counter used for GPU frame time
  138423. */
  138424. get gpuFrameTimeCounter(): PerfCounter;
  138425. /**
  138426. * Gets the GPU frame time capture status
  138427. */
  138428. get captureGPUFrameTime(): boolean;
  138429. /**
  138430. * Enable or disable the GPU frame time capture
  138431. */
  138432. set captureGPUFrameTime(value: boolean);
  138433. /**
  138434. * Gets the perf counter used for shader compilation time
  138435. */
  138436. get shaderCompilationTimeCounter(): PerfCounter;
  138437. /**
  138438. * Gets the shader compilation time capture status
  138439. */
  138440. get captureShaderCompilationTime(): boolean;
  138441. /**
  138442. * Enable or disable the shader compilation time capture
  138443. */
  138444. set captureShaderCompilationTime(value: boolean);
  138445. /**
  138446. * Instantiates a new engine instrumentation.
  138447. * This class can be used to get instrumentation data from a Babylon engine
  138448. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  138449. * @param engine Defines the engine to instrument
  138450. */
  138451. constructor(
  138452. /**
  138453. * Define the instrumented engine.
  138454. */
  138455. engine: Engine);
  138456. /**
  138457. * Dispose and release associated resources.
  138458. */
  138459. dispose(): void;
  138460. }
  138461. }
  138462. declare module BABYLON {
  138463. /**
  138464. * This class can be used to get instrumentation data from a Babylon engine
  138465. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  138466. */
  138467. export class SceneInstrumentation implements IDisposable {
  138468. /**
  138469. * Defines the scene to instrument
  138470. */
  138471. scene: Scene;
  138472. private _captureActiveMeshesEvaluationTime;
  138473. private _activeMeshesEvaluationTime;
  138474. private _captureRenderTargetsRenderTime;
  138475. private _renderTargetsRenderTime;
  138476. private _captureFrameTime;
  138477. private _frameTime;
  138478. private _captureRenderTime;
  138479. private _renderTime;
  138480. private _captureInterFrameTime;
  138481. private _interFrameTime;
  138482. private _captureParticlesRenderTime;
  138483. private _particlesRenderTime;
  138484. private _captureSpritesRenderTime;
  138485. private _spritesRenderTime;
  138486. private _capturePhysicsTime;
  138487. private _physicsTime;
  138488. private _captureAnimationsTime;
  138489. private _animationsTime;
  138490. private _captureCameraRenderTime;
  138491. private _cameraRenderTime;
  138492. private _onBeforeActiveMeshesEvaluationObserver;
  138493. private _onAfterActiveMeshesEvaluationObserver;
  138494. private _onBeforeRenderTargetsRenderObserver;
  138495. private _onAfterRenderTargetsRenderObserver;
  138496. private _onAfterRenderObserver;
  138497. private _onBeforeDrawPhaseObserver;
  138498. private _onAfterDrawPhaseObserver;
  138499. private _onBeforeAnimationsObserver;
  138500. private _onBeforeParticlesRenderingObserver;
  138501. private _onAfterParticlesRenderingObserver;
  138502. private _onBeforeSpritesRenderingObserver;
  138503. private _onAfterSpritesRenderingObserver;
  138504. private _onBeforePhysicsObserver;
  138505. private _onAfterPhysicsObserver;
  138506. private _onAfterAnimationsObserver;
  138507. private _onBeforeCameraRenderObserver;
  138508. private _onAfterCameraRenderObserver;
  138509. /**
  138510. * Gets the perf counter used for active meshes evaluation time
  138511. */
  138512. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  138513. /**
  138514. * Gets the active meshes evaluation time capture status
  138515. */
  138516. get captureActiveMeshesEvaluationTime(): boolean;
  138517. /**
  138518. * Enable or disable the active meshes evaluation time capture
  138519. */
  138520. set captureActiveMeshesEvaluationTime(value: boolean);
  138521. /**
  138522. * Gets the perf counter used for render targets render time
  138523. */
  138524. get renderTargetsRenderTimeCounter(): PerfCounter;
  138525. /**
  138526. * Gets the render targets render time capture status
  138527. */
  138528. get captureRenderTargetsRenderTime(): boolean;
  138529. /**
  138530. * Enable or disable the render targets render time capture
  138531. */
  138532. set captureRenderTargetsRenderTime(value: boolean);
  138533. /**
  138534. * Gets the perf counter used for particles render time
  138535. */
  138536. get particlesRenderTimeCounter(): PerfCounter;
  138537. /**
  138538. * Gets the particles render time capture status
  138539. */
  138540. get captureParticlesRenderTime(): boolean;
  138541. /**
  138542. * Enable or disable the particles render time capture
  138543. */
  138544. set captureParticlesRenderTime(value: boolean);
  138545. /**
  138546. * Gets the perf counter used for sprites render time
  138547. */
  138548. get spritesRenderTimeCounter(): PerfCounter;
  138549. /**
  138550. * Gets the sprites render time capture status
  138551. */
  138552. get captureSpritesRenderTime(): boolean;
  138553. /**
  138554. * Enable or disable the sprites render time capture
  138555. */
  138556. set captureSpritesRenderTime(value: boolean);
  138557. /**
  138558. * Gets the perf counter used for physics time
  138559. */
  138560. get physicsTimeCounter(): PerfCounter;
  138561. /**
  138562. * Gets the physics time capture status
  138563. */
  138564. get capturePhysicsTime(): boolean;
  138565. /**
  138566. * Enable or disable the physics time capture
  138567. */
  138568. set capturePhysicsTime(value: boolean);
  138569. /**
  138570. * Gets the perf counter used for animations time
  138571. */
  138572. get animationsTimeCounter(): PerfCounter;
  138573. /**
  138574. * Gets the animations time capture status
  138575. */
  138576. get captureAnimationsTime(): boolean;
  138577. /**
  138578. * Enable or disable the animations time capture
  138579. */
  138580. set captureAnimationsTime(value: boolean);
  138581. /**
  138582. * Gets the perf counter used for frame time capture
  138583. */
  138584. get frameTimeCounter(): PerfCounter;
  138585. /**
  138586. * Gets the frame time capture status
  138587. */
  138588. get captureFrameTime(): boolean;
  138589. /**
  138590. * Enable or disable the frame time capture
  138591. */
  138592. set captureFrameTime(value: boolean);
  138593. /**
  138594. * Gets the perf counter used for inter-frames time capture
  138595. */
  138596. get interFrameTimeCounter(): PerfCounter;
  138597. /**
  138598. * Gets the inter-frames time capture status
  138599. */
  138600. get captureInterFrameTime(): boolean;
  138601. /**
  138602. * Enable or disable the inter-frames time capture
  138603. */
  138604. set captureInterFrameTime(value: boolean);
  138605. /**
  138606. * Gets the perf counter used for render time capture
  138607. */
  138608. get renderTimeCounter(): PerfCounter;
  138609. /**
  138610. * Gets the render time capture status
  138611. */
  138612. get captureRenderTime(): boolean;
  138613. /**
  138614. * Enable or disable the render time capture
  138615. */
  138616. set captureRenderTime(value: boolean);
  138617. /**
  138618. * Gets the perf counter used for camera render time capture
  138619. */
  138620. get cameraRenderTimeCounter(): PerfCounter;
  138621. /**
  138622. * Gets the camera render time capture status
  138623. */
  138624. get captureCameraRenderTime(): boolean;
  138625. /**
  138626. * Enable or disable the camera render time capture
  138627. */
  138628. set captureCameraRenderTime(value: boolean);
  138629. /**
  138630. * Gets the perf counter used for draw calls
  138631. */
  138632. get drawCallsCounter(): PerfCounter;
  138633. /**
  138634. * Instantiates a new scene instrumentation.
  138635. * This class can be used to get instrumentation data from a Babylon engine
  138636. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  138637. * @param scene Defines the scene to instrument
  138638. */
  138639. constructor(
  138640. /**
  138641. * Defines the scene to instrument
  138642. */
  138643. scene: Scene);
  138644. /**
  138645. * Dispose and release associated resources.
  138646. */
  138647. dispose(): void;
  138648. }
  138649. }
  138650. declare module BABYLON {
  138651. /** @hidden */
  138652. export var glowMapGenerationPixelShader: {
  138653. name: string;
  138654. shader: string;
  138655. };
  138656. }
  138657. declare module BABYLON {
  138658. /** @hidden */
  138659. export var glowMapGenerationVertexShader: {
  138660. name: string;
  138661. shader: string;
  138662. };
  138663. }
  138664. declare module BABYLON {
  138665. /**
  138666. * Effect layer options. This helps customizing the behaviour
  138667. * of the effect layer.
  138668. */
  138669. export interface IEffectLayerOptions {
  138670. /**
  138671. * Multiplication factor apply to the canvas size to compute the render target size
  138672. * used to generated the objects (the smaller the faster).
  138673. */
  138674. mainTextureRatio: number;
  138675. /**
  138676. * Enforces a fixed size texture to ensure effect stability across devices.
  138677. */
  138678. mainTextureFixedSize?: number;
  138679. /**
  138680. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  138681. */
  138682. alphaBlendingMode: number;
  138683. /**
  138684. * The camera attached to the layer.
  138685. */
  138686. camera: Nullable<Camera>;
  138687. /**
  138688. * The rendering group to draw the layer in.
  138689. */
  138690. renderingGroupId: number;
  138691. }
  138692. /**
  138693. * The effect layer Helps adding post process effect blended with the main pass.
  138694. *
  138695. * This can be for instance use to generate glow or higlight effects on the scene.
  138696. *
  138697. * The effect layer class can not be used directly and is intented to inherited from to be
  138698. * customized per effects.
  138699. */
  138700. export abstract class EffectLayer {
  138701. private _vertexBuffers;
  138702. private _indexBuffer;
  138703. private _cachedDefines;
  138704. private _effectLayerMapGenerationEffect;
  138705. private _effectLayerOptions;
  138706. private _mergeEffect;
  138707. protected _scene: Scene;
  138708. protected _engine: Engine;
  138709. protected _maxSize: number;
  138710. protected _mainTextureDesiredSize: ISize;
  138711. protected _mainTexture: RenderTargetTexture;
  138712. protected _shouldRender: boolean;
  138713. protected _postProcesses: PostProcess[];
  138714. protected _textures: BaseTexture[];
  138715. protected _emissiveTextureAndColor: {
  138716. texture: Nullable<BaseTexture>;
  138717. color: Color4;
  138718. };
  138719. /**
  138720. * The name of the layer
  138721. */
  138722. name: string;
  138723. /**
  138724. * The clear color of the texture used to generate the glow map.
  138725. */
  138726. neutralColor: Color4;
  138727. /**
  138728. * Specifies whether the highlight layer is enabled or not.
  138729. */
  138730. isEnabled: boolean;
  138731. /**
  138732. * Gets the camera attached to the layer.
  138733. */
  138734. get camera(): Nullable<Camera>;
  138735. /**
  138736. * Gets the rendering group id the layer should render in.
  138737. */
  138738. get renderingGroupId(): number;
  138739. set renderingGroupId(renderingGroupId: number);
  138740. /**
  138741. * An event triggered when the effect layer has been disposed.
  138742. */
  138743. onDisposeObservable: Observable<EffectLayer>;
  138744. /**
  138745. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  138746. */
  138747. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  138748. /**
  138749. * An event triggered when the generated texture is being merged in the scene.
  138750. */
  138751. onBeforeComposeObservable: Observable<EffectLayer>;
  138752. /**
  138753. * An event triggered when the mesh is rendered into the effect render target.
  138754. */
  138755. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  138756. /**
  138757. * An event triggered after the mesh has been rendered into the effect render target.
  138758. */
  138759. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  138760. /**
  138761. * An event triggered when the generated texture has been merged in the scene.
  138762. */
  138763. onAfterComposeObservable: Observable<EffectLayer>;
  138764. /**
  138765. * An event triggered when the efffect layer changes its size.
  138766. */
  138767. onSizeChangedObservable: Observable<EffectLayer>;
  138768. /** @hidden */
  138769. static _SceneComponentInitialization: (scene: Scene) => void;
  138770. /**
  138771. * Instantiates a new effect Layer and references it in the scene.
  138772. * @param name The name of the layer
  138773. * @param scene The scene to use the layer in
  138774. */
  138775. constructor(
  138776. /** The Friendly of the effect in the scene */
  138777. name: string, scene: Scene);
  138778. /**
  138779. * Get the effect name of the layer.
  138780. * @return The effect name
  138781. */
  138782. abstract getEffectName(): string;
  138783. /**
  138784. * Checks for the readiness of the element composing the layer.
  138785. * @param subMesh the mesh to check for
  138786. * @param useInstances specify whether or not to use instances to render the mesh
  138787. * @return true if ready otherwise, false
  138788. */
  138789. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138790. /**
  138791. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138792. * @returns true if the effect requires stencil during the main canvas render pass.
  138793. */
  138794. abstract needStencil(): boolean;
  138795. /**
  138796. * Create the merge effect. This is the shader use to blit the information back
  138797. * to the main canvas at the end of the scene rendering.
  138798. * @returns The effect containing the shader used to merge the effect on the main canvas
  138799. */
  138800. protected abstract _createMergeEffect(): Effect;
  138801. /**
  138802. * Creates the render target textures and post processes used in the effect layer.
  138803. */
  138804. protected abstract _createTextureAndPostProcesses(): void;
  138805. /**
  138806. * Implementation specific of rendering the generating effect on the main canvas.
  138807. * @param effect The effect used to render through
  138808. */
  138809. protected abstract _internalRender(effect: Effect): void;
  138810. /**
  138811. * Sets the required values for both the emissive texture and and the main color.
  138812. */
  138813. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138814. /**
  138815. * Free any resources and references associated to a mesh.
  138816. * Internal use
  138817. * @param mesh The mesh to free.
  138818. */
  138819. abstract _disposeMesh(mesh: Mesh): void;
  138820. /**
  138821. * Serializes this layer (Glow or Highlight for example)
  138822. * @returns a serialized layer object
  138823. */
  138824. abstract serialize?(): any;
  138825. /**
  138826. * Initializes the effect layer with the required options.
  138827. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  138828. */
  138829. protected _init(options: Partial<IEffectLayerOptions>): void;
  138830. /**
  138831. * Generates the index buffer of the full screen quad blending to the main canvas.
  138832. */
  138833. private _generateIndexBuffer;
  138834. /**
  138835. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  138836. */
  138837. private _generateVertexBuffer;
  138838. /**
  138839. * Sets the main texture desired size which is the closest power of two
  138840. * of the engine canvas size.
  138841. */
  138842. private _setMainTextureSize;
  138843. /**
  138844. * Creates the main texture for the effect layer.
  138845. */
  138846. protected _createMainTexture(): void;
  138847. /**
  138848. * Adds specific effects defines.
  138849. * @param defines The defines to add specifics to.
  138850. */
  138851. protected _addCustomEffectDefines(defines: string[]): void;
  138852. /**
  138853. * Checks for the readiness of the element composing the layer.
  138854. * @param subMesh the mesh to check for
  138855. * @param useInstances specify whether or not to use instances to render the mesh
  138856. * @param emissiveTexture the associated emissive texture used to generate the glow
  138857. * @return true if ready otherwise, false
  138858. */
  138859. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  138860. /**
  138861. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  138862. */
  138863. render(): void;
  138864. /**
  138865. * Determine if a given mesh will be used in the current effect.
  138866. * @param mesh mesh to test
  138867. * @returns true if the mesh will be used
  138868. */
  138869. hasMesh(mesh: AbstractMesh): boolean;
  138870. /**
  138871. * Returns true if the layer contains information to display, otherwise false.
  138872. * @returns true if the glow layer should be rendered
  138873. */
  138874. shouldRender(): boolean;
  138875. /**
  138876. * Returns true if the mesh should render, otherwise false.
  138877. * @param mesh The mesh to render
  138878. * @returns true if it should render otherwise false
  138879. */
  138880. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  138881. /**
  138882. * Returns true if the mesh can be rendered, otherwise false.
  138883. * @param mesh The mesh to render
  138884. * @param material The material used on the mesh
  138885. * @returns true if it can be rendered otherwise false
  138886. */
  138887. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138888. /**
  138889. * Returns true if the mesh should render, otherwise false.
  138890. * @param mesh The mesh to render
  138891. * @returns true if it should render otherwise false
  138892. */
  138893. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  138894. /**
  138895. * Renders the submesh passed in parameter to the generation map.
  138896. */
  138897. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  138898. /**
  138899. * Defines whether the current material of the mesh should be use to render the effect.
  138900. * @param mesh defines the current mesh to render
  138901. */
  138902. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138903. /**
  138904. * Rebuild the required buffers.
  138905. * @hidden Internal use only.
  138906. */
  138907. _rebuild(): void;
  138908. /**
  138909. * Dispose only the render target textures and post process.
  138910. */
  138911. private _disposeTextureAndPostProcesses;
  138912. /**
  138913. * Dispose the highlight layer and free resources.
  138914. */
  138915. dispose(): void;
  138916. /**
  138917. * Gets the class name of the effect layer
  138918. * @returns the string with the class name of the effect layer
  138919. */
  138920. getClassName(): string;
  138921. /**
  138922. * Creates an effect layer from parsed effect layer data
  138923. * @param parsedEffectLayer defines effect layer data
  138924. * @param scene defines the current scene
  138925. * @param rootUrl defines the root URL containing the effect layer information
  138926. * @returns a parsed effect Layer
  138927. */
  138928. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  138929. }
  138930. }
  138931. declare module BABYLON {
  138932. interface AbstractScene {
  138933. /**
  138934. * The list of effect layers (highlights/glow) added to the scene
  138935. * @see https://doc.babylonjs.com/how_to/highlight_layer
  138936. * @see https://doc.babylonjs.com/how_to/glow_layer
  138937. */
  138938. effectLayers: Array<EffectLayer>;
  138939. /**
  138940. * Removes the given effect layer from this scene.
  138941. * @param toRemove defines the effect layer to remove
  138942. * @returns the index of the removed effect layer
  138943. */
  138944. removeEffectLayer(toRemove: EffectLayer): number;
  138945. /**
  138946. * Adds the given effect layer to this scene
  138947. * @param newEffectLayer defines the effect layer to add
  138948. */
  138949. addEffectLayer(newEffectLayer: EffectLayer): void;
  138950. }
  138951. /**
  138952. * Defines the layer scene component responsible to manage any effect layers
  138953. * in a given scene.
  138954. */
  138955. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138956. /**
  138957. * The component name helpfull to identify the component in the list of scene components.
  138958. */
  138959. readonly name: string;
  138960. /**
  138961. * The scene the component belongs to.
  138962. */
  138963. scene: Scene;
  138964. private _engine;
  138965. private _renderEffects;
  138966. private _needStencil;
  138967. private _previousStencilState;
  138968. /**
  138969. * Creates a new instance of the component for the given scene
  138970. * @param scene Defines the scene to register the component in
  138971. */
  138972. constructor(scene: Scene);
  138973. /**
  138974. * Registers the component in a given scene
  138975. */
  138976. register(): void;
  138977. /**
  138978. * Rebuilds the elements related to this component in case of
  138979. * context lost for instance.
  138980. */
  138981. rebuild(): void;
  138982. /**
  138983. * Serializes the component data to the specified json object
  138984. * @param serializationObject The object to serialize to
  138985. */
  138986. serialize(serializationObject: any): void;
  138987. /**
  138988. * Adds all the elements from the container to the scene
  138989. * @param container the container holding the elements
  138990. */
  138991. addFromContainer(container: AbstractScene): void;
  138992. /**
  138993. * Removes all the elements in the container from the scene
  138994. * @param container contains the elements to remove
  138995. * @param dispose if the removed element should be disposed (default: false)
  138996. */
  138997. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138998. /**
  138999. * Disposes the component and the associated ressources.
  139000. */
  139001. dispose(): void;
  139002. private _isReadyForMesh;
  139003. private _renderMainTexture;
  139004. private _setStencil;
  139005. private _setStencilBack;
  139006. private _draw;
  139007. private _drawCamera;
  139008. private _drawRenderingGroup;
  139009. }
  139010. }
  139011. declare module BABYLON {
  139012. /** @hidden */
  139013. export var glowMapMergePixelShader: {
  139014. name: string;
  139015. shader: string;
  139016. };
  139017. }
  139018. declare module BABYLON {
  139019. /** @hidden */
  139020. export var glowMapMergeVertexShader: {
  139021. name: string;
  139022. shader: string;
  139023. };
  139024. }
  139025. declare module BABYLON {
  139026. interface AbstractScene {
  139027. /**
  139028. * Return a the first highlight layer of the scene with a given name.
  139029. * @param name The name of the highlight layer to look for.
  139030. * @return The highlight layer if found otherwise null.
  139031. */
  139032. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  139033. }
  139034. /**
  139035. * Glow layer options. This helps customizing the behaviour
  139036. * of the glow layer.
  139037. */
  139038. export interface IGlowLayerOptions {
  139039. /**
  139040. * Multiplication factor apply to the canvas size to compute the render target size
  139041. * used to generated the glowing objects (the smaller the faster).
  139042. */
  139043. mainTextureRatio: number;
  139044. /**
  139045. * Enforces a fixed size texture to ensure resize independant blur.
  139046. */
  139047. mainTextureFixedSize?: number;
  139048. /**
  139049. * How big is the kernel of the blur texture.
  139050. */
  139051. blurKernelSize: number;
  139052. /**
  139053. * The camera attached to the layer.
  139054. */
  139055. camera: Nullable<Camera>;
  139056. /**
  139057. * Enable MSAA by chosing the number of samples.
  139058. */
  139059. mainTextureSamples?: number;
  139060. /**
  139061. * The rendering group to draw the layer in.
  139062. */
  139063. renderingGroupId: number;
  139064. }
  139065. /**
  139066. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  139067. *
  139068. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  139069. *
  139070. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  139071. */
  139072. export class GlowLayer extends EffectLayer {
  139073. /**
  139074. * Effect Name of the layer.
  139075. */
  139076. static readonly EffectName: string;
  139077. /**
  139078. * The default blur kernel size used for the glow.
  139079. */
  139080. static DefaultBlurKernelSize: number;
  139081. /**
  139082. * The default texture size ratio used for the glow.
  139083. */
  139084. static DefaultTextureRatio: number;
  139085. /**
  139086. * Sets the kernel size of the blur.
  139087. */
  139088. set blurKernelSize(value: number);
  139089. /**
  139090. * Gets the kernel size of the blur.
  139091. */
  139092. get blurKernelSize(): number;
  139093. /**
  139094. * Sets the glow intensity.
  139095. */
  139096. set intensity(value: number);
  139097. /**
  139098. * Gets the glow intensity.
  139099. */
  139100. get intensity(): number;
  139101. private _options;
  139102. private _intensity;
  139103. private _horizontalBlurPostprocess1;
  139104. private _verticalBlurPostprocess1;
  139105. private _horizontalBlurPostprocess2;
  139106. private _verticalBlurPostprocess2;
  139107. private _blurTexture1;
  139108. private _blurTexture2;
  139109. private _postProcesses1;
  139110. private _postProcesses2;
  139111. private _includedOnlyMeshes;
  139112. private _excludedMeshes;
  139113. private _meshesUsingTheirOwnMaterials;
  139114. /**
  139115. * Callback used to let the user override the color selection on a per mesh basis
  139116. */
  139117. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  139118. /**
  139119. * Callback used to let the user override the texture selection on a per mesh basis
  139120. */
  139121. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  139122. /**
  139123. * Instantiates a new glow Layer and references it to the scene.
  139124. * @param name The name of the layer
  139125. * @param scene The scene to use the layer in
  139126. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  139127. */
  139128. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  139129. /**
  139130. * Get the effect name of the layer.
  139131. * @return The effect name
  139132. */
  139133. getEffectName(): string;
  139134. /**
  139135. * Create the merge effect. This is the shader use to blit the information back
  139136. * to the main canvas at the end of the scene rendering.
  139137. */
  139138. protected _createMergeEffect(): Effect;
  139139. /**
  139140. * Creates the render target textures and post processes used in the glow layer.
  139141. */
  139142. protected _createTextureAndPostProcesses(): void;
  139143. /**
  139144. * Checks for the readiness of the element composing the layer.
  139145. * @param subMesh the mesh to check for
  139146. * @param useInstances specify wether or not to use instances to render the mesh
  139147. * @param emissiveTexture the associated emissive texture used to generate the glow
  139148. * @return true if ready otherwise, false
  139149. */
  139150. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139151. /**
  139152. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  139153. */
  139154. needStencil(): boolean;
  139155. /**
  139156. * Returns true if the mesh can be rendered, otherwise false.
  139157. * @param mesh The mesh to render
  139158. * @param material The material used on the mesh
  139159. * @returns true if it can be rendered otherwise false
  139160. */
  139161. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  139162. /**
  139163. * Implementation specific of rendering the generating effect on the main canvas.
  139164. * @param effect The effect used to render through
  139165. */
  139166. protected _internalRender(effect: Effect): void;
  139167. /**
  139168. * Sets the required values for both the emissive texture and and the main color.
  139169. */
  139170. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  139171. /**
  139172. * Returns true if the mesh should render, otherwise false.
  139173. * @param mesh The mesh to render
  139174. * @returns true if it should render otherwise false
  139175. */
  139176. protected _shouldRenderMesh(mesh: Mesh): boolean;
  139177. /**
  139178. * Adds specific effects defines.
  139179. * @param defines The defines to add specifics to.
  139180. */
  139181. protected _addCustomEffectDefines(defines: string[]): void;
  139182. /**
  139183. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  139184. * @param mesh The mesh to exclude from the glow layer
  139185. */
  139186. addExcludedMesh(mesh: Mesh): void;
  139187. /**
  139188. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  139189. * @param mesh The mesh to remove
  139190. */
  139191. removeExcludedMesh(mesh: Mesh): void;
  139192. /**
  139193. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  139194. * @param mesh The mesh to include in the glow layer
  139195. */
  139196. addIncludedOnlyMesh(mesh: Mesh): void;
  139197. /**
  139198. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  139199. * @param mesh The mesh to remove
  139200. */
  139201. removeIncludedOnlyMesh(mesh: Mesh): void;
  139202. /**
  139203. * Determine if a given mesh will be used in the glow layer
  139204. * @param mesh The mesh to test
  139205. * @returns true if the mesh will be highlighted by the current glow layer
  139206. */
  139207. hasMesh(mesh: AbstractMesh): boolean;
  139208. /**
  139209. * Defines whether the current material of the mesh should be use to render the effect.
  139210. * @param mesh defines the current mesh to render
  139211. */
  139212. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  139213. /**
  139214. * Add a mesh to be rendered through its own material and not with emissive only.
  139215. * @param mesh The mesh for which we need to use its material
  139216. */
  139217. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  139218. /**
  139219. * Remove a mesh from being rendered through its own material and not with emissive only.
  139220. * @param mesh The mesh for which we need to not use its material
  139221. */
  139222. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  139223. /**
  139224. * Free any resources and references associated to a mesh.
  139225. * Internal use
  139226. * @param mesh The mesh to free.
  139227. * @hidden
  139228. */
  139229. _disposeMesh(mesh: Mesh): void;
  139230. /**
  139231. * Gets the class name of the effect layer
  139232. * @returns the string with the class name of the effect layer
  139233. */
  139234. getClassName(): string;
  139235. /**
  139236. * Serializes this glow layer
  139237. * @returns a serialized glow layer object
  139238. */
  139239. serialize(): any;
  139240. /**
  139241. * Creates a Glow Layer from parsed glow layer data
  139242. * @param parsedGlowLayer defines glow layer data
  139243. * @param scene defines the current scene
  139244. * @param rootUrl defines the root URL containing the glow layer information
  139245. * @returns a parsed Glow Layer
  139246. */
  139247. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  139248. }
  139249. }
  139250. declare module BABYLON {
  139251. /** @hidden */
  139252. export var glowBlurPostProcessPixelShader: {
  139253. name: string;
  139254. shader: string;
  139255. };
  139256. }
  139257. declare module BABYLON {
  139258. interface AbstractScene {
  139259. /**
  139260. * Return a the first highlight layer of the scene with a given name.
  139261. * @param name The name of the highlight layer to look for.
  139262. * @return The highlight layer if found otherwise null.
  139263. */
  139264. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  139265. }
  139266. /**
  139267. * Highlight layer options. This helps customizing the behaviour
  139268. * of the highlight layer.
  139269. */
  139270. export interface IHighlightLayerOptions {
  139271. /**
  139272. * Multiplication factor apply to the canvas size to compute the render target size
  139273. * used to generated the glowing objects (the smaller the faster).
  139274. */
  139275. mainTextureRatio: number;
  139276. /**
  139277. * Enforces a fixed size texture to ensure resize independant blur.
  139278. */
  139279. mainTextureFixedSize?: number;
  139280. /**
  139281. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  139282. * of the picture to blur (the smaller the faster).
  139283. */
  139284. blurTextureSizeRatio: number;
  139285. /**
  139286. * How big in texel of the blur texture is the vertical blur.
  139287. */
  139288. blurVerticalSize: number;
  139289. /**
  139290. * How big in texel of the blur texture is the horizontal blur.
  139291. */
  139292. blurHorizontalSize: number;
  139293. /**
  139294. * Alpha blending mode used to apply the blur. Default is combine.
  139295. */
  139296. alphaBlendingMode: number;
  139297. /**
  139298. * The camera attached to the layer.
  139299. */
  139300. camera: Nullable<Camera>;
  139301. /**
  139302. * Should we display highlight as a solid stroke?
  139303. */
  139304. isStroke?: boolean;
  139305. /**
  139306. * The rendering group to draw the layer in.
  139307. */
  139308. renderingGroupId: number;
  139309. }
  139310. /**
  139311. * The highlight layer Helps adding a glow effect around a mesh.
  139312. *
  139313. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  139314. * glowy meshes to your scene.
  139315. *
  139316. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  139317. */
  139318. export class HighlightLayer extends EffectLayer {
  139319. name: string;
  139320. /**
  139321. * Effect Name of the highlight layer.
  139322. */
  139323. static readonly EffectName: string;
  139324. /**
  139325. * The neutral color used during the preparation of the glow effect.
  139326. * This is black by default as the blend operation is a blend operation.
  139327. */
  139328. static NeutralColor: Color4;
  139329. /**
  139330. * Stencil value used for glowing meshes.
  139331. */
  139332. static GlowingMeshStencilReference: number;
  139333. /**
  139334. * Stencil value used for the other meshes in the scene.
  139335. */
  139336. static NormalMeshStencilReference: number;
  139337. /**
  139338. * Specifies whether or not the inner glow is ACTIVE in the layer.
  139339. */
  139340. innerGlow: boolean;
  139341. /**
  139342. * Specifies whether or not the outer glow is ACTIVE in the layer.
  139343. */
  139344. outerGlow: boolean;
  139345. /**
  139346. * Specifies the horizontal size of the blur.
  139347. */
  139348. set blurHorizontalSize(value: number);
  139349. /**
  139350. * Specifies the vertical size of the blur.
  139351. */
  139352. set blurVerticalSize(value: number);
  139353. /**
  139354. * Gets the horizontal size of the blur.
  139355. */
  139356. get blurHorizontalSize(): number;
  139357. /**
  139358. * Gets the vertical size of the blur.
  139359. */
  139360. get blurVerticalSize(): number;
  139361. /**
  139362. * An event triggered when the highlight layer is being blurred.
  139363. */
  139364. onBeforeBlurObservable: Observable<HighlightLayer>;
  139365. /**
  139366. * An event triggered when the highlight layer has been blurred.
  139367. */
  139368. onAfterBlurObservable: Observable<HighlightLayer>;
  139369. private _instanceGlowingMeshStencilReference;
  139370. private _options;
  139371. private _downSamplePostprocess;
  139372. private _horizontalBlurPostprocess;
  139373. private _verticalBlurPostprocess;
  139374. private _blurTexture;
  139375. private _meshes;
  139376. private _excludedMeshes;
  139377. /**
  139378. * Instantiates a new highlight Layer and references it to the scene..
  139379. * @param name The name of the layer
  139380. * @param scene The scene to use the layer in
  139381. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  139382. */
  139383. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  139384. /**
  139385. * Get the effect name of the layer.
  139386. * @return The effect name
  139387. */
  139388. getEffectName(): string;
  139389. /**
  139390. * Create the merge effect. This is the shader use to blit the information back
  139391. * to the main canvas at the end of the scene rendering.
  139392. */
  139393. protected _createMergeEffect(): Effect;
  139394. /**
  139395. * Creates the render target textures and post processes used in the highlight layer.
  139396. */
  139397. protected _createTextureAndPostProcesses(): void;
  139398. /**
  139399. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  139400. */
  139401. needStencil(): boolean;
  139402. /**
  139403. * Checks for the readiness of the element composing the layer.
  139404. * @param subMesh the mesh to check for
  139405. * @param useInstances specify wether or not to use instances to render the mesh
  139406. * @param emissiveTexture the associated emissive texture used to generate the glow
  139407. * @return true if ready otherwise, false
  139408. */
  139409. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139410. /**
  139411. * Implementation specific of rendering the generating effect on the main canvas.
  139412. * @param effect The effect used to render through
  139413. */
  139414. protected _internalRender(effect: Effect): void;
  139415. /**
  139416. * Returns true if the layer contains information to display, otherwise false.
  139417. */
  139418. shouldRender(): boolean;
  139419. /**
  139420. * Returns true if the mesh should render, otherwise false.
  139421. * @param mesh The mesh to render
  139422. * @returns true if it should render otherwise false
  139423. */
  139424. protected _shouldRenderMesh(mesh: Mesh): boolean;
  139425. /**
  139426. * Returns true if the mesh can be rendered, otherwise false.
  139427. * @param mesh The mesh to render
  139428. * @param material The material used on the mesh
  139429. * @returns true if it can be rendered otherwise false
  139430. */
  139431. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  139432. /**
  139433. * Adds specific effects defines.
  139434. * @param defines The defines to add specifics to.
  139435. */
  139436. protected _addCustomEffectDefines(defines: string[]): void;
  139437. /**
  139438. * Sets the required values for both the emissive texture and and the main color.
  139439. */
  139440. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  139441. /**
  139442. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  139443. * @param mesh The mesh to exclude from the highlight layer
  139444. */
  139445. addExcludedMesh(mesh: Mesh): void;
  139446. /**
  139447. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  139448. * @param mesh The mesh to highlight
  139449. */
  139450. removeExcludedMesh(mesh: Mesh): void;
  139451. /**
  139452. * Determine if a given mesh will be highlighted by the current HighlightLayer
  139453. * @param mesh mesh to test
  139454. * @returns true if the mesh will be highlighted by the current HighlightLayer
  139455. */
  139456. hasMesh(mesh: AbstractMesh): boolean;
  139457. /**
  139458. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  139459. * @param mesh The mesh to highlight
  139460. * @param color The color of the highlight
  139461. * @param glowEmissiveOnly Extract the glow from the emissive texture
  139462. */
  139463. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  139464. /**
  139465. * Remove a mesh from the highlight layer in order to make it stop glowing.
  139466. * @param mesh The mesh to highlight
  139467. */
  139468. removeMesh(mesh: Mesh): void;
  139469. /**
  139470. * Remove all the meshes currently referenced in the highlight layer
  139471. */
  139472. removeAllMeshes(): void;
  139473. /**
  139474. * Force the stencil to the normal expected value for none glowing parts
  139475. */
  139476. private _defaultStencilReference;
  139477. /**
  139478. * Free any resources and references associated to a mesh.
  139479. * Internal use
  139480. * @param mesh The mesh to free.
  139481. * @hidden
  139482. */
  139483. _disposeMesh(mesh: Mesh): void;
  139484. /**
  139485. * Dispose the highlight layer and free resources.
  139486. */
  139487. dispose(): void;
  139488. /**
  139489. * Gets the class name of the effect layer
  139490. * @returns the string with the class name of the effect layer
  139491. */
  139492. getClassName(): string;
  139493. /**
  139494. * Serializes this Highlight layer
  139495. * @returns a serialized Highlight layer object
  139496. */
  139497. serialize(): any;
  139498. /**
  139499. * Creates a Highlight layer from parsed Highlight layer data
  139500. * @param parsedHightlightLayer defines the Highlight layer data
  139501. * @param scene defines the current scene
  139502. * @param rootUrl defines the root URL containing the Highlight layer information
  139503. * @returns a parsed Highlight layer
  139504. */
  139505. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  139506. }
  139507. }
  139508. declare module BABYLON {
  139509. interface AbstractScene {
  139510. /**
  139511. * The list of layers (background and foreground) of the scene
  139512. */
  139513. layers: Array<Layer>;
  139514. }
  139515. /**
  139516. * Defines the layer scene component responsible to manage any layers
  139517. * in a given scene.
  139518. */
  139519. export class LayerSceneComponent implements ISceneComponent {
  139520. /**
  139521. * The component name helpfull to identify the component in the list of scene components.
  139522. */
  139523. readonly name: string;
  139524. /**
  139525. * The scene the component belongs to.
  139526. */
  139527. scene: Scene;
  139528. private _engine;
  139529. /**
  139530. * Creates a new instance of the component for the given scene
  139531. * @param scene Defines the scene to register the component in
  139532. */
  139533. constructor(scene: Scene);
  139534. /**
  139535. * Registers the component in a given scene
  139536. */
  139537. register(): void;
  139538. /**
  139539. * Rebuilds the elements related to this component in case of
  139540. * context lost for instance.
  139541. */
  139542. rebuild(): void;
  139543. /**
  139544. * Disposes the component and the associated ressources.
  139545. */
  139546. dispose(): void;
  139547. private _draw;
  139548. private _drawCameraPredicate;
  139549. private _drawCameraBackground;
  139550. private _drawCameraForeground;
  139551. private _drawRenderTargetPredicate;
  139552. private _drawRenderTargetBackground;
  139553. private _drawRenderTargetForeground;
  139554. /**
  139555. * Adds all the elements from the container to the scene
  139556. * @param container the container holding the elements
  139557. */
  139558. addFromContainer(container: AbstractScene): void;
  139559. /**
  139560. * Removes all the elements in the container from the scene
  139561. * @param container contains the elements to remove
  139562. * @param dispose if the removed element should be disposed (default: false)
  139563. */
  139564. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139565. }
  139566. }
  139567. declare module BABYLON {
  139568. /** @hidden */
  139569. export var layerPixelShader: {
  139570. name: string;
  139571. shader: string;
  139572. };
  139573. }
  139574. declare module BABYLON {
  139575. /** @hidden */
  139576. export var layerVertexShader: {
  139577. name: string;
  139578. shader: string;
  139579. };
  139580. }
  139581. declare module BABYLON {
  139582. /**
  139583. * This represents a full screen 2d layer.
  139584. * This can be useful to display a picture in the background of your scene for instance.
  139585. * @see https://www.babylonjs-playground.com/#08A2BS#1
  139586. */
  139587. export class Layer {
  139588. /**
  139589. * Define the name of the layer.
  139590. */
  139591. name: string;
  139592. /**
  139593. * Define the texture the layer should display.
  139594. */
  139595. texture: Nullable<Texture>;
  139596. /**
  139597. * Is the layer in background or foreground.
  139598. */
  139599. isBackground: boolean;
  139600. /**
  139601. * Define the color of the layer (instead of texture).
  139602. */
  139603. color: Color4;
  139604. /**
  139605. * Define the scale of the layer in order to zoom in out of the texture.
  139606. */
  139607. scale: Vector2;
  139608. /**
  139609. * Define an offset for the layer in order to shift the texture.
  139610. */
  139611. offset: Vector2;
  139612. /**
  139613. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  139614. */
  139615. alphaBlendingMode: number;
  139616. /**
  139617. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  139618. * Alpha test will not mix with the background color in case of transparency.
  139619. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  139620. */
  139621. alphaTest: boolean;
  139622. /**
  139623. * Define a mask to restrict the layer to only some of the scene cameras.
  139624. */
  139625. layerMask: number;
  139626. /**
  139627. * Define the list of render target the layer is visible into.
  139628. */
  139629. renderTargetTextures: RenderTargetTexture[];
  139630. /**
  139631. * Define if the layer is only used in renderTarget or if it also
  139632. * renders in the main frame buffer of the canvas.
  139633. */
  139634. renderOnlyInRenderTargetTextures: boolean;
  139635. private _scene;
  139636. private _vertexBuffers;
  139637. private _indexBuffer;
  139638. private _effect;
  139639. private _previousDefines;
  139640. /**
  139641. * An event triggered when the layer is disposed.
  139642. */
  139643. onDisposeObservable: Observable<Layer>;
  139644. private _onDisposeObserver;
  139645. /**
  139646. * Back compatibility with callback before the onDisposeObservable existed.
  139647. * The set callback will be triggered when the layer has been disposed.
  139648. */
  139649. set onDispose(callback: () => void);
  139650. /**
  139651. * An event triggered before rendering the scene
  139652. */
  139653. onBeforeRenderObservable: Observable<Layer>;
  139654. private _onBeforeRenderObserver;
  139655. /**
  139656. * Back compatibility with callback before the onBeforeRenderObservable existed.
  139657. * The set callback will be triggered just before rendering the layer.
  139658. */
  139659. set onBeforeRender(callback: () => void);
  139660. /**
  139661. * An event triggered after rendering the scene
  139662. */
  139663. onAfterRenderObservable: Observable<Layer>;
  139664. private _onAfterRenderObserver;
  139665. /**
  139666. * Back compatibility with callback before the onAfterRenderObservable existed.
  139667. * The set callback will be triggered just after rendering the layer.
  139668. */
  139669. set onAfterRender(callback: () => void);
  139670. /**
  139671. * Instantiates a new layer.
  139672. * This represents a full screen 2d layer.
  139673. * This can be useful to display a picture in the background of your scene for instance.
  139674. * @see https://www.babylonjs-playground.com/#08A2BS#1
  139675. * @param name Define the name of the layer in the scene
  139676. * @param imgUrl Define the url of the texture to display in the layer
  139677. * @param scene Define the scene the layer belongs to
  139678. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  139679. * @param color Defines a color for the layer
  139680. */
  139681. constructor(
  139682. /**
  139683. * Define the name of the layer.
  139684. */
  139685. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  139686. private _createIndexBuffer;
  139687. /** @hidden */
  139688. _rebuild(): void;
  139689. /**
  139690. * Renders the layer in the scene.
  139691. */
  139692. render(): void;
  139693. /**
  139694. * Disposes and releases the associated ressources.
  139695. */
  139696. dispose(): void;
  139697. }
  139698. }
  139699. declare module BABYLON {
  139700. /** @hidden */
  139701. export var lensFlarePixelShader: {
  139702. name: string;
  139703. shader: string;
  139704. };
  139705. }
  139706. declare module BABYLON {
  139707. /** @hidden */
  139708. export var lensFlareVertexShader: {
  139709. name: string;
  139710. shader: string;
  139711. };
  139712. }
  139713. declare module BABYLON {
  139714. /**
  139715. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  139716. * It is usually composed of several `lensFlare`.
  139717. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139718. */
  139719. export class LensFlareSystem {
  139720. /**
  139721. * Define the name of the lens flare system
  139722. */
  139723. name: string;
  139724. /**
  139725. * List of lens flares used in this system.
  139726. */
  139727. lensFlares: LensFlare[];
  139728. /**
  139729. * Define a limit from the border the lens flare can be visible.
  139730. */
  139731. borderLimit: number;
  139732. /**
  139733. * Define a viewport border we do not want to see the lens flare in.
  139734. */
  139735. viewportBorder: number;
  139736. /**
  139737. * Define a predicate which could limit the list of meshes able to occlude the effect.
  139738. */
  139739. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  139740. /**
  139741. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  139742. */
  139743. layerMask: number;
  139744. /**
  139745. * Define the id of the lens flare system in the scene.
  139746. * (equal to name by default)
  139747. */
  139748. id: string;
  139749. private _scene;
  139750. private _emitter;
  139751. private _vertexBuffers;
  139752. private _indexBuffer;
  139753. private _effect;
  139754. private _positionX;
  139755. private _positionY;
  139756. private _isEnabled;
  139757. /** @hidden */
  139758. static _SceneComponentInitialization: (scene: Scene) => void;
  139759. /**
  139760. * Instantiates a lens flare system.
  139761. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  139762. * It is usually composed of several `lensFlare`.
  139763. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139764. * @param name Define the name of the lens flare system in the scene
  139765. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  139766. * @param scene Define the scene the lens flare system belongs to
  139767. */
  139768. constructor(
  139769. /**
  139770. * Define the name of the lens flare system
  139771. */
  139772. name: string, emitter: any, scene: Scene);
  139773. /**
  139774. * Define if the lens flare system is enabled.
  139775. */
  139776. get isEnabled(): boolean;
  139777. set isEnabled(value: boolean);
  139778. /**
  139779. * Get the scene the effects belongs to.
  139780. * @returns the scene holding the lens flare system
  139781. */
  139782. getScene(): Scene;
  139783. /**
  139784. * Get the emitter of the lens flare system.
  139785. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139786. * @returns the emitter of the lens flare system
  139787. */
  139788. getEmitter(): any;
  139789. /**
  139790. * Set the emitter of the lens flare system.
  139791. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139792. * @param newEmitter Define the new emitter of the system
  139793. */
  139794. setEmitter(newEmitter: any): void;
  139795. /**
  139796. * Get the lens flare system emitter position.
  139797. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  139798. * @returns the position
  139799. */
  139800. getEmitterPosition(): Vector3;
  139801. /**
  139802. * @hidden
  139803. */
  139804. computeEffectivePosition(globalViewport: Viewport): boolean;
  139805. /** @hidden */
  139806. _isVisible(): boolean;
  139807. /**
  139808. * @hidden
  139809. */
  139810. render(): boolean;
  139811. /**
  139812. * Dispose and release the lens flare with its associated resources.
  139813. */
  139814. dispose(): void;
  139815. /**
  139816. * Parse a lens flare system from a JSON repressentation
  139817. * @param parsedLensFlareSystem Define the JSON to parse
  139818. * @param scene Define the scene the parsed system should be instantiated in
  139819. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  139820. * @returns the parsed system
  139821. */
  139822. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  139823. /**
  139824. * Serialize the current Lens Flare System into a JSON representation.
  139825. * @returns the serialized JSON
  139826. */
  139827. serialize(): any;
  139828. }
  139829. }
  139830. declare module BABYLON {
  139831. /**
  139832. * This represents one of the lens effect in a `lensFlareSystem`.
  139833. * It controls one of the indiviual texture used in the effect.
  139834. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139835. */
  139836. export class LensFlare {
  139837. /**
  139838. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139839. */
  139840. size: number;
  139841. /**
  139842. * 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.
  139843. */
  139844. position: number;
  139845. /**
  139846. * Define the lens color.
  139847. */
  139848. color: Color3;
  139849. /**
  139850. * Define the lens texture.
  139851. */
  139852. texture: Nullable<Texture>;
  139853. /**
  139854. * Define the alpha mode to render this particular lens.
  139855. */
  139856. alphaMode: number;
  139857. private _system;
  139858. /**
  139859. * Creates a new Lens Flare.
  139860. * This represents one of the lens effect in a `lensFlareSystem`.
  139861. * It controls one of the indiviual texture used in the effect.
  139862. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139863. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  139864. * @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.
  139865. * @param color Define the lens color
  139866. * @param imgUrl Define the lens texture url
  139867. * @param system Define the `lensFlareSystem` this flare is part of
  139868. * @returns The newly created Lens Flare
  139869. */
  139870. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  139871. /**
  139872. * Instantiates a new Lens Flare.
  139873. * This represents one of the lens effect in a `lensFlareSystem`.
  139874. * It controls one of the indiviual texture used in the effect.
  139875. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139876. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  139877. * @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.
  139878. * @param color Define the lens color
  139879. * @param imgUrl Define the lens texture url
  139880. * @param system Define the `lensFlareSystem` this flare is part of
  139881. */
  139882. constructor(
  139883. /**
  139884. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139885. */
  139886. size: number,
  139887. /**
  139888. * 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.
  139889. */
  139890. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  139891. /**
  139892. * Dispose and release the lens flare with its associated resources.
  139893. */
  139894. dispose(): void;
  139895. }
  139896. }
  139897. declare module BABYLON {
  139898. interface AbstractScene {
  139899. /**
  139900. * The list of lens flare system added to the scene
  139901. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139902. */
  139903. lensFlareSystems: Array<LensFlareSystem>;
  139904. /**
  139905. * Removes the given lens flare system from this scene.
  139906. * @param toRemove The lens flare system to remove
  139907. * @returns The index of the removed lens flare system
  139908. */
  139909. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  139910. /**
  139911. * Adds the given lens flare system to this scene
  139912. * @param newLensFlareSystem The lens flare system to add
  139913. */
  139914. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  139915. /**
  139916. * Gets a lens flare system using its name
  139917. * @param name defines the name to look for
  139918. * @returns the lens flare system or null if not found
  139919. */
  139920. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  139921. /**
  139922. * Gets a lens flare system using its id
  139923. * @param id defines the id to look for
  139924. * @returns the lens flare system or null if not found
  139925. */
  139926. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  139927. }
  139928. /**
  139929. * Defines the lens flare scene component responsible to manage any lens flares
  139930. * in a given scene.
  139931. */
  139932. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  139933. /**
  139934. * The component name helpfull to identify the component in the list of scene components.
  139935. */
  139936. readonly name: string;
  139937. /**
  139938. * The scene the component belongs to.
  139939. */
  139940. scene: Scene;
  139941. /**
  139942. * Creates a new instance of the component for the given scene
  139943. * @param scene Defines the scene to register the component in
  139944. */
  139945. constructor(scene: Scene);
  139946. /**
  139947. * Registers the component in a given scene
  139948. */
  139949. register(): void;
  139950. /**
  139951. * Rebuilds the elements related to this component in case of
  139952. * context lost for instance.
  139953. */
  139954. rebuild(): void;
  139955. /**
  139956. * Adds all the elements from the container to the scene
  139957. * @param container the container holding the elements
  139958. */
  139959. addFromContainer(container: AbstractScene): void;
  139960. /**
  139961. * Removes all the elements in the container from the scene
  139962. * @param container contains the elements to remove
  139963. * @param dispose if the removed element should be disposed (default: false)
  139964. */
  139965. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139966. /**
  139967. * Serializes the component data to the specified json object
  139968. * @param serializationObject The object to serialize to
  139969. */
  139970. serialize(serializationObject: any): void;
  139971. /**
  139972. * Disposes the component and the associated ressources.
  139973. */
  139974. dispose(): void;
  139975. private _draw;
  139976. }
  139977. }
  139978. declare module BABYLON {
  139979. /** @hidden */
  139980. export var depthPixelShader: {
  139981. name: string;
  139982. shader: string;
  139983. };
  139984. }
  139985. declare module BABYLON {
  139986. /** @hidden */
  139987. export var depthVertexShader: {
  139988. name: string;
  139989. shader: string;
  139990. };
  139991. }
  139992. declare module BABYLON {
  139993. /**
  139994. * This represents a depth renderer in Babylon.
  139995. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139996. */
  139997. export class DepthRenderer {
  139998. private _scene;
  139999. private _depthMap;
  140000. private _effect;
  140001. private readonly _storeNonLinearDepth;
  140002. private readonly _clearColor;
  140003. /** Get if the depth renderer is using packed depth or not */
  140004. readonly isPacked: boolean;
  140005. private _cachedDefines;
  140006. private _camera;
  140007. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  140008. enabled: boolean;
  140009. /**
  140010. * Specifiess that the depth renderer will only be used within
  140011. * the camera it is created for.
  140012. * This can help forcing its rendering during the camera processing.
  140013. */
  140014. useOnlyInActiveCamera: boolean;
  140015. /** @hidden */
  140016. static _SceneComponentInitialization: (scene: Scene) => void;
  140017. /**
  140018. * Instantiates a depth renderer
  140019. * @param scene The scene the renderer belongs to
  140020. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  140021. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  140022. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  140023. */
  140024. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  140025. /**
  140026. * Creates the depth rendering effect and checks if the effect is ready.
  140027. * @param subMesh The submesh to be used to render the depth map of
  140028. * @param useInstances If multiple world instances should be used
  140029. * @returns if the depth renderer is ready to render the depth map
  140030. */
  140031. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  140032. /**
  140033. * Gets the texture which the depth map will be written to.
  140034. * @returns The depth map texture
  140035. */
  140036. getDepthMap(): RenderTargetTexture;
  140037. /**
  140038. * Disposes of the depth renderer.
  140039. */
  140040. dispose(): void;
  140041. }
  140042. }
  140043. declare module BABYLON {
  140044. /** @hidden */
  140045. export var minmaxReduxPixelShader: {
  140046. name: string;
  140047. shader: string;
  140048. };
  140049. }
  140050. declare module BABYLON {
  140051. /**
  140052. * This class computes a min/max reduction from a texture: it means it computes the minimum
  140053. * and maximum values from all values of the texture.
  140054. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  140055. * The source values are read from the red channel of the texture.
  140056. */
  140057. export class MinMaxReducer {
  140058. /**
  140059. * Observable triggered when the computation has been performed
  140060. */
  140061. onAfterReductionPerformed: Observable<{
  140062. min: number;
  140063. max: number;
  140064. }>;
  140065. protected _camera: Camera;
  140066. protected _sourceTexture: Nullable<RenderTargetTexture>;
  140067. protected _reductionSteps: Nullable<Array<PostProcess>>;
  140068. protected _postProcessManager: PostProcessManager;
  140069. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  140070. protected _forceFullscreenViewport: boolean;
  140071. /**
  140072. * Creates a min/max reducer
  140073. * @param camera The camera to use for the post processes
  140074. */
  140075. constructor(camera: Camera);
  140076. /**
  140077. * Gets the texture used to read the values from.
  140078. */
  140079. get sourceTexture(): Nullable<RenderTargetTexture>;
  140080. /**
  140081. * Sets the source texture to read the values from.
  140082. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  140083. * because in such textures '1' value must not be taken into account to compute the maximum
  140084. * as this value is used to clear the texture.
  140085. * Note that the computation is not activated by calling this function, you must call activate() for that!
  140086. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  140087. * @param depthRedux Indicates if the texture is a depth texture or not
  140088. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  140089. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  140090. */
  140091. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  140092. /**
  140093. * Defines the refresh rate of the computation.
  140094. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  140095. */
  140096. get refreshRate(): number;
  140097. set refreshRate(value: number);
  140098. protected _activated: boolean;
  140099. /**
  140100. * Gets the activation status of the reducer
  140101. */
  140102. get activated(): boolean;
  140103. /**
  140104. * Activates the reduction computation.
  140105. * When activated, the observers registered in onAfterReductionPerformed are
  140106. * called after the compuation is performed
  140107. */
  140108. activate(): void;
  140109. /**
  140110. * Deactivates the reduction computation.
  140111. */
  140112. deactivate(): void;
  140113. /**
  140114. * Disposes the min/max reducer
  140115. * @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.
  140116. */
  140117. dispose(disposeAll?: boolean): void;
  140118. }
  140119. }
  140120. declare module BABYLON {
  140121. /**
  140122. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  140123. */
  140124. export class DepthReducer extends MinMaxReducer {
  140125. private _depthRenderer;
  140126. private _depthRendererId;
  140127. /**
  140128. * Gets the depth renderer used for the computation.
  140129. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  140130. */
  140131. get depthRenderer(): Nullable<DepthRenderer>;
  140132. /**
  140133. * Creates a depth reducer
  140134. * @param camera The camera used to render the depth texture
  140135. */
  140136. constructor(camera: Camera);
  140137. /**
  140138. * Sets the depth renderer to use to generate the depth map
  140139. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  140140. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  140141. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  140142. */
  140143. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  140144. /** @hidden */
  140145. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  140146. /**
  140147. * Activates the reduction computation.
  140148. * When activated, the observers registered in onAfterReductionPerformed are
  140149. * called after the compuation is performed
  140150. */
  140151. activate(): void;
  140152. /**
  140153. * Deactivates the reduction computation.
  140154. */
  140155. deactivate(): void;
  140156. /**
  140157. * Disposes the depth reducer
  140158. * @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.
  140159. */
  140160. dispose(disposeAll?: boolean): void;
  140161. }
  140162. }
  140163. declare module BABYLON {
  140164. /**
  140165. * A CSM implementation allowing casting shadows on large scenes.
  140166. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  140167. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  140168. */
  140169. export class CascadedShadowGenerator extends ShadowGenerator {
  140170. private static readonly frustumCornersNDCSpace;
  140171. /**
  140172. * Name of the CSM class
  140173. */
  140174. static CLASSNAME: string;
  140175. /**
  140176. * Defines the default number of cascades used by the CSM.
  140177. */
  140178. static readonly DEFAULT_CASCADES_COUNT: number;
  140179. /**
  140180. * Defines the minimum number of cascades used by the CSM.
  140181. */
  140182. static readonly MIN_CASCADES_COUNT: number;
  140183. /**
  140184. * Defines the maximum number of cascades used by the CSM.
  140185. */
  140186. static readonly MAX_CASCADES_COUNT: number;
  140187. protected _validateFilter(filter: number): number;
  140188. /**
  140189. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  140190. */
  140191. penumbraDarkness: number;
  140192. private _numCascades;
  140193. /**
  140194. * Gets or set the number of cascades used by the CSM.
  140195. */
  140196. get numCascades(): number;
  140197. set numCascades(value: number);
  140198. /**
  140199. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  140200. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  140201. */
  140202. stabilizeCascades: boolean;
  140203. private _freezeShadowCastersBoundingInfo;
  140204. private _freezeShadowCastersBoundingInfoObservable;
  140205. /**
  140206. * Enables or disables the shadow casters bounding info computation.
  140207. * If your shadow casters don't move, you can disable this feature.
  140208. * If it is enabled, the bounding box computation is done every frame.
  140209. */
  140210. get freezeShadowCastersBoundingInfo(): boolean;
  140211. set freezeShadowCastersBoundingInfo(freeze: boolean);
  140212. private _scbiMin;
  140213. private _scbiMax;
  140214. protected _computeShadowCastersBoundingInfo(): void;
  140215. protected _shadowCastersBoundingInfo: BoundingInfo;
  140216. /**
  140217. * Gets or sets the shadow casters bounding info.
  140218. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  140219. * so that the system won't overwrite the bounds you provide
  140220. */
  140221. get shadowCastersBoundingInfo(): BoundingInfo;
  140222. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  140223. protected _breaksAreDirty: boolean;
  140224. protected _minDistance: number;
  140225. protected _maxDistance: number;
  140226. /**
  140227. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  140228. *
  140229. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  140230. * If you don't know these values, simply leave them to their defaults and don't call this function.
  140231. * @param min minimal distance for the breaks (default to 0.)
  140232. * @param max maximal distance for the breaks (default to 1.)
  140233. */
  140234. setMinMaxDistance(min: number, max: number): void;
  140235. /** Gets the minimal distance used in the cascade break computation */
  140236. get minDistance(): number;
  140237. /** Gets the maximal distance used in the cascade break computation */
  140238. get maxDistance(): number;
  140239. /**
  140240. * Gets the class name of that object
  140241. * @returns "CascadedShadowGenerator"
  140242. */
  140243. getClassName(): string;
  140244. private _cascadeMinExtents;
  140245. private _cascadeMaxExtents;
  140246. /**
  140247. * Gets a cascade minimum extents
  140248. * @param cascadeIndex index of the cascade
  140249. * @returns the minimum cascade extents
  140250. */
  140251. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  140252. /**
  140253. * Gets a cascade maximum extents
  140254. * @param cascadeIndex index of the cascade
  140255. * @returns the maximum cascade extents
  140256. */
  140257. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  140258. private _cascades;
  140259. private _currentLayer;
  140260. private _viewSpaceFrustumsZ;
  140261. private _viewMatrices;
  140262. private _projectionMatrices;
  140263. private _transformMatrices;
  140264. private _transformMatricesAsArray;
  140265. private _frustumLengths;
  140266. private _lightSizeUVCorrection;
  140267. private _depthCorrection;
  140268. private _frustumCornersWorldSpace;
  140269. private _frustumCenter;
  140270. private _shadowCameraPos;
  140271. private _shadowMaxZ;
  140272. /**
  140273. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  140274. * It defaults to camera.maxZ
  140275. */
  140276. get shadowMaxZ(): number;
  140277. /**
  140278. * Sets the shadow max z distance.
  140279. */
  140280. set shadowMaxZ(value: number);
  140281. protected _debug: boolean;
  140282. /**
  140283. * Gets or sets the debug flag.
  140284. * When enabled, the cascades are materialized by different colors on the screen.
  140285. */
  140286. get debug(): boolean;
  140287. set debug(dbg: boolean);
  140288. private _depthClamp;
  140289. /**
  140290. * Gets or sets the depth clamping value.
  140291. *
  140292. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  140293. * to account for the shadow casters far away.
  140294. *
  140295. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  140296. */
  140297. get depthClamp(): boolean;
  140298. set depthClamp(value: boolean);
  140299. private _cascadeBlendPercentage;
  140300. /**
  140301. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  140302. * It defaults to 0.1 (10% blending).
  140303. */
  140304. get cascadeBlendPercentage(): number;
  140305. set cascadeBlendPercentage(value: number);
  140306. private _lambda;
  140307. /**
  140308. * Gets or set the lambda parameter.
  140309. * This parameter is used to split the camera frustum and create the cascades.
  140310. * 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.
  140311. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  140312. */
  140313. get lambda(): number;
  140314. set lambda(value: number);
  140315. /**
  140316. * Gets the view matrix corresponding to a given cascade
  140317. * @param cascadeNum cascade to retrieve the view matrix from
  140318. * @returns the cascade view matrix
  140319. */
  140320. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  140321. /**
  140322. * Gets the projection matrix corresponding to a given cascade
  140323. * @param cascadeNum cascade to retrieve the projection matrix from
  140324. * @returns the cascade projection matrix
  140325. */
  140326. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  140327. /**
  140328. * Gets the transformation matrix corresponding to a given cascade
  140329. * @param cascadeNum cascade to retrieve the transformation matrix from
  140330. * @returns the cascade transformation matrix
  140331. */
  140332. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  140333. private _depthRenderer;
  140334. /**
  140335. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  140336. *
  140337. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  140338. *
  140339. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  140340. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  140341. * @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
  140342. */
  140343. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  140344. private _depthReducer;
  140345. private _autoCalcDepthBounds;
  140346. /**
  140347. * Gets or sets the autoCalcDepthBounds property.
  140348. *
  140349. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  140350. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  140351. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  140352. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  140353. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  140354. */
  140355. get autoCalcDepthBounds(): boolean;
  140356. set autoCalcDepthBounds(value: boolean);
  140357. /**
  140358. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  140359. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  140360. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  140361. * for setting the refresh rate on the renderer yourself!
  140362. */
  140363. get autoCalcDepthBoundsRefreshRate(): number;
  140364. set autoCalcDepthBoundsRefreshRate(value: number);
  140365. /**
  140366. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  140367. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  140368. * you change the camera near/far planes!
  140369. */
  140370. splitFrustum(): void;
  140371. private _splitFrustum;
  140372. private _computeMatrices;
  140373. private _computeFrustumInWorldSpace;
  140374. private _computeCascadeFrustum;
  140375. /**
  140376. * Support test.
  140377. */
  140378. static get IsSupported(): boolean;
  140379. /** @hidden */
  140380. static _SceneComponentInitialization: (scene: Scene) => void;
  140381. /**
  140382. * Creates a Cascaded Shadow Generator object.
  140383. * A ShadowGenerator is the required tool to use the shadows.
  140384. * Each directional light casting shadows needs to use its own ShadowGenerator.
  140385. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  140386. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  140387. * @param light The directional light object generating the shadows.
  140388. * @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.
  140389. */
  140390. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  140391. protected _initializeGenerator(): void;
  140392. protected _createTargetRenderTexture(): void;
  140393. protected _initializeShadowMap(): void;
  140394. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  140395. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  140396. /**
  140397. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  140398. * @param defines Defines of the material we want to update
  140399. * @param lightIndex Index of the light in the enabled light list of the material
  140400. */
  140401. prepareDefines(defines: any, lightIndex: number): void;
  140402. /**
  140403. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  140404. * defined in the generator but impacting the effect).
  140405. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  140406. * @param effect The effect we are binfing the information for
  140407. */
  140408. bindShadowLight(lightIndex: string, effect: Effect): void;
  140409. /**
  140410. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  140411. * (eq to view projection * shadow projection matrices)
  140412. * @returns The transform matrix used to create the shadow map
  140413. */
  140414. getTransformMatrix(): Matrix;
  140415. /**
  140416. * Disposes the ShadowGenerator.
  140417. * Returns nothing.
  140418. */
  140419. dispose(): void;
  140420. /**
  140421. * Serializes the shadow generator setup to a json object.
  140422. * @returns The serialized JSON object
  140423. */
  140424. serialize(): any;
  140425. /**
  140426. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  140427. * @param parsedShadowGenerator The JSON object to parse
  140428. * @param scene The scene to create the shadow map for
  140429. * @returns The parsed shadow generator
  140430. */
  140431. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  140432. }
  140433. }
  140434. declare module BABYLON {
  140435. /**
  140436. * Defines the shadow generator component responsible to manage any shadow generators
  140437. * in a given scene.
  140438. */
  140439. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  140440. /**
  140441. * The component name helpfull to identify the component in the list of scene components.
  140442. */
  140443. readonly name: string;
  140444. /**
  140445. * The scene the component belongs to.
  140446. */
  140447. scene: Scene;
  140448. /**
  140449. * Creates a new instance of the component for the given scene
  140450. * @param scene Defines the scene to register the component in
  140451. */
  140452. constructor(scene: Scene);
  140453. /**
  140454. * Registers the component in a given scene
  140455. */
  140456. register(): void;
  140457. /**
  140458. * Rebuilds the elements related to this component in case of
  140459. * context lost for instance.
  140460. */
  140461. rebuild(): void;
  140462. /**
  140463. * Serializes the component data to the specified json object
  140464. * @param serializationObject The object to serialize to
  140465. */
  140466. serialize(serializationObject: any): void;
  140467. /**
  140468. * Adds all the elements from the container to the scene
  140469. * @param container the container holding the elements
  140470. */
  140471. addFromContainer(container: AbstractScene): void;
  140472. /**
  140473. * Removes all the elements in the container from the scene
  140474. * @param container contains the elements to remove
  140475. * @param dispose if the removed element should be disposed (default: false)
  140476. */
  140477. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  140478. /**
  140479. * Rebuilds the elements related to this component in case of
  140480. * context lost for instance.
  140481. */
  140482. dispose(): void;
  140483. private _gatherRenderTargets;
  140484. }
  140485. }
  140486. declare module BABYLON {
  140487. /**
  140488. * A point light is a light defined by an unique point in world space.
  140489. * The light is emitted in every direction from this point.
  140490. * A good example of a point light is a standard light bulb.
  140491. * Documentation: https://doc.babylonjs.com/babylon101/lights
  140492. */
  140493. export class PointLight extends ShadowLight {
  140494. private _shadowAngle;
  140495. /**
  140496. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140497. * This specifies what angle the shadow will use to be created.
  140498. *
  140499. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  140500. */
  140501. get shadowAngle(): number;
  140502. /**
  140503. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140504. * This specifies what angle the shadow will use to be created.
  140505. *
  140506. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  140507. */
  140508. set shadowAngle(value: number);
  140509. /**
  140510. * Gets the direction if it has been set.
  140511. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140512. */
  140513. get direction(): Vector3;
  140514. /**
  140515. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140516. */
  140517. set direction(value: Vector3);
  140518. /**
  140519. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  140520. * A PointLight emits the light in every direction.
  140521. * It can cast shadows.
  140522. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  140523. * ```javascript
  140524. * var pointLight = new PointLight("pl", camera.position, scene);
  140525. * ```
  140526. * Documentation : https://doc.babylonjs.com/babylon101/lights
  140527. * @param name The light friendly name
  140528. * @param position The position of the point light in the scene
  140529. * @param scene The scene the lights belongs to
  140530. */
  140531. constructor(name: string, position: Vector3, scene: Scene);
  140532. /**
  140533. * Returns the string "PointLight"
  140534. * @returns the class name
  140535. */
  140536. getClassName(): string;
  140537. /**
  140538. * Returns the integer 0.
  140539. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  140540. */
  140541. getTypeID(): number;
  140542. /**
  140543. * Specifies wether or not the shadowmap should be a cube texture.
  140544. * @returns true if the shadowmap needs to be a cube texture.
  140545. */
  140546. needCube(): boolean;
  140547. /**
  140548. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  140549. * @param faceIndex The index of the face we are computed the direction to generate shadow
  140550. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  140551. */
  140552. getShadowDirection(faceIndex?: number): Vector3;
  140553. /**
  140554. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  140555. * - fov = PI / 2
  140556. * - aspect ratio : 1.0
  140557. * - z-near and far equal to the active camera minZ and maxZ.
  140558. * Returns the PointLight.
  140559. */
  140560. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  140561. protected _buildUniformLayout(): void;
  140562. /**
  140563. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  140564. * @param effect The effect to update
  140565. * @param lightIndex The index of the light in the effect to update
  140566. * @returns The point light
  140567. */
  140568. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  140569. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  140570. /**
  140571. * Prepares the list of defines specific to the light type.
  140572. * @param defines the list of defines
  140573. * @param lightIndex defines the index of the light for the effect
  140574. */
  140575. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  140576. }
  140577. }
  140578. declare module BABYLON {
  140579. /**
  140580. * Header information of HDR texture files.
  140581. */
  140582. export interface HDRInfo {
  140583. /**
  140584. * The height of the texture in pixels.
  140585. */
  140586. height: number;
  140587. /**
  140588. * The width of the texture in pixels.
  140589. */
  140590. width: number;
  140591. /**
  140592. * The index of the beginning of the data in the binary file.
  140593. */
  140594. dataPosition: number;
  140595. }
  140596. /**
  140597. * This groups tools to convert HDR texture to native colors array.
  140598. */
  140599. export class HDRTools {
  140600. private static Ldexp;
  140601. private static Rgbe2float;
  140602. private static readStringLine;
  140603. /**
  140604. * Reads header information from an RGBE texture stored in a native array.
  140605. * More information on this format are available here:
  140606. * https://en.wikipedia.org/wiki/RGBE_image_format
  140607. *
  140608. * @param uint8array The binary file stored in native array.
  140609. * @return The header information.
  140610. */
  140611. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  140612. /**
  140613. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  140614. * This RGBE texture needs to store the information as a panorama.
  140615. *
  140616. * More information on this format are available here:
  140617. * https://en.wikipedia.org/wiki/RGBE_image_format
  140618. *
  140619. * @param buffer The binary file stored in an array buffer.
  140620. * @param size The expected size of the extracted cubemap.
  140621. * @return The Cube Map information.
  140622. */
  140623. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  140624. /**
  140625. * Returns the pixels data extracted from an RGBE texture.
  140626. * This pixels will be stored left to right up to down in the R G B order in one array.
  140627. *
  140628. * More information on this format are available here:
  140629. * https://en.wikipedia.org/wiki/RGBE_image_format
  140630. *
  140631. * @param uint8array The binary file stored in an array buffer.
  140632. * @param hdrInfo The header information of the file.
  140633. * @return The pixels data in RGB right to left up to down order.
  140634. */
  140635. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  140636. private static RGBE_ReadPixels_RLE;
  140637. private static RGBE_ReadPixels_NOT_RLE;
  140638. }
  140639. }
  140640. declare module BABYLON {
  140641. /**
  140642. * Effect Render Options
  140643. */
  140644. export interface IEffectRendererOptions {
  140645. /**
  140646. * Defines the vertices positions.
  140647. */
  140648. positions?: number[];
  140649. /**
  140650. * Defines the indices.
  140651. */
  140652. indices?: number[];
  140653. }
  140654. /**
  140655. * Helper class to render one or more effects.
  140656. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  140657. */
  140658. export class EffectRenderer {
  140659. private engine;
  140660. private static _DefaultOptions;
  140661. private _vertexBuffers;
  140662. private _indexBuffer;
  140663. private _fullscreenViewport;
  140664. /**
  140665. * Creates an effect renderer
  140666. * @param engine the engine to use for rendering
  140667. * @param options defines the options of the effect renderer
  140668. */
  140669. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  140670. /**
  140671. * Sets the current viewport in normalized coordinates 0-1
  140672. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  140673. */
  140674. setViewport(viewport?: Viewport): void;
  140675. /**
  140676. * Binds the embedded attributes buffer to the effect.
  140677. * @param effect Defines the effect to bind the attributes for
  140678. */
  140679. bindBuffers(effect: Effect): void;
  140680. /**
  140681. * Sets the current effect wrapper to use during draw.
  140682. * The effect needs to be ready before calling this api.
  140683. * This also sets the default full screen position attribute.
  140684. * @param effectWrapper Defines the effect to draw with
  140685. */
  140686. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  140687. /**
  140688. * Restores engine states
  140689. */
  140690. restoreStates(): void;
  140691. /**
  140692. * Draws a full screen quad.
  140693. */
  140694. draw(): void;
  140695. private isRenderTargetTexture;
  140696. /**
  140697. * renders one or more effects to a specified texture
  140698. * @param effectWrapper the effect to renderer
  140699. * @param outputTexture texture to draw to, if null it will render to the screen.
  140700. */
  140701. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  140702. /**
  140703. * Disposes of the effect renderer
  140704. */
  140705. dispose(): void;
  140706. }
  140707. /**
  140708. * Options to create an EffectWrapper
  140709. */
  140710. interface EffectWrapperCreationOptions {
  140711. /**
  140712. * Engine to use to create the effect
  140713. */
  140714. engine: ThinEngine;
  140715. /**
  140716. * Fragment shader for the effect
  140717. */
  140718. fragmentShader: string;
  140719. /**
  140720. * Use the shader store instead of direct source code
  140721. */
  140722. useShaderStore?: boolean;
  140723. /**
  140724. * Vertex shader for the effect
  140725. */
  140726. vertexShader?: string;
  140727. /**
  140728. * Attributes to use in the shader
  140729. */
  140730. attributeNames?: Array<string>;
  140731. /**
  140732. * Uniforms to use in the shader
  140733. */
  140734. uniformNames?: Array<string>;
  140735. /**
  140736. * Texture sampler names to use in the shader
  140737. */
  140738. samplerNames?: Array<string>;
  140739. /**
  140740. * Defines to use in the shader
  140741. */
  140742. defines?: Array<string>;
  140743. /**
  140744. * Callback when effect is compiled
  140745. */
  140746. onCompiled?: Nullable<(effect: Effect) => void>;
  140747. /**
  140748. * The friendly name of the effect displayed in Spector.
  140749. */
  140750. name?: string;
  140751. }
  140752. /**
  140753. * Wraps an effect to be used for rendering
  140754. */
  140755. export class EffectWrapper {
  140756. /**
  140757. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  140758. */
  140759. onApplyObservable: Observable<{}>;
  140760. /**
  140761. * The underlying effect
  140762. */
  140763. effect: Effect;
  140764. /**
  140765. * Creates an effect to be renderer
  140766. * @param creationOptions options to create the effect
  140767. */
  140768. constructor(creationOptions: EffectWrapperCreationOptions);
  140769. /**
  140770. * Disposes of the effect wrapper
  140771. */
  140772. dispose(): void;
  140773. }
  140774. }
  140775. declare module BABYLON {
  140776. /** @hidden */
  140777. export var hdrFilteringVertexShader: {
  140778. name: string;
  140779. shader: string;
  140780. };
  140781. }
  140782. declare module BABYLON {
  140783. /** @hidden */
  140784. export var hdrFilteringPixelShader: {
  140785. name: string;
  140786. shader: string;
  140787. };
  140788. }
  140789. declare module BABYLON {
  140790. /**
  140791. * Options for texture filtering
  140792. */
  140793. interface IHDRFilteringOptions {
  140794. /**
  140795. * Scales pixel intensity for the input HDR map.
  140796. */
  140797. hdrScale?: number;
  140798. /**
  140799. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  140800. */
  140801. quality?: number;
  140802. }
  140803. /**
  140804. * Filters HDR maps to get correct renderings of PBR reflections
  140805. */
  140806. export class HDRFiltering {
  140807. private _engine;
  140808. private _effectRenderer;
  140809. private _effectWrapper;
  140810. private _lodGenerationOffset;
  140811. private _lodGenerationScale;
  140812. /**
  140813. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  140814. * you care about baking speed.
  140815. */
  140816. quality: number;
  140817. /**
  140818. * Scales pixel intensity for the input HDR map.
  140819. */
  140820. hdrScale: number;
  140821. /**
  140822. * Instantiates HDR filter for reflection maps
  140823. *
  140824. * @param engine Thin engine
  140825. * @param options Options
  140826. */
  140827. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  140828. private _createRenderTarget;
  140829. private _prefilterInternal;
  140830. private _createEffect;
  140831. /**
  140832. * Get a value indicating if the filter is ready to be used
  140833. * @param texture Texture to filter
  140834. * @returns true if the filter is ready
  140835. */
  140836. isReady(texture: BaseTexture): boolean;
  140837. /**
  140838. * Prefilters a cube texture to have mipmap levels representing roughness values.
  140839. * Prefiltering will be invoked at the end of next rendering pass.
  140840. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  140841. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  140842. * @param texture Texture to filter
  140843. * @param onFinished Callback when filtering is done
  140844. * @return Promise called when prefiltering is done
  140845. */
  140846. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  140847. }
  140848. }
  140849. declare module BABYLON {
  140850. /**
  140851. * This represents a texture coming from an HDR input.
  140852. *
  140853. * The only supported format is currently panorama picture stored in RGBE format.
  140854. * Example of such files can be found on HDRLib: http://hdrlib.com/
  140855. */
  140856. export class HDRCubeTexture extends BaseTexture {
  140857. private static _facesMapping;
  140858. private _generateHarmonics;
  140859. private _noMipmap;
  140860. private _prefilterOnLoad;
  140861. private _textureMatrix;
  140862. private _size;
  140863. private _onLoad;
  140864. private _onError;
  140865. /**
  140866. * The texture URL.
  140867. */
  140868. url: string;
  140869. protected _isBlocking: boolean;
  140870. /**
  140871. * Sets wether or not the texture is blocking during loading.
  140872. */
  140873. set isBlocking(value: boolean);
  140874. /**
  140875. * Gets wether or not the texture is blocking during loading.
  140876. */
  140877. get isBlocking(): boolean;
  140878. protected _rotationY: number;
  140879. /**
  140880. * Sets texture matrix rotation angle around Y axis in radians.
  140881. */
  140882. set rotationY(value: number);
  140883. /**
  140884. * Gets texture matrix rotation angle around Y axis radians.
  140885. */
  140886. get rotationY(): number;
  140887. /**
  140888. * Gets or sets the center of the bounding box associated with the cube texture
  140889. * It must define where the camera used to render the texture was set
  140890. */
  140891. boundingBoxPosition: Vector3;
  140892. private _boundingBoxSize;
  140893. /**
  140894. * Gets or sets the size of the bounding box associated with the cube texture
  140895. * When defined, the cubemap will switch to local mode
  140896. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  140897. * @example https://www.babylonjs-playground.com/#RNASML
  140898. */
  140899. set boundingBoxSize(value: Vector3);
  140900. get boundingBoxSize(): Vector3;
  140901. /**
  140902. * Instantiates an HDRTexture from the following parameters.
  140903. *
  140904. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  140905. * @param sceneOrEngine The scene or engine the texture will be used in
  140906. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140907. * @param noMipmap Forces to not generate the mipmap if true
  140908. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  140909. * @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)
  140910. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  140911. */
  140912. 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>);
  140913. /**
  140914. * Get the current class name of the texture useful for serialization or dynamic coding.
  140915. * @returns "HDRCubeTexture"
  140916. */
  140917. getClassName(): string;
  140918. /**
  140919. * Occurs when the file is raw .hdr file.
  140920. */
  140921. private loadTexture;
  140922. clone(): HDRCubeTexture;
  140923. delayLoad(): void;
  140924. /**
  140925. * Get the texture reflection matrix used to rotate/transform the reflection.
  140926. * @returns the reflection matrix
  140927. */
  140928. getReflectionTextureMatrix(): Matrix;
  140929. /**
  140930. * Set the texture reflection matrix used to rotate/transform the reflection.
  140931. * @param value Define the reflection matrix to set
  140932. */
  140933. setReflectionTextureMatrix(value: Matrix): void;
  140934. /**
  140935. * Parses a JSON representation of an HDR Texture in order to create the texture
  140936. * @param parsedTexture Define the JSON representation
  140937. * @param scene Define the scene the texture should be created in
  140938. * @param rootUrl Define the root url in case we need to load relative dependencies
  140939. * @returns the newly created texture after parsing
  140940. */
  140941. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  140942. serialize(): any;
  140943. }
  140944. }
  140945. declare module BABYLON {
  140946. /**
  140947. * Class used to control physics engine
  140948. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140949. */
  140950. export class PhysicsEngine implements IPhysicsEngine {
  140951. private _physicsPlugin;
  140952. /**
  140953. * Global value used to control the smallest number supported by the simulation
  140954. */
  140955. static Epsilon: number;
  140956. private _impostors;
  140957. private _joints;
  140958. private _subTimeStep;
  140959. /**
  140960. * Gets the gravity vector used by the simulation
  140961. */
  140962. gravity: Vector3;
  140963. /**
  140964. * Factory used to create the default physics plugin.
  140965. * @returns The default physics plugin
  140966. */
  140967. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140968. /**
  140969. * Creates a new Physics Engine
  140970. * @param gravity defines the gravity vector used by the simulation
  140971. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140972. */
  140973. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140974. /**
  140975. * Sets the gravity vector used by the simulation
  140976. * @param gravity defines the gravity vector to use
  140977. */
  140978. setGravity(gravity: Vector3): void;
  140979. /**
  140980. * Set the time step of the physics engine.
  140981. * Default is 1/60.
  140982. * To slow it down, enter 1/600 for example.
  140983. * To speed it up, 1/30
  140984. * @param newTimeStep defines the new timestep to apply to this world.
  140985. */
  140986. setTimeStep(newTimeStep?: number): void;
  140987. /**
  140988. * Get the time step of the physics engine.
  140989. * @returns the current time step
  140990. */
  140991. getTimeStep(): number;
  140992. /**
  140993. * Set the sub time step of the physics engine.
  140994. * Default is 0 meaning there is no sub steps
  140995. * To increase physics resolution precision, set a small value (like 1 ms)
  140996. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140997. */
  140998. setSubTimeStep(subTimeStep?: number): void;
  140999. /**
  141000. * Get the sub time step of the physics engine.
  141001. * @returns the current sub time step
  141002. */
  141003. getSubTimeStep(): number;
  141004. /**
  141005. * Release all resources
  141006. */
  141007. dispose(): void;
  141008. /**
  141009. * Gets the name of the current physics plugin
  141010. * @returns the name of the plugin
  141011. */
  141012. getPhysicsPluginName(): string;
  141013. /**
  141014. * Adding a new impostor for the impostor tracking.
  141015. * This will be done by the impostor itself.
  141016. * @param impostor the impostor to add
  141017. */
  141018. addImpostor(impostor: PhysicsImpostor): void;
  141019. /**
  141020. * Remove an impostor from the engine.
  141021. * This impostor and its mesh will not longer be updated by the physics engine.
  141022. * @param impostor the impostor to remove
  141023. */
  141024. removeImpostor(impostor: PhysicsImpostor): void;
  141025. /**
  141026. * Add a joint to the physics engine
  141027. * @param mainImpostor defines the main impostor to which the joint is added.
  141028. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  141029. * @param joint defines the joint that will connect both impostors.
  141030. */
  141031. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  141032. /**
  141033. * Removes a joint from the simulation
  141034. * @param mainImpostor defines the impostor used with the joint
  141035. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  141036. * @param joint defines the joint to remove
  141037. */
  141038. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  141039. /**
  141040. * Called by the scene. No need to call it.
  141041. * @param delta defines the timespam between frames
  141042. */
  141043. _step(delta: number): void;
  141044. /**
  141045. * Gets the current plugin used to run the simulation
  141046. * @returns current plugin
  141047. */
  141048. getPhysicsPlugin(): IPhysicsEnginePlugin;
  141049. /**
  141050. * Gets the list of physic impostors
  141051. * @returns an array of PhysicsImpostor
  141052. */
  141053. getImpostors(): Array<PhysicsImpostor>;
  141054. /**
  141055. * Gets the impostor for a physics enabled object
  141056. * @param object defines the object impersonated by the impostor
  141057. * @returns the PhysicsImpostor or null if not found
  141058. */
  141059. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  141060. /**
  141061. * Gets the impostor for a physics body object
  141062. * @param body defines physics body used by the impostor
  141063. * @returns the PhysicsImpostor or null if not found
  141064. */
  141065. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  141066. /**
  141067. * Does a raycast in the physics world
  141068. * @param from when should the ray start?
  141069. * @param to when should the ray end?
  141070. * @returns PhysicsRaycastResult
  141071. */
  141072. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141073. }
  141074. }
  141075. declare module BABYLON {
  141076. /** @hidden */
  141077. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  141078. private _useDeltaForWorldStep;
  141079. world: any;
  141080. name: string;
  141081. private _physicsMaterials;
  141082. private _fixedTimeStep;
  141083. private _cannonRaycastResult;
  141084. private _raycastResult;
  141085. private _physicsBodysToRemoveAfterStep;
  141086. private _firstFrame;
  141087. BJSCANNON: any;
  141088. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  141089. setGravity(gravity: Vector3): void;
  141090. setTimeStep(timeStep: number): void;
  141091. getTimeStep(): number;
  141092. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  141093. private _removeMarkedPhysicsBodiesFromWorld;
  141094. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141095. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141096. generatePhysicsBody(impostor: PhysicsImpostor): void;
  141097. private _processChildMeshes;
  141098. removePhysicsBody(impostor: PhysicsImpostor): void;
  141099. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  141100. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  141101. private _addMaterial;
  141102. private _checkWithEpsilon;
  141103. private _createShape;
  141104. private _createHeightmap;
  141105. private _minus90X;
  141106. private _plus90X;
  141107. private _tmpPosition;
  141108. private _tmpDeltaPosition;
  141109. private _tmpUnityRotation;
  141110. private _updatePhysicsBodyTransformation;
  141111. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  141112. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  141113. isSupported(): boolean;
  141114. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141115. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141116. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141117. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141118. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  141119. getBodyMass(impostor: PhysicsImpostor): number;
  141120. getBodyFriction(impostor: PhysicsImpostor): number;
  141121. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  141122. getBodyRestitution(impostor: PhysicsImpostor): number;
  141123. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  141124. sleepBody(impostor: PhysicsImpostor): void;
  141125. wakeUpBody(impostor: PhysicsImpostor): void;
  141126. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  141127. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  141128. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  141129. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  141130. getRadius(impostor: PhysicsImpostor): number;
  141131. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  141132. dispose(): void;
  141133. private _extendNamespace;
  141134. /**
  141135. * Does a raycast in the physics world
  141136. * @param from when should the ray start?
  141137. * @param to when should the ray end?
  141138. * @returns PhysicsRaycastResult
  141139. */
  141140. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141141. }
  141142. }
  141143. declare module BABYLON {
  141144. /** @hidden */
  141145. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  141146. private _useDeltaForWorldStep;
  141147. world: any;
  141148. name: string;
  141149. BJSOIMO: any;
  141150. private _raycastResult;
  141151. private _fixedTimeStep;
  141152. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  141153. setGravity(gravity: Vector3): void;
  141154. setTimeStep(timeStep: number): void;
  141155. getTimeStep(): number;
  141156. private _tmpImpostorsArray;
  141157. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  141158. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141159. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141160. generatePhysicsBody(impostor: PhysicsImpostor): void;
  141161. private _tmpPositionVector;
  141162. removePhysicsBody(impostor: PhysicsImpostor): void;
  141163. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  141164. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  141165. isSupported(): boolean;
  141166. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  141167. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  141168. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141169. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141170. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141171. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141172. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  141173. getBodyMass(impostor: PhysicsImpostor): number;
  141174. getBodyFriction(impostor: PhysicsImpostor): number;
  141175. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  141176. getBodyRestitution(impostor: PhysicsImpostor): number;
  141177. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  141178. sleepBody(impostor: PhysicsImpostor): void;
  141179. wakeUpBody(impostor: PhysicsImpostor): void;
  141180. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  141181. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  141182. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  141183. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  141184. getRadius(impostor: PhysicsImpostor): number;
  141185. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  141186. dispose(): void;
  141187. /**
  141188. * Does a raycast in the physics world
  141189. * @param from when should the ray start?
  141190. * @param to when should the ray end?
  141191. * @returns PhysicsRaycastResult
  141192. */
  141193. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141194. }
  141195. }
  141196. declare module BABYLON {
  141197. /**
  141198. * AmmoJS Physics plugin
  141199. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  141200. * @see https://github.com/kripken/ammo.js/
  141201. */
  141202. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  141203. private _useDeltaForWorldStep;
  141204. /**
  141205. * Reference to the Ammo library
  141206. */
  141207. bjsAMMO: any;
  141208. /**
  141209. * Created ammoJS world which physics bodies are added to
  141210. */
  141211. world: any;
  141212. /**
  141213. * Name of the plugin
  141214. */
  141215. name: string;
  141216. private _timeStep;
  141217. private _fixedTimeStep;
  141218. private _maxSteps;
  141219. private _tmpQuaternion;
  141220. private _tmpAmmoTransform;
  141221. private _tmpAmmoQuaternion;
  141222. private _tmpAmmoConcreteContactResultCallback;
  141223. private _collisionConfiguration;
  141224. private _dispatcher;
  141225. private _overlappingPairCache;
  141226. private _solver;
  141227. private _softBodySolver;
  141228. private _tmpAmmoVectorA;
  141229. private _tmpAmmoVectorB;
  141230. private _tmpAmmoVectorC;
  141231. private _tmpAmmoVectorD;
  141232. private _tmpContactCallbackResult;
  141233. private _tmpAmmoVectorRCA;
  141234. private _tmpAmmoVectorRCB;
  141235. private _raycastResult;
  141236. private static readonly DISABLE_COLLISION_FLAG;
  141237. private static readonly KINEMATIC_FLAG;
  141238. private static readonly DISABLE_DEACTIVATION_FLAG;
  141239. /**
  141240. * Initializes the ammoJS plugin
  141241. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  141242. * @param ammoInjection can be used to inject your own ammo reference
  141243. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  141244. */
  141245. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  141246. /**
  141247. * Sets the gravity of the physics world (m/(s^2))
  141248. * @param gravity Gravity to set
  141249. */
  141250. setGravity(gravity: Vector3): void;
  141251. /**
  141252. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  141253. * @param timeStep timestep to use in seconds
  141254. */
  141255. setTimeStep(timeStep: number): void;
  141256. /**
  141257. * 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)
  141258. * @param fixedTimeStep fixedTimeStep to use in seconds
  141259. */
  141260. setFixedTimeStep(fixedTimeStep: number): void;
  141261. /**
  141262. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  141263. * @param maxSteps the maximum number of steps by the physics engine per frame
  141264. */
  141265. setMaxSteps(maxSteps: number): void;
  141266. /**
  141267. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  141268. * @returns the current timestep in seconds
  141269. */
  141270. getTimeStep(): number;
  141271. /**
  141272. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  141273. */
  141274. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  141275. private _isImpostorInContact;
  141276. private _isImpostorPairInContact;
  141277. private _stepSimulation;
  141278. /**
  141279. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  141280. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  141281. * After the step the babylon meshes are set to the position of the physics imposters
  141282. * @param delta amount of time to step forward
  141283. * @param impostors array of imposters to update before/after the step
  141284. */
  141285. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  141286. /**
  141287. * Update babylon mesh to match physics world object
  141288. * @param impostor imposter to match
  141289. */
  141290. private _afterSoftStep;
  141291. /**
  141292. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  141293. * @param impostor imposter to match
  141294. */
  141295. private _ropeStep;
  141296. /**
  141297. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  141298. * @param impostor imposter to match
  141299. */
  141300. private _softbodyOrClothStep;
  141301. private _tmpMatrix;
  141302. /**
  141303. * Applies an impulse on the imposter
  141304. * @param impostor imposter to apply impulse to
  141305. * @param force amount of force to be applied to the imposter
  141306. * @param contactPoint the location to apply the impulse on the imposter
  141307. */
  141308. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141309. /**
  141310. * Applies a force on the imposter
  141311. * @param impostor imposter to apply force
  141312. * @param force amount of force to be applied to the imposter
  141313. * @param contactPoint the location to apply the force on the imposter
  141314. */
  141315. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141316. /**
  141317. * Creates a physics body using the plugin
  141318. * @param impostor the imposter to create the physics body on
  141319. */
  141320. generatePhysicsBody(impostor: PhysicsImpostor): void;
  141321. /**
  141322. * Removes the physics body from the imposter and disposes of the body's memory
  141323. * @param impostor imposter to remove the physics body from
  141324. */
  141325. removePhysicsBody(impostor: PhysicsImpostor): void;
  141326. /**
  141327. * Generates a joint
  141328. * @param impostorJoint the imposter joint to create the joint with
  141329. */
  141330. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  141331. /**
  141332. * Removes a joint
  141333. * @param impostorJoint the imposter joint to remove the joint from
  141334. */
  141335. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  141336. private _addMeshVerts;
  141337. /**
  141338. * Initialise the soft body vertices to match its object's (mesh) vertices
  141339. * Softbody vertices (nodes) are in world space and to match this
  141340. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  141341. * @param impostor to create the softbody for
  141342. */
  141343. private _softVertexData;
  141344. /**
  141345. * Create an impostor's soft body
  141346. * @param impostor to create the softbody for
  141347. */
  141348. private _createSoftbody;
  141349. /**
  141350. * Create cloth for an impostor
  141351. * @param impostor to create the softbody for
  141352. */
  141353. private _createCloth;
  141354. /**
  141355. * Create rope for an impostor
  141356. * @param impostor to create the softbody for
  141357. */
  141358. private _createRope;
  141359. /**
  141360. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  141361. * @param impostor to create the custom physics shape for
  141362. */
  141363. private _createCustom;
  141364. private _addHullVerts;
  141365. private _createShape;
  141366. /**
  141367. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  141368. * @param impostor imposter containing the physics body and babylon object
  141369. */
  141370. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  141371. /**
  141372. * Sets the babylon object's position/rotation from the physics body's position/rotation
  141373. * @param impostor imposter containing the physics body and babylon object
  141374. * @param newPosition new position
  141375. * @param newRotation new rotation
  141376. */
  141377. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  141378. /**
  141379. * If this plugin is supported
  141380. * @returns true if its supported
  141381. */
  141382. isSupported(): boolean;
  141383. /**
  141384. * Sets the linear velocity of the physics body
  141385. * @param impostor imposter to set the velocity on
  141386. * @param velocity velocity to set
  141387. */
  141388. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141389. /**
  141390. * Sets the angular velocity of the physics body
  141391. * @param impostor imposter to set the velocity on
  141392. * @param velocity velocity to set
  141393. */
  141394. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141395. /**
  141396. * gets the linear velocity
  141397. * @param impostor imposter to get linear velocity from
  141398. * @returns linear velocity
  141399. */
  141400. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141401. /**
  141402. * gets the angular velocity
  141403. * @param impostor imposter to get angular velocity from
  141404. * @returns angular velocity
  141405. */
  141406. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141407. /**
  141408. * Sets the mass of physics body
  141409. * @param impostor imposter to set the mass on
  141410. * @param mass mass to set
  141411. */
  141412. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  141413. /**
  141414. * Gets the mass of the physics body
  141415. * @param impostor imposter to get the mass from
  141416. * @returns mass
  141417. */
  141418. getBodyMass(impostor: PhysicsImpostor): number;
  141419. /**
  141420. * Gets friction of the impostor
  141421. * @param impostor impostor to get friction from
  141422. * @returns friction value
  141423. */
  141424. getBodyFriction(impostor: PhysicsImpostor): number;
  141425. /**
  141426. * Sets friction of the impostor
  141427. * @param impostor impostor to set friction on
  141428. * @param friction friction value
  141429. */
  141430. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  141431. /**
  141432. * Gets restitution of the impostor
  141433. * @param impostor impostor to get restitution from
  141434. * @returns restitution value
  141435. */
  141436. getBodyRestitution(impostor: PhysicsImpostor): number;
  141437. /**
  141438. * Sets resitution of the impostor
  141439. * @param impostor impostor to set resitution on
  141440. * @param restitution resitution value
  141441. */
  141442. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  141443. /**
  141444. * Gets pressure inside the impostor
  141445. * @param impostor impostor to get pressure from
  141446. * @returns pressure value
  141447. */
  141448. getBodyPressure(impostor: PhysicsImpostor): number;
  141449. /**
  141450. * Sets pressure inside a soft body impostor
  141451. * Cloth and rope must remain 0 pressure
  141452. * @param impostor impostor to set pressure on
  141453. * @param pressure pressure value
  141454. */
  141455. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  141456. /**
  141457. * Gets stiffness of the impostor
  141458. * @param impostor impostor to get stiffness from
  141459. * @returns pressure value
  141460. */
  141461. getBodyStiffness(impostor: PhysicsImpostor): number;
  141462. /**
  141463. * Sets stiffness of the impostor
  141464. * @param impostor impostor to set stiffness on
  141465. * @param stiffness stiffness value from 0 to 1
  141466. */
  141467. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  141468. /**
  141469. * Gets velocityIterations of the impostor
  141470. * @param impostor impostor to get velocity iterations from
  141471. * @returns velocityIterations value
  141472. */
  141473. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  141474. /**
  141475. * Sets velocityIterations of the impostor
  141476. * @param impostor impostor to set velocity iterations on
  141477. * @param velocityIterations velocityIterations value
  141478. */
  141479. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  141480. /**
  141481. * Gets positionIterations of the impostor
  141482. * @param impostor impostor to get position iterations from
  141483. * @returns positionIterations value
  141484. */
  141485. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  141486. /**
  141487. * Sets positionIterations of the impostor
  141488. * @param impostor impostor to set position on
  141489. * @param positionIterations positionIterations value
  141490. */
  141491. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  141492. /**
  141493. * Append an anchor to a cloth object
  141494. * @param impostor is the cloth impostor to add anchor to
  141495. * @param otherImpostor is the rigid impostor to anchor to
  141496. * @param width ratio across width from 0 to 1
  141497. * @param height ratio up height from 0 to 1
  141498. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  141499. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  141500. */
  141501. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  141502. /**
  141503. * Append an hook to a rope object
  141504. * @param impostor is the rope impostor to add hook to
  141505. * @param otherImpostor is the rigid impostor to hook to
  141506. * @param length ratio along the rope from 0 to 1
  141507. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  141508. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  141509. */
  141510. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  141511. /**
  141512. * Sleeps the physics body and stops it from being active
  141513. * @param impostor impostor to sleep
  141514. */
  141515. sleepBody(impostor: PhysicsImpostor): void;
  141516. /**
  141517. * Activates the physics body
  141518. * @param impostor impostor to activate
  141519. */
  141520. wakeUpBody(impostor: PhysicsImpostor): void;
  141521. /**
  141522. * Updates the distance parameters of the joint
  141523. * @param joint joint to update
  141524. * @param maxDistance maximum distance of the joint
  141525. * @param minDistance minimum distance of the joint
  141526. */
  141527. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  141528. /**
  141529. * Sets a motor on the joint
  141530. * @param joint joint to set motor on
  141531. * @param speed speed of the motor
  141532. * @param maxForce maximum force of the motor
  141533. * @param motorIndex index of the motor
  141534. */
  141535. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  141536. /**
  141537. * Sets the motors limit
  141538. * @param joint joint to set limit on
  141539. * @param upperLimit upper limit
  141540. * @param lowerLimit lower limit
  141541. */
  141542. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  141543. /**
  141544. * Syncs the position and rotation of a mesh with the impostor
  141545. * @param mesh mesh to sync
  141546. * @param impostor impostor to update the mesh with
  141547. */
  141548. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  141549. /**
  141550. * Gets the radius of the impostor
  141551. * @param impostor impostor to get radius from
  141552. * @returns the radius
  141553. */
  141554. getRadius(impostor: PhysicsImpostor): number;
  141555. /**
  141556. * Gets the box size of the impostor
  141557. * @param impostor impostor to get box size from
  141558. * @param result the resulting box size
  141559. */
  141560. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  141561. /**
  141562. * Disposes of the impostor
  141563. */
  141564. dispose(): void;
  141565. /**
  141566. * Does a raycast in the physics world
  141567. * @param from when should the ray start?
  141568. * @param to when should the ray end?
  141569. * @returns PhysicsRaycastResult
  141570. */
  141571. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141572. }
  141573. }
  141574. declare module BABYLON {
  141575. interface AbstractScene {
  141576. /**
  141577. * The list of reflection probes added to the scene
  141578. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  141579. */
  141580. reflectionProbes: Array<ReflectionProbe>;
  141581. /**
  141582. * Removes the given reflection probe from this scene.
  141583. * @param toRemove The reflection probe to remove
  141584. * @returns The index of the removed reflection probe
  141585. */
  141586. removeReflectionProbe(toRemove: ReflectionProbe): number;
  141587. /**
  141588. * Adds the given reflection probe to this scene.
  141589. * @param newReflectionProbe The reflection probe to add
  141590. */
  141591. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  141592. }
  141593. /**
  141594. * Class used to generate realtime reflection / refraction cube textures
  141595. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  141596. */
  141597. export class ReflectionProbe {
  141598. /** defines the name of the probe */
  141599. name: string;
  141600. private _scene;
  141601. private _renderTargetTexture;
  141602. private _projectionMatrix;
  141603. private _viewMatrix;
  141604. private _target;
  141605. private _add;
  141606. private _attachedMesh;
  141607. private _invertYAxis;
  141608. /** Gets or sets probe position (center of the cube map) */
  141609. position: Vector3;
  141610. /**
  141611. * Creates a new reflection probe
  141612. * @param name defines the name of the probe
  141613. * @param size defines the texture resolution (for each face)
  141614. * @param scene defines the hosting scene
  141615. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  141616. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  141617. */
  141618. constructor(
  141619. /** defines the name of the probe */
  141620. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  141621. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  141622. get samples(): number;
  141623. set samples(value: number);
  141624. /** Gets or sets the refresh rate to use (on every frame by default) */
  141625. get refreshRate(): number;
  141626. set refreshRate(value: number);
  141627. /**
  141628. * Gets the hosting scene
  141629. * @returns a Scene
  141630. */
  141631. getScene(): Scene;
  141632. /** Gets the internal CubeTexture used to render to */
  141633. get cubeTexture(): RenderTargetTexture;
  141634. /** Gets the list of meshes to render */
  141635. get renderList(): Nullable<AbstractMesh[]>;
  141636. /**
  141637. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  141638. * @param mesh defines the mesh to attach to
  141639. */
  141640. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  141641. /**
  141642. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  141643. * @param renderingGroupId The rendering group id corresponding to its index
  141644. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  141645. */
  141646. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  141647. /**
  141648. * Clean all associated resources
  141649. */
  141650. dispose(): void;
  141651. /**
  141652. * Converts the reflection probe information to a readable string for debug purpose.
  141653. * @param fullDetails Supports for multiple levels of logging within scene loading
  141654. * @returns the human readable reflection probe info
  141655. */
  141656. toString(fullDetails?: boolean): string;
  141657. /**
  141658. * Get the class name of the relfection probe.
  141659. * @returns "ReflectionProbe"
  141660. */
  141661. getClassName(): string;
  141662. /**
  141663. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  141664. * @returns The JSON representation of the texture
  141665. */
  141666. serialize(): any;
  141667. /**
  141668. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  141669. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  141670. * @param scene Define the scene the parsed reflection probe should be instantiated in
  141671. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  141672. * @returns The parsed reflection probe if successful
  141673. */
  141674. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  141675. }
  141676. }
  141677. declare module BABYLON {
  141678. /** @hidden */
  141679. export var _BabylonLoaderRegistered: boolean;
  141680. /**
  141681. * Helps setting up some configuration for the babylon file loader.
  141682. */
  141683. export class BabylonFileLoaderConfiguration {
  141684. /**
  141685. * The loader does not allow injecting custom physix engine into the plugins.
  141686. * Unfortunately in ES6, we need to manually inject them into the plugin.
  141687. * So you could set this variable to your engine import to make it work.
  141688. */
  141689. static LoaderInjectedPhysicsEngine: any;
  141690. }
  141691. }
  141692. declare module BABYLON {
  141693. /**
  141694. * The Physically based simple base material of BJS.
  141695. *
  141696. * This enables better naming and convention enforcements on top of the pbrMaterial.
  141697. * It is used as the base class for both the specGloss and metalRough conventions.
  141698. */
  141699. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  141700. /**
  141701. * Number of Simultaneous lights allowed on the material.
  141702. */
  141703. maxSimultaneousLights: number;
  141704. /**
  141705. * If sets to true, disables all the lights affecting the material.
  141706. */
  141707. disableLighting: boolean;
  141708. /**
  141709. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  141710. */
  141711. environmentTexture: BaseTexture;
  141712. /**
  141713. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  141714. */
  141715. invertNormalMapX: boolean;
  141716. /**
  141717. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  141718. */
  141719. invertNormalMapY: boolean;
  141720. /**
  141721. * Normal map used in the model.
  141722. */
  141723. normalTexture: BaseTexture;
  141724. /**
  141725. * Emissivie color used to self-illuminate the model.
  141726. */
  141727. emissiveColor: Color3;
  141728. /**
  141729. * Emissivie texture used to self-illuminate the model.
  141730. */
  141731. emissiveTexture: BaseTexture;
  141732. /**
  141733. * Occlusion Channel Strenght.
  141734. */
  141735. occlusionStrength: number;
  141736. /**
  141737. * Occlusion Texture of the material (adding extra occlusion effects).
  141738. */
  141739. occlusionTexture: BaseTexture;
  141740. /**
  141741. * Defines the alpha limits in alpha test mode.
  141742. */
  141743. alphaCutOff: number;
  141744. /**
  141745. * Gets the current double sided mode.
  141746. */
  141747. get doubleSided(): boolean;
  141748. /**
  141749. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  141750. */
  141751. set doubleSided(value: boolean);
  141752. /**
  141753. * Stores the pre-calculated light information of a mesh in a texture.
  141754. */
  141755. lightmapTexture: BaseTexture;
  141756. /**
  141757. * If true, the light map contains occlusion information instead of lighting info.
  141758. */
  141759. useLightmapAsShadowmap: boolean;
  141760. /**
  141761. * Instantiates a new PBRMaterial instance.
  141762. *
  141763. * @param name The material name
  141764. * @param scene The scene the material will be use in.
  141765. */
  141766. constructor(name: string, scene: Scene);
  141767. getClassName(): string;
  141768. }
  141769. }
  141770. declare module BABYLON {
  141771. /**
  141772. * The PBR material of BJS following the metal roughness convention.
  141773. *
  141774. * This fits to the PBR convention in the GLTF definition:
  141775. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  141776. */
  141777. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  141778. /**
  141779. * The base color has two different interpretations depending on the value of metalness.
  141780. * When the material is a metal, the base color is the specific measured reflectance value
  141781. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  141782. * of the material.
  141783. */
  141784. baseColor: Color3;
  141785. /**
  141786. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  141787. * well as opacity information in the alpha channel.
  141788. */
  141789. baseTexture: BaseTexture;
  141790. /**
  141791. * Specifies the metallic scalar value of the material.
  141792. * Can also be used to scale the metalness values of the metallic texture.
  141793. */
  141794. metallic: number;
  141795. /**
  141796. * Specifies the roughness scalar value of the material.
  141797. * Can also be used to scale the roughness values of the metallic texture.
  141798. */
  141799. roughness: number;
  141800. /**
  141801. * Texture containing both the metallic value in the B channel and the
  141802. * roughness value in the G channel to keep better precision.
  141803. */
  141804. metallicRoughnessTexture: BaseTexture;
  141805. /**
  141806. * Instantiates a new PBRMetalRoughnessMaterial instance.
  141807. *
  141808. * @param name The material name
  141809. * @param scene The scene the material will be use in.
  141810. */
  141811. constructor(name: string, scene: Scene);
  141812. /**
  141813. * Return the currrent class name of the material.
  141814. */
  141815. getClassName(): string;
  141816. /**
  141817. * Makes a duplicate of the current material.
  141818. * @param name - name to use for the new material.
  141819. */
  141820. clone(name: string): PBRMetallicRoughnessMaterial;
  141821. /**
  141822. * Serialize the material to a parsable JSON object.
  141823. */
  141824. serialize(): any;
  141825. /**
  141826. * Parses a JSON object correponding to the serialize function.
  141827. */
  141828. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  141829. }
  141830. }
  141831. declare module BABYLON {
  141832. /**
  141833. * The PBR material of BJS following the specular glossiness convention.
  141834. *
  141835. * This fits to the PBR convention in the GLTF definition:
  141836. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  141837. */
  141838. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  141839. /**
  141840. * Specifies the diffuse color of the material.
  141841. */
  141842. diffuseColor: Color3;
  141843. /**
  141844. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  141845. * channel.
  141846. */
  141847. diffuseTexture: BaseTexture;
  141848. /**
  141849. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  141850. */
  141851. specularColor: Color3;
  141852. /**
  141853. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  141854. */
  141855. glossiness: number;
  141856. /**
  141857. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  141858. */
  141859. specularGlossinessTexture: BaseTexture;
  141860. /**
  141861. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  141862. *
  141863. * @param name The material name
  141864. * @param scene The scene the material will be use in.
  141865. */
  141866. constructor(name: string, scene: Scene);
  141867. /**
  141868. * Return the currrent class name of the material.
  141869. */
  141870. getClassName(): string;
  141871. /**
  141872. * Makes a duplicate of the current material.
  141873. * @param name - name to use for the new material.
  141874. */
  141875. clone(name: string): PBRSpecularGlossinessMaterial;
  141876. /**
  141877. * Serialize the material to a parsable JSON object.
  141878. */
  141879. serialize(): any;
  141880. /**
  141881. * Parses a JSON object correponding to the serialize function.
  141882. */
  141883. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  141884. }
  141885. }
  141886. declare module BABYLON {
  141887. /**
  141888. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  141889. * It can help converting any input color in a desired output one. This can then be used to create effects
  141890. * from sepia, black and white to sixties or futuristic rendering...
  141891. *
  141892. * The only supported format is currently 3dl.
  141893. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  141894. */
  141895. export class ColorGradingTexture extends BaseTexture {
  141896. /**
  141897. * The texture URL.
  141898. */
  141899. url: string;
  141900. /**
  141901. * Empty line regex stored for GC.
  141902. */
  141903. private static _noneEmptyLineRegex;
  141904. private _textureMatrix;
  141905. private _onLoad;
  141906. /**
  141907. * Instantiates a ColorGradingTexture from the following parameters.
  141908. *
  141909. * @param url The location of the color gradind data (currently only supporting 3dl)
  141910. * @param sceneOrEngine The scene or engine the texture will be used in
  141911. * @param onLoad defines a callback triggered when the texture has been loaded
  141912. */
  141913. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  141914. /**
  141915. * Fires the onload event from the constructor if requested.
  141916. */
  141917. private _triggerOnLoad;
  141918. /**
  141919. * Returns the texture matrix used in most of the material.
  141920. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  141921. */
  141922. getTextureMatrix(): Matrix;
  141923. /**
  141924. * Occurs when the file being loaded is a .3dl LUT file.
  141925. */
  141926. private load3dlTexture;
  141927. /**
  141928. * Starts the loading process of the texture.
  141929. */
  141930. private loadTexture;
  141931. /**
  141932. * Clones the color gradind texture.
  141933. */
  141934. clone(): ColorGradingTexture;
  141935. /**
  141936. * Called during delayed load for textures.
  141937. */
  141938. delayLoad(): void;
  141939. /**
  141940. * Parses a color grading texture serialized by Babylon.
  141941. * @param parsedTexture The texture information being parsedTexture
  141942. * @param scene The scene to load the texture in
  141943. * @param rootUrl The root url of the data assets to load
  141944. * @return A color gradind texture
  141945. */
  141946. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  141947. /**
  141948. * Serializes the LUT texture to json format.
  141949. */
  141950. serialize(): any;
  141951. }
  141952. }
  141953. declare module BABYLON {
  141954. /**
  141955. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141956. */
  141957. export class EquiRectangularCubeTexture extends BaseTexture {
  141958. /** The six faces of the cube. */
  141959. private static _FacesMapping;
  141960. private _noMipmap;
  141961. private _onLoad;
  141962. private _onError;
  141963. /** The size of the cubemap. */
  141964. private _size;
  141965. /** The buffer of the image. */
  141966. private _buffer;
  141967. /** The width of the input image. */
  141968. private _width;
  141969. /** The height of the input image. */
  141970. private _height;
  141971. /** The URL to the image. */
  141972. url: string;
  141973. /**
  141974. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141975. * @param url The location of the image
  141976. * @param scene The scene the texture will be used in
  141977. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141978. * @param noMipmap Forces to not generate the mipmap if true
  141979. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141980. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141981. * @param onLoad — defines a callback called when texture is loaded
  141982. * @param onError — defines a callback called if there is an error
  141983. */
  141984. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141985. /**
  141986. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141987. */
  141988. private loadImage;
  141989. /**
  141990. * Convert the image buffer into a cubemap and create a CubeTexture.
  141991. */
  141992. private loadTexture;
  141993. /**
  141994. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141995. * @param buffer The ArrayBuffer that should be converted.
  141996. * @returns The buffer as Float32Array.
  141997. */
  141998. private getFloat32ArrayFromArrayBuffer;
  141999. /**
  142000. * Get the current class name of the texture useful for serialization or dynamic coding.
  142001. * @returns "EquiRectangularCubeTexture"
  142002. */
  142003. getClassName(): string;
  142004. /**
  142005. * Create a clone of the current EquiRectangularCubeTexture and return it.
  142006. * @returns A clone of the current EquiRectangularCubeTexture.
  142007. */
  142008. clone(): EquiRectangularCubeTexture;
  142009. }
  142010. }
  142011. declare module BABYLON {
  142012. /**
  142013. * Defines the options related to the creation of an HtmlElementTexture
  142014. */
  142015. export interface IHtmlElementTextureOptions {
  142016. /**
  142017. * Defines wether mip maps should be created or not.
  142018. */
  142019. generateMipMaps?: boolean;
  142020. /**
  142021. * Defines the sampling mode of the texture.
  142022. */
  142023. samplingMode?: number;
  142024. /**
  142025. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  142026. */
  142027. engine: Nullable<ThinEngine>;
  142028. /**
  142029. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  142030. */
  142031. scene: Nullable<Scene>;
  142032. }
  142033. /**
  142034. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  142035. * To be as efficient as possible depending on your constraints nothing aside the first upload
  142036. * is automatically managed.
  142037. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  142038. * in your application.
  142039. *
  142040. * As the update is not automatic, you need to call them manually.
  142041. */
  142042. export class HtmlElementTexture extends BaseTexture {
  142043. /**
  142044. * The texture URL.
  142045. */
  142046. element: HTMLVideoElement | HTMLCanvasElement;
  142047. private static readonly DefaultOptions;
  142048. private _textureMatrix;
  142049. private _isVideo;
  142050. private _generateMipMaps;
  142051. private _samplingMode;
  142052. /**
  142053. * Instantiates a HtmlElementTexture from the following parameters.
  142054. *
  142055. * @param name Defines the name of the texture
  142056. * @param element Defines the video or canvas the texture is filled with
  142057. * @param options Defines the other none mandatory texture creation options
  142058. */
  142059. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  142060. private _createInternalTexture;
  142061. /**
  142062. * Returns the texture matrix used in most of the material.
  142063. */
  142064. getTextureMatrix(): Matrix;
  142065. /**
  142066. * Updates the content of the texture.
  142067. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  142068. */
  142069. update(invertY?: Nullable<boolean>): void;
  142070. }
  142071. }
  142072. declare module BABYLON {
  142073. /**
  142074. * Based on jsTGALoader - Javascript loader for TGA file
  142075. * By Vincent Thibault
  142076. * @see http://blog.robrowser.com/javascript-tga-loader.html
  142077. */
  142078. export class TGATools {
  142079. private static _TYPE_INDEXED;
  142080. private static _TYPE_RGB;
  142081. private static _TYPE_GREY;
  142082. private static _TYPE_RLE_INDEXED;
  142083. private static _TYPE_RLE_RGB;
  142084. private static _TYPE_RLE_GREY;
  142085. private static _ORIGIN_MASK;
  142086. private static _ORIGIN_SHIFT;
  142087. private static _ORIGIN_BL;
  142088. private static _ORIGIN_BR;
  142089. private static _ORIGIN_UL;
  142090. private static _ORIGIN_UR;
  142091. /**
  142092. * Gets the header of a TGA file
  142093. * @param data defines the TGA data
  142094. * @returns the header
  142095. */
  142096. static GetTGAHeader(data: Uint8Array): any;
  142097. /**
  142098. * Uploads TGA content to a Babylon Texture
  142099. * @hidden
  142100. */
  142101. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  142102. /** @hidden */
  142103. 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;
  142104. /** @hidden */
  142105. 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;
  142106. /** @hidden */
  142107. 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;
  142108. /** @hidden */
  142109. 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;
  142110. /** @hidden */
  142111. 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;
  142112. /** @hidden */
  142113. 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;
  142114. }
  142115. }
  142116. declare module BABYLON {
  142117. /**
  142118. * Implementation of the TGA Texture Loader.
  142119. * @hidden
  142120. */
  142121. export class _TGATextureLoader implements IInternalTextureLoader {
  142122. /**
  142123. * Defines wether the loader supports cascade loading the different faces.
  142124. */
  142125. readonly supportCascades: boolean;
  142126. /**
  142127. * This returns if the loader support the current file information.
  142128. * @param extension defines the file extension of the file being loaded
  142129. * @returns true if the loader can load the specified file
  142130. */
  142131. canLoad(extension: string): boolean;
  142132. /**
  142133. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  142134. * @param data contains the texture data
  142135. * @param texture defines the BabylonJS internal texture
  142136. * @param createPolynomials will be true if polynomials have been requested
  142137. * @param onLoad defines the callback to trigger once the texture is ready
  142138. * @param onError defines the callback to trigger in case of error
  142139. */
  142140. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  142141. /**
  142142. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  142143. * @param data contains the texture data
  142144. * @param texture defines the BabylonJS internal texture
  142145. * @param callback defines the method to call once ready to upload
  142146. */
  142147. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  142148. }
  142149. }
  142150. declare module BABYLON {
  142151. /**
  142152. * Info about the .basis files
  142153. */
  142154. class BasisFileInfo {
  142155. /**
  142156. * If the file has alpha
  142157. */
  142158. hasAlpha: boolean;
  142159. /**
  142160. * Info about each image of the basis file
  142161. */
  142162. images: Array<{
  142163. levels: Array<{
  142164. width: number;
  142165. height: number;
  142166. transcodedPixels: ArrayBufferView;
  142167. }>;
  142168. }>;
  142169. }
  142170. /**
  142171. * Result of transcoding a basis file
  142172. */
  142173. class TranscodeResult {
  142174. /**
  142175. * Info about the .basis file
  142176. */
  142177. fileInfo: BasisFileInfo;
  142178. /**
  142179. * Format to use when loading the file
  142180. */
  142181. format: number;
  142182. }
  142183. /**
  142184. * Configuration options for the Basis transcoder
  142185. */
  142186. export class BasisTranscodeConfiguration {
  142187. /**
  142188. * Supported compression formats used to determine the supported output format of the transcoder
  142189. */
  142190. supportedCompressionFormats?: {
  142191. /**
  142192. * etc1 compression format
  142193. */
  142194. etc1?: boolean;
  142195. /**
  142196. * s3tc compression format
  142197. */
  142198. s3tc?: boolean;
  142199. /**
  142200. * pvrtc compression format
  142201. */
  142202. pvrtc?: boolean;
  142203. /**
  142204. * etc2 compression format
  142205. */
  142206. etc2?: boolean;
  142207. };
  142208. /**
  142209. * If mipmap levels should be loaded for transcoded images (Default: true)
  142210. */
  142211. loadMipmapLevels?: boolean;
  142212. /**
  142213. * Index of a single image to load (Default: all images)
  142214. */
  142215. loadSingleImage?: number;
  142216. }
  142217. /**
  142218. * Used to load .Basis files
  142219. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  142220. */
  142221. export class BasisTools {
  142222. private static _IgnoreSupportedFormats;
  142223. /**
  142224. * URL to use when loading the basis transcoder
  142225. */
  142226. static JSModuleURL: string;
  142227. /**
  142228. * URL to use when loading the wasm module for the transcoder
  142229. */
  142230. static WasmModuleURL: string;
  142231. /**
  142232. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  142233. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  142234. * @returns internal format corresponding to the Basis format
  142235. */
  142236. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  142237. private static _WorkerPromise;
  142238. private static _Worker;
  142239. private static _actionId;
  142240. private static _CreateWorkerAsync;
  142241. /**
  142242. * Transcodes a loaded image file to compressed pixel data
  142243. * @param data image data to transcode
  142244. * @param config configuration options for the transcoding
  142245. * @returns a promise resulting in the transcoded image
  142246. */
  142247. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  142248. /**
  142249. * Loads a texture from the transcode result
  142250. * @param texture texture load to
  142251. * @param transcodeResult the result of transcoding the basis file to load from
  142252. */
  142253. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  142254. }
  142255. }
  142256. declare module BABYLON {
  142257. /**
  142258. * Loader for .basis file format
  142259. */
  142260. export class _BasisTextureLoader implements IInternalTextureLoader {
  142261. /**
  142262. * Defines whether the loader supports cascade loading the different faces.
  142263. */
  142264. readonly supportCascades: boolean;
  142265. /**
  142266. * This returns if the loader support the current file information.
  142267. * @param extension defines the file extension of the file being loaded
  142268. * @returns true if the loader can load the specified file
  142269. */
  142270. canLoad(extension: string): boolean;
  142271. /**
  142272. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  142273. * @param data contains the texture data
  142274. * @param texture defines the BabylonJS internal texture
  142275. * @param createPolynomials will be true if polynomials have been requested
  142276. * @param onLoad defines the callback to trigger once the texture is ready
  142277. * @param onError defines the callback to trigger in case of error
  142278. */
  142279. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  142280. /**
  142281. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  142282. * @param data contains the texture data
  142283. * @param texture defines the BabylonJS internal texture
  142284. * @param callback defines the method to call once ready to upload
  142285. */
  142286. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  142287. }
  142288. }
  142289. declare module BABYLON {
  142290. /**
  142291. * Defines the basic options interface of a TexturePacker Frame
  142292. */
  142293. export interface ITexturePackerFrame {
  142294. /**
  142295. * The frame ID
  142296. */
  142297. id: number;
  142298. /**
  142299. * The frames Scale
  142300. */
  142301. scale: Vector2;
  142302. /**
  142303. * The Frames offset
  142304. */
  142305. offset: Vector2;
  142306. }
  142307. /**
  142308. * This is a support class for frame Data on texture packer sets.
  142309. */
  142310. export class TexturePackerFrame implements ITexturePackerFrame {
  142311. /**
  142312. * The frame ID
  142313. */
  142314. id: number;
  142315. /**
  142316. * The frames Scale
  142317. */
  142318. scale: Vector2;
  142319. /**
  142320. * The Frames offset
  142321. */
  142322. offset: Vector2;
  142323. /**
  142324. * Initializes a texture package frame.
  142325. * @param id The numerical frame identifier
  142326. * @param scale Scalar Vector2 for UV frame
  142327. * @param offset Vector2 for the frame position in UV units.
  142328. * @returns TexturePackerFrame
  142329. */
  142330. constructor(id: number, scale: Vector2, offset: Vector2);
  142331. }
  142332. }
  142333. declare module BABYLON {
  142334. /**
  142335. * Defines the basic options interface of a TexturePacker
  142336. */
  142337. export interface ITexturePackerOptions {
  142338. /**
  142339. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  142340. */
  142341. map?: string[];
  142342. /**
  142343. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  142344. */
  142345. uvsIn?: string;
  142346. /**
  142347. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  142348. */
  142349. uvsOut?: string;
  142350. /**
  142351. * number representing the layout style. Defaults to LAYOUT_STRIP
  142352. */
  142353. layout?: number;
  142354. /**
  142355. * number of columns if using custom column count layout(2). This defaults to 4.
  142356. */
  142357. colnum?: number;
  142358. /**
  142359. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  142360. */
  142361. updateInputMeshes?: boolean;
  142362. /**
  142363. * boolean flag to dispose all the source textures. Defaults to true.
  142364. */
  142365. disposeSources?: boolean;
  142366. /**
  142367. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  142368. */
  142369. fillBlanks?: boolean;
  142370. /**
  142371. * string value representing the context fill style color. Defaults to 'black'.
  142372. */
  142373. customFillColor?: string;
  142374. /**
  142375. * Width and Height Value of each Frame in the TexturePacker Sets
  142376. */
  142377. frameSize?: number;
  142378. /**
  142379. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  142380. */
  142381. paddingRatio?: number;
  142382. /**
  142383. * Number that declares the fill method for the padding gutter.
  142384. */
  142385. paddingMode?: number;
  142386. /**
  142387. * If in SUBUV_COLOR padding mode what color to use.
  142388. */
  142389. paddingColor?: Color3 | Color4;
  142390. }
  142391. /**
  142392. * Defines the basic interface of a TexturePacker JSON File
  142393. */
  142394. export interface ITexturePackerJSON {
  142395. /**
  142396. * The frame ID
  142397. */
  142398. name: string;
  142399. /**
  142400. * The base64 channel data
  142401. */
  142402. sets: any;
  142403. /**
  142404. * The options of the Packer
  142405. */
  142406. options: ITexturePackerOptions;
  142407. /**
  142408. * The frame data of the Packer
  142409. */
  142410. frames: Array<number>;
  142411. }
  142412. /**
  142413. * This is a support class that generates a series of packed texture sets.
  142414. * @see https://doc.babylonjs.com/babylon101/materials
  142415. */
  142416. export class TexturePacker {
  142417. /** Packer Layout Constant 0 */
  142418. static readonly LAYOUT_STRIP: number;
  142419. /** Packer Layout Constant 1 */
  142420. static readonly LAYOUT_POWER2: number;
  142421. /** Packer Layout Constant 2 */
  142422. static readonly LAYOUT_COLNUM: number;
  142423. /** Packer Layout Constant 0 */
  142424. static readonly SUBUV_WRAP: number;
  142425. /** Packer Layout Constant 1 */
  142426. static readonly SUBUV_EXTEND: number;
  142427. /** Packer Layout Constant 2 */
  142428. static readonly SUBUV_COLOR: number;
  142429. /** The Name of the Texture Package */
  142430. name: string;
  142431. /** The scene scope of the TexturePacker */
  142432. scene: Scene;
  142433. /** The Meshes to target */
  142434. meshes: AbstractMesh[];
  142435. /** Arguments passed with the Constructor */
  142436. options: ITexturePackerOptions;
  142437. /** The promise that is started upon initialization */
  142438. promise: Nullable<Promise<TexturePacker | string>>;
  142439. /** The Container object for the channel sets that are generated */
  142440. sets: object;
  142441. /** The Container array for the frames that are generated */
  142442. frames: TexturePackerFrame[];
  142443. /** The expected number of textures the system is parsing. */
  142444. private _expecting;
  142445. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  142446. private _paddingValue;
  142447. /**
  142448. * Initializes a texture package series from an array of meshes or a single mesh.
  142449. * @param name The name of the package
  142450. * @param meshes The target meshes to compose the package from
  142451. * @param options The arguments that texture packer should follow while building.
  142452. * @param scene The scene which the textures are scoped to.
  142453. * @returns TexturePacker
  142454. */
  142455. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  142456. /**
  142457. * Starts the package process
  142458. * @param resolve The promises resolution function
  142459. * @returns TexturePacker
  142460. */
  142461. private _createFrames;
  142462. /**
  142463. * Calculates the Size of the Channel Sets
  142464. * @returns Vector2
  142465. */
  142466. private _calculateSize;
  142467. /**
  142468. * Calculates the UV data for the frames.
  142469. * @param baseSize the base frameSize
  142470. * @param padding the base frame padding
  142471. * @param dtSize size of the Dynamic Texture for that channel
  142472. * @param dtUnits is 1/dtSize
  142473. * @param update flag to update the input meshes
  142474. */
  142475. private _calculateMeshUVFrames;
  142476. /**
  142477. * Calculates the frames Offset.
  142478. * @param index of the frame
  142479. * @returns Vector2
  142480. */
  142481. private _getFrameOffset;
  142482. /**
  142483. * Updates a Mesh to the frame data
  142484. * @param mesh that is the target
  142485. * @param frameID or the frame index
  142486. */
  142487. private _updateMeshUV;
  142488. /**
  142489. * Updates a Meshes materials to use the texture packer channels
  142490. * @param m is the mesh to target
  142491. * @param force all channels on the packer to be set.
  142492. */
  142493. private _updateTextureReferences;
  142494. /**
  142495. * Public method to set a Mesh to a frame
  142496. * @param m that is the target
  142497. * @param frameID or the frame index
  142498. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  142499. */
  142500. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  142501. /**
  142502. * Starts the async promise to compile the texture packer.
  142503. * @returns Promise<void>
  142504. */
  142505. processAsync(): Promise<void>;
  142506. /**
  142507. * Disposes all textures associated with this packer
  142508. */
  142509. dispose(): void;
  142510. /**
  142511. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  142512. * @param imageType is the image type to use.
  142513. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  142514. */
  142515. download(imageType?: string, quality?: number): void;
  142516. /**
  142517. * Public method to load a texturePacker JSON file.
  142518. * @param data of the JSON file in string format.
  142519. */
  142520. updateFromJSON(data: string): void;
  142521. }
  142522. }
  142523. declare module BABYLON {
  142524. /**
  142525. * 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.
  142526. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  142527. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  142528. */
  142529. export class CustomProceduralTexture extends ProceduralTexture {
  142530. private _animate;
  142531. private _time;
  142532. private _config;
  142533. private _texturePath;
  142534. /**
  142535. * Instantiates a new Custom Procedural Texture.
  142536. * 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.
  142537. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  142538. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  142539. * @param name Define the name of the texture
  142540. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  142541. * @param size Define the size of the texture to create
  142542. * @param scene Define the scene the texture belongs to
  142543. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  142544. * @param generateMipMaps Define if the texture should creates mip maps or not
  142545. */
  142546. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  142547. private _loadJson;
  142548. /**
  142549. * Is the texture ready to be used ? (rendered at least once)
  142550. * @returns true if ready, otherwise, false.
  142551. */
  142552. isReady(): boolean;
  142553. /**
  142554. * Render the texture to its associated render target.
  142555. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  142556. */
  142557. render(useCameraPostProcess?: boolean): void;
  142558. /**
  142559. * Update the list of dependant textures samplers in the shader.
  142560. */
  142561. updateTextures(): void;
  142562. /**
  142563. * Update the uniform values of the procedural texture in the shader.
  142564. */
  142565. updateShaderUniforms(): void;
  142566. /**
  142567. * Define if the texture animates or not.
  142568. */
  142569. get animate(): boolean;
  142570. set animate(value: boolean);
  142571. }
  142572. }
  142573. declare module BABYLON {
  142574. /** @hidden */
  142575. export var noisePixelShader: {
  142576. name: string;
  142577. shader: string;
  142578. };
  142579. }
  142580. declare module BABYLON {
  142581. /**
  142582. * Class used to generate noise procedural textures
  142583. */
  142584. export class NoiseProceduralTexture extends ProceduralTexture {
  142585. /** Gets or sets the start time (default is 0) */
  142586. time: number;
  142587. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  142588. brightness: number;
  142589. /** Defines the number of octaves to process */
  142590. octaves: number;
  142591. /** Defines the level of persistence (0.8 by default) */
  142592. persistence: number;
  142593. /** Gets or sets animation speed factor (default is 1) */
  142594. animationSpeedFactor: number;
  142595. /**
  142596. * Creates a new NoiseProceduralTexture
  142597. * @param name defines the name fo the texture
  142598. * @param size defines the size of the texture (default is 256)
  142599. * @param scene defines the hosting scene
  142600. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  142601. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  142602. */
  142603. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  142604. private _updateShaderUniforms;
  142605. protected _getDefines(): string;
  142606. /** Generate the current state of the procedural texture */
  142607. render(useCameraPostProcess?: boolean): void;
  142608. /**
  142609. * Serializes this noise procedural texture
  142610. * @returns a serialized noise procedural texture object
  142611. */
  142612. serialize(): any;
  142613. /**
  142614. * Clone the texture.
  142615. * @returns the cloned texture
  142616. */
  142617. clone(): NoiseProceduralTexture;
  142618. /**
  142619. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  142620. * @param parsedTexture defines parsed texture data
  142621. * @param scene defines the current scene
  142622. * @param rootUrl defines the root URL containing noise procedural texture information
  142623. * @returns a parsed NoiseProceduralTexture
  142624. */
  142625. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  142626. }
  142627. }
  142628. declare module BABYLON {
  142629. /**
  142630. * Raw cube texture where the raw buffers are passed in
  142631. */
  142632. export class RawCubeTexture extends CubeTexture {
  142633. /**
  142634. * Creates a cube texture where the raw buffers are passed in.
  142635. * @param scene defines the scene the texture is attached to
  142636. * @param data defines the array of data to use to create each face
  142637. * @param size defines the size of the textures
  142638. * @param format defines the format of the data
  142639. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  142640. * @param generateMipMaps defines if the engine should generate the mip levels
  142641. * @param invertY defines if data must be stored with Y axis inverted
  142642. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  142643. * @param compression defines the compression used (null by default)
  142644. */
  142645. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  142646. /**
  142647. * Updates the raw cube texture.
  142648. * @param data defines the data to store
  142649. * @param format defines the data format
  142650. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  142651. * @param invertY defines if data must be stored with Y axis inverted
  142652. * @param compression defines the compression used (null by default)
  142653. * @param level defines which level of the texture to update
  142654. */
  142655. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  142656. /**
  142657. * Updates a raw cube texture with RGBD encoded data.
  142658. * @param data defines the array of data [mipmap][face] to use to create each face
  142659. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  142660. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  142661. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  142662. * @returns a promsie that resolves when the operation is complete
  142663. */
  142664. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  142665. /**
  142666. * Clones the raw cube texture.
  142667. * @return a new cube texture
  142668. */
  142669. clone(): CubeTexture;
  142670. /** @hidden */
  142671. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  142672. }
  142673. }
  142674. declare module BABYLON {
  142675. /**
  142676. * Class used to store 2D array textures containing user data
  142677. */
  142678. export class RawTexture2DArray extends Texture {
  142679. /** Gets or sets the texture format to use */
  142680. format: number;
  142681. /**
  142682. * Create a new RawTexture2DArray
  142683. * @param data defines the data of the texture
  142684. * @param width defines the width of the texture
  142685. * @param height defines the height of the texture
  142686. * @param depth defines the number of layers of the texture
  142687. * @param format defines the texture format to use
  142688. * @param scene defines the hosting scene
  142689. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  142690. * @param invertY defines if texture must be stored with Y axis inverted
  142691. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  142692. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  142693. */
  142694. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  142695. /** Gets or sets the texture format to use */
  142696. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  142697. /**
  142698. * Update the texture with new data
  142699. * @param data defines the data to store in the texture
  142700. */
  142701. update(data: ArrayBufferView): void;
  142702. }
  142703. }
  142704. declare module BABYLON {
  142705. /**
  142706. * Class used to store 3D textures containing user data
  142707. */
  142708. export class RawTexture3D extends Texture {
  142709. /** Gets or sets the texture format to use */
  142710. format: number;
  142711. /**
  142712. * Create a new RawTexture3D
  142713. * @param data defines the data of the texture
  142714. * @param width defines the width of the texture
  142715. * @param height defines the height of the texture
  142716. * @param depth defines the depth of the texture
  142717. * @param format defines the texture format to use
  142718. * @param scene defines the hosting scene
  142719. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  142720. * @param invertY defines if texture must be stored with Y axis inverted
  142721. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  142722. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  142723. */
  142724. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  142725. /** Gets or sets the texture format to use */
  142726. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  142727. /**
  142728. * Update the texture with new data
  142729. * @param data defines the data to store in the texture
  142730. */
  142731. update(data: ArrayBufferView): void;
  142732. }
  142733. }
  142734. declare module BABYLON {
  142735. /**
  142736. * Creates a refraction texture used by refraction channel of the standard material.
  142737. * It is like a mirror but to see through a material.
  142738. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142739. */
  142740. export class RefractionTexture extends RenderTargetTexture {
  142741. /**
  142742. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  142743. * 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.
  142744. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142745. */
  142746. refractionPlane: Plane;
  142747. /**
  142748. * Define how deep under the surface we should see.
  142749. */
  142750. depth: number;
  142751. /**
  142752. * Creates a refraction texture used by refraction channel of the standard material.
  142753. * It is like a mirror but to see through a material.
  142754. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142755. * @param name Define the texture name
  142756. * @param size Define the size of the underlying texture
  142757. * @param scene Define the scene the refraction belongs to
  142758. * @param generateMipMaps Define if we need to generate mips level for the refraction
  142759. */
  142760. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  142761. /**
  142762. * Clone the refraction texture.
  142763. * @returns the cloned texture
  142764. */
  142765. clone(): RefractionTexture;
  142766. /**
  142767. * Serialize the texture to a JSON representation you could use in Parse later on
  142768. * @returns the serialized JSON representation
  142769. */
  142770. serialize(): any;
  142771. }
  142772. }
  142773. declare module BABYLON {
  142774. /**
  142775. * Block used to add support for vertex skinning (bones)
  142776. */
  142777. export class BonesBlock extends NodeMaterialBlock {
  142778. /**
  142779. * Creates a new BonesBlock
  142780. * @param name defines the block name
  142781. */
  142782. constructor(name: string);
  142783. /**
  142784. * Initialize the block and prepare the context for build
  142785. * @param state defines the state that will be used for the build
  142786. */
  142787. initialize(state: NodeMaterialBuildState): void;
  142788. /**
  142789. * Gets the current class name
  142790. * @returns the class name
  142791. */
  142792. getClassName(): string;
  142793. /**
  142794. * Gets the matrix indices input component
  142795. */
  142796. get matricesIndices(): NodeMaterialConnectionPoint;
  142797. /**
  142798. * Gets the matrix weights input component
  142799. */
  142800. get matricesWeights(): NodeMaterialConnectionPoint;
  142801. /**
  142802. * Gets the extra matrix indices input component
  142803. */
  142804. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  142805. /**
  142806. * Gets the extra matrix weights input component
  142807. */
  142808. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  142809. /**
  142810. * Gets the world input component
  142811. */
  142812. get world(): NodeMaterialConnectionPoint;
  142813. /**
  142814. * Gets the output component
  142815. */
  142816. get output(): NodeMaterialConnectionPoint;
  142817. autoConfigure(material: NodeMaterial): void;
  142818. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  142819. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142820. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142821. protected _buildBlock(state: NodeMaterialBuildState): this;
  142822. }
  142823. }
  142824. declare module BABYLON {
  142825. /**
  142826. * Block used to add support for instances
  142827. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  142828. */
  142829. export class InstancesBlock extends NodeMaterialBlock {
  142830. /**
  142831. * Creates a new InstancesBlock
  142832. * @param name defines the block name
  142833. */
  142834. constructor(name: string);
  142835. /**
  142836. * Gets the current class name
  142837. * @returns the class name
  142838. */
  142839. getClassName(): string;
  142840. /**
  142841. * Gets the first world row input component
  142842. */
  142843. get world0(): NodeMaterialConnectionPoint;
  142844. /**
  142845. * Gets the second world row input component
  142846. */
  142847. get world1(): NodeMaterialConnectionPoint;
  142848. /**
  142849. * Gets the third world row input component
  142850. */
  142851. get world2(): NodeMaterialConnectionPoint;
  142852. /**
  142853. * Gets the forth world row input component
  142854. */
  142855. get world3(): NodeMaterialConnectionPoint;
  142856. /**
  142857. * Gets the world input component
  142858. */
  142859. get world(): NodeMaterialConnectionPoint;
  142860. /**
  142861. * Gets the output component
  142862. */
  142863. get output(): NodeMaterialConnectionPoint;
  142864. /**
  142865. * Gets the isntanceID component
  142866. */
  142867. get instanceID(): NodeMaterialConnectionPoint;
  142868. autoConfigure(material: NodeMaterial): void;
  142869. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  142870. protected _buildBlock(state: NodeMaterialBuildState): this;
  142871. }
  142872. }
  142873. declare module BABYLON {
  142874. /**
  142875. * Block used to add morph targets support to vertex shader
  142876. */
  142877. export class MorphTargetsBlock extends NodeMaterialBlock {
  142878. private _repeatableContentAnchor;
  142879. /**
  142880. * Create a new MorphTargetsBlock
  142881. * @param name defines the block name
  142882. */
  142883. constructor(name: string);
  142884. /**
  142885. * Gets the current class name
  142886. * @returns the class name
  142887. */
  142888. getClassName(): string;
  142889. /**
  142890. * Gets the position input component
  142891. */
  142892. get position(): NodeMaterialConnectionPoint;
  142893. /**
  142894. * Gets the normal input component
  142895. */
  142896. get normal(): NodeMaterialConnectionPoint;
  142897. /**
  142898. * Gets the tangent input component
  142899. */
  142900. get tangent(): NodeMaterialConnectionPoint;
  142901. /**
  142902. * Gets the tangent input component
  142903. */
  142904. get uv(): NodeMaterialConnectionPoint;
  142905. /**
  142906. * Gets the position output component
  142907. */
  142908. get positionOutput(): NodeMaterialConnectionPoint;
  142909. /**
  142910. * Gets the normal output component
  142911. */
  142912. get normalOutput(): NodeMaterialConnectionPoint;
  142913. /**
  142914. * Gets the tangent output component
  142915. */
  142916. get tangentOutput(): NodeMaterialConnectionPoint;
  142917. /**
  142918. * Gets the tangent output component
  142919. */
  142920. get uvOutput(): NodeMaterialConnectionPoint;
  142921. initialize(state: NodeMaterialBuildState): void;
  142922. autoConfigure(material: NodeMaterial): void;
  142923. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142924. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142925. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  142926. protected _buildBlock(state: NodeMaterialBuildState): this;
  142927. }
  142928. }
  142929. declare module BABYLON {
  142930. /**
  142931. * Block used to get data information from a light
  142932. */
  142933. export class LightInformationBlock extends NodeMaterialBlock {
  142934. private _lightDataUniformName;
  142935. private _lightColorUniformName;
  142936. private _lightTypeDefineName;
  142937. /**
  142938. * Gets or sets the light associated with this block
  142939. */
  142940. light: Nullable<Light>;
  142941. /**
  142942. * Creates a new LightInformationBlock
  142943. * @param name defines the block name
  142944. */
  142945. constructor(name: string);
  142946. /**
  142947. * Gets the current class name
  142948. * @returns the class name
  142949. */
  142950. getClassName(): string;
  142951. /**
  142952. * Gets the world position input component
  142953. */
  142954. get worldPosition(): NodeMaterialConnectionPoint;
  142955. /**
  142956. * Gets the direction output component
  142957. */
  142958. get direction(): NodeMaterialConnectionPoint;
  142959. /**
  142960. * Gets the direction output component
  142961. */
  142962. get color(): NodeMaterialConnectionPoint;
  142963. /**
  142964. * Gets the direction output component
  142965. */
  142966. get intensity(): NodeMaterialConnectionPoint;
  142967. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142968. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142969. protected _buildBlock(state: NodeMaterialBuildState): this;
  142970. serialize(): any;
  142971. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142972. }
  142973. }
  142974. declare module BABYLON {
  142975. /**
  142976. * Block used to add image processing support to fragment shader
  142977. */
  142978. export class ImageProcessingBlock extends NodeMaterialBlock {
  142979. /**
  142980. * Create a new ImageProcessingBlock
  142981. * @param name defines the block name
  142982. */
  142983. constructor(name: string);
  142984. /**
  142985. * Gets the current class name
  142986. * @returns the class name
  142987. */
  142988. getClassName(): string;
  142989. /**
  142990. * Gets the color input component
  142991. */
  142992. get color(): NodeMaterialConnectionPoint;
  142993. /**
  142994. * Gets the output component
  142995. */
  142996. get output(): NodeMaterialConnectionPoint;
  142997. /**
  142998. * Initialize the block and prepare the context for build
  142999. * @param state defines the state that will be used for the build
  143000. */
  143001. initialize(state: NodeMaterialBuildState): void;
  143002. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  143003. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143004. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143005. protected _buildBlock(state: NodeMaterialBuildState): this;
  143006. }
  143007. }
  143008. declare module BABYLON {
  143009. /**
  143010. * Block used to pertub normals based on a normal map
  143011. */
  143012. export class PerturbNormalBlock extends NodeMaterialBlock {
  143013. private _tangentSpaceParameterName;
  143014. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143015. invertX: boolean;
  143016. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  143017. invertY: boolean;
  143018. /**
  143019. * Create a new PerturbNormalBlock
  143020. * @param name defines the block name
  143021. */
  143022. constructor(name: string);
  143023. /**
  143024. * Gets the current class name
  143025. * @returns the class name
  143026. */
  143027. getClassName(): string;
  143028. /**
  143029. * Gets the world position input component
  143030. */
  143031. get worldPosition(): NodeMaterialConnectionPoint;
  143032. /**
  143033. * Gets the world normal input component
  143034. */
  143035. get worldNormal(): NodeMaterialConnectionPoint;
  143036. /**
  143037. * Gets the world tangent input component
  143038. */
  143039. get worldTangent(): NodeMaterialConnectionPoint;
  143040. /**
  143041. * Gets the uv input component
  143042. */
  143043. get uv(): NodeMaterialConnectionPoint;
  143044. /**
  143045. * Gets the normal map color input component
  143046. */
  143047. get normalMapColor(): NodeMaterialConnectionPoint;
  143048. /**
  143049. * Gets the strength input component
  143050. */
  143051. get strength(): NodeMaterialConnectionPoint;
  143052. /**
  143053. * Gets the output component
  143054. */
  143055. get output(): NodeMaterialConnectionPoint;
  143056. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143057. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143058. autoConfigure(material: NodeMaterial): void;
  143059. protected _buildBlock(state: NodeMaterialBuildState): this;
  143060. protected _dumpPropertiesCode(): string;
  143061. serialize(): any;
  143062. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143063. }
  143064. }
  143065. declare module BABYLON {
  143066. /**
  143067. * Block used to discard a pixel if a value is smaller than a cutoff
  143068. */
  143069. export class DiscardBlock extends NodeMaterialBlock {
  143070. /**
  143071. * Create a new DiscardBlock
  143072. * @param name defines the block name
  143073. */
  143074. constructor(name: string);
  143075. /**
  143076. * Gets the current class name
  143077. * @returns the class name
  143078. */
  143079. getClassName(): string;
  143080. /**
  143081. * Gets the color input component
  143082. */
  143083. get value(): NodeMaterialConnectionPoint;
  143084. /**
  143085. * Gets the cutoff input component
  143086. */
  143087. get cutoff(): NodeMaterialConnectionPoint;
  143088. protected _buildBlock(state: NodeMaterialBuildState): this;
  143089. }
  143090. }
  143091. declare module BABYLON {
  143092. /**
  143093. * Block used to test if the fragment shader is front facing
  143094. */
  143095. export class FrontFacingBlock extends NodeMaterialBlock {
  143096. /**
  143097. * Creates a new FrontFacingBlock
  143098. * @param name defines the block name
  143099. */
  143100. constructor(name: string);
  143101. /**
  143102. * Gets the current class name
  143103. * @returns the class name
  143104. */
  143105. getClassName(): string;
  143106. /**
  143107. * Gets the output component
  143108. */
  143109. get output(): NodeMaterialConnectionPoint;
  143110. protected _buildBlock(state: NodeMaterialBuildState): this;
  143111. }
  143112. }
  143113. declare module BABYLON {
  143114. /**
  143115. * Block used to get the derivative value on x and y of a given input
  143116. */
  143117. export class DerivativeBlock extends NodeMaterialBlock {
  143118. /**
  143119. * Create a new DerivativeBlock
  143120. * @param name defines the block name
  143121. */
  143122. constructor(name: string);
  143123. /**
  143124. * Gets the current class name
  143125. * @returns the class name
  143126. */
  143127. getClassName(): string;
  143128. /**
  143129. * Gets the input component
  143130. */
  143131. get input(): NodeMaterialConnectionPoint;
  143132. /**
  143133. * Gets the derivative output on x
  143134. */
  143135. get dx(): NodeMaterialConnectionPoint;
  143136. /**
  143137. * Gets the derivative output on y
  143138. */
  143139. get dy(): NodeMaterialConnectionPoint;
  143140. protected _buildBlock(state: NodeMaterialBuildState): this;
  143141. }
  143142. }
  143143. declare module BABYLON {
  143144. /**
  143145. * Block used to make gl_FragCoord available
  143146. */
  143147. export class FragCoordBlock extends NodeMaterialBlock {
  143148. /**
  143149. * Creates a new FragCoordBlock
  143150. * @param name defines the block name
  143151. */
  143152. constructor(name: string);
  143153. /**
  143154. * Gets the current class name
  143155. * @returns the class name
  143156. */
  143157. getClassName(): string;
  143158. /**
  143159. * Gets the xy component
  143160. */
  143161. get xy(): NodeMaterialConnectionPoint;
  143162. /**
  143163. * Gets the xyz component
  143164. */
  143165. get xyz(): NodeMaterialConnectionPoint;
  143166. /**
  143167. * Gets the xyzw component
  143168. */
  143169. get xyzw(): NodeMaterialConnectionPoint;
  143170. /**
  143171. * Gets the x component
  143172. */
  143173. get x(): NodeMaterialConnectionPoint;
  143174. /**
  143175. * Gets the y component
  143176. */
  143177. get y(): NodeMaterialConnectionPoint;
  143178. /**
  143179. * Gets the z component
  143180. */
  143181. get z(): NodeMaterialConnectionPoint;
  143182. /**
  143183. * Gets the w component
  143184. */
  143185. get output(): NodeMaterialConnectionPoint;
  143186. protected writeOutputs(state: NodeMaterialBuildState): string;
  143187. protected _buildBlock(state: NodeMaterialBuildState): this;
  143188. }
  143189. }
  143190. declare module BABYLON {
  143191. /**
  143192. * Block used to get the screen sizes
  143193. */
  143194. export class ScreenSizeBlock extends NodeMaterialBlock {
  143195. private _varName;
  143196. private _scene;
  143197. /**
  143198. * Creates a new ScreenSizeBlock
  143199. * @param name defines the block name
  143200. */
  143201. constructor(name: string);
  143202. /**
  143203. * Gets the current class name
  143204. * @returns the class name
  143205. */
  143206. getClassName(): string;
  143207. /**
  143208. * Gets the xy component
  143209. */
  143210. get xy(): NodeMaterialConnectionPoint;
  143211. /**
  143212. * Gets the x component
  143213. */
  143214. get x(): NodeMaterialConnectionPoint;
  143215. /**
  143216. * Gets the y component
  143217. */
  143218. get y(): NodeMaterialConnectionPoint;
  143219. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143220. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  143221. protected _buildBlock(state: NodeMaterialBuildState): this;
  143222. }
  143223. }
  143224. declare module BABYLON {
  143225. /**
  143226. * Block used to add support for scene fog
  143227. */
  143228. export class FogBlock extends NodeMaterialBlock {
  143229. private _fogDistanceName;
  143230. private _fogParameters;
  143231. /**
  143232. * Create a new FogBlock
  143233. * @param name defines the block name
  143234. */
  143235. constructor(name: string);
  143236. /**
  143237. * Gets the current class name
  143238. * @returns the class name
  143239. */
  143240. getClassName(): string;
  143241. /**
  143242. * Gets the world position input component
  143243. */
  143244. get worldPosition(): NodeMaterialConnectionPoint;
  143245. /**
  143246. * Gets the view input component
  143247. */
  143248. get view(): NodeMaterialConnectionPoint;
  143249. /**
  143250. * Gets the color input component
  143251. */
  143252. get input(): NodeMaterialConnectionPoint;
  143253. /**
  143254. * Gets the fog color input component
  143255. */
  143256. get fogColor(): NodeMaterialConnectionPoint;
  143257. /**
  143258. * Gets the output component
  143259. */
  143260. get output(): NodeMaterialConnectionPoint;
  143261. autoConfigure(material: NodeMaterial): void;
  143262. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143263. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143264. protected _buildBlock(state: NodeMaterialBuildState): this;
  143265. }
  143266. }
  143267. declare module BABYLON {
  143268. /**
  143269. * Block used to add light in the fragment shader
  143270. */
  143271. export class LightBlock extends NodeMaterialBlock {
  143272. private _lightId;
  143273. /**
  143274. * Gets or sets the light associated with this block
  143275. */
  143276. light: Nullable<Light>;
  143277. /**
  143278. * Create a new LightBlock
  143279. * @param name defines the block name
  143280. */
  143281. constructor(name: string);
  143282. /**
  143283. * Gets the current class name
  143284. * @returns the class name
  143285. */
  143286. getClassName(): string;
  143287. /**
  143288. * Gets the world position input component
  143289. */
  143290. get worldPosition(): NodeMaterialConnectionPoint;
  143291. /**
  143292. * Gets the world normal input component
  143293. */
  143294. get worldNormal(): NodeMaterialConnectionPoint;
  143295. /**
  143296. * Gets the camera (or eye) position component
  143297. */
  143298. get cameraPosition(): NodeMaterialConnectionPoint;
  143299. /**
  143300. * Gets the glossiness component
  143301. */
  143302. get glossiness(): NodeMaterialConnectionPoint;
  143303. /**
  143304. * Gets the glossinness power component
  143305. */
  143306. get glossPower(): NodeMaterialConnectionPoint;
  143307. /**
  143308. * Gets the diffuse color component
  143309. */
  143310. get diffuseColor(): NodeMaterialConnectionPoint;
  143311. /**
  143312. * Gets the specular color component
  143313. */
  143314. get specularColor(): NodeMaterialConnectionPoint;
  143315. /**
  143316. * Gets the diffuse output component
  143317. */
  143318. get diffuseOutput(): NodeMaterialConnectionPoint;
  143319. /**
  143320. * Gets the specular output component
  143321. */
  143322. get specularOutput(): NodeMaterialConnectionPoint;
  143323. /**
  143324. * Gets the shadow output component
  143325. */
  143326. get shadow(): NodeMaterialConnectionPoint;
  143327. autoConfigure(material: NodeMaterial): void;
  143328. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143329. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  143330. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143331. private _injectVertexCode;
  143332. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143333. serialize(): any;
  143334. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143335. }
  143336. }
  143337. declare module BABYLON {
  143338. /**
  143339. * Block used to read a reflection texture from a sampler
  143340. */
  143341. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  143342. /**
  143343. * Create a new ReflectionTextureBlock
  143344. * @param name defines the block name
  143345. */
  143346. constructor(name: string);
  143347. /**
  143348. * Gets the current class name
  143349. * @returns the class name
  143350. */
  143351. getClassName(): string;
  143352. /**
  143353. * Gets the world position input component
  143354. */
  143355. get position(): NodeMaterialConnectionPoint;
  143356. /**
  143357. * Gets the world position input component
  143358. */
  143359. get worldPosition(): NodeMaterialConnectionPoint;
  143360. /**
  143361. * Gets the world normal input component
  143362. */
  143363. get worldNormal(): NodeMaterialConnectionPoint;
  143364. /**
  143365. * Gets the world input component
  143366. */
  143367. get world(): NodeMaterialConnectionPoint;
  143368. /**
  143369. * Gets the camera (or eye) position component
  143370. */
  143371. get cameraPosition(): NodeMaterialConnectionPoint;
  143372. /**
  143373. * Gets the view input component
  143374. */
  143375. get view(): NodeMaterialConnectionPoint;
  143376. /**
  143377. * Gets the rgb output component
  143378. */
  143379. get rgb(): NodeMaterialConnectionPoint;
  143380. /**
  143381. * Gets the rgba output component
  143382. */
  143383. get rgba(): NodeMaterialConnectionPoint;
  143384. /**
  143385. * Gets the r output component
  143386. */
  143387. get r(): NodeMaterialConnectionPoint;
  143388. /**
  143389. * Gets the g output component
  143390. */
  143391. get g(): NodeMaterialConnectionPoint;
  143392. /**
  143393. * Gets the b output component
  143394. */
  143395. get b(): NodeMaterialConnectionPoint;
  143396. /**
  143397. * Gets the a output component
  143398. */
  143399. get a(): NodeMaterialConnectionPoint;
  143400. autoConfigure(material: NodeMaterial): void;
  143401. protected _buildBlock(state: NodeMaterialBuildState): this;
  143402. }
  143403. }
  143404. declare module BABYLON {
  143405. /**
  143406. * Block used to add 2 vectors
  143407. */
  143408. export class AddBlock extends NodeMaterialBlock {
  143409. /**
  143410. * Creates a new AddBlock
  143411. * @param name defines the block name
  143412. */
  143413. constructor(name: string);
  143414. /**
  143415. * Gets the current class name
  143416. * @returns the class name
  143417. */
  143418. getClassName(): string;
  143419. /**
  143420. * Gets the left operand input component
  143421. */
  143422. get left(): NodeMaterialConnectionPoint;
  143423. /**
  143424. * Gets the right operand input component
  143425. */
  143426. get right(): NodeMaterialConnectionPoint;
  143427. /**
  143428. * Gets the output component
  143429. */
  143430. get output(): NodeMaterialConnectionPoint;
  143431. protected _buildBlock(state: NodeMaterialBuildState): this;
  143432. }
  143433. }
  143434. declare module BABYLON {
  143435. /**
  143436. * Block used to scale a vector by a float
  143437. */
  143438. export class ScaleBlock extends NodeMaterialBlock {
  143439. /**
  143440. * Creates a new ScaleBlock
  143441. * @param name defines the block name
  143442. */
  143443. constructor(name: string);
  143444. /**
  143445. * Gets the current class name
  143446. * @returns the class name
  143447. */
  143448. getClassName(): string;
  143449. /**
  143450. * Gets the input component
  143451. */
  143452. get input(): NodeMaterialConnectionPoint;
  143453. /**
  143454. * Gets the factor input component
  143455. */
  143456. get factor(): NodeMaterialConnectionPoint;
  143457. /**
  143458. * Gets the output component
  143459. */
  143460. get output(): NodeMaterialConnectionPoint;
  143461. protected _buildBlock(state: NodeMaterialBuildState): this;
  143462. }
  143463. }
  143464. declare module BABYLON {
  143465. /**
  143466. * Block used to clamp a float
  143467. */
  143468. export class ClampBlock extends NodeMaterialBlock {
  143469. /** Gets or sets the minimum range */
  143470. minimum: number;
  143471. /** Gets or sets the maximum range */
  143472. maximum: number;
  143473. /**
  143474. * Creates a new ClampBlock
  143475. * @param name defines the block name
  143476. */
  143477. constructor(name: string);
  143478. /**
  143479. * Gets the current class name
  143480. * @returns the class name
  143481. */
  143482. getClassName(): string;
  143483. /**
  143484. * Gets the value input component
  143485. */
  143486. get value(): NodeMaterialConnectionPoint;
  143487. /**
  143488. * Gets the output component
  143489. */
  143490. get output(): NodeMaterialConnectionPoint;
  143491. protected _buildBlock(state: NodeMaterialBuildState): this;
  143492. protected _dumpPropertiesCode(): string;
  143493. serialize(): any;
  143494. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143495. }
  143496. }
  143497. declare module BABYLON {
  143498. /**
  143499. * Block used to apply a cross product between 2 vectors
  143500. */
  143501. export class CrossBlock extends NodeMaterialBlock {
  143502. /**
  143503. * Creates a new CrossBlock
  143504. * @param name defines the block name
  143505. */
  143506. constructor(name: string);
  143507. /**
  143508. * Gets the current class name
  143509. * @returns the class name
  143510. */
  143511. getClassName(): string;
  143512. /**
  143513. * Gets the left operand input component
  143514. */
  143515. get left(): NodeMaterialConnectionPoint;
  143516. /**
  143517. * Gets the right operand input component
  143518. */
  143519. get right(): NodeMaterialConnectionPoint;
  143520. /**
  143521. * Gets the output component
  143522. */
  143523. get output(): NodeMaterialConnectionPoint;
  143524. protected _buildBlock(state: NodeMaterialBuildState): this;
  143525. }
  143526. }
  143527. declare module BABYLON {
  143528. /**
  143529. * Block used to apply a dot product between 2 vectors
  143530. */
  143531. export class DotBlock extends NodeMaterialBlock {
  143532. /**
  143533. * Creates a new DotBlock
  143534. * @param name defines the block name
  143535. */
  143536. constructor(name: string);
  143537. /**
  143538. * Gets the current class name
  143539. * @returns the class name
  143540. */
  143541. getClassName(): string;
  143542. /**
  143543. * Gets the left operand input component
  143544. */
  143545. get left(): NodeMaterialConnectionPoint;
  143546. /**
  143547. * Gets the right operand input component
  143548. */
  143549. get right(): NodeMaterialConnectionPoint;
  143550. /**
  143551. * Gets the output component
  143552. */
  143553. get output(): NodeMaterialConnectionPoint;
  143554. protected _buildBlock(state: NodeMaterialBuildState): this;
  143555. }
  143556. }
  143557. declare module BABYLON {
  143558. /**
  143559. * Block used to normalize a vector
  143560. */
  143561. export class NormalizeBlock extends NodeMaterialBlock {
  143562. /**
  143563. * Creates a new NormalizeBlock
  143564. * @param name defines the block name
  143565. */
  143566. constructor(name: string);
  143567. /**
  143568. * Gets the current class name
  143569. * @returns the class name
  143570. */
  143571. getClassName(): string;
  143572. /**
  143573. * Gets the input component
  143574. */
  143575. get input(): NodeMaterialConnectionPoint;
  143576. /**
  143577. * Gets the output component
  143578. */
  143579. get output(): NodeMaterialConnectionPoint;
  143580. protected _buildBlock(state: NodeMaterialBuildState): this;
  143581. }
  143582. }
  143583. declare module BABYLON {
  143584. /**
  143585. * Block used to create a Color3/4 out of individual inputs (one for each component)
  143586. */
  143587. export class ColorMergerBlock extends NodeMaterialBlock {
  143588. /**
  143589. * Create a new ColorMergerBlock
  143590. * @param name defines the block name
  143591. */
  143592. constructor(name: string);
  143593. /**
  143594. * Gets the current class name
  143595. * @returns the class name
  143596. */
  143597. getClassName(): string;
  143598. /**
  143599. * Gets the rgb component (input)
  143600. */
  143601. get rgbIn(): NodeMaterialConnectionPoint;
  143602. /**
  143603. * Gets the r component (input)
  143604. */
  143605. get r(): NodeMaterialConnectionPoint;
  143606. /**
  143607. * Gets the g component (input)
  143608. */
  143609. get g(): NodeMaterialConnectionPoint;
  143610. /**
  143611. * Gets the b component (input)
  143612. */
  143613. get b(): NodeMaterialConnectionPoint;
  143614. /**
  143615. * Gets the a component (input)
  143616. */
  143617. get a(): NodeMaterialConnectionPoint;
  143618. /**
  143619. * Gets the rgba component (output)
  143620. */
  143621. get rgba(): NodeMaterialConnectionPoint;
  143622. /**
  143623. * Gets the rgb component (output)
  143624. */
  143625. get rgbOut(): NodeMaterialConnectionPoint;
  143626. /**
  143627. * Gets the rgb component (output)
  143628. * @deprecated Please use rgbOut instead.
  143629. */
  143630. get rgb(): NodeMaterialConnectionPoint;
  143631. protected _buildBlock(state: NodeMaterialBuildState): this;
  143632. }
  143633. }
  143634. declare module BABYLON {
  143635. /**
  143636. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  143637. */
  143638. export class VectorSplitterBlock extends NodeMaterialBlock {
  143639. /**
  143640. * Create a new VectorSplitterBlock
  143641. * @param name defines the block name
  143642. */
  143643. constructor(name: string);
  143644. /**
  143645. * Gets the current class name
  143646. * @returns the class name
  143647. */
  143648. getClassName(): string;
  143649. /**
  143650. * Gets the xyzw component (input)
  143651. */
  143652. get xyzw(): NodeMaterialConnectionPoint;
  143653. /**
  143654. * Gets the xyz component (input)
  143655. */
  143656. get xyzIn(): NodeMaterialConnectionPoint;
  143657. /**
  143658. * Gets the xy component (input)
  143659. */
  143660. get xyIn(): NodeMaterialConnectionPoint;
  143661. /**
  143662. * Gets the xyz component (output)
  143663. */
  143664. get xyzOut(): NodeMaterialConnectionPoint;
  143665. /**
  143666. * Gets the xy component (output)
  143667. */
  143668. get xyOut(): NodeMaterialConnectionPoint;
  143669. /**
  143670. * Gets the x component (output)
  143671. */
  143672. get x(): NodeMaterialConnectionPoint;
  143673. /**
  143674. * Gets the y component (output)
  143675. */
  143676. get y(): NodeMaterialConnectionPoint;
  143677. /**
  143678. * Gets the z component (output)
  143679. */
  143680. get z(): NodeMaterialConnectionPoint;
  143681. /**
  143682. * Gets the w component (output)
  143683. */
  143684. get w(): NodeMaterialConnectionPoint;
  143685. protected _inputRename(name: string): string;
  143686. protected _outputRename(name: string): string;
  143687. protected _buildBlock(state: NodeMaterialBuildState): this;
  143688. }
  143689. }
  143690. declare module BABYLON {
  143691. /**
  143692. * Block used to lerp between 2 values
  143693. */
  143694. export class LerpBlock extends NodeMaterialBlock {
  143695. /**
  143696. * Creates a new LerpBlock
  143697. * @param name defines the block name
  143698. */
  143699. constructor(name: string);
  143700. /**
  143701. * Gets the current class name
  143702. * @returns the class name
  143703. */
  143704. getClassName(): string;
  143705. /**
  143706. * Gets the left operand input component
  143707. */
  143708. get left(): NodeMaterialConnectionPoint;
  143709. /**
  143710. * Gets the right operand input component
  143711. */
  143712. get right(): NodeMaterialConnectionPoint;
  143713. /**
  143714. * Gets the gradient operand input component
  143715. */
  143716. get gradient(): NodeMaterialConnectionPoint;
  143717. /**
  143718. * Gets the output component
  143719. */
  143720. get output(): NodeMaterialConnectionPoint;
  143721. protected _buildBlock(state: NodeMaterialBuildState): this;
  143722. }
  143723. }
  143724. declare module BABYLON {
  143725. /**
  143726. * Block used to divide 2 vectors
  143727. */
  143728. export class DivideBlock extends NodeMaterialBlock {
  143729. /**
  143730. * Creates a new DivideBlock
  143731. * @param name defines the block name
  143732. */
  143733. constructor(name: string);
  143734. /**
  143735. * Gets the current class name
  143736. * @returns the class name
  143737. */
  143738. getClassName(): string;
  143739. /**
  143740. * Gets the left operand input component
  143741. */
  143742. get left(): NodeMaterialConnectionPoint;
  143743. /**
  143744. * Gets the right operand input component
  143745. */
  143746. get right(): NodeMaterialConnectionPoint;
  143747. /**
  143748. * Gets the output component
  143749. */
  143750. get output(): NodeMaterialConnectionPoint;
  143751. protected _buildBlock(state: NodeMaterialBuildState): this;
  143752. }
  143753. }
  143754. declare module BABYLON {
  143755. /**
  143756. * Block used to subtract 2 vectors
  143757. */
  143758. export class SubtractBlock extends NodeMaterialBlock {
  143759. /**
  143760. * Creates a new SubtractBlock
  143761. * @param name defines the block name
  143762. */
  143763. constructor(name: string);
  143764. /**
  143765. * Gets the current class name
  143766. * @returns the class name
  143767. */
  143768. getClassName(): string;
  143769. /**
  143770. * Gets the left operand input component
  143771. */
  143772. get left(): NodeMaterialConnectionPoint;
  143773. /**
  143774. * Gets the right operand input component
  143775. */
  143776. get right(): NodeMaterialConnectionPoint;
  143777. /**
  143778. * Gets the output component
  143779. */
  143780. get output(): NodeMaterialConnectionPoint;
  143781. protected _buildBlock(state: NodeMaterialBuildState): this;
  143782. }
  143783. }
  143784. declare module BABYLON {
  143785. /**
  143786. * Block used to step a value
  143787. */
  143788. export class StepBlock extends NodeMaterialBlock {
  143789. /**
  143790. * Creates a new StepBlock
  143791. * @param name defines the block name
  143792. */
  143793. constructor(name: string);
  143794. /**
  143795. * Gets the current class name
  143796. * @returns the class name
  143797. */
  143798. getClassName(): string;
  143799. /**
  143800. * Gets the value operand input component
  143801. */
  143802. get value(): NodeMaterialConnectionPoint;
  143803. /**
  143804. * Gets the edge operand input component
  143805. */
  143806. get edge(): NodeMaterialConnectionPoint;
  143807. /**
  143808. * Gets the output component
  143809. */
  143810. get output(): NodeMaterialConnectionPoint;
  143811. protected _buildBlock(state: NodeMaterialBuildState): this;
  143812. }
  143813. }
  143814. declare module BABYLON {
  143815. /**
  143816. * Block used to get the opposite (1 - x) of a value
  143817. */
  143818. export class OneMinusBlock extends NodeMaterialBlock {
  143819. /**
  143820. * Creates a new OneMinusBlock
  143821. * @param name defines the block name
  143822. */
  143823. constructor(name: string);
  143824. /**
  143825. * Gets the current class name
  143826. * @returns the class name
  143827. */
  143828. getClassName(): string;
  143829. /**
  143830. * Gets the input component
  143831. */
  143832. get input(): NodeMaterialConnectionPoint;
  143833. /**
  143834. * Gets the output component
  143835. */
  143836. get output(): NodeMaterialConnectionPoint;
  143837. protected _buildBlock(state: NodeMaterialBuildState): this;
  143838. }
  143839. }
  143840. declare module BABYLON {
  143841. /**
  143842. * Block used to get the view direction
  143843. */
  143844. export class ViewDirectionBlock extends NodeMaterialBlock {
  143845. /**
  143846. * Creates a new ViewDirectionBlock
  143847. * @param name defines the block name
  143848. */
  143849. constructor(name: string);
  143850. /**
  143851. * Gets the current class name
  143852. * @returns the class name
  143853. */
  143854. getClassName(): string;
  143855. /**
  143856. * Gets the world position component
  143857. */
  143858. get worldPosition(): NodeMaterialConnectionPoint;
  143859. /**
  143860. * Gets the camera position component
  143861. */
  143862. get cameraPosition(): NodeMaterialConnectionPoint;
  143863. /**
  143864. * Gets the output component
  143865. */
  143866. get output(): NodeMaterialConnectionPoint;
  143867. autoConfigure(material: NodeMaterial): void;
  143868. protected _buildBlock(state: NodeMaterialBuildState): this;
  143869. }
  143870. }
  143871. declare module BABYLON {
  143872. /**
  143873. * Block used to compute fresnel value
  143874. */
  143875. export class FresnelBlock extends NodeMaterialBlock {
  143876. /**
  143877. * Create a new FresnelBlock
  143878. * @param name defines the block name
  143879. */
  143880. constructor(name: string);
  143881. /**
  143882. * Gets the current class name
  143883. * @returns the class name
  143884. */
  143885. getClassName(): string;
  143886. /**
  143887. * Gets the world normal input component
  143888. */
  143889. get worldNormal(): NodeMaterialConnectionPoint;
  143890. /**
  143891. * Gets the view direction input component
  143892. */
  143893. get viewDirection(): NodeMaterialConnectionPoint;
  143894. /**
  143895. * Gets the bias input component
  143896. */
  143897. get bias(): NodeMaterialConnectionPoint;
  143898. /**
  143899. * Gets the camera (or eye) position component
  143900. */
  143901. get power(): NodeMaterialConnectionPoint;
  143902. /**
  143903. * Gets the fresnel output component
  143904. */
  143905. get fresnel(): NodeMaterialConnectionPoint;
  143906. autoConfigure(material: NodeMaterial): void;
  143907. protected _buildBlock(state: NodeMaterialBuildState): this;
  143908. }
  143909. }
  143910. declare module BABYLON {
  143911. /**
  143912. * Block used to get the max of 2 values
  143913. */
  143914. export class MaxBlock extends NodeMaterialBlock {
  143915. /**
  143916. * Creates a new MaxBlock
  143917. * @param name defines the block name
  143918. */
  143919. constructor(name: string);
  143920. /**
  143921. * Gets the current class name
  143922. * @returns the class name
  143923. */
  143924. getClassName(): string;
  143925. /**
  143926. * Gets the left operand input component
  143927. */
  143928. get left(): NodeMaterialConnectionPoint;
  143929. /**
  143930. * Gets the right operand input component
  143931. */
  143932. get right(): NodeMaterialConnectionPoint;
  143933. /**
  143934. * Gets the output component
  143935. */
  143936. get output(): NodeMaterialConnectionPoint;
  143937. protected _buildBlock(state: NodeMaterialBuildState): this;
  143938. }
  143939. }
  143940. declare module BABYLON {
  143941. /**
  143942. * Block used to get the min of 2 values
  143943. */
  143944. export class MinBlock extends NodeMaterialBlock {
  143945. /**
  143946. * Creates a new MinBlock
  143947. * @param name defines the block name
  143948. */
  143949. constructor(name: string);
  143950. /**
  143951. * Gets the current class name
  143952. * @returns the class name
  143953. */
  143954. getClassName(): string;
  143955. /**
  143956. * Gets the left operand input component
  143957. */
  143958. get left(): NodeMaterialConnectionPoint;
  143959. /**
  143960. * Gets the right operand input component
  143961. */
  143962. get right(): NodeMaterialConnectionPoint;
  143963. /**
  143964. * Gets the output component
  143965. */
  143966. get output(): NodeMaterialConnectionPoint;
  143967. protected _buildBlock(state: NodeMaterialBuildState): this;
  143968. }
  143969. }
  143970. declare module BABYLON {
  143971. /**
  143972. * Block used to get the distance between 2 values
  143973. */
  143974. export class DistanceBlock extends NodeMaterialBlock {
  143975. /**
  143976. * Creates a new DistanceBlock
  143977. * @param name defines the block name
  143978. */
  143979. constructor(name: string);
  143980. /**
  143981. * Gets the current class name
  143982. * @returns the class name
  143983. */
  143984. getClassName(): string;
  143985. /**
  143986. * Gets the left operand input component
  143987. */
  143988. get left(): NodeMaterialConnectionPoint;
  143989. /**
  143990. * Gets the right operand input component
  143991. */
  143992. get right(): NodeMaterialConnectionPoint;
  143993. /**
  143994. * Gets the output component
  143995. */
  143996. get output(): NodeMaterialConnectionPoint;
  143997. protected _buildBlock(state: NodeMaterialBuildState): this;
  143998. }
  143999. }
  144000. declare module BABYLON {
  144001. /**
  144002. * Block used to get the length of a vector
  144003. */
  144004. export class LengthBlock extends NodeMaterialBlock {
  144005. /**
  144006. * Creates a new LengthBlock
  144007. * @param name defines the block name
  144008. */
  144009. constructor(name: string);
  144010. /**
  144011. * Gets the current class name
  144012. * @returns the class name
  144013. */
  144014. getClassName(): string;
  144015. /**
  144016. * Gets the value input component
  144017. */
  144018. get value(): NodeMaterialConnectionPoint;
  144019. /**
  144020. * Gets the output component
  144021. */
  144022. get output(): NodeMaterialConnectionPoint;
  144023. protected _buildBlock(state: NodeMaterialBuildState): this;
  144024. }
  144025. }
  144026. declare module BABYLON {
  144027. /**
  144028. * Block used to get negative version of a value (i.e. x * -1)
  144029. */
  144030. export class NegateBlock extends NodeMaterialBlock {
  144031. /**
  144032. * Creates a new NegateBlock
  144033. * @param name defines the block name
  144034. */
  144035. constructor(name: string);
  144036. /**
  144037. * Gets the current class name
  144038. * @returns the class name
  144039. */
  144040. getClassName(): string;
  144041. /**
  144042. * Gets the value input component
  144043. */
  144044. get value(): NodeMaterialConnectionPoint;
  144045. /**
  144046. * Gets the output component
  144047. */
  144048. get output(): NodeMaterialConnectionPoint;
  144049. protected _buildBlock(state: NodeMaterialBuildState): this;
  144050. }
  144051. }
  144052. declare module BABYLON {
  144053. /**
  144054. * Block used to get the value of the first parameter raised to the power of the second
  144055. */
  144056. export class PowBlock extends NodeMaterialBlock {
  144057. /**
  144058. * Creates a new PowBlock
  144059. * @param name defines the block name
  144060. */
  144061. constructor(name: string);
  144062. /**
  144063. * Gets the current class name
  144064. * @returns the class name
  144065. */
  144066. getClassName(): string;
  144067. /**
  144068. * Gets the value operand input component
  144069. */
  144070. get value(): NodeMaterialConnectionPoint;
  144071. /**
  144072. * Gets the power operand input component
  144073. */
  144074. get power(): NodeMaterialConnectionPoint;
  144075. /**
  144076. * Gets the output component
  144077. */
  144078. get output(): NodeMaterialConnectionPoint;
  144079. protected _buildBlock(state: NodeMaterialBuildState): this;
  144080. }
  144081. }
  144082. declare module BABYLON {
  144083. /**
  144084. * Block used to get a random number
  144085. */
  144086. export class RandomNumberBlock extends NodeMaterialBlock {
  144087. /**
  144088. * Creates a new RandomNumberBlock
  144089. * @param name defines the block name
  144090. */
  144091. constructor(name: string);
  144092. /**
  144093. * Gets the current class name
  144094. * @returns the class name
  144095. */
  144096. getClassName(): string;
  144097. /**
  144098. * Gets the seed input component
  144099. */
  144100. get seed(): NodeMaterialConnectionPoint;
  144101. /**
  144102. * Gets the output component
  144103. */
  144104. get output(): NodeMaterialConnectionPoint;
  144105. protected _buildBlock(state: NodeMaterialBuildState): this;
  144106. }
  144107. }
  144108. declare module BABYLON {
  144109. /**
  144110. * Block used to compute arc tangent of 2 values
  144111. */
  144112. export class ArcTan2Block extends NodeMaterialBlock {
  144113. /**
  144114. * Creates a new ArcTan2Block
  144115. * @param name defines the block name
  144116. */
  144117. constructor(name: string);
  144118. /**
  144119. * Gets the current class name
  144120. * @returns the class name
  144121. */
  144122. getClassName(): string;
  144123. /**
  144124. * Gets the x operand input component
  144125. */
  144126. get x(): NodeMaterialConnectionPoint;
  144127. /**
  144128. * Gets the y operand input component
  144129. */
  144130. get y(): NodeMaterialConnectionPoint;
  144131. /**
  144132. * Gets the output component
  144133. */
  144134. get output(): NodeMaterialConnectionPoint;
  144135. protected _buildBlock(state: NodeMaterialBuildState): this;
  144136. }
  144137. }
  144138. declare module BABYLON {
  144139. /**
  144140. * Block used to smooth step a value
  144141. */
  144142. export class SmoothStepBlock extends NodeMaterialBlock {
  144143. /**
  144144. * Creates a new SmoothStepBlock
  144145. * @param name defines the block name
  144146. */
  144147. constructor(name: string);
  144148. /**
  144149. * Gets the current class name
  144150. * @returns the class name
  144151. */
  144152. getClassName(): string;
  144153. /**
  144154. * Gets the value operand input component
  144155. */
  144156. get value(): NodeMaterialConnectionPoint;
  144157. /**
  144158. * Gets the first edge operand input component
  144159. */
  144160. get edge0(): NodeMaterialConnectionPoint;
  144161. /**
  144162. * Gets the second edge operand input component
  144163. */
  144164. get edge1(): NodeMaterialConnectionPoint;
  144165. /**
  144166. * Gets the output component
  144167. */
  144168. get output(): NodeMaterialConnectionPoint;
  144169. protected _buildBlock(state: NodeMaterialBuildState): this;
  144170. }
  144171. }
  144172. declare module BABYLON {
  144173. /**
  144174. * Block used to get the reciprocal (1 / x) of a value
  144175. */
  144176. export class ReciprocalBlock extends NodeMaterialBlock {
  144177. /**
  144178. * Creates a new ReciprocalBlock
  144179. * @param name defines the block name
  144180. */
  144181. constructor(name: string);
  144182. /**
  144183. * Gets the current class name
  144184. * @returns the class name
  144185. */
  144186. getClassName(): string;
  144187. /**
  144188. * Gets the input component
  144189. */
  144190. get input(): NodeMaterialConnectionPoint;
  144191. /**
  144192. * Gets the output component
  144193. */
  144194. get output(): NodeMaterialConnectionPoint;
  144195. protected _buildBlock(state: NodeMaterialBuildState): this;
  144196. }
  144197. }
  144198. declare module BABYLON {
  144199. /**
  144200. * Block used to replace a color by another one
  144201. */
  144202. export class ReplaceColorBlock extends NodeMaterialBlock {
  144203. /**
  144204. * Creates a new ReplaceColorBlock
  144205. * @param name defines the block name
  144206. */
  144207. constructor(name: string);
  144208. /**
  144209. * Gets the current class name
  144210. * @returns the class name
  144211. */
  144212. getClassName(): string;
  144213. /**
  144214. * Gets the value input component
  144215. */
  144216. get value(): NodeMaterialConnectionPoint;
  144217. /**
  144218. * Gets the reference input component
  144219. */
  144220. get reference(): NodeMaterialConnectionPoint;
  144221. /**
  144222. * Gets the distance input component
  144223. */
  144224. get distance(): NodeMaterialConnectionPoint;
  144225. /**
  144226. * Gets the replacement input component
  144227. */
  144228. get replacement(): NodeMaterialConnectionPoint;
  144229. /**
  144230. * Gets the output component
  144231. */
  144232. get output(): NodeMaterialConnectionPoint;
  144233. protected _buildBlock(state: NodeMaterialBuildState): this;
  144234. }
  144235. }
  144236. declare module BABYLON {
  144237. /**
  144238. * Block used to posterize a value
  144239. * @see https://en.wikipedia.org/wiki/Posterization
  144240. */
  144241. export class PosterizeBlock extends NodeMaterialBlock {
  144242. /**
  144243. * Creates a new PosterizeBlock
  144244. * @param name defines the block name
  144245. */
  144246. constructor(name: string);
  144247. /**
  144248. * Gets the current class name
  144249. * @returns the class name
  144250. */
  144251. getClassName(): string;
  144252. /**
  144253. * Gets the value input component
  144254. */
  144255. get value(): NodeMaterialConnectionPoint;
  144256. /**
  144257. * Gets the steps input component
  144258. */
  144259. get steps(): NodeMaterialConnectionPoint;
  144260. /**
  144261. * Gets the output component
  144262. */
  144263. get output(): NodeMaterialConnectionPoint;
  144264. protected _buildBlock(state: NodeMaterialBuildState): this;
  144265. }
  144266. }
  144267. declare module BABYLON {
  144268. /**
  144269. * Operations supported by the Wave block
  144270. */
  144271. export enum WaveBlockKind {
  144272. /** SawTooth */
  144273. SawTooth = 0,
  144274. /** Square */
  144275. Square = 1,
  144276. /** Triangle */
  144277. Triangle = 2
  144278. }
  144279. /**
  144280. * Block used to apply wave operation to floats
  144281. */
  144282. export class WaveBlock extends NodeMaterialBlock {
  144283. /**
  144284. * Gets or sets the kibnd of wave to be applied by the block
  144285. */
  144286. kind: WaveBlockKind;
  144287. /**
  144288. * Creates a new WaveBlock
  144289. * @param name defines the block name
  144290. */
  144291. constructor(name: string);
  144292. /**
  144293. * Gets the current class name
  144294. * @returns the class name
  144295. */
  144296. getClassName(): string;
  144297. /**
  144298. * Gets the input component
  144299. */
  144300. get input(): NodeMaterialConnectionPoint;
  144301. /**
  144302. * Gets the output component
  144303. */
  144304. get output(): NodeMaterialConnectionPoint;
  144305. protected _buildBlock(state: NodeMaterialBuildState): this;
  144306. serialize(): any;
  144307. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144308. }
  144309. }
  144310. declare module BABYLON {
  144311. /**
  144312. * Class used to store a color step for the GradientBlock
  144313. */
  144314. export class GradientBlockColorStep {
  144315. private _step;
  144316. /**
  144317. * Gets value indicating which step this color is associated with (between 0 and 1)
  144318. */
  144319. get step(): number;
  144320. /**
  144321. * Sets a value indicating which step this color is associated with (between 0 and 1)
  144322. */
  144323. set step(val: number);
  144324. private _color;
  144325. /**
  144326. * Gets the color associated with this step
  144327. */
  144328. get color(): Color3;
  144329. /**
  144330. * Sets the color associated with this step
  144331. */
  144332. set color(val: Color3);
  144333. /**
  144334. * Creates a new GradientBlockColorStep
  144335. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  144336. * @param color defines the color associated with this step
  144337. */
  144338. constructor(step: number, color: Color3);
  144339. }
  144340. /**
  144341. * Block used to return a color from a gradient based on an input value between 0 and 1
  144342. */
  144343. export class GradientBlock extends NodeMaterialBlock {
  144344. /**
  144345. * Gets or sets the list of color steps
  144346. */
  144347. colorSteps: GradientBlockColorStep[];
  144348. /** Gets an observable raised when the value is changed */
  144349. onValueChangedObservable: Observable<GradientBlock>;
  144350. /** calls observable when the value is changed*/
  144351. colorStepsUpdated(): void;
  144352. /**
  144353. * Creates a new GradientBlock
  144354. * @param name defines the block name
  144355. */
  144356. constructor(name: string);
  144357. /**
  144358. * Gets the current class name
  144359. * @returns the class name
  144360. */
  144361. getClassName(): string;
  144362. /**
  144363. * Gets the gradient input component
  144364. */
  144365. get gradient(): NodeMaterialConnectionPoint;
  144366. /**
  144367. * Gets the output component
  144368. */
  144369. get output(): NodeMaterialConnectionPoint;
  144370. private _writeColorConstant;
  144371. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144372. serialize(): any;
  144373. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144374. protected _dumpPropertiesCode(): string;
  144375. }
  144376. }
  144377. declare module BABYLON {
  144378. /**
  144379. * Block used to normalize lerp between 2 values
  144380. */
  144381. export class NLerpBlock extends NodeMaterialBlock {
  144382. /**
  144383. * Creates a new NLerpBlock
  144384. * @param name defines the block name
  144385. */
  144386. constructor(name: string);
  144387. /**
  144388. * Gets the current class name
  144389. * @returns the class name
  144390. */
  144391. getClassName(): string;
  144392. /**
  144393. * Gets the left operand input component
  144394. */
  144395. get left(): NodeMaterialConnectionPoint;
  144396. /**
  144397. * Gets the right operand input component
  144398. */
  144399. get right(): NodeMaterialConnectionPoint;
  144400. /**
  144401. * Gets the gradient operand input component
  144402. */
  144403. get gradient(): NodeMaterialConnectionPoint;
  144404. /**
  144405. * Gets the output component
  144406. */
  144407. get output(): NodeMaterialConnectionPoint;
  144408. protected _buildBlock(state: NodeMaterialBuildState): this;
  144409. }
  144410. }
  144411. declare module BABYLON {
  144412. /**
  144413. * block used to Generate a Worley Noise 3D Noise Pattern
  144414. */
  144415. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  144416. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  144417. manhattanDistance: boolean;
  144418. /**
  144419. * Creates a new WorleyNoise3DBlock
  144420. * @param name defines the block name
  144421. */
  144422. constructor(name: string);
  144423. /**
  144424. * Gets the current class name
  144425. * @returns the class name
  144426. */
  144427. getClassName(): string;
  144428. /**
  144429. * Gets the seed input component
  144430. */
  144431. get seed(): NodeMaterialConnectionPoint;
  144432. /**
  144433. * Gets the jitter input component
  144434. */
  144435. get jitter(): NodeMaterialConnectionPoint;
  144436. /**
  144437. * Gets the output component
  144438. */
  144439. get output(): NodeMaterialConnectionPoint;
  144440. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144441. /**
  144442. * Exposes the properties to the UI?
  144443. */
  144444. protected _dumpPropertiesCode(): string;
  144445. /**
  144446. * Exposes the properties to the Seralize?
  144447. */
  144448. serialize(): any;
  144449. /**
  144450. * Exposes the properties to the deseralize?
  144451. */
  144452. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144453. }
  144454. }
  144455. declare module BABYLON {
  144456. /**
  144457. * block used to Generate a Simplex Perlin 3d Noise Pattern
  144458. */
  144459. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  144460. /**
  144461. * Creates a new SimplexPerlin3DBlock
  144462. * @param name defines the block name
  144463. */
  144464. constructor(name: string);
  144465. /**
  144466. * Gets the current class name
  144467. * @returns the class name
  144468. */
  144469. getClassName(): string;
  144470. /**
  144471. * Gets the seed operand input component
  144472. */
  144473. get seed(): NodeMaterialConnectionPoint;
  144474. /**
  144475. * Gets the output component
  144476. */
  144477. get output(): NodeMaterialConnectionPoint;
  144478. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144479. }
  144480. }
  144481. declare module BABYLON {
  144482. /**
  144483. * Block used to blend normals
  144484. */
  144485. export class NormalBlendBlock extends NodeMaterialBlock {
  144486. /**
  144487. * Creates a new NormalBlendBlock
  144488. * @param name defines the block name
  144489. */
  144490. constructor(name: string);
  144491. /**
  144492. * Gets the current class name
  144493. * @returns the class name
  144494. */
  144495. getClassName(): string;
  144496. /**
  144497. * Gets the first input component
  144498. */
  144499. get normalMap0(): NodeMaterialConnectionPoint;
  144500. /**
  144501. * Gets the second input component
  144502. */
  144503. get normalMap1(): NodeMaterialConnectionPoint;
  144504. /**
  144505. * Gets the output component
  144506. */
  144507. get output(): NodeMaterialConnectionPoint;
  144508. protected _buildBlock(state: NodeMaterialBuildState): this;
  144509. }
  144510. }
  144511. declare module BABYLON {
  144512. /**
  144513. * Block used to rotate a 2d vector by a given angle
  144514. */
  144515. export class Rotate2dBlock extends NodeMaterialBlock {
  144516. /**
  144517. * Creates a new Rotate2dBlock
  144518. * @param name defines the block name
  144519. */
  144520. constructor(name: string);
  144521. /**
  144522. * Gets the current class name
  144523. * @returns the class name
  144524. */
  144525. getClassName(): string;
  144526. /**
  144527. * Gets the input vector
  144528. */
  144529. get input(): NodeMaterialConnectionPoint;
  144530. /**
  144531. * Gets the input angle
  144532. */
  144533. get angle(): NodeMaterialConnectionPoint;
  144534. /**
  144535. * Gets the output component
  144536. */
  144537. get output(): NodeMaterialConnectionPoint;
  144538. autoConfigure(material: NodeMaterial): void;
  144539. protected _buildBlock(state: NodeMaterialBuildState): this;
  144540. }
  144541. }
  144542. declare module BABYLON {
  144543. /**
  144544. * Block used to get the reflected vector from a direction and a normal
  144545. */
  144546. export class ReflectBlock extends NodeMaterialBlock {
  144547. /**
  144548. * Creates a new ReflectBlock
  144549. * @param name defines the block name
  144550. */
  144551. constructor(name: string);
  144552. /**
  144553. * Gets the current class name
  144554. * @returns the class name
  144555. */
  144556. getClassName(): string;
  144557. /**
  144558. * Gets the incident component
  144559. */
  144560. get incident(): NodeMaterialConnectionPoint;
  144561. /**
  144562. * Gets the normal component
  144563. */
  144564. get normal(): NodeMaterialConnectionPoint;
  144565. /**
  144566. * Gets the output component
  144567. */
  144568. get output(): NodeMaterialConnectionPoint;
  144569. protected _buildBlock(state: NodeMaterialBuildState): this;
  144570. }
  144571. }
  144572. declare module BABYLON {
  144573. /**
  144574. * Block used to get the refracted vector from a direction and a normal
  144575. */
  144576. export class RefractBlock extends NodeMaterialBlock {
  144577. /**
  144578. * Creates a new RefractBlock
  144579. * @param name defines the block name
  144580. */
  144581. constructor(name: string);
  144582. /**
  144583. * Gets the current class name
  144584. * @returns the class name
  144585. */
  144586. getClassName(): string;
  144587. /**
  144588. * Gets the incident component
  144589. */
  144590. get incident(): NodeMaterialConnectionPoint;
  144591. /**
  144592. * Gets the normal component
  144593. */
  144594. get normal(): NodeMaterialConnectionPoint;
  144595. /**
  144596. * Gets the index of refraction component
  144597. */
  144598. get ior(): NodeMaterialConnectionPoint;
  144599. /**
  144600. * Gets the output component
  144601. */
  144602. get output(): NodeMaterialConnectionPoint;
  144603. protected _buildBlock(state: NodeMaterialBuildState): this;
  144604. }
  144605. }
  144606. declare module BABYLON {
  144607. /**
  144608. * Block used to desaturate a color
  144609. */
  144610. export class DesaturateBlock extends NodeMaterialBlock {
  144611. /**
  144612. * Creates a new DesaturateBlock
  144613. * @param name defines the block name
  144614. */
  144615. constructor(name: string);
  144616. /**
  144617. * Gets the current class name
  144618. * @returns the class name
  144619. */
  144620. getClassName(): string;
  144621. /**
  144622. * Gets the color operand input component
  144623. */
  144624. get color(): NodeMaterialConnectionPoint;
  144625. /**
  144626. * Gets the level operand input component
  144627. */
  144628. get level(): NodeMaterialConnectionPoint;
  144629. /**
  144630. * Gets the output component
  144631. */
  144632. get output(): NodeMaterialConnectionPoint;
  144633. protected _buildBlock(state: NodeMaterialBuildState): this;
  144634. }
  144635. }
  144636. declare module BABYLON {
  144637. /**
  144638. * Block used to implement the ambient occlusion module of the PBR material
  144639. */
  144640. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  144641. /**
  144642. * Create a new AmbientOcclusionBlock
  144643. * @param name defines the block name
  144644. */
  144645. constructor(name: string);
  144646. /**
  144647. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  144648. */
  144649. useAmbientInGrayScale: boolean;
  144650. /**
  144651. * Initialize the block and prepare the context for build
  144652. * @param state defines the state that will be used for the build
  144653. */
  144654. initialize(state: NodeMaterialBuildState): void;
  144655. /**
  144656. * Gets the current class name
  144657. * @returns the class name
  144658. */
  144659. getClassName(): string;
  144660. /**
  144661. * Gets the texture input component
  144662. */
  144663. get texture(): NodeMaterialConnectionPoint;
  144664. /**
  144665. * Gets the texture intensity component
  144666. */
  144667. get intensity(): NodeMaterialConnectionPoint;
  144668. /**
  144669. * Gets the direct light intensity input component
  144670. */
  144671. get directLightIntensity(): NodeMaterialConnectionPoint;
  144672. /**
  144673. * Gets the ambient occlusion object output component
  144674. */
  144675. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144676. /**
  144677. * Gets the main code of the block (fragment side)
  144678. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  144679. * @returns the shader code
  144680. */
  144681. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  144682. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144683. protected _buildBlock(state: NodeMaterialBuildState): this;
  144684. protected _dumpPropertiesCode(): string;
  144685. serialize(): any;
  144686. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144687. }
  144688. }
  144689. declare module BABYLON {
  144690. /**
  144691. * Block used to implement the reflection module of the PBR material
  144692. */
  144693. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  144694. /** @hidden */
  144695. _defineLODReflectionAlpha: string;
  144696. /** @hidden */
  144697. _defineLinearSpecularReflection: string;
  144698. private _vEnvironmentIrradianceName;
  144699. /** @hidden */
  144700. _vReflectionMicrosurfaceInfosName: string;
  144701. /** @hidden */
  144702. _vReflectionInfosName: string;
  144703. /** @hidden */
  144704. _vReflectionFilteringInfoName: string;
  144705. private _scene;
  144706. /**
  144707. * The three properties below are set by the main PBR block prior to calling methods of this class.
  144708. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144709. * It's less burden on the user side in the editor part.
  144710. */
  144711. /** @hidden */
  144712. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144713. /** @hidden */
  144714. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144715. /** @hidden */
  144716. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  144717. /**
  144718. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  144719. * diffuse part of the IBL.
  144720. */
  144721. useSphericalHarmonics: boolean;
  144722. /**
  144723. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  144724. */
  144725. forceIrradianceInFragment: boolean;
  144726. /**
  144727. * Create a new ReflectionBlock
  144728. * @param name defines the block name
  144729. */
  144730. constructor(name: string);
  144731. /**
  144732. * Gets the current class name
  144733. * @returns the class name
  144734. */
  144735. getClassName(): string;
  144736. /**
  144737. * Gets the position input component
  144738. */
  144739. get position(): NodeMaterialConnectionPoint;
  144740. /**
  144741. * Gets the world position input component
  144742. */
  144743. get worldPosition(): NodeMaterialConnectionPoint;
  144744. /**
  144745. * Gets the world normal input component
  144746. */
  144747. get worldNormal(): NodeMaterialConnectionPoint;
  144748. /**
  144749. * Gets the world input component
  144750. */
  144751. get world(): NodeMaterialConnectionPoint;
  144752. /**
  144753. * Gets the camera (or eye) position component
  144754. */
  144755. get cameraPosition(): NodeMaterialConnectionPoint;
  144756. /**
  144757. * Gets the view input component
  144758. */
  144759. get view(): NodeMaterialConnectionPoint;
  144760. /**
  144761. * Gets the color input component
  144762. */
  144763. get color(): NodeMaterialConnectionPoint;
  144764. /**
  144765. * Gets the reflection object output component
  144766. */
  144767. get reflection(): NodeMaterialConnectionPoint;
  144768. /**
  144769. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  144770. */
  144771. get hasTexture(): boolean;
  144772. /**
  144773. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  144774. */
  144775. get reflectionColor(): string;
  144776. protected _getTexture(): Nullable<BaseTexture>;
  144777. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144778. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144779. /**
  144780. * Gets the code to inject in the vertex shader
  144781. * @param state current state of the node material building
  144782. * @returns the shader code
  144783. */
  144784. handleVertexSide(state: NodeMaterialBuildState): string;
  144785. /**
  144786. * Gets the main code of the block (fragment side)
  144787. * @param state current state of the node material building
  144788. * @param normalVarName name of the existing variable corresponding to the normal
  144789. * @returns the shader code
  144790. */
  144791. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  144792. protected _buildBlock(state: NodeMaterialBuildState): this;
  144793. protected _dumpPropertiesCode(): string;
  144794. serialize(): any;
  144795. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144796. }
  144797. }
  144798. declare module BABYLON {
  144799. /**
  144800. * Block used to implement the sheen module of the PBR material
  144801. */
  144802. export class SheenBlock extends NodeMaterialBlock {
  144803. /**
  144804. * Create a new SheenBlock
  144805. * @param name defines the block name
  144806. */
  144807. constructor(name: string);
  144808. /**
  144809. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  144810. * It allows the strength of the sheen effect to not depend on the base color of the material,
  144811. * making it easier to setup and tweak the effect
  144812. */
  144813. albedoScaling: boolean;
  144814. /**
  144815. * Defines if the sheen is linked to the sheen color.
  144816. */
  144817. linkSheenWithAlbedo: boolean;
  144818. /**
  144819. * Initialize the block and prepare the context for build
  144820. * @param state defines the state that will be used for the build
  144821. */
  144822. initialize(state: NodeMaterialBuildState): void;
  144823. /**
  144824. * Gets the current class name
  144825. * @returns the class name
  144826. */
  144827. getClassName(): string;
  144828. /**
  144829. * Gets the intensity input component
  144830. */
  144831. get intensity(): NodeMaterialConnectionPoint;
  144832. /**
  144833. * Gets the color input component
  144834. */
  144835. get color(): NodeMaterialConnectionPoint;
  144836. /**
  144837. * Gets the roughness input component
  144838. */
  144839. get roughness(): NodeMaterialConnectionPoint;
  144840. /**
  144841. * Gets the sheen object output component
  144842. */
  144843. get sheen(): NodeMaterialConnectionPoint;
  144844. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144845. /**
  144846. * Gets the main code of the block (fragment side)
  144847. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144848. * @returns the shader code
  144849. */
  144850. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  144851. protected _buildBlock(state: NodeMaterialBuildState): this;
  144852. protected _dumpPropertiesCode(): string;
  144853. serialize(): any;
  144854. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144855. }
  144856. }
  144857. declare module BABYLON {
  144858. /**
  144859. * Block used to implement the reflectivity module of the PBR material
  144860. */
  144861. export class ReflectivityBlock extends NodeMaterialBlock {
  144862. private _metallicReflectanceColor;
  144863. private _metallicF0Factor;
  144864. /** @hidden */
  144865. _vMetallicReflectanceFactorsName: string;
  144866. /**
  144867. * The property below is set by the main PBR block prior to calling methods of this class.
  144868. */
  144869. /** @hidden */
  144870. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  144871. /**
  144872. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  144873. */
  144874. useAmbientOcclusionFromMetallicTextureRed: boolean;
  144875. /**
  144876. * Specifies if the metallic texture contains the metallness information in its blue channel.
  144877. */
  144878. useMetallnessFromMetallicTextureBlue: boolean;
  144879. /**
  144880. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  144881. */
  144882. useRoughnessFromMetallicTextureAlpha: boolean;
  144883. /**
  144884. * Specifies if the metallic texture contains the roughness information in its green channel.
  144885. */
  144886. useRoughnessFromMetallicTextureGreen: boolean;
  144887. /**
  144888. * Create a new ReflectivityBlock
  144889. * @param name defines the block name
  144890. */
  144891. constructor(name: string);
  144892. /**
  144893. * Initialize the block and prepare the context for build
  144894. * @param state defines the state that will be used for the build
  144895. */
  144896. initialize(state: NodeMaterialBuildState): void;
  144897. /**
  144898. * Gets the current class name
  144899. * @returns the class name
  144900. */
  144901. getClassName(): string;
  144902. /**
  144903. * Gets the metallic input component
  144904. */
  144905. get metallic(): NodeMaterialConnectionPoint;
  144906. /**
  144907. * Gets the roughness input component
  144908. */
  144909. get roughness(): NodeMaterialConnectionPoint;
  144910. /**
  144911. * Gets the texture input component
  144912. */
  144913. get texture(): NodeMaterialConnectionPoint;
  144914. /**
  144915. * Gets the reflectivity object output component
  144916. */
  144917. get reflectivity(): NodeMaterialConnectionPoint;
  144918. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144919. /**
  144920. * Gets the main code of the block (fragment side)
  144921. * @param state current state of the node material building
  144922. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144923. * @returns the shader code
  144924. */
  144925. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144926. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144927. protected _buildBlock(state: NodeMaterialBuildState): this;
  144928. protected _dumpPropertiesCode(): string;
  144929. serialize(): any;
  144930. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144931. }
  144932. }
  144933. declare module BABYLON {
  144934. /**
  144935. * Block used to implement the anisotropy module of the PBR material
  144936. */
  144937. export class AnisotropyBlock extends NodeMaterialBlock {
  144938. /**
  144939. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144940. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144941. * It's less burden on the user side in the editor part.
  144942. */
  144943. /** @hidden */
  144944. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144945. /** @hidden */
  144946. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144947. /**
  144948. * Create a new AnisotropyBlock
  144949. * @param name defines the block name
  144950. */
  144951. constructor(name: string);
  144952. /**
  144953. * Initialize the block and prepare the context for build
  144954. * @param state defines the state that will be used for the build
  144955. */
  144956. initialize(state: NodeMaterialBuildState): void;
  144957. /**
  144958. * Gets the current class name
  144959. * @returns the class name
  144960. */
  144961. getClassName(): string;
  144962. /**
  144963. * Gets the intensity input component
  144964. */
  144965. get intensity(): NodeMaterialConnectionPoint;
  144966. /**
  144967. * Gets the direction input component
  144968. */
  144969. get direction(): NodeMaterialConnectionPoint;
  144970. /**
  144971. * Gets the texture input component
  144972. */
  144973. get texture(): NodeMaterialConnectionPoint;
  144974. /**
  144975. * Gets the uv input component
  144976. */
  144977. get uv(): NodeMaterialConnectionPoint;
  144978. /**
  144979. * Gets the worldTangent input component
  144980. */
  144981. get worldTangent(): NodeMaterialConnectionPoint;
  144982. /**
  144983. * Gets the anisotropy object output component
  144984. */
  144985. get anisotropy(): NodeMaterialConnectionPoint;
  144986. private _generateTBNSpace;
  144987. /**
  144988. * Gets the main code of the block (fragment side)
  144989. * @param state current state of the node material building
  144990. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144991. * @returns the shader code
  144992. */
  144993. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144994. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144995. protected _buildBlock(state: NodeMaterialBuildState): this;
  144996. }
  144997. }
  144998. declare module BABYLON {
  144999. /**
  145000. * Block used to implement the clear coat module of the PBR material
  145001. */
  145002. export class ClearCoatBlock extends NodeMaterialBlock {
  145003. private _scene;
  145004. /**
  145005. * Create a new ClearCoatBlock
  145006. * @param name defines the block name
  145007. */
  145008. constructor(name: string);
  145009. /**
  145010. * Initialize the block and prepare the context for build
  145011. * @param state defines the state that will be used for the build
  145012. */
  145013. initialize(state: NodeMaterialBuildState): void;
  145014. /**
  145015. * Gets the current class name
  145016. * @returns the class name
  145017. */
  145018. getClassName(): string;
  145019. /**
  145020. * Gets the intensity input component
  145021. */
  145022. get intensity(): NodeMaterialConnectionPoint;
  145023. /**
  145024. * Gets the roughness input component
  145025. */
  145026. get roughness(): NodeMaterialConnectionPoint;
  145027. /**
  145028. * Gets the ior input component
  145029. */
  145030. get ior(): NodeMaterialConnectionPoint;
  145031. /**
  145032. * Gets the texture input component
  145033. */
  145034. get texture(): NodeMaterialConnectionPoint;
  145035. /**
  145036. * Gets the bump texture input component
  145037. */
  145038. get bumpTexture(): NodeMaterialConnectionPoint;
  145039. /**
  145040. * Gets the uv input component
  145041. */
  145042. get uv(): NodeMaterialConnectionPoint;
  145043. /**
  145044. * Gets the tint color input component
  145045. */
  145046. get tintColor(): NodeMaterialConnectionPoint;
  145047. /**
  145048. * Gets the tint "at distance" input component
  145049. */
  145050. get tintAtDistance(): NodeMaterialConnectionPoint;
  145051. /**
  145052. * Gets the tint thickness input component
  145053. */
  145054. get tintThickness(): NodeMaterialConnectionPoint;
  145055. /**
  145056. * Gets the world tangent input component
  145057. */
  145058. get worldTangent(): NodeMaterialConnectionPoint;
  145059. /**
  145060. * Gets the clear coat object output component
  145061. */
  145062. get clearcoat(): NodeMaterialConnectionPoint;
  145063. autoConfigure(material: NodeMaterial): void;
  145064. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145065. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  145066. private _generateTBNSpace;
  145067. /**
  145068. * Gets the main code of the block (fragment side)
  145069. * @param state current state of the node material building
  145070. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  145071. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  145072. * @param worldPosVarName name of the variable holding the world position
  145073. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  145074. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  145075. * @param worldNormalVarName name of the variable holding the world normal
  145076. * @returns the shader code
  145077. */
  145078. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  145079. protected _buildBlock(state: NodeMaterialBuildState): this;
  145080. }
  145081. }
  145082. declare module BABYLON {
  145083. /**
  145084. * Block used to implement the sub surface module of the PBR material
  145085. */
  145086. export class SubSurfaceBlock extends NodeMaterialBlock {
  145087. /**
  145088. * Create a new SubSurfaceBlock
  145089. * @param name defines the block name
  145090. */
  145091. constructor(name: string);
  145092. /**
  145093. * Stores the intensity of the different subsurface effects in the thickness texture.
  145094. * * the green channel is the translucency intensity.
  145095. * * the blue channel is the scattering intensity.
  145096. * * the alpha channel is the refraction intensity.
  145097. */
  145098. useMaskFromThicknessTexture: boolean;
  145099. /**
  145100. * Initialize the block and prepare the context for build
  145101. * @param state defines the state that will be used for the build
  145102. */
  145103. initialize(state: NodeMaterialBuildState): void;
  145104. /**
  145105. * Gets the current class name
  145106. * @returns the class name
  145107. */
  145108. getClassName(): string;
  145109. /**
  145110. * Gets the min thickness input component
  145111. */
  145112. get minThickness(): NodeMaterialConnectionPoint;
  145113. /**
  145114. * Gets the max thickness input component
  145115. */
  145116. get maxThickness(): NodeMaterialConnectionPoint;
  145117. /**
  145118. * Gets the thickness texture component
  145119. */
  145120. get thicknessTexture(): NodeMaterialConnectionPoint;
  145121. /**
  145122. * Gets the tint color input component
  145123. */
  145124. get tintColor(): NodeMaterialConnectionPoint;
  145125. /**
  145126. * Gets the translucency intensity input component
  145127. */
  145128. get translucencyIntensity(): NodeMaterialConnectionPoint;
  145129. /**
  145130. * Gets the translucency diffusion distance input component
  145131. */
  145132. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  145133. /**
  145134. * Gets the refraction object parameters
  145135. */
  145136. get refraction(): NodeMaterialConnectionPoint;
  145137. /**
  145138. * Gets the sub surface object output component
  145139. */
  145140. get subsurface(): NodeMaterialConnectionPoint;
  145141. autoConfigure(material: NodeMaterial): void;
  145142. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145143. /**
  145144. * Gets the main code of the block (fragment side)
  145145. * @param state current state of the node material building
  145146. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  145147. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  145148. * @param worldPosVarName name of the variable holding the world position
  145149. * @returns the shader code
  145150. */
  145151. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  145152. protected _buildBlock(state: NodeMaterialBuildState): this;
  145153. }
  145154. }
  145155. declare module BABYLON {
  145156. /**
  145157. * Block used to implement the PBR metallic/roughness model
  145158. */
  145159. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  145160. /**
  145161. * Gets or sets the light associated with this block
  145162. */
  145163. light: Nullable<Light>;
  145164. private _lightId;
  145165. private _scene;
  145166. private _environmentBRDFTexture;
  145167. private _environmentBrdfSamplerName;
  145168. private _vNormalWName;
  145169. private _invertNormalName;
  145170. /**
  145171. * Create a new ReflectionBlock
  145172. * @param name defines the block name
  145173. */
  145174. constructor(name: string);
  145175. /**
  145176. * Intensity of the direct lights e.g. the four lights available in your scene.
  145177. * This impacts both the direct diffuse and specular highlights.
  145178. */
  145179. directIntensity: number;
  145180. /**
  145181. * Intensity of the environment e.g. how much the environment will light the object
  145182. * either through harmonics for rough material or through the refelction for shiny ones.
  145183. */
  145184. environmentIntensity: number;
  145185. /**
  145186. * This is a special control allowing the reduction of the specular highlights coming from the
  145187. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  145188. */
  145189. specularIntensity: number;
  145190. /**
  145191. * Defines the falloff type used in this material.
  145192. * It by default is Physical.
  145193. */
  145194. lightFalloff: number;
  145195. /**
  145196. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  145197. */
  145198. useAlphaFromAlbedoTexture: boolean;
  145199. /**
  145200. * Specifies that alpha test should be used
  145201. */
  145202. useAlphaTest: boolean;
  145203. /**
  145204. * Defines the alpha limits in alpha test mode.
  145205. */
  145206. alphaTestCutoff: number;
  145207. /**
  145208. * Specifies that alpha blending should be used
  145209. */
  145210. useAlphaBlending: boolean;
  145211. /**
  145212. * Defines if the alpha value should be determined via the rgb values.
  145213. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  145214. */
  145215. opacityRGB: boolean;
  145216. /**
  145217. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  145218. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  145219. */
  145220. useRadianceOverAlpha: boolean;
  145221. /**
  145222. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  145223. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  145224. */
  145225. useSpecularOverAlpha: boolean;
  145226. /**
  145227. * Enables specular anti aliasing in the PBR shader.
  145228. * It will both interacts on the Geometry for analytical and IBL lighting.
  145229. * It also prefilter the roughness map based on the bump values.
  145230. */
  145231. enableSpecularAntiAliasing: boolean;
  145232. /**
  145233. * Enables realtime filtering on the texture.
  145234. */
  145235. realTimeFiltering: boolean;
  145236. /**
  145237. * Quality switch for realtime filtering
  145238. */
  145239. realTimeFilteringQuality: number;
  145240. /**
  145241. * Defines if the material uses energy conservation.
  145242. */
  145243. useEnergyConservation: boolean;
  145244. /**
  145245. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  145246. * too much the area relying on ambient texture to define their ambient occlusion.
  145247. */
  145248. useRadianceOcclusion: boolean;
  145249. /**
  145250. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  145251. * makes the reflect vector face the model (under horizon).
  145252. */
  145253. useHorizonOcclusion: boolean;
  145254. /**
  145255. * If set to true, no lighting calculations will be applied.
  145256. */
  145257. unlit: boolean;
  145258. /**
  145259. * Force normal to face away from face.
  145260. */
  145261. forceNormalForward: boolean;
  145262. /**
  145263. * Defines the material debug mode.
  145264. * It helps seeing only some components of the material while troubleshooting.
  145265. */
  145266. debugMode: number;
  145267. /**
  145268. * Specify from where on screen the debug mode should start.
  145269. * The value goes from -1 (full screen) to 1 (not visible)
  145270. * It helps with side by side comparison against the final render
  145271. * This defaults to 0
  145272. */
  145273. debugLimit: number;
  145274. /**
  145275. * As the default viewing range might not be enough (if the ambient is really small for instance)
  145276. * You can use the factor to better multiply the final value.
  145277. */
  145278. debugFactor: number;
  145279. /**
  145280. * Initialize the block and prepare the context for build
  145281. * @param state defines the state that will be used for the build
  145282. */
  145283. initialize(state: NodeMaterialBuildState): void;
  145284. /**
  145285. * Gets the current class name
  145286. * @returns the class name
  145287. */
  145288. getClassName(): string;
  145289. /**
  145290. * Gets the world position input component
  145291. */
  145292. get worldPosition(): NodeMaterialConnectionPoint;
  145293. /**
  145294. * Gets the world normal input component
  145295. */
  145296. get worldNormal(): NodeMaterialConnectionPoint;
  145297. /**
  145298. * Gets the perturbed normal input component
  145299. */
  145300. get perturbedNormal(): NodeMaterialConnectionPoint;
  145301. /**
  145302. * Gets the camera position input component
  145303. */
  145304. get cameraPosition(): NodeMaterialConnectionPoint;
  145305. /**
  145306. * Gets the base color input component
  145307. */
  145308. get baseColor(): NodeMaterialConnectionPoint;
  145309. /**
  145310. * Gets the opacity texture input component
  145311. */
  145312. get opacityTexture(): NodeMaterialConnectionPoint;
  145313. /**
  145314. * Gets the ambient color input component
  145315. */
  145316. get ambientColor(): NodeMaterialConnectionPoint;
  145317. /**
  145318. * Gets the reflectivity object parameters
  145319. */
  145320. get reflectivity(): NodeMaterialConnectionPoint;
  145321. /**
  145322. * Gets the ambient occlusion object parameters
  145323. */
  145324. get ambientOcclusion(): NodeMaterialConnectionPoint;
  145325. /**
  145326. * Gets the reflection object parameters
  145327. */
  145328. get reflection(): NodeMaterialConnectionPoint;
  145329. /**
  145330. * Gets the sheen object parameters
  145331. */
  145332. get sheen(): NodeMaterialConnectionPoint;
  145333. /**
  145334. * Gets the clear coat object parameters
  145335. */
  145336. get clearcoat(): NodeMaterialConnectionPoint;
  145337. /**
  145338. * Gets the sub surface object parameters
  145339. */
  145340. get subsurface(): NodeMaterialConnectionPoint;
  145341. /**
  145342. * Gets the anisotropy object parameters
  145343. */
  145344. get anisotropy(): NodeMaterialConnectionPoint;
  145345. /**
  145346. * Gets the ambient output component
  145347. */
  145348. get ambient(): NodeMaterialConnectionPoint;
  145349. /**
  145350. * Gets the diffuse output component
  145351. */
  145352. get diffuse(): NodeMaterialConnectionPoint;
  145353. /**
  145354. * Gets the specular output component
  145355. */
  145356. get specular(): NodeMaterialConnectionPoint;
  145357. /**
  145358. * Gets the sheen output component
  145359. */
  145360. get sheenDir(): NodeMaterialConnectionPoint;
  145361. /**
  145362. * Gets the clear coat output component
  145363. */
  145364. get clearcoatDir(): NodeMaterialConnectionPoint;
  145365. /**
  145366. * Gets the indirect diffuse output component
  145367. */
  145368. get diffuseIndirect(): NodeMaterialConnectionPoint;
  145369. /**
  145370. * Gets the indirect specular output component
  145371. */
  145372. get specularIndirect(): NodeMaterialConnectionPoint;
  145373. /**
  145374. * Gets the indirect sheen output component
  145375. */
  145376. get sheenIndirect(): NodeMaterialConnectionPoint;
  145377. /**
  145378. * Gets the indirect clear coat output component
  145379. */
  145380. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  145381. /**
  145382. * Gets the refraction output component
  145383. */
  145384. get refraction(): NodeMaterialConnectionPoint;
  145385. /**
  145386. * Gets the global lighting output component
  145387. */
  145388. get lighting(): NodeMaterialConnectionPoint;
  145389. /**
  145390. * Gets the shadow output component
  145391. */
  145392. get shadow(): NodeMaterialConnectionPoint;
  145393. /**
  145394. * Gets the alpha output component
  145395. */
  145396. get alpha(): NodeMaterialConnectionPoint;
  145397. autoConfigure(material: NodeMaterial): void;
  145398. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145399. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  145400. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  145401. private _injectVertexCode;
  145402. /**
  145403. * Gets the code corresponding to the albedo/opacity module
  145404. * @returns the shader code
  145405. */
  145406. getAlbedoOpacityCode(): string;
  145407. protected _buildBlock(state: NodeMaterialBuildState): this;
  145408. protected _dumpPropertiesCode(): string;
  145409. serialize(): any;
  145410. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145411. }
  145412. }
  145413. declare module BABYLON {
  145414. /**
  145415. * Block used to compute value of one parameter modulo another
  145416. */
  145417. export class ModBlock extends NodeMaterialBlock {
  145418. /**
  145419. * Creates a new ModBlock
  145420. * @param name defines the block name
  145421. */
  145422. constructor(name: string);
  145423. /**
  145424. * Gets the current class name
  145425. * @returns the class name
  145426. */
  145427. getClassName(): string;
  145428. /**
  145429. * Gets the left operand input component
  145430. */
  145431. get left(): NodeMaterialConnectionPoint;
  145432. /**
  145433. * Gets the right operand input component
  145434. */
  145435. get right(): NodeMaterialConnectionPoint;
  145436. /**
  145437. * Gets the output component
  145438. */
  145439. get output(): NodeMaterialConnectionPoint;
  145440. protected _buildBlock(state: NodeMaterialBuildState): this;
  145441. }
  145442. }
  145443. declare module BABYLON {
  145444. /**
  145445. * Configuration for Draco compression
  145446. */
  145447. export interface IDracoCompressionConfiguration {
  145448. /**
  145449. * Configuration for the decoder.
  145450. */
  145451. decoder: {
  145452. /**
  145453. * The url to the WebAssembly module.
  145454. */
  145455. wasmUrl?: string;
  145456. /**
  145457. * The url to the WebAssembly binary.
  145458. */
  145459. wasmBinaryUrl?: string;
  145460. /**
  145461. * The url to the fallback JavaScript module.
  145462. */
  145463. fallbackUrl?: string;
  145464. };
  145465. }
  145466. /**
  145467. * Draco compression (https://google.github.io/draco/)
  145468. *
  145469. * This class wraps the Draco module.
  145470. *
  145471. * **Encoder**
  145472. *
  145473. * The encoder is not currently implemented.
  145474. *
  145475. * **Decoder**
  145476. *
  145477. * 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.
  145478. *
  145479. * To update the configuration, use the following code:
  145480. * ```javascript
  145481. * DracoCompression.Configuration = {
  145482. * decoder: {
  145483. * wasmUrl: "<url to the WebAssembly library>",
  145484. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  145485. * fallbackUrl: "<url to the fallback JavaScript library>",
  145486. * }
  145487. * };
  145488. * ```
  145489. *
  145490. * 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.
  145491. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  145492. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  145493. *
  145494. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  145495. * ```javascript
  145496. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  145497. * ```
  145498. *
  145499. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  145500. */
  145501. export class DracoCompression implements IDisposable {
  145502. private _workerPoolPromise?;
  145503. private _decoderModulePromise?;
  145504. /**
  145505. * The configuration. Defaults to the following urls:
  145506. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  145507. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  145508. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  145509. */
  145510. static Configuration: IDracoCompressionConfiguration;
  145511. /**
  145512. * Returns true if the decoder configuration is available.
  145513. */
  145514. static get DecoderAvailable(): boolean;
  145515. /**
  145516. * Default number of workers to create when creating the draco compression object.
  145517. */
  145518. static DefaultNumWorkers: number;
  145519. private static GetDefaultNumWorkers;
  145520. private static _Default;
  145521. /**
  145522. * Default instance for the draco compression object.
  145523. */
  145524. static get Default(): DracoCompression;
  145525. /**
  145526. * Constructor
  145527. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  145528. */
  145529. constructor(numWorkers?: number);
  145530. /**
  145531. * Stop all async operations and release resources.
  145532. */
  145533. dispose(): void;
  145534. /**
  145535. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  145536. * @returns a promise that resolves when ready
  145537. */
  145538. whenReadyAsync(): Promise<void>;
  145539. /**
  145540. * Decode Draco compressed mesh data to vertex data.
  145541. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  145542. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  145543. * @returns A promise that resolves with the decoded vertex data
  145544. */
  145545. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  145546. [kind: string]: number;
  145547. }): Promise<VertexData>;
  145548. }
  145549. }
  145550. declare module BABYLON {
  145551. /**
  145552. * Class for building Constructive Solid Geometry
  145553. */
  145554. export class CSG {
  145555. private polygons;
  145556. /**
  145557. * The world matrix
  145558. */
  145559. matrix: Matrix;
  145560. /**
  145561. * Stores the position
  145562. */
  145563. position: Vector3;
  145564. /**
  145565. * Stores the rotation
  145566. */
  145567. rotation: Vector3;
  145568. /**
  145569. * Stores the rotation quaternion
  145570. */
  145571. rotationQuaternion: Nullable<Quaternion>;
  145572. /**
  145573. * Stores the scaling vector
  145574. */
  145575. scaling: Vector3;
  145576. /**
  145577. * Convert the Mesh to CSG
  145578. * @param mesh The Mesh to convert to CSG
  145579. * @returns A new CSG from the Mesh
  145580. */
  145581. static FromMesh(mesh: Mesh): CSG;
  145582. /**
  145583. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  145584. * @param polygons Polygons used to construct a CSG solid
  145585. */
  145586. private static FromPolygons;
  145587. /**
  145588. * Clones, or makes a deep copy, of the CSG
  145589. * @returns A new CSG
  145590. */
  145591. clone(): CSG;
  145592. /**
  145593. * Unions this CSG with another CSG
  145594. * @param csg The CSG to union against this CSG
  145595. * @returns The unioned CSG
  145596. */
  145597. union(csg: CSG): CSG;
  145598. /**
  145599. * Unions this CSG with another CSG in place
  145600. * @param csg The CSG to union against this CSG
  145601. */
  145602. unionInPlace(csg: CSG): void;
  145603. /**
  145604. * Subtracts this CSG with another CSG
  145605. * @param csg The CSG to subtract against this CSG
  145606. * @returns A new CSG
  145607. */
  145608. subtract(csg: CSG): CSG;
  145609. /**
  145610. * Subtracts this CSG with another CSG in place
  145611. * @param csg The CSG to subtact against this CSG
  145612. */
  145613. subtractInPlace(csg: CSG): void;
  145614. /**
  145615. * Intersect this CSG with another CSG
  145616. * @param csg The CSG to intersect against this CSG
  145617. * @returns A new CSG
  145618. */
  145619. intersect(csg: CSG): CSG;
  145620. /**
  145621. * Intersects this CSG with another CSG in place
  145622. * @param csg The CSG to intersect against this CSG
  145623. */
  145624. intersectInPlace(csg: CSG): void;
  145625. /**
  145626. * Return a new CSG solid with solid and empty space switched. This solid is
  145627. * not modified.
  145628. * @returns A new CSG solid with solid and empty space switched
  145629. */
  145630. inverse(): CSG;
  145631. /**
  145632. * Inverses the CSG in place
  145633. */
  145634. inverseInPlace(): void;
  145635. /**
  145636. * This is used to keep meshes transformations so they can be restored
  145637. * when we build back a Babylon Mesh
  145638. * NB : All CSG operations are performed in world coordinates
  145639. * @param csg The CSG to copy the transform attributes from
  145640. * @returns This CSG
  145641. */
  145642. copyTransformAttributes(csg: CSG): CSG;
  145643. /**
  145644. * Build Raw mesh from CSG
  145645. * Coordinates here are in world space
  145646. * @param name The name of the mesh geometry
  145647. * @param scene The Scene
  145648. * @param keepSubMeshes Specifies if the submeshes should be kept
  145649. * @returns A new Mesh
  145650. */
  145651. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  145652. /**
  145653. * Build Mesh from CSG taking material and transforms into account
  145654. * @param name The name of the Mesh
  145655. * @param material The material of the Mesh
  145656. * @param scene The Scene
  145657. * @param keepSubMeshes Specifies if submeshes should be kept
  145658. * @returns The new Mesh
  145659. */
  145660. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  145661. }
  145662. }
  145663. declare module BABYLON {
  145664. /**
  145665. * Class used to create a trail following a mesh
  145666. */
  145667. export class TrailMesh extends Mesh {
  145668. private _generator;
  145669. private _autoStart;
  145670. private _running;
  145671. private _diameter;
  145672. private _length;
  145673. private _sectionPolygonPointsCount;
  145674. private _sectionVectors;
  145675. private _sectionNormalVectors;
  145676. private _beforeRenderObserver;
  145677. /**
  145678. * @constructor
  145679. * @param name The value used by scene.getMeshByName() to do a lookup.
  145680. * @param generator The mesh or transform node to generate a trail.
  145681. * @param scene The scene to add this mesh to.
  145682. * @param diameter Diameter of trailing mesh. Default is 1.
  145683. * @param length Length of trailing mesh. Default is 60.
  145684. * @param autoStart Automatically start trailing mesh. Default true.
  145685. */
  145686. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  145687. /**
  145688. * "TrailMesh"
  145689. * @returns "TrailMesh"
  145690. */
  145691. getClassName(): string;
  145692. private _createMesh;
  145693. /**
  145694. * Start trailing mesh.
  145695. */
  145696. start(): void;
  145697. /**
  145698. * Stop trailing mesh.
  145699. */
  145700. stop(): void;
  145701. /**
  145702. * Update trailing mesh geometry.
  145703. */
  145704. update(): void;
  145705. /**
  145706. * Returns a new TrailMesh object.
  145707. * @param name is a string, the name given to the new mesh
  145708. * @param newGenerator use new generator object for cloned trail mesh
  145709. * @returns a new mesh
  145710. */
  145711. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  145712. /**
  145713. * Serializes this trail mesh
  145714. * @param serializationObject object to write serialization to
  145715. */
  145716. serialize(serializationObject: any): void;
  145717. /**
  145718. * Parses a serialized trail mesh
  145719. * @param parsedMesh the serialized mesh
  145720. * @param scene the scene to create the trail mesh in
  145721. * @returns the created trail mesh
  145722. */
  145723. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  145724. }
  145725. }
  145726. declare module BABYLON {
  145727. /**
  145728. * Class containing static functions to help procedurally build meshes
  145729. */
  145730. export class TiledBoxBuilder {
  145731. /**
  145732. * Creates a box mesh
  145733. * 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)
  145734. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145735. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145736. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145738. * @param name defines the name of the mesh
  145739. * @param options defines the options used to create the mesh
  145740. * @param scene defines the hosting scene
  145741. * @returns the box mesh
  145742. */
  145743. static CreateTiledBox(name: string, options: {
  145744. pattern?: number;
  145745. width?: number;
  145746. height?: number;
  145747. depth?: number;
  145748. tileSize?: number;
  145749. tileWidth?: number;
  145750. tileHeight?: number;
  145751. alignHorizontal?: number;
  145752. alignVertical?: number;
  145753. faceUV?: Vector4[];
  145754. faceColors?: Color4[];
  145755. sideOrientation?: number;
  145756. updatable?: boolean;
  145757. }, scene?: Nullable<Scene>): Mesh;
  145758. }
  145759. }
  145760. declare module BABYLON {
  145761. /**
  145762. * Class containing static functions to help procedurally build meshes
  145763. */
  145764. export class TorusKnotBuilder {
  145765. /**
  145766. * Creates a torus knot mesh
  145767. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145768. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145769. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145770. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145771. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145772. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145774. * @param name defines the name of the mesh
  145775. * @param options defines the options used to create the mesh
  145776. * @param scene defines the hosting scene
  145777. * @returns the torus knot mesh
  145778. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145779. */
  145780. static CreateTorusKnot(name: string, options: {
  145781. radius?: number;
  145782. tube?: number;
  145783. radialSegments?: number;
  145784. tubularSegments?: number;
  145785. p?: number;
  145786. q?: number;
  145787. updatable?: boolean;
  145788. sideOrientation?: number;
  145789. frontUVs?: Vector4;
  145790. backUVs?: Vector4;
  145791. }, scene: any): Mesh;
  145792. }
  145793. }
  145794. declare module BABYLON {
  145795. /**
  145796. * Polygon
  145797. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  145798. */
  145799. export class Polygon {
  145800. /**
  145801. * Creates a rectangle
  145802. * @param xmin bottom X coord
  145803. * @param ymin bottom Y coord
  145804. * @param xmax top X coord
  145805. * @param ymax top Y coord
  145806. * @returns points that make the resulting rectation
  145807. */
  145808. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  145809. /**
  145810. * Creates a circle
  145811. * @param radius radius of circle
  145812. * @param cx scale in x
  145813. * @param cy scale in y
  145814. * @param numberOfSides number of sides that make up the circle
  145815. * @returns points that make the resulting circle
  145816. */
  145817. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  145818. /**
  145819. * Creates a polygon from input string
  145820. * @param input Input polygon data
  145821. * @returns the parsed points
  145822. */
  145823. static Parse(input: string): Vector2[];
  145824. /**
  145825. * Starts building a polygon from x and y coordinates
  145826. * @param x x coordinate
  145827. * @param y y coordinate
  145828. * @returns the started path2
  145829. */
  145830. static StartingAt(x: number, y: number): Path2;
  145831. }
  145832. /**
  145833. * Builds a polygon
  145834. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  145835. */
  145836. export class PolygonMeshBuilder {
  145837. private _points;
  145838. private _outlinepoints;
  145839. private _holes;
  145840. private _name;
  145841. private _scene;
  145842. private _epoints;
  145843. private _eholes;
  145844. private _addToepoint;
  145845. /**
  145846. * Babylon reference to the earcut plugin.
  145847. */
  145848. bjsEarcut: any;
  145849. /**
  145850. * Creates a PolygonMeshBuilder
  145851. * @param name name of the builder
  145852. * @param contours Path of the polygon
  145853. * @param scene scene to add to when creating the mesh
  145854. * @param earcutInjection can be used to inject your own earcut reference
  145855. */
  145856. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145857. /**
  145858. * Adds a whole within the polygon
  145859. * @param hole Array of points defining the hole
  145860. * @returns this
  145861. */
  145862. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145863. /**
  145864. * Creates the polygon
  145865. * @param updatable If the mesh should be updatable
  145866. * @param depth The depth of the mesh created
  145867. * @returns the created mesh
  145868. */
  145869. build(updatable?: boolean, depth?: number): Mesh;
  145870. /**
  145871. * Creates the polygon
  145872. * @param depth The depth of the mesh created
  145873. * @returns the created VertexData
  145874. */
  145875. buildVertexData(depth?: number): VertexData;
  145876. /**
  145877. * Adds a side to the polygon
  145878. * @param positions points that make the polygon
  145879. * @param normals normals of the polygon
  145880. * @param uvs uvs of the polygon
  145881. * @param indices indices of the polygon
  145882. * @param bounds bounds of the polygon
  145883. * @param points points of the polygon
  145884. * @param depth depth of the polygon
  145885. * @param flip flip of the polygon
  145886. */
  145887. private addSide;
  145888. }
  145889. }
  145890. declare module BABYLON {
  145891. /**
  145892. * Class containing static functions to help procedurally build meshes
  145893. */
  145894. export class PolygonBuilder {
  145895. /**
  145896. * Creates a polygon mesh
  145897. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145898. * * 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
  145899. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145901. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145902. * * Remember you can only change the shape positions, not their number when updating a polygon
  145903. * @param name defines the name of the mesh
  145904. * @param options defines the options used to create the mesh
  145905. * @param scene defines the hosting scene
  145906. * @param earcutInjection can be used to inject your own earcut reference
  145907. * @returns the polygon mesh
  145908. */
  145909. static CreatePolygon(name: string, options: {
  145910. shape: Vector3[];
  145911. holes?: Vector3[][];
  145912. depth?: number;
  145913. faceUV?: Vector4[];
  145914. faceColors?: Color4[];
  145915. updatable?: boolean;
  145916. sideOrientation?: number;
  145917. frontUVs?: Vector4;
  145918. backUVs?: Vector4;
  145919. wrap?: boolean;
  145920. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145921. /**
  145922. * Creates an extruded polygon mesh, with depth in the Y direction.
  145923. * * 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)
  145924. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145925. * @param name defines the name of the mesh
  145926. * @param options defines the options used to create the mesh
  145927. * @param scene defines the hosting scene
  145928. * @param earcutInjection can be used to inject your own earcut reference
  145929. * @returns the polygon mesh
  145930. */
  145931. static ExtrudePolygon(name: string, options: {
  145932. shape: Vector3[];
  145933. holes?: Vector3[][];
  145934. depth?: number;
  145935. faceUV?: Vector4[];
  145936. faceColors?: Color4[];
  145937. updatable?: boolean;
  145938. sideOrientation?: number;
  145939. frontUVs?: Vector4;
  145940. backUVs?: Vector4;
  145941. wrap?: boolean;
  145942. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145943. }
  145944. }
  145945. declare module BABYLON {
  145946. /**
  145947. * Class containing static functions to help procedurally build meshes
  145948. */
  145949. export class LatheBuilder {
  145950. /**
  145951. * Creates lathe mesh.
  145952. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145953. * * 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
  145954. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145955. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145956. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145957. * * 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
  145958. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145959. * * 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
  145960. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145961. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145962. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145963. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145964. * @param name defines the name of the mesh
  145965. * @param options defines the options used to create the mesh
  145966. * @param scene defines the hosting scene
  145967. * @returns the lathe mesh
  145968. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145969. */
  145970. static CreateLathe(name: string, options: {
  145971. shape: Vector3[];
  145972. radius?: number;
  145973. tessellation?: number;
  145974. clip?: number;
  145975. arc?: number;
  145976. closed?: boolean;
  145977. updatable?: boolean;
  145978. sideOrientation?: number;
  145979. frontUVs?: Vector4;
  145980. backUVs?: Vector4;
  145981. cap?: number;
  145982. invertUV?: boolean;
  145983. }, scene?: Nullable<Scene>): Mesh;
  145984. }
  145985. }
  145986. declare module BABYLON {
  145987. /**
  145988. * Class containing static functions to help procedurally build meshes
  145989. */
  145990. export class TiledPlaneBuilder {
  145991. /**
  145992. * Creates a tiled plane mesh
  145993. * * The parameter `pattern` will, depending on value, do nothing or
  145994. * * * flip (reflect about central vertical) alternate tiles across and up
  145995. * * * flip every tile on alternate rows
  145996. * * * rotate (180 degs) alternate tiles across and up
  145997. * * * rotate every tile on alternate rows
  145998. * * * flip and rotate alternate tiles across and up
  145999. * * * flip and rotate every tile on alternate rows
  146000. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  146001. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  146002. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146003. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  146004. * * 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)
  146005. * * 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)
  146006. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  146007. * @param name defines the name of the mesh
  146008. * @param options defines the options used to create the mesh
  146009. * @param scene defines the hosting scene
  146010. * @returns the box mesh
  146011. */
  146012. static CreateTiledPlane(name: string, options: {
  146013. pattern?: number;
  146014. tileSize?: number;
  146015. tileWidth?: number;
  146016. tileHeight?: number;
  146017. size?: number;
  146018. width?: number;
  146019. height?: number;
  146020. alignHorizontal?: number;
  146021. alignVertical?: number;
  146022. sideOrientation?: number;
  146023. frontUVs?: Vector4;
  146024. backUVs?: Vector4;
  146025. updatable?: boolean;
  146026. }, scene?: Nullable<Scene>): Mesh;
  146027. }
  146028. }
  146029. declare module BABYLON {
  146030. /**
  146031. * Class containing static functions to help procedurally build meshes
  146032. */
  146033. export class TubeBuilder {
  146034. /**
  146035. * Creates a tube mesh.
  146036. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146037. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  146038. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  146039. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  146040. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  146041. * * 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)
  146042. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  146043. * * 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
  146044. * * 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
  146045. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146046. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146047. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146048. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146049. * @param name defines the name of the mesh
  146050. * @param options defines the options used to create the mesh
  146051. * @param scene defines the hosting scene
  146052. * @returns the tube mesh
  146053. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146054. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  146055. */
  146056. static CreateTube(name: string, options: {
  146057. path: Vector3[];
  146058. radius?: number;
  146059. tessellation?: number;
  146060. radiusFunction?: {
  146061. (i: number, distance: number): number;
  146062. };
  146063. cap?: number;
  146064. arc?: number;
  146065. updatable?: boolean;
  146066. sideOrientation?: number;
  146067. frontUVs?: Vector4;
  146068. backUVs?: Vector4;
  146069. instance?: Mesh;
  146070. invertUV?: boolean;
  146071. }, scene?: Nullable<Scene>): Mesh;
  146072. }
  146073. }
  146074. declare module BABYLON {
  146075. /**
  146076. * Class containing static functions to help procedurally build meshes
  146077. */
  146078. export class IcoSphereBuilder {
  146079. /**
  146080. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  146081. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  146082. * * 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`)
  146083. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  146084. * * 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
  146085. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146086. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146087. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146088. * @param name defines the name of the mesh
  146089. * @param options defines the options used to create the mesh
  146090. * @param scene defines the hosting scene
  146091. * @returns the icosahedron mesh
  146092. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  146093. */
  146094. static CreateIcoSphere(name: string, options: {
  146095. radius?: number;
  146096. radiusX?: number;
  146097. radiusY?: number;
  146098. radiusZ?: number;
  146099. flat?: boolean;
  146100. subdivisions?: number;
  146101. sideOrientation?: number;
  146102. frontUVs?: Vector4;
  146103. backUVs?: Vector4;
  146104. updatable?: boolean;
  146105. }, scene?: Nullable<Scene>): Mesh;
  146106. }
  146107. }
  146108. declare module BABYLON {
  146109. /**
  146110. * Class containing static functions to help procedurally build meshes
  146111. */
  146112. export class DecalBuilder {
  146113. /**
  146114. * Creates a decal mesh.
  146115. * 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
  146116. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146117. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146118. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146119. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146120. * @param name defines the name of the mesh
  146121. * @param sourceMesh defines the mesh where the decal must be applied
  146122. * @param options defines the options used to create the mesh
  146123. * @param scene defines the hosting scene
  146124. * @returns the decal mesh
  146125. * @see https://doc.babylonjs.com/how_to/decals
  146126. */
  146127. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146128. position?: Vector3;
  146129. normal?: Vector3;
  146130. size?: Vector3;
  146131. angle?: number;
  146132. }): Mesh;
  146133. }
  146134. }
  146135. declare module BABYLON {
  146136. /**
  146137. * Class containing static functions to help procedurally build meshes
  146138. */
  146139. export class MeshBuilder {
  146140. /**
  146141. * Creates a box mesh
  146142. * * The parameter `size` sets the size (float) of each box side (default 1)
  146143. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  146144. * * 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)
  146145. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146146. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146147. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146148. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146149. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  146150. * @param name defines the name of the mesh
  146151. * @param options defines the options used to create the mesh
  146152. * @param scene defines the hosting scene
  146153. * @returns the box mesh
  146154. */
  146155. static CreateBox(name: string, options: {
  146156. size?: number;
  146157. width?: number;
  146158. height?: number;
  146159. depth?: number;
  146160. faceUV?: Vector4[];
  146161. faceColors?: Color4[];
  146162. sideOrientation?: number;
  146163. frontUVs?: Vector4;
  146164. backUVs?: Vector4;
  146165. wrap?: boolean;
  146166. topBaseAt?: number;
  146167. bottomBaseAt?: number;
  146168. updatable?: boolean;
  146169. }, scene?: Nullable<Scene>): Mesh;
  146170. /**
  146171. * Creates a tiled box mesh
  146172. * * faceTiles sets the pattern, tile size and number of tiles for a face
  146173. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146174. * @param name defines the name of the mesh
  146175. * @param options defines the options used to create the mesh
  146176. * @param scene defines the hosting scene
  146177. * @returns the tiled box mesh
  146178. */
  146179. static CreateTiledBox(name: string, options: {
  146180. pattern?: number;
  146181. size?: number;
  146182. width?: number;
  146183. height?: number;
  146184. depth: number;
  146185. tileSize?: number;
  146186. tileWidth?: number;
  146187. tileHeight?: number;
  146188. faceUV?: Vector4[];
  146189. faceColors?: Color4[];
  146190. alignHorizontal?: number;
  146191. alignVertical?: number;
  146192. sideOrientation?: number;
  146193. updatable?: boolean;
  146194. }, scene?: Nullable<Scene>): Mesh;
  146195. /**
  146196. * Creates a sphere mesh
  146197. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  146198. * * 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`)
  146199. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  146200. * * 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
  146201. * * 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)
  146202. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146203. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146204. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146205. * @param name defines the name of the mesh
  146206. * @param options defines the options used to create the mesh
  146207. * @param scene defines the hosting scene
  146208. * @returns the sphere mesh
  146209. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  146210. */
  146211. static CreateSphere(name: string, options: {
  146212. segments?: number;
  146213. diameter?: number;
  146214. diameterX?: number;
  146215. diameterY?: number;
  146216. diameterZ?: number;
  146217. arc?: number;
  146218. slice?: number;
  146219. sideOrientation?: number;
  146220. frontUVs?: Vector4;
  146221. backUVs?: Vector4;
  146222. updatable?: boolean;
  146223. }, scene?: Nullable<Scene>): Mesh;
  146224. /**
  146225. * Creates a plane polygonal mesh. By default, this is a disc
  146226. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  146227. * * 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
  146228. * * 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
  146229. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146230. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146231. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146232. * @param name defines the name of the mesh
  146233. * @param options defines the options used to create the mesh
  146234. * @param scene defines the hosting scene
  146235. * @returns the plane polygonal mesh
  146236. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  146237. */
  146238. static CreateDisc(name: string, options: {
  146239. radius?: number;
  146240. tessellation?: number;
  146241. arc?: number;
  146242. updatable?: boolean;
  146243. sideOrientation?: number;
  146244. frontUVs?: Vector4;
  146245. backUVs?: Vector4;
  146246. }, scene?: Nullable<Scene>): Mesh;
  146247. /**
  146248. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  146249. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  146250. * * 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`)
  146251. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  146252. * * 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
  146253. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146254. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146255. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146256. * @param name defines the name of the mesh
  146257. * @param options defines the options used to create the mesh
  146258. * @param scene defines the hosting scene
  146259. * @returns the icosahedron mesh
  146260. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  146261. */
  146262. static CreateIcoSphere(name: string, options: {
  146263. radius?: number;
  146264. radiusX?: number;
  146265. radiusY?: number;
  146266. radiusZ?: number;
  146267. flat?: boolean;
  146268. subdivisions?: number;
  146269. sideOrientation?: number;
  146270. frontUVs?: Vector4;
  146271. backUVs?: Vector4;
  146272. updatable?: boolean;
  146273. }, scene?: Nullable<Scene>): Mesh;
  146274. /**
  146275. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146276. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  146277. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  146278. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  146279. * * 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
  146280. * * 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
  146281. * * 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
  146282. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146283. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146284. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146285. * * 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
  146286. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  146287. * * 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
  146288. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  146289. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146290. * @param name defines the name of the mesh
  146291. * @param options defines the options used to create the mesh
  146292. * @param scene defines the hosting scene
  146293. * @returns the ribbon mesh
  146294. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  146295. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146296. */
  146297. static CreateRibbon(name: string, options: {
  146298. pathArray: Vector3[][];
  146299. closeArray?: boolean;
  146300. closePath?: boolean;
  146301. offset?: number;
  146302. updatable?: boolean;
  146303. sideOrientation?: number;
  146304. frontUVs?: Vector4;
  146305. backUVs?: Vector4;
  146306. instance?: Mesh;
  146307. invertUV?: boolean;
  146308. uvs?: Vector2[];
  146309. colors?: Color4[];
  146310. }, scene?: Nullable<Scene>): Mesh;
  146311. /**
  146312. * Creates a cylinder or a cone mesh
  146313. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  146314. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  146315. * * 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.
  146316. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  146317. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  146318. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  146319. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  146320. * * 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).
  146321. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  146322. * * 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).
  146323. * * 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
  146324. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  146325. * * 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
  146326. * * 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.
  146327. * * If `enclose` is false, a ring surface is one element.
  146328. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  146329. * * 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
  146330. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146331. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146332. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146333. * @param name defines the name of the mesh
  146334. * @param options defines the options used to create the mesh
  146335. * @param scene defines the hosting scene
  146336. * @returns the cylinder mesh
  146337. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  146338. */
  146339. static CreateCylinder(name: string, options: {
  146340. height?: number;
  146341. diameterTop?: number;
  146342. diameterBottom?: number;
  146343. diameter?: number;
  146344. tessellation?: number;
  146345. subdivisions?: number;
  146346. arc?: number;
  146347. faceColors?: Color4[];
  146348. faceUV?: Vector4[];
  146349. updatable?: boolean;
  146350. hasRings?: boolean;
  146351. enclose?: boolean;
  146352. cap?: number;
  146353. sideOrientation?: number;
  146354. frontUVs?: Vector4;
  146355. backUVs?: Vector4;
  146356. }, scene?: Nullable<Scene>): Mesh;
  146357. /**
  146358. * Creates a torus mesh
  146359. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  146360. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  146361. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  146362. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146363. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146364. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146365. * @param name defines the name of the mesh
  146366. * @param options defines the options used to create the mesh
  146367. * @param scene defines the hosting scene
  146368. * @returns the torus mesh
  146369. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  146370. */
  146371. static CreateTorus(name: string, options: {
  146372. diameter?: number;
  146373. thickness?: number;
  146374. tessellation?: number;
  146375. updatable?: boolean;
  146376. sideOrientation?: number;
  146377. frontUVs?: Vector4;
  146378. backUVs?: Vector4;
  146379. }, scene?: Nullable<Scene>): Mesh;
  146380. /**
  146381. * Creates a torus knot mesh
  146382. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  146383. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  146384. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  146385. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  146386. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146387. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146388. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146389. * @param name defines the name of the mesh
  146390. * @param options defines the options used to create the mesh
  146391. * @param scene defines the hosting scene
  146392. * @returns the torus knot mesh
  146393. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  146394. */
  146395. static CreateTorusKnot(name: string, options: {
  146396. radius?: number;
  146397. tube?: number;
  146398. radialSegments?: number;
  146399. tubularSegments?: number;
  146400. p?: number;
  146401. q?: number;
  146402. updatable?: boolean;
  146403. sideOrientation?: number;
  146404. frontUVs?: Vector4;
  146405. backUVs?: Vector4;
  146406. }, scene?: Nullable<Scene>): Mesh;
  146407. /**
  146408. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  146409. * * 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
  146410. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  146411. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  146412. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  146413. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  146414. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  146415. * * 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
  146416. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  146417. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146418. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  146419. * @param name defines the name of the new line system
  146420. * @param options defines the options used to create the line system
  146421. * @param scene defines the hosting scene
  146422. * @returns a new line system mesh
  146423. */
  146424. static CreateLineSystem(name: string, options: {
  146425. lines: Vector3[][];
  146426. updatable?: boolean;
  146427. instance?: Nullable<LinesMesh>;
  146428. colors?: Nullable<Color4[][]>;
  146429. useVertexAlpha?: boolean;
  146430. }, scene: Nullable<Scene>): LinesMesh;
  146431. /**
  146432. * Creates a line mesh
  146433. * 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
  146434. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  146435. * * The parameter `points` is an array successive Vector3
  146436. * * 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
  146437. * * The optional parameter `colors` is an array of successive Color4, one per line point
  146438. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  146439. * * When updating an instance, remember that only point positions can change, not the number of points
  146440. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146441. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  146442. * @param name defines the name of the new line system
  146443. * @param options defines the options used to create the line system
  146444. * @param scene defines the hosting scene
  146445. * @returns a new line mesh
  146446. */
  146447. static CreateLines(name: string, options: {
  146448. points: Vector3[];
  146449. updatable?: boolean;
  146450. instance?: Nullable<LinesMesh>;
  146451. colors?: Color4[];
  146452. useVertexAlpha?: boolean;
  146453. }, scene?: Nullable<Scene>): LinesMesh;
  146454. /**
  146455. * Creates a dashed line mesh
  146456. * * 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
  146457. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  146458. * * The parameter `points` is an array successive Vector3
  146459. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  146460. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  146461. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  146462. * * 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
  146463. * * When updating an instance, remember that only point positions can change, not the number of points
  146464. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146465. * @param name defines the name of the mesh
  146466. * @param options defines the options used to create the mesh
  146467. * @param scene defines the hosting scene
  146468. * @returns the dashed line mesh
  146469. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  146470. */
  146471. static CreateDashedLines(name: string, options: {
  146472. points: Vector3[];
  146473. dashSize?: number;
  146474. gapSize?: number;
  146475. dashNb?: number;
  146476. updatable?: boolean;
  146477. instance?: LinesMesh;
  146478. }, scene?: Nullable<Scene>): LinesMesh;
  146479. /**
  146480. * 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.
  146481. * * 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.
  146482. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  146483. * * 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.
  146484. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  146485. * * 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
  146486. * * 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
  146487. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  146488. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146489. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146490. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  146491. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146492. * @param name defines the name of the mesh
  146493. * @param options defines the options used to create the mesh
  146494. * @param scene defines the hosting scene
  146495. * @returns the extruded shape mesh
  146496. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146497. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  146498. */
  146499. static ExtrudeShape(name: string, options: {
  146500. shape: Vector3[];
  146501. path: Vector3[];
  146502. scale?: number;
  146503. rotation?: number;
  146504. cap?: number;
  146505. updatable?: boolean;
  146506. sideOrientation?: number;
  146507. frontUVs?: Vector4;
  146508. backUVs?: Vector4;
  146509. instance?: Mesh;
  146510. invertUV?: boolean;
  146511. }, scene?: Nullable<Scene>): Mesh;
  146512. /**
  146513. * Creates an custom extruded shape mesh.
  146514. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  146515. * * 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.
  146516. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  146517. * * 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
  146518. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  146519. * * 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
  146520. * * It must returns a float value that will be the scale value applied to the shape on each path point
  146521. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  146522. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  146523. * * 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
  146524. * * 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
  146525. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  146526. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146527. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146528. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146529. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146530. * @param name defines the name of the mesh
  146531. * @param options defines the options used to create the mesh
  146532. * @param scene defines the hosting scene
  146533. * @returns the custom extruded shape mesh
  146534. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  146535. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146536. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  146537. */
  146538. static ExtrudeShapeCustom(name: string, options: {
  146539. shape: Vector3[];
  146540. path: Vector3[];
  146541. scaleFunction?: any;
  146542. rotationFunction?: any;
  146543. ribbonCloseArray?: boolean;
  146544. ribbonClosePath?: boolean;
  146545. cap?: number;
  146546. updatable?: boolean;
  146547. sideOrientation?: number;
  146548. frontUVs?: Vector4;
  146549. backUVs?: Vector4;
  146550. instance?: Mesh;
  146551. invertUV?: boolean;
  146552. }, scene?: Nullable<Scene>): Mesh;
  146553. /**
  146554. * Creates lathe mesh.
  146555. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  146556. * * 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
  146557. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  146558. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  146559. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  146560. * * 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
  146561. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  146562. * * 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
  146563. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146564. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146565. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146566. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146567. * @param name defines the name of the mesh
  146568. * @param options defines the options used to create the mesh
  146569. * @param scene defines the hosting scene
  146570. * @returns the lathe mesh
  146571. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  146572. */
  146573. static CreateLathe(name: string, options: {
  146574. shape: Vector3[];
  146575. radius?: number;
  146576. tessellation?: number;
  146577. clip?: number;
  146578. arc?: number;
  146579. closed?: boolean;
  146580. updatable?: boolean;
  146581. sideOrientation?: number;
  146582. frontUVs?: Vector4;
  146583. backUVs?: Vector4;
  146584. cap?: number;
  146585. invertUV?: boolean;
  146586. }, scene?: Nullable<Scene>): Mesh;
  146587. /**
  146588. * Creates a tiled plane mesh
  146589. * * You can set a limited pattern arrangement with the tiles
  146590. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146591. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146592. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146593. * @param name defines the name of the mesh
  146594. * @param options defines the options used to create the mesh
  146595. * @param scene defines the hosting scene
  146596. * @returns the plane mesh
  146597. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  146598. */
  146599. static CreateTiledPlane(name: string, options: {
  146600. pattern?: number;
  146601. tileSize?: number;
  146602. tileWidth?: number;
  146603. tileHeight?: number;
  146604. size?: number;
  146605. width?: number;
  146606. height?: number;
  146607. alignHorizontal?: number;
  146608. alignVertical?: number;
  146609. sideOrientation?: number;
  146610. frontUVs?: Vector4;
  146611. backUVs?: Vector4;
  146612. updatable?: boolean;
  146613. }, scene?: Nullable<Scene>): Mesh;
  146614. /**
  146615. * Creates a plane mesh
  146616. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  146617. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  146618. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  146619. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146620. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146621. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146622. * @param name defines the name of the mesh
  146623. * @param options defines the options used to create the mesh
  146624. * @param scene defines the hosting scene
  146625. * @returns the plane mesh
  146626. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  146627. */
  146628. static CreatePlane(name: string, options: {
  146629. size?: number;
  146630. width?: number;
  146631. height?: number;
  146632. sideOrientation?: number;
  146633. frontUVs?: Vector4;
  146634. backUVs?: Vector4;
  146635. updatable?: boolean;
  146636. sourcePlane?: Plane;
  146637. }, scene?: Nullable<Scene>): Mesh;
  146638. /**
  146639. * Creates a ground mesh
  146640. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  146641. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  146642. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146643. * @param name defines the name of the mesh
  146644. * @param options defines the options used to create the mesh
  146645. * @param scene defines the hosting scene
  146646. * @returns the ground mesh
  146647. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  146648. */
  146649. static CreateGround(name: string, options: {
  146650. width?: number;
  146651. height?: number;
  146652. subdivisions?: number;
  146653. subdivisionsX?: number;
  146654. subdivisionsY?: number;
  146655. updatable?: boolean;
  146656. }, scene?: Nullable<Scene>): Mesh;
  146657. /**
  146658. * Creates a tiled ground mesh
  146659. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  146660. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  146661. * * 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
  146662. * * 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
  146663. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146664. * @param name defines the name of the mesh
  146665. * @param options defines the options used to create the mesh
  146666. * @param scene defines the hosting scene
  146667. * @returns the tiled ground mesh
  146668. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  146669. */
  146670. static CreateTiledGround(name: string, options: {
  146671. xmin: number;
  146672. zmin: number;
  146673. xmax: number;
  146674. zmax: number;
  146675. subdivisions?: {
  146676. w: number;
  146677. h: number;
  146678. };
  146679. precision?: {
  146680. w: number;
  146681. h: number;
  146682. };
  146683. updatable?: boolean;
  146684. }, scene?: Nullable<Scene>): Mesh;
  146685. /**
  146686. * Creates a ground mesh from a height map
  146687. * * The parameter `url` sets the URL of the height map image resource.
  146688. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  146689. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  146690. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  146691. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  146692. * * 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.
  146693. * * 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).
  146694. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  146695. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146696. * @param name defines the name of the mesh
  146697. * @param url defines the url to the height map
  146698. * @param options defines the options used to create the mesh
  146699. * @param scene defines the hosting scene
  146700. * @returns the ground mesh
  146701. * @see https://doc.babylonjs.com/babylon101/height_map
  146702. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  146703. */
  146704. static CreateGroundFromHeightMap(name: string, url: string, options: {
  146705. width?: number;
  146706. height?: number;
  146707. subdivisions?: number;
  146708. minHeight?: number;
  146709. maxHeight?: number;
  146710. colorFilter?: Color3;
  146711. alphaFilter?: number;
  146712. updatable?: boolean;
  146713. onReady?: (mesh: GroundMesh) => void;
  146714. }, scene?: Nullable<Scene>): GroundMesh;
  146715. /**
  146716. * Creates a polygon mesh
  146717. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  146718. * * 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
  146719. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  146720. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146721. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  146722. * * Remember you can only change the shape positions, not their number when updating a polygon
  146723. * @param name defines the name of the mesh
  146724. * @param options defines the options used to create the mesh
  146725. * @param scene defines the hosting scene
  146726. * @param earcutInjection can be used to inject your own earcut reference
  146727. * @returns the polygon mesh
  146728. */
  146729. static CreatePolygon(name: string, options: {
  146730. shape: Vector3[];
  146731. holes?: Vector3[][];
  146732. depth?: number;
  146733. faceUV?: Vector4[];
  146734. faceColors?: Color4[];
  146735. updatable?: boolean;
  146736. sideOrientation?: number;
  146737. frontUVs?: Vector4;
  146738. backUVs?: Vector4;
  146739. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146740. /**
  146741. * Creates an extruded polygon mesh, with depth in the Y direction.
  146742. * * 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)
  146743. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146744. * @param name defines the name of the mesh
  146745. * @param options defines the options used to create the mesh
  146746. * @param scene defines the hosting scene
  146747. * @param earcutInjection can be used to inject your own earcut reference
  146748. * @returns the polygon mesh
  146749. */
  146750. static ExtrudePolygon(name: string, options: {
  146751. shape: Vector3[];
  146752. holes?: Vector3[][];
  146753. depth?: number;
  146754. faceUV?: Vector4[];
  146755. faceColors?: Color4[];
  146756. updatable?: boolean;
  146757. sideOrientation?: number;
  146758. frontUVs?: Vector4;
  146759. backUVs?: Vector4;
  146760. wrap?: boolean;
  146761. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146762. /**
  146763. * Creates a tube mesh.
  146764. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146765. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  146766. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  146767. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  146768. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  146769. * * 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)
  146770. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  146771. * * 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
  146772. * * 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
  146773. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146774. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146775. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146776. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146777. * @param name defines the name of the mesh
  146778. * @param options defines the options used to create the mesh
  146779. * @param scene defines the hosting scene
  146780. * @returns the tube mesh
  146781. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146782. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  146783. */
  146784. static CreateTube(name: string, options: {
  146785. path: Vector3[];
  146786. radius?: number;
  146787. tessellation?: number;
  146788. radiusFunction?: {
  146789. (i: number, distance: number): number;
  146790. };
  146791. cap?: number;
  146792. arc?: number;
  146793. updatable?: boolean;
  146794. sideOrientation?: number;
  146795. frontUVs?: Vector4;
  146796. backUVs?: Vector4;
  146797. instance?: Mesh;
  146798. invertUV?: boolean;
  146799. }, scene?: Nullable<Scene>): Mesh;
  146800. /**
  146801. * Creates a polyhedron mesh
  146802. * * 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
  146803. * * The parameter `size` (positive float, default 1) sets the polygon size
  146804. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  146805. * * 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`
  146806. * * 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
  146807. * * 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)`)
  146808. * * 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
  146809. * * 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
  146810. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146811. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146812. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146813. * @param name defines the name of the mesh
  146814. * @param options defines the options used to create the mesh
  146815. * @param scene defines the hosting scene
  146816. * @returns the polyhedron mesh
  146817. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  146818. */
  146819. static CreatePolyhedron(name: string, options: {
  146820. type?: number;
  146821. size?: number;
  146822. sizeX?: number;
  146823. sizeY?: number;
  146824. sizeZ?: number;
  146825. custom?: any;
  146826. faceUV?: Vector4[];
  146827. faceColors?: Color4[];
  146828. flat?: boolean;
  146829. updatable?: boolean;
  146830. sideOrientation?: number;
  146831. frontUVs?: Vector4;
  146832. backUVs?: Vector4;
  146833. }, scene?: Nullable<Scene>): Mesh;
  146834. /**
  146835. * Creates a decal mesh.
  146836. * 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
  146837. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146838. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146839. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146840. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146841. * @param name defines the name of the mesh
  146842. * @param sourceMesh defines the mesh where the decal must be applied
  146843. * @param options defines the options used to create the mesh
  146844. * @param scene defines the hosting scene
  146845. * @returns the decal mesh
  146846. * @see https://doc.babylonjs.com/how_to/decals
  146847. */
  146848. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146849. position?: Vector3;
  146850. normal?: Vector3;
  146851. size?: Vector3;
  146852. angle?: number;
  146853. }): Mesh;
  146854. /**
  146855. * Creates a Capsule Mesh
  146856. * @param name defines the name of the mesh.
  146857. * @param options the constructors options used to shape the mesh.
  146858. * @param scene defines the scene the mesh is scoped to.
  146859. * @returns the capsule mesh
  146860. * @see https://doc.babylonjs.com/how_to/capsule_shape
  146861. */
  146862. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  146863. }
  146864. }
  146865. declare module BABYLON {
  146866. /**
  146867. * A simplifier interface for future simplification implementations
  146868. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146869. */
  146870. export interface ISimplifier {
  146871. /**
  146872. * Simplification of a given mesh according to the given settings.
  146873. * Since this requires computation, it is assumed that the function runs async.
  146874. * @param settings The settings of the simplification, including quality and distance
  146875. * @param successCallback A callback that will be called after the mesh was simplified.
  146876. * @param errorCallback in case of an error, this callback will be called. optional.
  146877. */
  146878. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146879. }
  146880. /**
  146881. * Expected simplification settings.
  146882. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146883. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146884. */
  146885. export interface ISimplificationSettings {
  146886. /**
  146887. * Gets or sets the expected quality
  146888. */
  146889. quality: number;
  146890. /**
  146891. * Gets or sets the distance when this optimized version should be used
  146892. */
  146893. distance: number;
  146894. /**
  146895. * Gets an already optimized mesh
  146896. */
  146897. optimizeMesh?: boolean;
  146898. }
  146899. /**
  146900. * Class used to specify simplification options
  146901. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146902. */
  146903. export class SimplificationSettings implements ISimplificationSettings {
  146904. /** expected quality */
  146905. quality: number;
  146906. /** distance when this optimized version should be used */
  146907. distance: number;
  146908. /** already optimized mesh */
  146909. optimizeMesh?: boolean | undefined;
  146910. /**
  146911. * Creates a SimplificationSettings
  146912. * @param quality expected quality
  146913. * @param distance distance when this optimized version should be used
  146914. * @param optimizeMesh already optimized mesh
  146915. */
  146916. constructor(
  146917. /** expected quality */
  146918. quality: number,
  146919. /** distance when this optimized version should be used */
  146920. distance: number,
  146921. /** already optimized mesh */
  146922. optimizeMesh?: boolean | undefined);
  146923. }
  146924. /**
  146925. * Interface used to define a simplification task
  146926. */
  146927. export interface ISimplificationTask {
  146928. /**
  146929. * Array of settings
  146930. */
  146931. settings: Array<ISimplificationSettings>;
  146932. /**
  146933. * Simplification type
  146934. */
  146935. simplificationType: SimplificationType;
  146936. /**
  146937. * Mesh to simplify
  146938. */
  146939. mesh: Mesh;
  146940. /**
  146941. * Callback called on success
  146942. */
  146943. successCallback?: () => void;
  146944. /**
  146945. * Defines if parallel processing can be used
  146946. */
  146947. parallelProcessing: boolean;
  146948. }
  146949. /**
  146950. * Queue used to order the simplification tasks
  146951. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146952. */
  146953. export class SimplificationQueue {
  146954. private _simplificationArray;
  146955. /**
  146956. * Gets a boolean indicating that the process is still running
  146957. */
  146958. running: boolean;
  146959. /**
  146960. * Creates a new queue
  146961. */
  146962. constructor();
  146963. /**
  146964. * Adds a new simplification task
  146965. * @param task defines a task to add
  146966. */
  146967. addTask(task: ISimplificationTask): void;
  146968. /**
  146969. * Execute next task
  146970. */
  146971. executeNext(): void;
  146972. /**
  146973. * Execute a simplification task
  146974. * @param task defines the task to run
  146975. */
  146976. runSimplification(task: ISimplificationTask): void;
  146977. private getSimplifier;
  146978. }
  146979. /**
  146980. * The implemented types of simplification
  146981. * At the moment only Quadratic Error Decimation is implemented
  146982. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146983. */
  146984. export enum SimplificationType {
  146985. /** Quadratic error decimation */
  146986. QUADRATIC = 0
  146987. }
  146988. /**
  146989. * An implementation of the Quadratic Error simplification algorithm.
  146990. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146991. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146992. * @author RaananW
  146993. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146994. */
  146995. export class QuadraticErrorSimplification implements ISimplifier {
  146996. private _mesh;
  146997. private triangles;
  146998. private vertices;
  146999. private references;
  147000. private _reconstructedMesh;
  147001. /** Gets or sets the number pf sync interations */
  147002. syncIterations: number;
  147003. /** Gets or sets the aggressiveness of the simplifier */
  147004. aggressiveness: number;
  147005. /** Gets or sets the number of allowed iterations for decimation */
  147006. decimationIterations: number;
  147007. /** Gets or sets the espilon to use for bounding box computation */
  147008. boundingBoxEpsilon: number;
  147009. /**
  147010. * Creates a new QuadraticErrorSimplification
  147011. * @param _mesh defines the target mesh
  147012. */
  147013. constructor(_mesh: Mesh);
  147014. /**
  147015. * Simplification of a given mesh according to the given settings.
  147016. * Since this requires computation, it is assumed that the function runs async.
  147017. * @param settings The settings of the simplification, including quality and distance
  147018. * @param successCallback A callback that will be called after the mesh was simplified.
  147019. */
  147020. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  147021. private runDecimation;
  147022. private initWithMesh;
  147023. private init;
  147024. private reconstructMesh;
  147025. private initDecimatedMesh;
  147026. private isFlipped;
  147027. private updateTriangles;
  147028. private identifyBorder;
  147029. private updateMesh;
  147030. private vertexError;
  147031. private calculateError;
  147032. }
  147033. }
  147034. declare module BABYLON {
  147035. interface Scene {
  147036. /** @hidden (Backing field) */
  147037. _simplificationQueue: SimplificationQueue;
  147038. /**
  147039. * Gets or sets the simplification queue attached to the scene
  147040. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  147041. */
  147042. simplificationQueue: SimplificationQueue;
  147043. }
  147044. interface Mesh {
  147045. /**
  147046. * Simplify the mesh according to the given array of settings.
  147047. * Function will return immediately and will simplify async
  147048. * @param settings a collection of simplification settings
  147049. * @param parallelProcessing should all levels calculate parallel or one after the other
  147050. * @param simplificationType the type of simplification to run
  147051. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  147052. * @returns the current mesh
  147053. */
  147054. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  147055. }
  147056. /**
  147057. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  147058. * created in a scene
  147059. */
  147060. export class SimplicationQueueSceneComponent implements ISceneComponent {
  147061. /**
  147062. * The component name helpfull to identify the component in the list of scene components.
  147063. */
  147064. readonly name: string;
  147065. /**
  147066. * The scene the component belongs to.
  147067. */
  147068. scene: Scene;
  147069. /**
  147070. * Creates a new instance of the component for the given scene
  147071. * @param scene Defines the scene to register the component in
  147072. */
  147073. constructor(scene: Scene);
  147074. /**
  147075. * Registers the component in a given scene
  147076. */
  147077. register(): void;
  147078. /**
  147079. * Rebuilds the elements related to this component in case of
  147080. * context lost for instance.
  147081. */
  147082. rebuild(): void;
  147083. /**
  147084. * Disposes the component and the associated ressources
  147085. */
  147086. dispose(): void;
  147087. private _beforeCameraUpdate;
  147088. }
  147089. }
  147090. declare module BABYLON {
  147091. interface Mesh {
  147092. /**
  147093. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  147094. */
  147095. thinInstanceEnablePicking: boolean;
  147096. /**
  147097. * Creates a new thin instance
  147098. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  147099. * @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
  147100. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  147101. */
  147102. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  147103. /**
  147104. * Adds the transformation (matrix) of the current mesh as a thin instance
  147105. * @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
  147106. * @returns the thin instance index number
  147107. */
  147108. thinInstanceAddSelf(refresh: boolean): number;
  147109. /**
  147110. * Registers a custom attribute to be used with thin instances
  147111. * @param kind name of the attribute
  147112. * @param stride size in floats of the attribute
  147113. */
  147114. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  147115. /**
  147116. * Sets the matrix of a thin instance
  147117. * @param index index of the thin instance
  147118. * @param matrix matrix to set
  147119. * @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
  147120. */
  147121. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  147122. /**
  147123. * Sets the value of a custom attribute for a thin instance
  147124. * @param kind name of the attribute
  147125. * @param index index of the thin instance
  147126. * @param value value to set
  147127. * @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
  147128. */
  147129. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  147130. /**
  147131. * 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.
  147132. */
  147133. thinInstanceCount: number;
  147134. /**
  147135. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  147136. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  147137. * @param buffer buffer to set
  147138. * @param stride size in floats of each value of the buffer
  147139. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  147140. */
  147141. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  147142. /**
  147143. * Gets the list of world matrices
  147144. * @return an array containing all the world matrices from the thin instances
  147145. */
  147146. thinInstanceGetWorldMatrices(): Matrix[];
  147147. /**
  147148. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  147149. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  147150. */
  147151. thinInstanceBufferUpdated(kind: string): void;
  147152. /**
  147153. * Applies a partial update to a buffer directly on the GPU
  147154. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  147155. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  147156. * @param data the data to set in the GPU buffer
  147157. * @param offset the offset in the GPU buffer where to update the data
  147158. */
  147159. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  147160. /**
  147161. * Refreshes the bounding info, taking into account all the thin instances defined
  147162. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  147163. */
  147164. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  147165. /** @hidden */
  147166. _thinInstanceInitializeUserStorage(): void;
  147167. /** @hidden */
  147168. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  147169. /** @hidden */
  147170. _userThinInstanceBuffersStorage: {
  147171. data: {
  147172. [key: string]: Float32Array;
  147173. };
  147174. sizes: {
  147175. [key: string]: number;
  147176. };
  147177. vertexBuffers: {
  147178. [key: string]: Nullable<VertexBuffer>;
  147179. };
  147180. strides: {
  147181. [key: string]: number;
  147182. };
  147183. };
  147184. }
  147185. }
  147186. declare module BABYLON {
  147187. /**
  147188. * Navigation plugin interface to add navigation constrained by a navigation mesh
  147189. */
  147190. export interface INavigationEnginePlugin {
  147191. /**
  147192. * plugin name
  147193. */
  147194. name: string;
  147195. /**
  147196. * Creates a navigation mesh
  147197. * @param meshes array of all the geometry used to compute the navigatio mesh
  147198. * @param parameters bunch of parameters used to filter geometry
  147199. */
  147200. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  147201. /**
  147202. * Create a navigation mesh debug mesh
  147203. * @param scene is where the mesh will be added
  147204. * @returns debug display mesh
  147205. */
  147206. createDebugNavMesh(scene: Scene): Mesh;
  147207. /**
  147208. * Get a navigation mesh constrained position, closest to the parameter position
  147209. * @param position world position
  147210. * @returns the closest point to position constrained by the navigation mesh
  147211. */
  147212. getClosestPoint(position: Vector3): Vector3;
  147213. /**
  147214. * Get a navigation mesh constrained position, closest to the parameter position
  147215. * @param position world position
  147216. * @param result output the closest point to position constrained by the navigation mesh
  147217. */
  147218. getClosestPointToRef(position: Vector3, result: Vector3): void;
  147219. /**
  147220. * Get a navigation mesh constrained position, within a particular radius
  147221. * @param position world position
  147222. * @param maxRadius the maximum distance to the constrained world position
  147223. * @returns the closest point to position constrained by the navigation mesh
  147224. */
  147225. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  147226. /**
  147227. * Get a navigation mesh constrained position, within a particular radius
  147228. * @param position world position
  147229. * @param maxRadius the maximum distance to the constrained world position
  147230. * @param result output the closest point to position constrained by the navigation mesh
  147231. */
  147232. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  147233. /**
  147234. * Compute the final position from a segment made of destination-position
  147235. * @param position world position
  147236. * @param destination world position
  147237. * @returns the resulting point along the navmesh
  147238. */
  147239. moveAlong(position: Vector3, destination: Vector3): Vector3;
  147240. /**
  147241. * Compute the final position from a segment made of destination-position
  147242. * @param position world position
  147243. * @param destination world position
  147244. * @param result output the resulting point along the navmesh
  147245. */
  147246. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  147247. /**
  147248. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  147249. * @param start world position
  147250. * @param end world position
  147251. * @returns array containing world position composing the path
  147252. */
  147253. computePath(start: Vector3, end: Vector3): Vector3[];
  147254. /**
  147255. * If this plugin is supported
  147256. * @returns true if plugin is supported
  147257. */
  147258. isSupported(): boolean;
  147259. /**
  147260. * Create a new Crowd so you can add agents
  147261. * @param maxAgents the maximum agent count in the crowd
  147262. * @param maxAgentRadius the maximum radius an agent can have
  147263. * @param scene to attach the crowd to
  147264. * @returns the crowd you can add agents to
  147265. */
  147266. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  147267. /**
  147268. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147269. * The queries will try to find a solution within those bounds
  147270. * default is (1,1,1)
  147271. * @param extent x,y,z value that define the extent around the queries point of reference
  147272. */
  147273. setDefaultQueryExtent(extent: Vector3): void;
  147274. /**
  147275. * Get the Bounding box extent specified by setDefaultQueryExtent
  147276. * @returns the box extent values
  147277. */
  147278. getDefaultQueryExtent(): Vector3;
  147279. /**
  147280. * build the navmesh from a previously saved state using getNavmeshData
  147281. * @param data the Uint8Array returned by getNavmeshData
  147282. */
  147283. buildFromNavmeshData(data: Uint8Array): void;
  147284. /**
  147285. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  147286. * @returns data the Uint8Array that can be saved and reused
  147287. */
  147288. getNavmeshData(): Uint8Array;
  147289. /**
  147290. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147291. * @param result output the box extent values
  147292. */
  147293. getDefaultQueryExtentToRef(result: Vector3): void;
  147294. /**
  147295. * Release all resources
  147296. */
  147297. dispose(): void;
  147298. }
  147299. /**
  147300. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  147301. */
  147302. export interface ICrowd {
  147303. /**
  147304. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  147305. * You can attach anything to that node. The node position is updated in the scene update tick.
  147306. * @param pos world position that will be constrained by the navigation mesh
  147307. * @param parameters agent parameters
  147308. * @param transform hooked to the agent that will be update by the scene
  147309. * @returns agent index
  147310. */
  147311. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  147312. /**
  147313. * Returns the agent position in world space
  147314. * @param index agent index returned by addAgent
  147315. * @returns world space position
  147316. */
  147317. getAgentPosition(index: number): Vector3;
  147318. /**
  147319. * Gets the agent position result in world space
  147320. * @param index agent index returned by addAgent
  147321. * @param result output world space position
  147322. */
  147323. getAgentPositionToRef(index: number, result: Vector3): void;
  147324. /**
  147325. * Gets the agent velocity in world space
  147326. * @param index agent index returned by addAgent
  147327. * @returns world space velocity
  147328. */
  147329. getAgentVelocity(index: number): Vector3;
  147330. /**
  147331. * Gets the agent velocity result in world space
  147332. * @param index agent index returned by addAgent
  147333. * @param result output world space velocity
  147334. */
  147335. getAgentVelocityToRef(index: number, result: Vector3): void;
  147336. /**
  147337. * remove a particular agent previously created
  147338. * @param index agent index returned by addAgent
  147339. */
  147340. removeAgent(index: number): void;
  147341. /**
  147342. * get the list of all agents attached to this crowd
  147343. * @returns list of agent indices
  147344. */
  147345. getAgents(): number[];
  147346. /**
  147347. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  147348. * @param deltaTime in seconds
  147349. */
  147350. update(deltaTime: number): void;
  147351. /**
  147352. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  147353. * @param index agent index returned by addAgent
  147354. * @param destination targeted world position
  147355. */
  147356. agentGoto(index: number, destination: Vector3): void;
  147357. /**
  147358. * Teleport the agent to a new position
  147359. * @param index agent index returned by addAgent
  147360. * @param destination targeted world position
  147361. */
  147362. agentTeleport(index: number, destination: Vector3): void;
  147363. /**
  147364. * Update agent parameters
  147365. * @param index agent index returned by addAgent
  147366. * @param parameters agent parameters
  147367. */
  147368. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  147369. /**
  147370. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147371. * The queries will try to find a solution within those bounds
  147372. * default is (1,1,1)
  147373. * @param extent x,y,z value that define the extent around the queries point of reference
  147374. */
  147375. setDefaultQueryExtent(extent: Vector3): void;
  147376. /**
  147377. * Get the Bounding box extent specified by setDefaultQueryExtent
  147378. * @returns the box extent values
  147379. */
  147380. getDefaultQueryExtent(): Vector3;
  147381. /**
  147382. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147383. * @param result output the box extent values
  147384. */
  147385. getDefaultQueryExtentToRef(result: Vector3): void;
  147386. /**
  147387. * Release all resources
  147388. */
  147389. dispose(): void;
  147390. }
  147391. /**
  147392. * Configures an agent
  147393. */
  147394. export interface IAgentParameters {
  147395. /**
  147396. * Agent radius. [Limit: >= 0]
  147397. */
  147398. radius: number;
  147399. /**
  147400. * Agent height. [Limit: > 0]
  147401. */
  147402. height: number;
  147403. /**
  147404. * Maximum allowed acceleration. [Limit: >= 0]
  147405. */
  147406. maxAcceleration: number;
  147407. /**
  147408. * Maximum allowed speed. [Limit: >= 0]
  147409. */
  147410. maxSpeed: number;
  147411. /**
  147412. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  147413. */
  147414. collisionQueryRange: number;
  147415. /**
  147416. * The path visibility optimization range. [Limit: > 0]
  147417. */
  147418. pathOptimizationRange: number;
  147419. /**
  147420. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  147421. */
  147422. separationWeight: number;
  147423. }
  147424. /**
  147425. * Configures the navigation mesh creation
  147426. */
  147427. export interface INavMeshParameters {
  147428. /**
  147429. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  147430. */
  147431. cs: number;
  147432. /**
  147433. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  147434. */
  147435. ch: number;
  147436. /**
  147437. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  147438. */
  147439. walkableSlopeAngle: number;
  147440. /**
  147441. * Minimum floor to 'ceiling' height that will still allow the floor area to
  147442. * be considered walkable. [Limit: >= 3] [Units: vx]
  147443. */
  147444. walkableHeight: number;
  147445. /**
  147446. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  147447. */
  147448. walkableClimb: number;
  147449. /**
  147450. * The distance to erode/shrink the walkable area of the heightfield away from
  147451. * obstructions. [Limit: >=0] [Units: vx]
  147452. */
  147453. walkableRadius: number;
  147454. /**
  147455. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  147456. */
  147457. maxEdgeLen: number;
  147458. /**
  147459. * The maximum distance a simplfied contour's border edges should deviate
  147460. * the original raw contour. [Limit: >=0] [Units: vx]
  147461. */
  147462. maxSimplificationError: number;
  147463. /**
  147464. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  147465. */
  147466. minRegionArea: number;
  147467. /**
  147468. * Any regions with a span count smaller than this value will, if possible,
  147469. * be merged with larger regions. [Limit: >=0] [Units: vx]
  147470. */
  147471. mergeRegionArea: number;
  147472. /**
  147473. * The maximum number of vertices allowed for polygons generated during the
  147474. * contour to polygon conversion process. [Limit: >= 3]
  147475. */
  147476. maxVertsPerPoly: number;
  147477. /**
  147478. * Sets the sampling distance to use when generating the detail mesh.
  147479. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  147480. */
  147481. detailSampleDist: number;
  147482. /**
  147483. * The maximum distance the detail mesh surface should deviate from heightfield
  147484. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  147485. */
  147486. detailSampleMaxError: number;
  147487. }
  147488. }
  147489. declare module BABYLON {
  147490. /**
  147491. * RecastJS navigation plugin
  147492. */
  147493. export class RecastJSPlugin implements INavigationEnginePlugin {
  147494. /**
  147495. * Reference to the Recast library
  147496. */
  147497. bjsRECAST: any;
  147498. /**
  147499. * plugin name
  147500. */
  147501. name: string;
  147502. /**
  147503. * the first navmesh created. We might extend this to support multiple navmeshes
  147504. */
  147505. navMesh: any;
  147506. /**
  147507. * Initializes the recastJS plugin
  147508. * @param recastInjection can be used to inject your own recast reference
  147509. */
  147510. constructor(recastInjection?: any);
  147511. /**
  147512. * Creates a navigation mesh
  147513. * @param meshes array of all the geometry used to compute the navigatio mesh
  147514. * @param parameters bunch of parameters used to filter geometry
  147515. */
  147516. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  147517. /**
  147518. * Create a navigation mesh debug mesh
  147519. * @param scene is where the mesh will be added
  147520. * @returns debug display mesh
  147521. */
  147522. createDebugNavMesh(scene: Scene): Mesh;
  147523. /**
  147524. * Get a navigation mesh constrained position, closest to the parameter position
  147525. * @param position world position
  147526. * @returns the closest point to position constrained by the navigation mesh
  147527. */
  147528. getClosestPoint(position: Vector3): Vector3;
  147529. /**
  147530. * Get a navigation mesh constrained position, closest to the parameter position
  147531. * @param position world position
  147532. * @param result output the closest point to position constrained by the navigation mesh
  147533. */
  147534. getClosestPointToRef(position: Vector3, result: Vector3): void;
  147535. /**
  147536. * Get a navigation mesh constrained position, within a particular radius
  147537. * @param position world position
  147538. * @param maxRadius the maximum distance to the constrained world position
  147539. * @returns the closest point to position constrained by the navigation mesh
  147540. */
  147541. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  147542. /**
  147543. * Get a navigation mesh constrained position, within a particular radius
  147544. * @param position world position
  147545. * @param maxRadius the maximum distance to the constrained world position
  147546. * @param result output the closest point to position constrained by the navigation mesh
  147547. */
  147548. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  147549. /**
  147550. * Compute the final position from a segment made of destination-position
  147551. * @param position world position
  147552. * @param destination world position
  147553. * @returns the resulting point along the navmesh
  147554. */
  147555. moveAlong(position: Vector3, destination: Vector3): Vector3;
  147556. /**
  147557. * Compute the final position from a segment made of destination-position
  147558. * @param position world position
  147559. * @param destination world position
  147560. * @param result output the resulting point along the navmesh
  147561. */
  147562. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  147563. /**
  147564. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  147565. * @param start world position
  147566. * @param end world position
  147567. * @returns array containing world position composing the path
  147568. */
  147569. computePath(start: Vector3, end: Vector3): Vector3[];
  147570. /**
  147571. * Create a new Crowd so you can add agents
  147572. * @param maxAgents the maximum agent count in the crowd
  147573. * @param maxAgentRadius the maximum radius an agent can have
  147574. * @param scene to attach the crowd to
  147575. * @returns the crowd you can add agents to
  147576. */
  147577. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  147578. /**
  147579. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147580. * The queries will try to find a solution within those bounds
  147581. * default is (1,1,1)
  147582. * @param extent x,y,z value that define the extent around the queries point of reference
  147583. */
  147584. setDefaultQueryExtent(extent: Vector3): void;
  147585. /**
  147586. * Get the Bounding box extent specified by setDefaultQueryExtent
  147587. * @returns the box extent values
  147588. */
  147589. getDefaultQueryExtent(): Vector3;
  147590. /**
  147591. * build the navmesh from a previously saved state using getNavmeshData
  147592. * @param data the Uint8Array returned by getNavmeshData
  147593. */
  147594. buildFromNavmeshData(data: Uint8Array): void;
  147595. /**
  147596. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  147597. * @returns data the Uint8Array that can be saved and reused
  147598. */
  147599. getNavmeshData(): Uint8Array;
  147600. /**
  147601. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147602. * @param result output the box extent values
  147603. */
  147604. getDefaultQueryExtentToRef(result: Vector3): void;
  147605. /**
  147606. * Disposes
  147607. */
  147608. dispose(): void;
  147609. /**
  147610. * If this plugin is supported
  147611. * @returns true if plugin is supported
  147612. */
  147613. isSupported(): boolean;
  147614. }
  147615. /**
  147616. * Recast detour crowd implementation
  147617. */
  147618. export class RecastJSCrowd implements ICrowd {
  147619. /**
  147620. * Recast/detour plugin
  147621. */
  147622. bjsRECASTPlugin: RecastJSPlugin;
  147623. /**
  147624. * Link to the detour crowd
  147625. */
  147626. recastCrowd: any;
  147627. /**
  147628. * One transform per agent
  147629. */
  147630. transforms: TransformNode[];
  147631. /**
  147632. * All agents created
  147633. */
  147634. agents: number[];
  147635. /**
  147636. * Link to the scene is kept to unregister the crowd from the scene
  147637. */
  147638. private _scene;
  147639. /**
  147640. * Observer for crowd updates
  147641. */
  147642. private _onBeforeAnimationsObserver;
  147643. /**
  147644. * Constructor
  147645. * @param plugin recastJS plugin
  147646. * @param maxAgents the maximum agent count in the crowd
  147647. * @param maxAgentRadius the maximum radius an agent can have
  147648. * @param scene to attach the crowd to
  147649. * @returns the crowd you can add agents to
  147650. */
  147651. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  147652. /**
  147653. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  147654. * You can attach anything to that node. The node position is updated in the scene update tick.
  147655. * @param pos world position that will be constrained by the navigation mesh
  147656. * @param parameters agent parameters
  147657. * @param transform hooked to the agent that will be update by the scene
  147658. * @returns agent index
  147659. */
  147660. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  147661. /**
  147662. * Returns the agent position in world space
  147663. * @param index agent index returned by addAgent
  147664. * @returns world space position
  147665. */
  147666. getAgentPosition(index: number): Vector3;
  147667. /**
  147668. * Returns the agent position result in world space
  147669. * @param index agent index returned by addAgent
  147670. * @param result output world space position
  147671. */
  147672. getAgentPositionToRef(index: number, result: Vector3): void;
  147673. /**
  147674. * Returns the agent velocity in world space
  147675. * @param index agent index returned by addAgent
  147676. * @returns world space velocity
  147677. */
  147678. getAgentVelocity(index: number): Vector3;
  147679. /**
  147680. * Returns the agent velocity result in world space
  147681. * @param index agent index returned by addAgent
  147682. * @param result output world space velocity
  147683. */
  147684. getAgentVelocityToRef(index: number, result: Vector3): void;
  147685. /**
  147686. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  147687. * @param index agent index returned by addAgent
  147688. * @param destination targeted world position
  147689. */
  147690. agentGoto(index: number, destination: Vector3): void;
  147691. /**
  147692. * Teleport the agent to a new position
  147693. * @param index agent index returned by addAgent
  147694. * @param destination targeted world position
  147695. */
  147696. agentTeleport(index: number, destination: Vector3): void;
  147697. /**
  147698. * Update agent parameters
  147699. * @param index agent index returned by addAgent
  147700. * @param parameters agent parameters
  147701. */
  147702. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  147703. /**
  147704. * remove a particular agent previously created
  147705. * @param index agent index returned by addAgent
  147706. */
  147707. removeAgent(index: number): void;
  147708. /**
  147709. * get the list of all agents attached to this crowd
  147710. * @returns list of agent indices
  147711. */
  147712. getAgents(): number[];
  147713. /**
  147714. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  147715. * @param deltaTime in seconds
  147716. */
  147717. update(deltaTime: number): void;
  147718. /**
  147719. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147720. * The queries will try to find a solution within those bounds
  147721. * default is (1,1,1)
  147722. * @param extent x,y,z value that define the extent around the queries point of reference
  147723. */
  147724. setDefaultQueryExtent(extent: Vector3): void;
  147725. /**
  147726. * Get the Bounding box extent specified by setDefaultQueryExtent
  147727. * @returns the box extent values
  147728. */
  147729. getDefaultQueryExtent(): Vector3;
  147730. /**
  147731. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147732. * @param result output the box extent values
  147733. */
  147734. getDefaultQueryExtentToRef(result: Vector3): void;
  147735. /**
  147736. * Release all resources
  147737. */
  147738. dispose(): void;
  147739. }
  147740. }
  147741. declare module BABYLON {
  147742. /**
  147743. * Class used to enable access to IndexedDB
  147744. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  147745. */
  147746. export class Database implements IOfflineProvider {
  147747. private _callbackManifestChecked;
  147748. private _currentSceneUrl;
  147749. private _db;
  147750. private _enableSceneOffline;
  147751. private _enableTexturesOffline;
  147752. private _manifestVersionFound;
  147753. private _mustUpdateRessources;
  147754. private _hasReachedQuota;
  147755. private _isSupported;
  147756. private _idbFactory;
  147757. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  147758. private static IsUASupportingBlobStorage;
  147759. /**
  147760. * Gets a boolean indicating if Database storate is enabled (off by default)
  147761. */
  147762. static IDBStorageEnabled: boolean;
  147763. /**
  147764. * Gets a boolean indicating if scene must be saved in the database
  147765. */
  147766. get enableSceneOffline(): boolean;
  147767. /**
  147768. * Gets a boolean indicating if textures must be saved in the database
  147769. */
  147770. get enableTexturesOffline(): boolean;
  147771. /**
  147772. * Creates a new Database
  147773. * @param urlToScene defines the url to load the scene
  147774. * @param callbackManifestChecked defines the callback to use when manifest is checked
  147775. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  147776. */
  147777. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  147778. private static _ParseURL;
  147779. private static _ReturnFullUrlLocation;
  147780. private _checkManifestFile;
  147781. /**
  147782. * Open the database and make it available
  147783. * @param successCallback defines the callback to call on success
  147784. * @param errorCallback defines the callback to call on error
  147785. */
  147786. open(successCallback: () => void, errorCallback: () => void): void;
  147787. /**
  147788. * Loads an image from the database
  147789. * @param url defines the url to load from
  147790. * @param image defines the target DOM image
  147791. */
  147792. loadImage(url: string, image: HTMLImageElement): void;
  147793. private _loadImageFromDBAsync;
  147794. private _saveImageIntoDBAsync;
  147795. private _checkVersionFromDB;
  147796. private _loadVersionFromDBAsync;
  147797. private _saveVersionIntoDBAsync;
  147798. /**
  147799. * Loads a file from database
  147800. * @param url defines the URL to load from
  147801. * @param sceneLoaded defines a callback to call on success
  147802. * @param progressCallBack defines a callback to call when progress changed
  147803. * @param errorCallback defines a callback to call on error
  147804. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  147805. */
  147806. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  147807. private _loadFileAsync;
  147808. private _saveFileAsync;
  147809. /**
  147810. * Validates if xhr data is correct
  147811. * @param xhr defines the request to validate
  147812. * @param dataType defines the expected data type
  147813. * @returns true if data is correct
  147814. */
  147815. private static _ValidateXHRData;
  147816. }
  147817. }
  147818. declare module BABYLON {
  147819. /** @hidden */
  147820. export var gpuUpdateParticlesPixelShader: {
  147821. name: string;
  147822. shader: string;
  147823. };
  147824. }
  147825. declare module BABYLON {
  147826. /** @hidden */
  147827. export var gpuUpdateParticlesVertexShader: {
  147828. name: string;
  147829. shader: string;
  147830. };
  147831. }
  147832. declare module BABYLON {
  147833. /** @hidden */
  147834. export var clipPlaneFragmentDeclaration2: {
  147835. name: string;
  147836. shader: string;
  147837. };
  147838. }
  147839. declare module BABYLON {
  147840. /** @hidden */
  147841. export var gpuRenderParticlesPixelShader: {
  147842. name: string;
  147843. shader: string;
  147844. };
  147845. }
  147846. declare module BABYLON {
  147847. /** @hidden */
  147848. export var clipPlaneVertexDeclaration2: {
  147849. name: string;
  147850. shader: string;
  147851. };
  147852. }
  147853. declare module BABYLON {
  147854. /** @hidden */
  147855. export var gpuRenderParticlesVertexShader: {
  147856. name: string;
  147857. shader: string;
  147858. };
  147859. }
  147860. declare module BABYLON {
  147861. /**
  147862. * This represents a GPU particle system in Babylon
  147863. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  147864. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  147865. */
  147866. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  147867. /**
  147868. * The layer mask we are rendering the particles through.
  147869. */
  147870. layerMask: number;
  147871. private _capacity;
  147872. private _activeCount;
  147873. private _currentActiveCount;
  147874. private _accumulatedCount;
  147875. private _renderEffect;
  147876. private _updateEffect;
  147877. private _buffer0;
  147878. private _buffer1;
  147879. private _spriteBuffer;
  147880. private _updateVAO;
  147881. private _renderVAO;
  147882. private _targetIndex;
  147883. private _sourceBuffer;
  147884. private _targetBuffer;
  147885. private _currentRenderId;
  147886. private _started;
  147887. private _stopped;
  147888. private _timeDelta;
  147889. private _randomTexture;
  147890. private _randomTexture2;
  147891. private _attributesStrideSize;
  147892. private _updateEffectOptions;
  147893. private _randomTextureSize;
  147894. private _actualFrame;
  147895. private _customEffect;
  147896. private readonly _rawTextureWidth;
  147897. /**
  147898. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147899. */
  147900. static get IsSupported(): boolean;
  147901. /**
  147902. * An event triggered when the system is disposed.
  147903. */
  147904. onDisposeObservable: Observable<IParticleSystem>;
  147905. /**
  147906. * Gets the maximum number of particles active at the same time.
  147907. * @returns The max number of active particles.
  147908. */
  147909. getCapacity(): number;
  147910. /**
  147911. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147912. * to override the particles.
  147913. */
  147914. forceDepthWrite: boolean;
  147915. /**
  147916. * Gets or set the number of active particles
  147917. */
  147918. get activeParticleCount(): number;
  147919. set activeParticleCount(value: number);
  147920. private _preWarmDone;
  147921. /**
  147922. * Specifies if the particles are updated in emitter local space or world space.
  147923. */
  147924. isLocal: boolean;
  147925. /** Gets or sets a matrix to use to compute projection */
  147926. defaultProjectionMatrix: Matrix;
  147927. /**
  147928. * Is this system ready to be used/rendered
  147929. * @return true if the system is ready
  147930. */
  147931. isReady(): boolean;
  147932. /**
  147933. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147934. * @returns True if it has been started, otherwise false.
  147935. */
  147936. isStarted(): boolean;
  147937. /**
  147938. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147939. * @returns True if it has been stopped, otherwise false.
  147940. */
  147941. isStopped(): boolean;
  147942. /**
  147943. * Gets a boolean indicating that the system is stopping
  147944. * @returns true if the system is currently stopping
  147945. */
  147946. isStopping(): boolean;
  147947. /**
  147948. * Gets the number of particles active at the same time.
  147949. * @returns The number of active particles.
  147950. */
  147951. getActiveCount(): number;
  147952. /**
  147953. * Starts the particle system and begins to emit
  147954. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147955. */
  147956. start(delay?: number): void;
  147957. /**
  147958. * Stops the particle system.
  147959. */
  147960. stop(): void;
  147961. /**
  147962. * Remove all active particles
  147963. */
  147964. reset(): void;
  147965. /**
  147966. * Returns the string "GPUParticleSystem"
  147967. * @returns a string containing the class name
  147968. */
  147969. getClassName(): string;
  147970. /**
  147971. * Gets the custom effect used to render the particles
  147972. * @param blendMode Blend mode for which the effect should be retrieved
  147973. * @returns The effect
  147974. */
  147975. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147976. /**
  147977. * Sets the custom effect used to render the particles
  147978. * @param effect The effect to set
  147979. * @param blendMode Blend mode for which the effect should be set
  147980. */
  147981. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147982. /** @hidden */
  147983. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147984. /**
  147985. * Observable that will be called just before the particles are drawn
  147986. */
  147987. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147988. /**
  147989. * Gets the name of the particle vertex shader
  147990. */
  147991. get vertexShaderName(): string;
  147992. private _colorGradientsTexture;
  147993. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147994. /**
  147995. * Adds a new color gradient
  147996. * @param gradient defines the gradient to use (between 0 and 1)
  147997. * @param color1 defines the color to affect to the specified gradient
  147998. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147999. * @returns the current particle system
  148000. */
  148001. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  148002. private _refreshColorGradient;
  148003. /** Force the system to rebuild all gradients that need to be resync */
  148004. forceRefreshGradients(): void;
  148005. /**
  148006. * Remove a specific color gradient
  148007. * @param gradient defines the gradient to remove
  148008. * @returns the current particle system
  148009. */
  148010. removeColorGradient(gradient: number): GPUParticleSystem;
  148011. private _angularSpeedGradientsTexture;
  148012. private _sizeGradientsTexture;
  148013. private _velocityGradientsTexture;
  148014. private _limitVelocityGradientsTexture;
  148015. private _dragGradientsTexture;
  148016. private _addFactorGradient;
  148017. /**
  148018. * Adds a new size gradient
  148019. * @param gradient defines the gradient to use (between 0 and 1)
  148020. * @param factor defines the size factor to affect to the specified gradient
  148021. * @returns the current particle system
  148022. */
  148023. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  148024. /**
  148025. * Remove a specific size gradient
  148026. * @param gradient defines the gradient to remove
  148027. * @returns the current particle system
  148028. */
  148029. removeSizeGradient(gradient: number): GPUParticleSystem;
  148030. private _refreshFactorGradient;
  148031. /**
  148032. * Adds a new angular speed gradient
  148033. * @param gradient defines the gradient to use (between 0 and 1)
  148034. * @param factor defines the angular speed to affect to the specified gradient
  148035. * @returns the current particle system
  148036. */
  148037. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  148038. /**
  148039. * Remove a specific angular speed gradient
  148040. * @param gradient defines the gradient to remove
  148041. * @returns the current particle system
  148042. */
  148043. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  148044. /**
  148045. * Adds a new velocity gradient
  148046. * @param gradient defines the gradient to use (between 0 and 1)
  148047. * @param factor defines the velocity to affect to the specified gradient
  148048. * @returns the current particle system
  148049. */
  148050. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  148051. /**
  148052. * Remove a specific velocity gradient
  148053. * @param gradient defines the gradient to remove
  148054. * @returns the current particle system
  148055. */
  148056. removeVelocityGradient(gradient: number): GPUParticleSystem;
  148057. /**
  148058. * Adds a new limit velocity gradient
  148059. * @param gradient defines the gradient to use (between 0 and 1)
  148060. * @param factor defines the limit velocity value to affect to the specified gradient
  148061. * @returns the current particle system
  148062. */
  148063. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  148064. /**
  148065. * Remove a specific limit velocity gradient
  148066. * @param gradient defines the gradient to remove
  148067. * @returns the current particle system
  148068. */
  148069. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  148070. /**
  148071. * Adds a new drag gradient
  148072. * @param gradient defines the gradient to use (between 0 and 1)
  148073. * @param factor defines the drag value to affect to the specified gradient
  148074. * @returns the current particle system
  148075. */
  148076. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  148077. /**
  148078. * Remove a specific drag gradient
  148079. * @param gradient defines the gradient to remove
  148080. * @returns the current particle system
  148081. */
  148082. removeDragGradient(gradient: number): GPUParticleSystem;
  148083. /**
  148084. * Not supported by GPUParticleSystem
  148085. * @param gradient defines the gradient to use (between 0 and 1)
  148086. * @param factor defines the emit rate value to affect to the specified gradient
  148087. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  148088. * @returns the current particle system
  148089. */
  148090. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  148091. /**
  148092. * Not supported by GPUParticleSystem
  148093. * @param gradient defines the gradient to remove
  148094. * @returns the current particle system
  148095. */
  148096. removeEmitRateGradient(gradient: number): IParticleSystem;
  148097. /**
  148098. * Not supported by GPUParticleSystem
  148099. * @param gradient defines the gradient to use (between 0 and 1)
  148100. * @param factor defines the start size value to affect to the specified gradient
  148101. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  148102. * @returns the current particle system
  148103. */
  148104. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  148105. /**
  148106. * Not supported by GPUParticleSystem
  148107. * @param gradient defines the gradient to remove
  148108. * @returns the current particle system
  148109. */
  148110. removeStartSizeGradient(gradient: number): IParticleSystem;
  148111. /**
  148112. * Not supported by GPUParticleSystem
  148113. * @param gradient defines the gradient to use (between 0 and 1)
  148114. * @param min defines the color remap minimal range
  148115. * @param max defines the color remap maximal range
  148116. * @returns the current particle system
  148117. */
  148118. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  148119. /**
  148120. * Not supported by GPUParticleSystem
  148121. * @param gradient defines the gradient to remove
  148122. * @returns the current particle system
  148123. */
  148124. removeColorRemapGradient(): IParticleSystem;
  148125. /**
  148126. * Not supported by GPUParticleSystem
  148127. * @param gradient defines the gradient to use (between 0 and 1)
  148128. * @param min defines the alpha remap minimal range
  148129. * @param max defines the alpha remap maximal range
  148130. * @returns the current particle system
  148131. */
  148132. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  148133. /**
  148134. * Not supported by GPUParticleSystem
  148135. * @param gradient defines the gradient to remove
  148136. * @returns the current particle system
  148137. */
  148138. removeAlphaRemapGradient(): IParticleSystem;
  148139. /**
  148140. * Not supported by GPUParticleSystem
  148141. * @param gradient defines the gradient to use (between 0 and 1)
  148142. * @param color defines the color to affect to the specified gradient
  148143. * @returns the current particle system
  148144. */
  148145. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  148146. /**
  148147. * Not supported by GPUParticleSystem
  148148. * @param gradient defines the gradient to remove
  148149. * @returns the current particle system
  148150. */
  148151. removeRampGradient(): IParticleSystem;
  148152. /**
  148153. * Not supported by GPUParticleSystem
  148154. * @returns the list of ramp gradients
  148155. */
  148156. getRampGradients(): Nullable<Array<Color3Gradient>>;
  148157. /**
  148158. * Not supported by GPUParticleSystem
  148159. * Gets or sets a boolean indicating that ramp gradients must be used
  148160. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  148161. */
  148162. get useRampGradients(): boolean;
  148163. set useRampGradients(value: boolean);
  148164. /**
  148165. * Not supported by GPUParticleSystem
  148166. * @param gradient defines the gradient to use (between 0 and 1)
  148167. * @param factor defines the life time factor to affect to the specified gradient
  148168. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  148169. * @returns the current particle system
  148170. */
  148171. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  148172. /**
  148173. * Not supported by GPUParticleSystem
  148174. * @param gradient defines the gradient to remove
  148175. * @returns the current particle system
  148176. */
  148177. removeLifeTimeGradient(gradient: number): IParticleSystem;
  148178. /**
  148179. * Instantiates a GPU particle system.
  148180. * 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.
  148181. * @param name The name of the particle system
  148182. * @param options The options used to create the system
  148183. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  148184. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  148185. * @param customEffect a custom effect used to change the way particles are rendered by default
  148186. */
  148187. constructor(name: string, options: Partial<{
  148188. capacity: number;
  148189. randomTextureSize: number;
  148190. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  148191. protected _reset(): void;
  148192. private _createUpdateVAO;
  148193. private _createRenderVAO;
  148194. private _initialize;
  148195. /** @hidden */
  148196. _recreateUpdateEffect(): void;
  148197. private _getEffect;
  148198. /**
  148199. * Fill the defines array according to the current settings of the particle system
  148200. * @param defines Array to be updated
  148201. * @param blendMode blend mode to take into account when updating the array
  148202. */
  148203. fillDefines(defines: Array<string>, blendMode?: number): void;
  148204. /**
  148205. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  148206. * @param uniforms Uniforms array to fill
  148207. * @param attributes Attributes array to fill
  148208. * @param samplers Samplers array to fill
  148209. */
  148210. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  148211. /** @hidden */
  148212. _recreateRenderEffect(): Effect;
  148213. /**
  148214. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  148215. * @param preWarm defines if we are in the pre-warmimg phase
  148216. */
  148217. animate(preWarm?: boolean): void;
  148218. private _createFactorGradientTexture;
  148219. private _createSizeGradientTexture;
  148220. private _createAngularSpeedGradientTexture;
  148221. private _createVelocityGradientTexture;
  148222. private _createLimitVelocityGradientTexture;
  148223. private _createDragGradientTexture;
  148224. private _createColorGradientTexture;
  148225. /**
  148226. * Renders the particle system in its current state
  148227. * @param preWarm defines if the system should only update the particles but not render them
  148228. * @returns the current number of particles
  148229. */
  148230. render(preWarm?: boolean): number;
  148231. /**
  148232. * Rebuilds the particle system
  148233. */
  148234. rebuild(): void;
  148235. private _releaseBuffers;
  148236. private _releaseVAOs;
  148237. /**
  148238. * Disposes the particle system and free the associated resources
  148239. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  148240. */
  148241. dispose(disposeTexture?: boolean): void;
  148242. /**
  148243. * Clones the particle system.
  148244. * @param name The name of the cloned object
  148245. * @param newEmitter The new emitter to use
  148246. * @returns the cloned particle system
  148247. */
  148248. clone(name: string, newEmitter: any): GPUParticleSystem;
  148249. /**
  148250. * Serializes the particle system to a JSON object
  148251. * @param serializeTexture defines if the texture must be serialized as well
  148252. * @returns the JSON object
  148253. */
  148254. serialize(serializeTexture?: boolean): any;
  148255. /**
  148256. * Parses a JSON object to create a GPU particle system.
  148257. * @param parsedParticleSystem The JSON object to parse
  148258. * @param sceneOrEngine The scene or the engine to create the particle system in
  148259. * @param rootUrl The root url to use to load external dependencies like texture
  148260. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  148261. * @returns the parsed GPU particle system
  148262. */
  148263. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  148264. }
  148265. }
  148266. declare module BABYLON {
  148267. /**
  148268. * Represents a set of particle systems working together to create a specific effect
  148269. */
  148270. export class ParticleSystemSet implements IDisposable {
  148271. /**
  148272. * Gets or sets base Assets URL
  148273. */
  148274. static BaseAssetsUrl: string;
  148275. private _emitterCreationOptions;
  148276. private _emitterNode;
  148277. /**
  148278. * Gets the particle system list
  148279. */
  148280. systems: IParticleSystem[];
  148281. /**
  148282. * Gets the emitter node used with this set
  148283. */
  148284. get emitterNode(): Nullable<TransformNode>;
  148285. /**
  148286. * Creates a new emitter mesh as a sphere
  148287. * @param options defines the options used to create the sphere
  148288. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  148289. * @param scene defines the hosting scene
  148290. */
  148291. setEmitterAsSphere(options: {
  148292. diameter: number;
  148293. segments: number;
  148294. color: Color3;
  148295. }, renderingGroupId: number, scene: Scene): void;
  148296. /**
  148297. * Starts all particle systems of the set
  148298. * @param emitter defines an optional mesh to use as emitter for the particle systems
  148299. */
  148300. start(emitter?: AbstractMesh): void;
  148301. /**
  148302. * Release all associated resources
  148303. */
  148304. dispose(): void;
  148305. /**
  148306. * Serialize the set into a JSON compatible object
  148307. * @param serializeTexture defines if the texture must be serialized as well
  148308. * @returns a JSON compatible representation of the set
  148309. */
  148310. serialize(serializeTexture?: boolean): any;
  148311. /**
  148312. * Parse a new ParticleSystemSet from a serialized source
  148313. * @param data defines a JSON compatible representation of the set
  148314. * @param scene defines the hosting scene
  148315. * @param gpu defines if we want GPU particles or CPU particles
  148316. * @returns a new ParticleSystemSet
  148317. */
  148318. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  148319. }
  148320. }
  148321. declare module BABYLON {
  148322. /**
  148323. * This class is made for on one-liner static method to help creating particle system set.
  148324. */
  148325. export class ParticleHelper {
  148326. /**
  148327. * Gets or sets base Assets URL
  148328. */
  148329. static BaseAssetsUrl: string;
  148330. /** Define the Url to load snippets */
  148331. static SnippetUrl: string;
  148332. /**
  148333. * Create a default particle system that you can tweak
  148334. * @param emitter defines the emitter to use
  148335. * @param capacity defines the system capacity (default is 500 particles)
  148336. * @param scene defines the hosting scene
  148337. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  148338. * @returns the new Particle system
  148339. */
  148340. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  148341. /**
  148342. * This is the main static method (one-liner) of this helper to create different particle systems
  148343. * @param type This string represents the type to the particle system to create
  148344. * @param scene The scene where the particle system should live
  148345. * @param gpu If the system will use gpu
  148346. * @returns the ParticleSystemSet created
  148347. */
  148348. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  148349. /**
  148350. * Static function used to export a particle system to a ParticleSystemSet variable.
  148351. * Please note that the emitter shape is not exported
  148352. * @param systems defines the particle systems to export
  148353. * @returns the created particle system set
  148354. */
  148355. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  148356. /**
  148357. * Creates a particle system from a snippet saved in a remote file
  148358. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  148359. * @param url defines the url to load from
  148360. * @param scene defines the hosting scene
  148361. * @param gpu If the system will use gpu
  148362. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  148363. * @returns a promise that will resolve to the new particle system
  148364. */
  148365. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  148366. /**
  148367. * Creates a particle system from a snippet saved by the particle system editor
  148368. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  148369. * @param scene defines the hosting scene
  148370. * @param gpu If the system will use gpu
  148371. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  148372. * @returns a promise that will resolve to the new particle system
  148373. */
  148374. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  148375. }
  148376. }
  148377. declare module BABYLON {
  148378. interface Engine {
  148379. /**
  148380. * Create an effect to use with particle systems.
  148381. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  148382. * the particle system for which you want to create a custom effect in the last parameter
  148383. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  148384. * @param uniformsNames defines a list of attribute names
  148385. * @param samplers defines an array of string used to represent textures
  148386. * @param defines defines the string containing the defines to use to compile the shaders
  148387. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  148388. * @param onCompiled defines a function to call when the effect creation is successful
  148389. * @param onError defines a function to call when the effect creation has failed
  148390. * @param particleSystem the particle system you want to create the effect for
  148391. * @returns the new Effect
  148392. */
  148393. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  148394. }
  148395. interface Mesh {
  148396. /**
  148397. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  148398. * @returns an array of IParticleSystem
  148399. */
  148400. getEmittedParticleSystems(): IParticleSystem[];
  148401. /**
  148402. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  148403. * @returns an array of IParticleSystem
  148404. */
  148405. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  148406. }
  148407. }
  148408. declare module BABYLON {
  148409. /** Defines the 4 color options */
  148410. export enum PointColor {
  148411. /** color value */
  148412. Color = 2,
  148413. /** uv value */
  148414. UV = 1,
  148415. /** random value */
  148416. Random = 0,
  148417. /** stated value */
  148418. Stated = 3
  148419. }
  148420. /**
  148421. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  148422. * 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.
  148423. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  148424. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  148425. *
  148426. * Full documentation here : TO BE ENTERED
  148427. */
  148428. export class PointsCloudSystem implements IDisposable {
  148429. /**
  148430. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  148431. * Example : var p = SPS.particles[i];
  148432. */
  148433. particles: CloudPoint[];
  148434. /**
  148435. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  148436. */
  148437. nbParticles: number;
  148438. /**
  148439. * This a counter for your own usage. It's not set by any SPS functions.
  148440. */
  148441. counter: number;
  148442. /**
  148443. * The PCS name. This name is also given to the underlying mesh.
  148444. */
  148445. name: string;
  148446. /**
  148447. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  148448. */
  148449. mesh: Mesh;
  148450. /**
  148451. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  148452. * Please read :
  148453. */
  148454. vars: any;
  148455. /**
  148456. * @hidden
  148457. */
  148458. _size: number;
  148459. private _scene;
  148460. private _promises;
  148461. private _positions;
  148462. private _indices;
  148463. private _normals;
  148464. private _colors;
  148465. private _uvs;
  148466. private _indices32;
  148467. private _positions32;
  148468. private _colors32;
  148469. private _uvs32;
  148470. private _updatable;
  148471. private _isVisibilityBoxLocked;
  148472. private _alwaysVisible;
  148473. private _groups;
  148474. private _groupCounter;
  148475. private _computeParticleColor;
  148476. private _computeParticleTexture;
  148477. private _computeParticleRotation;
  148478. private _computeBoundingBox;
  148479. private _isReady;
  148480. /**
  148481. * Creates a PCS (Points Cloud System) object
  148482. * @param name (String) is the PCS name, this will be the underlying mesh name
  148483. * @param pointSize (number) is the size for each point
  148484. * @param scene (Scene) is the scene in which the PCS is added
  148485. * @param options defines the options of the PCS e.g.
  148486. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  148487. */
  148488. constructor(name: string, pointSize: number, scene: Scene, options?: {
  148489. updatable?: boolean;
  148490. });
  148491. /**
  148492. * Builds the PCS underlying mesh. Returns a standard Mesh.
  148493. * If no points were added to the PCS, the returned mesh is just a single point.
  148494. * @returns a promise for the created mesh
  148495. */
  148496. buildMeshAsync(): Promise<Mesh>;
  148497. /**
  148498. * @hidden
  148499. */
  148500. private _buildMesh;
  148501. private _addParticle;
  148502. private _randomUnitVector;
  148503. private _getColorIndicesForCoord;
  148504. private _setPointsColorOrUV;
  148505. private _colorFromTexture;
  148506. private _calculateDensity;
  148507. /**
  148508. * Adds points to the PCS in random positions within a unit sphere
  148509. * @param nb (positive integer) the number of particles to be created from this model
  148510. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  148511. * @returns the number of groups in the system
  148512. */
  148513. addPoints(nb: number, pointFunction?: any): number;
  148514. /**
  148515. * Adds points to the PCS from the surface of the model shape
  148516. * @param mesh is any Mesh object that will be used as a surface model for the points
  148517. * @param nb (positive integer) the number of particles to be created from this model
  148518. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  148519. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  148520. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  148521. * @returns the number of groups in the system
  148522. */
  148523. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  148524. /**
  148525. * Adds points to the PCS inside the model shape
  148526. * @param mesh is any Mesh object that will be used as a surface model for the points
  148527. * @param nb (positive integer) the number of particles to be created from this model
  148528. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  148529. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  148530. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  148531. * @returns the number of groups in the system
  148532. */
  148533. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  148534. /**
  148535. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  148536. * This method calls `updateParticle()` for each particle of the SPS.
  148537. * For an animated SPS, it is usually called within the render loop.
  148538. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  148539. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  148540. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  148541. * @returns the PCS.
  148542. */
  148543. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  148544. /**
  148545. * Disposes the PCS.
  148546. */
  148547. dispose(): void;
  148548. /**
  148549. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  148550. * doc :
  148551. * @returns the PCS.
  148552. */
  148553. refreshVisibleSize(): PointsCloudSystem;
  148554. /**
  148555. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  148556. * @param size the size (float) of the visibility box
  148557. * note : this doesn't lock the PCS mesh bounding box.
  148558. * doc :
  148559. */
  148560. setVisibilityBox(size: number): void;
  148561. /**
  148562. * Gets whether the PCS is always visible or not
  148563. * doc :
  148564. */
  148565. get isAlwaysVisible(): boolean;
  148566. /**
  148567. * Sets the PCS as always visible or not
  148568. * doc :
  148569. */
  148570. set isAlwaysVisible(val: boolean);
  148571. /**
  148572. * Tells to `setParticles()` to compute the particle rotations or not
  148573. * Default value : false. The PCS is faster when it's set to false
  148574. * Note : particle rotations are only applied to parent particles
  148575. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  148576. */
  148577. set computeParticleRotation(val: boolean);
  148578. /**
  148579. * Tells to `setParticles()` to compute the particle colors or not.
  148580. * Default value : true. The PCS is faster when it's set to false.
  148581. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  148582. */
  148583. set computeParticleColor(val: boolean);
  148584. set computeParticleTexture(val: boolean);
  148585. /**
  148586. * Gets if `setParticles()` computes the particle colors or not.
  148587. * Default value : false. The PCS is faster when it's set to false.
  148588. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  148589. */
  148590. get computeParticleColor(): boolean;
  148591. /**
  148592. * Gets if `setParticles()` computes the particle textures or not.
  148593. * Default value : false. The PCS is faster when it's set to false.
  148594. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  148595. */
  148596. get computeParticleTexture(): boolean;
  148597. /**
  148598. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  148599. */
  148600. set computeBoundingBox(val: boolean);
  148601. /**
  148602. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  148603. */
  148604. get computeBoundingBox(): boolean;
  148605. /**
  148606. * This function does nothing. It may be overwritten to set all the particle first values.
  148607. * The PCS doesn't call this function, you may have to call it by your own.
  148608. * doc :
  148609. */
  148610. initParticles(): void;
  148611. /**
  148612. * This function does nothing. It may be overwritten to recycle a particle
  148613. * The PCS doesn't call this function, you can to call it
  148614. * doc :
  148615. * @param particle The particle to recycle
  148616. * @returns the recycled particle
  148617. */
  148618. recycleParticle(particle: CloudPoint): CloudPoint;
  148619. /**
  148620. * Updates a particle : this function should be overwritten by the user.
  148621. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  148622. * doc :
  148623. * @example : just set a particle position or velocity and recycle conditions
  148624. * @param particle The particle to update
  148625. * @returns the updated particle
  148626. */
  148627. updateParticle(particle: CloudPoint): CloudPoint;
  148628. /**
  148629. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  148630. * This does nothing and may be overwritten by the user.
  148631. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  148632. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  148633. * @param update the boolean update value actually passed to setParticles()
  148634. */
  148635. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  148636. /**
  148637. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  148638. * This will be passed three parameters.
  148639. * This does nothing and may be overwritten by the user.
  148640. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  148641. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  148642. * @param update the boolean update value actually passed to setParticles()
  148643. */
  148644. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  148645. }
  148646. }
  148647. declare module BABYLON {
  148648. /**
  148649. * Represents one particle of a points cloud system.
  148650. */
  148651. export class CloudPoint {
  148652. /**
  148653. * particle global index
  148654. */
  148655. idx: number;
  148656. /**
  148657. * The color of the particle
  148658. */
  148659. color: Nullable<Color4>;
  148660. /**
  148661. * The world space position of the particle.
  148662. */
  148663. position: Vector3;
  148664. /**
  148665. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  148666. */
  148667. rotation: Vector3;
  148668. /**
  148669. * The world space rotation quaternion of the particle.
  148670. */
  148671. rotationQuaternion: Nullable<Quaternion>;
  148672. /**
  148673. * The uv of the particle.
  148674. */
  148675. uv: Nullable<Vector2>;
  148676. /**
  148677. * The current speed of the particle.
  148678. */
  148679. velocity: Vector3;
  148680. /**
  148681. * The pivot point in the particle local space.
  148682. */
  148683. pivot: Vector3;
  148684. /**
  148685. * Must the particle be translated from its pivot point in its local space ?
  148686. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  148687. * Default : false
  148688. */
  148689. translateFromPivot: boolean;
  148690. /**
  148691. * Index of this particle in the global "positions" array (Internal use)
  148692. * @hidden
  148693. */
  148694. _pos: number;
  148695. /**
  148696. * @hidden Index of this particle in the global "indices" array (Internal use)
  148697. */
  148698. _ind: number;
  148699. /**
  148700. * Group this particle belongs to
  148701. */
  148702. _group: PointsGroup;
  148703. /**
  148704. * Group id of this particle
  148705. */
  148706. groupId: number;
  148707. /**
  148708. * Index of the particle in its group id (Internal use)
  148709. */
  148710. idxInGroup: number;
  148711. /**
  148712. * @hidden Particle BoundingInfo object (Internal use)
  148713. */
  148714. _boundingInfo: BoundingInfo;
  148715. /**
  148716. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  148717. */
  148718. _pcs: PointsCloudSystem;
  148719. /**
  148720. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  148721. */
  148722. _stillInvisible: boolean;
  148723. /**
  148724. * @hidden Last computed particle rotation matrix
  148725. */
  148726. _rotationMatrix: number[];
  148727. /**
  148728. * Parent particle Id, if any.
  148729. * Default null.
  148730. */
  148731. parentId: Nullable<number>;
  148732. /**
  148733. * @hidden Internal global position in the PCS.
  148734. */
  148735. _globalPosition: Vector3;
  148736. /**
  148737. * Creates a Point Cloud object.
  148738. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  148739. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  148740. * @param group (PointsGroup) is the group the particle belongs to
  148741. * @param groupId (integer) is the group identifier in the PCS.
  148742. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  148743. * @param pcs defines the PCS it is associated to
  148744. */
  148745. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  148746. /**
  148747. * get point size
  148748. */
  148749. get size(): Vector3;
  148750. /**
  148751. * Set point size
  148752. */
  148753. set size(scale: Vector3);
  148754. /**
  148755. * Legacy support, changed quaternion to rotationQuaternion
  148756. */
  148757. get quaternion(): Nullable<Quaternion>;
  148758. /**
  148759. * Legacy support, changed quaternion to rotationQuaternion
  148760. */
  148761. set quaternion(q: Nullable<Quaternion>);
  148762. /**
  148763. * Returns a boolean. True if the particle intersects a mesh, else false
  148764. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  148765. * @param target is the object (point or mesh) what the intersection is computed against
  148766. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  148767. * @returns true if it intersects
  148768. */
  148769. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  148770. /**
  148771. * get the rotation matrix of the particle
  148772. * @hidden
  148773. */
  148774. getRotationMatrix(m: Matrix): void;
  148775. }
  148776. /**
  148777. * Represents a group of points in a points cloud system
  148778. * * PCS internal tool, don't use it manually.
  148779. */
  148780. export class PointsGroup {
  148781. /**
  148782. * The group id
  148783. * @hidden
  148784. */
  148785. groupID: number;
  148786. /**
  148787. * image data for group (internal use)
  148788. * @hidden
  148789. */
  148790. _groupImageData: Nullable<ArrayBufferView>;
  148791. /**
  148792. * Image Width (internal use)
  148793. * @hidden
  148794. */
  148795. _groupImgWidth: number;
  148796. /**
  148797. * Image Height (internal use)
  148798. * @hidden
  148799. */
  148800. _groupImgHeight: number;
  148801. /**
  148802. * Custom position function (internal use)
  148803. * @hidden
  148804. */
  148805. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  148806. /**
  148807. * density per facet for surface points
  148808. * @hidden
  148809. */
  148810. _groupDensity: number[];
  148811. /**
  148812. * Only when points are colored by texture carries pointer to texture list array
  148813. * @hidden
  148814. */
  148815. _textureNb: number;
  148816. /**
  148817. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  148818. * PCS internal tool, don't use it manually.
  148819. * @hidden
  148820. */
  148821. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  148822. }
  148823. }
  148824. declare module BABYLON {
  148825. interface Scene {
  148826. /** @hidden (Backing field) */
  148827. _physicsEngine: Nullable<IPhysicsEngine>;
  148828. /** @hidden */
  148829. _physicsTimeAccumulator: number;
  148830. /**
  148831. * Gets the current physics engine
  148832. * @returns a IPhysicsEngine or null if none attached
  148833. */
  148834. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  148835. /**
  148836. * Enables physics to the current scene
  148837. * @param gravity defines the scene's gravity for the physics engine
  148838. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  148839. * @return a boolean indicating if the physics engine was initialized
  148840. */
  148841. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  148842. /**
  148843. * Disables and disposes the physics engine associated with the scene
  148844. */
  148845. disablePhysicsEngine(): void;
  148846. /**
  148847. * Gets a boolean indicating if there is an active physics engine
  148848. * @returns a boolean indicating if there is an active physics engine
  148849. */
  148850. isPhysicsEnabled(): boolean;
  148851. /**
  148852. * Deletes a physics compound impostor
  148853. * @param compound defines the compound to delete
  148854. */
  148855. deleteCompoundImpostor(compound: any): void;
  148856. /**
  148857. * An event triggered when physic simulation is about to be run
  148858. */
  148859. onBeforePhysicsObservable: Observable<Scene>;
  148860. /**
  148861. * An event triggered when physic simulation has been done
  148862. */
  148863. onAfterPhysicsObservable: Observable<Scene>;
  148864. }
  148865. interface AbstractMesh {
  148866. /** @hidden */
  148867. _physicsImpostor: Nullable<PhysicsImpostor>;
  148868. /**
  148869. * Gets or sets impostor used for physic simulation
  148870. * @see https://doc.babylonjs.com/features/physics_engine
  148871. */
  148872. physicsImpostor: Nullable<PhysicsImpostor>;
  148873. /**
  148874. * Gets the current physics impostor
  148875. * @see https://doc.babylonjs.com/features/physics_engine
  148876. * @returns a physics impostor or null
  148877. */
  148878. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148879. /** Apply a physic impulse to the mesh
  148880. * @param force defines the force to apply
  148881. * @param contactPoint defines where to apply the force
  148882. * @returns the current mesh
  148883. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148884. */
  148885. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148886. /**
  148887. * Creates a physic joint between two meshes
  148888. * @param otherMesh defines the other mesh to use
  148889. * @param pivot1 defines the pivot to use on this mesh
  148890. * @param pivot2 defines the pivot to use on the other mesh
  148891. * @param options defines additional options (can be plugin dependent)
  148892. * @returns the current mesh
  148893. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148894. */
  148895. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148896. /** @hidden */
  148897. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148898. }
  148899. /**
  148900. * Defines the physics engine scene component responsible to manage a physics engine
  148901. */
  148902. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148903. /**
  148904. * The component name helpful to identify the component in the list of scene components.
  148905. */
  148906. readonly name: string;
  148907. /**
  148908. * The scene the component belongs to.
  148909. */
  148910. scene: Scene;
  148911. /**
  148912. * Creates a new instance of the component for the given scene
  148913. * @param scene Defines the scene to register the component in
  148914. */
  148915. constructor(scene: Scene);
  148916. /**
  148917. * Registers the component in a given scene
  148918. */
  148919. register(): void;
  148920. /**
  148921. * Rebuilds the elements related to this component in case of
  148922. * context lost for instance.
  148923. */
  148924. rebuild(): void;
  148925. /**
  148926. * Disposes the component and the associated ressources
  148927. */
  148928. dispose(): void;
  148929. }
  148930. }
  148931. declare module BABYLON {
  148932. /**
  148933. * A helper for physics simulations
  148934. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148935. */
  148936. export class PhysicsHelper {
  148937. private _scene;
  148938. private _physicsEngine;
  148939. /**
  148940. * Initializes the Physics helper
  148941. * @param scene Babylon.js scene
  148942. */
  148943. constructor(scene: Scene);
  148944. /**
  148945. * Applies a radial explosion impulse
  148946. * @param origin the origin of the explosion
  148947. * @param radiusOrEventOptions the radius or the options of radial explosion
  148948. * @param strength the explosion strength
  148949. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148950. * @returns A physics radial explosion event, or null
  148951. */
  148952. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148953. /**
  148954. * Applies a radial explosion force
  148955. * @param origin the origin of the explosion
  148956. * @param radiusOrEventOptions the radius or the options of radial explosion
  148957. * @param strength the explosion strength
  148958. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148959. * @returns A physics radial explosion event, or null
  148960. */
  148961. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148962. /**
  148963. * Creates a gravitational field
  148964. * @param origin the origin of the explosion
  148965. * @param radiusOrEventOptions the radius or the options of radial explosion
  148966. * @param strength the explosion strength
  148967. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148968. * @returns A physics gravitational field event, or null
  148969. */
  148970. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148971. /**
  148972. * Creates a physics updraft event
  148973. * @param origin the origin of the updraft
  148974. * @param radiusOrEventOptions the radius or the options of the updraft
  148975. * @param strength the strength of the updraft
  148976. * @param height the height of the updraft
  148977. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148978. * @returns A physics updraft event, or null
  148979. */
  148980. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148981. /**
  148982. * Creates a physics vortex event
  148983. * @param origin the of the vortex
  148984. * @param radiusOrEventOptions the radius or the options of the vortex
  148985. * @param strength the strength of the vortex
  148986. * @param height the height of the vortex
  148987. * @returns a Physics vortex event, or null
  148988. * A physics vortex event or null
  148989. */
  148990. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148991. }
  148992. /**
  148993. * Represents a physics radial explosion event
  148994. */
  148995. class PhysicsRadialExplosionEvent {
  148996. private _scene;
  148997. private _options;
  148998. private _sphere;
  148999. private _dataFetched;
  149000. /**
  149001. * Initializes a radial explosioin event
  149002. * @param _scene BabylonJS scene
  149003. * @param _options The options for the vortex event
  149004. */
  149005. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  149006. /**
  149007. * Returns the data related to the radial explosion event (sphere).
  149008. * @returns The radial explosion event data
  149009. */
  149010. getData(): PhysicsRadialExplosionEventData;
  149011. /**
  149012. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  149013. * @param impostor A physics imposter
  149014. * @param origin the origin of the explosion
  149015. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  149016. */
  149017. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  149018. /**
  149019. * Triggers affecterd impostors callbacks
  149020. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  149021. */
  149022. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  149023. /**
  149024. * Disposes the sphere.
  149025. * @param force Specifies if the sphere should be disposed by force
  149026. */
  149027. dispose(force?: boolean): void;
  149028. /*** Helpers ***/
  149029. private _prepareSphere;
  149030. private _intersectsWithSphere;
  149031. }
  149032. /**
  149033. * Represents a gravitational field event
  149034. */
  149035. class PhysicsGravitationalFieldEvent {
  149036. private _physicsHelper;
  149037. private _scene;
  149038. private _origin;
  149039. private _options;
  149040. private _tickCallback;
  149041. private _sphere;
  149042. private _dataFetched;
  149043. /**
  149044. * Initializes the physics gravitational field event
  149045. * @param _physicsHelper A physics helper
  149046. * @param _scene BabylonJS scene
  149047. * @param _origin The origin position of the gravitational field event
  149048. * @param _options The options for the vortex event
  149049. */
  149050. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  149051. /**
  149052. * Returns the data related to the gravitational field event (sphere).
  149053. * @returns A gravitational field event
  149054. */
  149055. getData(): PhysicsGravitationalFieldEventData;
  149056. /**
  149057. * Enables the gravitational field.
  149058. */
  149059. enable(): void;
  149060. /**
  149061. * Disables the gravitational field.
  149062. */
  149063. disable(): void;
  149064. /**
  149065. * Disposes the sphere.
  149066. * @param force The force to dispose from the gravitational field event
  149067. */
  149068. dispose(force?: boolean): void;
  149069. private _tick;
  149070. }
  149071. /**
  149072. * Represents a physics updraft event
  149073. */
  149074. class PhysicsUpdraftEvent {
  149075. private _scene;
  149076. private _origin;
  149077. private _options;
  149078. private _physicsEngine;
  149079. private _originTop;
  149080. private _originDirection;
  149081. private _tickCallback;
  149082. private _cylinder;
  149083. private _cylinderPosition;
  149084. private _dataFetched;
  149085. /**
  149086. * Initializes the physics updraft event
  149087. * @param _scene BabylonJS scene
  149088. * @param _origin The origin position of the updraft
  149089. * @param _options The options for the updraft event
  149090. */
  149091. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  149092. /**
  149093. * Returns the data related to the updraft event (cylinder).
  149094. * @returns A physics updraft event
  149095. */
  149096. getData(): PhysicsUpdraftEventData;
  149097. /**
  149098. * Enables the updraft.
  149099. */
  149100. enable(): void;
  149101. /**
  149102. * Disables the updraft.
  149103. */
  149104. disable(): void;
  149105. /**
  149106. * Disposes the cylinder.
  149107. * @param force Specifies if the updraft should be disposed by force
  149108. */
  149109. dispose(force?: boolean): void;
  149110. private getImpostorHitData;
  149111. private _tick;
  149112. /*** Helpers ***/
  149113. private _prepareCylinder;
  149114. private _intersectsWithCylinder;
  149115. }
  149116. /**
  149117. * Represents a physics vortex event
  149118. */
  149119. class PhysicsVortexEvent {
  149120. private _scene;
  149121. private _origin;
  149122. private _options;
  149123. private _physicsEngine;
  149124. private _originTop;
  149125. private _tickCallback;
  149126. private _cylinder;
  149127. private _cylinderPosition;
  149128. private _dataFetched;
  149129. /**
  149130. * Initializes the physics vortex event
  149131. * @param _scene The BabylonJS scene
  149132. * @param _origin The origin position of the vortex
  149133. * @param _options The options for the vortex event
  149134. */
  149135. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  149136. /**
  149137. * Returns the data related to the vortex event (cylinder).
  149138. * @returns The physics vortex event data
  149139. */
  149140. getData(): PhysicsVortexEventData;
  149141. /**
  149142. * Enables the vortex.
  149143. */
  149144. enable(): void;
  149145. /**
  149146. * Disables the cortex.
  149147. */
  149148. disable(): void;
  149149. /**
  149150. * Disposes the sphere.
  149151. * @param force
  149152. */
  149153. dispose(force?: boolean): void;
  149154. private getImpostorHitData;
  149155. private _tick;
  149156. /*** Helpers ***/
  149157. private _prepareCylinder;
  149158. private _intersectsWithCylinder;
  149159. }
  149160. /**
  149161. * Options fot the radial explosion event
  149162. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149163. */
  149164. export class PhysicsRadialExplosionEventOptions {
  149165. /**
  149166. * The radius of the sphere for the radial explosion.
  149167. */
  149168. radius: number;
  149169. /**
  149170. * The strenth of the explosion.
  149171. */
  149172. strength: number;
  149173. /**
  149174. * The strenght of the force in correspondence to the distance of the affected object
  149175. */
  149176. falloff: PhysicsRadialImpulseFalloff;
  149177. /**
  149178. * Sphere options for the radial explosion.
  149179. */
  149180. sphere: {
  149181. segments: number;
  149182. diameter: number;
  149183. };
  149184. /**
  149185. * Sphere options for the radial explosion.
  149186. */
  149187. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  149188. }
  149189. /**
  149190. * Options fot the updraft event
  149191. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149192. */
  149193. export class PhysicsUpdraftEventOptions {
  149194. /**
  149195. * The radius of the cylinder for the vortex
  149196. */
  149197. radius: number;
  149198. /**
  149199. * The strenth of the updraft.
  149200. */
  149201. strength: number;
  149202. /**
  149203. * The height of the cylinder for the updraft.
  149204. */
  149205. height: number;
  149206. /**
  149207. * The mode for the the updraft.
  149208. */
  149209. updraftMode: PhysicsUpdraftMode;
  149210. }
  149211. /**
  149212. * Options fot the vortex event
  149213. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149214. */
  149215. export class PhysicsVortexEventOptions {
  149216. /**
  149217. * The radius of the cylinder for the vortex
  149218. */
  149219. radius: number;
  149220. /**
  149221. * The strenth of the vortex.
  149222. */
  149223. strength: number;
  149224. /**
  149225. * The height of the cylinder for the vortex.
  149226. */
  149227. height: number;
  149228. /**
  149229. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  149230. */
  149231. centripetalForceThreshold: number;
  149232. /**
  149233. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  149234. */
  149235. centripetalForceMultiplier: number;
  149236. /**
  149237. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  149238. */
  149239. centrifugalForceMultiplier: number;
  149240. /**
  149241. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  149242. */
  149243. updraftForceMultiplier: number;
  149244. }
  149245. /**
  149246. * The strenght of the force in correspondence to the distance of the affected object
  149247. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149248. */
  149249. export enum PhysicsRadialImpulseFalloff {
  149250. /** Defines that impulse is constant in strength across it's whole radius */
  149251. Constant = 0,
  149252. /** Defines that impulse gets weaker if it's further from the origin */
  149253. Linear = 1
  149254. }
  149255. /**
  149256. * The strength of the force in correspondence to the distance of the affected object
  149257. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149258. */
  149259. export enum PhysicsUpdraftMode {
  149260. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  149261. Center = 0,
  149262. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  149263. Perpendicular = 1
  149264. }
  149265. /**
  149266. * Interface for a physics hit data
  149267. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149268. */
  149269. export interface PhysicsHitData {
  149270. /**
  149271. * The force applied at the contact point
  149272. */
  149273. force: Vector3;
  149274. /**
  149275. * The contact point
  149276. */
  149277. contactPoint: Vector3;
  149278. /**
  149279. * The distance from the origin to the contact point
  149280. */
  149281. distanceFromOrigin: number;
  149282. }
  149283. /**
  149284. * Interface for radial explosion event data
  149285. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149286. */
  149287. export interface PhysicsRadialExplosionEventData {
  149288. /**
  149289. * A sphere used for the radial explosion event
  149290. */
  149291. sphere: Mesh;
  149292. }
  149293. /**
  149294. * Interface for gravitational field event data
  149295. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149296. */
  149297. export interface PhysicsGravitationalFieldEventData {
  149298. /**
  149299. * A sphere mesh used for the gravitational field event
  149300. */
  149301. sphere: Mesh;
  149302. }
  149303. /**
  149304. * Interface for updraft event data
  149305. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149306. */
  149307. export interface PhysicsUpdraftEventData {
  149308. /**
  149309. * A cylinder used for the updraft event
  149310. */
  149311. cylinder: Mesh;
  149312. }
  149313. /**
  149314. * Interface for vortex event data
  149315. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149316. */
  149317. export interface PhysicsVortexEventData {
  149318. /**
  149319. * A cylinder used for the vortex event
  149320. */
  149321. cylinder: Mesh;
  149322. }
  149323. /**
  149324. * Interface for an affected physics impostor
  149325. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149326. */
  149327. export interface PhysicsAffectedImpostorWithData {
  149328. /**
  149329. * The impostor affected by the effect
  149330. */
  149331. impostor: PhysicsImpostor;
  149332. /**
  149333. * The data about the hit/horce from the explosion
  149334. */
  149335. hitData: PhysicsHitData;
  149336. }
  149337. }
  149338. declare module BABYLON {
  149339. /** @hidden */
  149340. export var blackAndWhitePixelShader: {
  149341. name: string;
  149342. shader: string;
  149343. };
  149344. }
  149345. declare module BABYLON {
  149346. /**
  149347. * Post process used to render in black and white
  149348. */
  149349. export class BlackAndWhitePostProcess extends PostProcess {
  149350. /**
  149351. * Linear about to convert he result to black and white (default: 1)
  149352. */
  149353. degree: number;
  149354. /**
  149355. * Gets a string identifying the name of the class
  149356. * @returns "BlackAndWhitePostProcess" string
  149357. */
  149358. getClassName(): string;
  149359. /**
  149360. * Creates a black and white post process
  149361. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  149362. * @param name The name of the effect.
  149363. * @param options The required width/height ratio to downsize to before computing the render pass.
  149364. * @param camera The camera to apply the render pass to.
  149365. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149366. * @param engine The engine which the post process will be applied. (default: current engine)
  149367. * @param reusable If the post process can be reused on the same frame. (default: false)
  149368. */
  149369. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149370. /** @hidden */
  149371. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  149372. }
  149373. }
  149374. declare module BABYLON {
  149375. /**
  149376. * This represents a set of one or more post processes in Babylon.
  149377. * A post process can be used to apply a shader to a texture after it is rendered.
  149378. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149379. */
  149380. export class PostProcessRenderEffect {
  149381. private _postProcesses;
  149382. private _getPostProcesses;
  149383. private _singleInstance;
  149384. private _cameras;
  149385. private _indicesForCamera;
  149386. /**
  149387. * Name of the effect
  149388. * @hidden
  149389. */
  149390. _name: string;
  149391. /**
  149392. * Instantiates a post process render effect.
  149393. * A post process can be used to apply a shader to a texture after it is rendered.
  149394. * @param engine The engine the effect is tied to
  149395. * @param name The name of the effect
  149396. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  149397. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  149398. */
  149399. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  149400. /**
  149401. * Checks if all the post processes in the effect are supported.
  149402. */
  149403. get isSupported(): boolean;
  149404. /**
  149405. * Updates the current state of the effect
  149406. * @hidden
  149407. */
  149408. _update(): void;
  149409. /**
  149410. * Attaches the effect on cameras
  149411. * @param cameras The camera to attach to.
  149412. * @hidden
  149413. */
  149414. _attachCameras(cameras: Camera): void;
  149415. /**
  149416. * Attaches the effect on cameras
  149417. * @param cameras The camera to attach to.
  149418. * @hidden
  149419. */
  149420. _attachCameras(cameras: Camera[]): void;
  149421. /**
  149422. * Detaches the effect on cameras
  149423. * @param cameras The camera to detatch from.
  149424. * @hidden
  149425. */
  149426. _detachCameras(cameras: Camera): void;
  149427. /**
  149428. * Detatches the effect on cameras
  149429. * @param cameras The camera to detatch from.
  149430. * @hidden
  149431. */
  149432. _detachCameras(cameras: Camera[]): void;
  149433. /**
  149434. * Enables the effect on given cameras
  149435. * @param cameras The camera to enable.
  149436. * @hidden
  149437. */
  149438. _enable(cameras: Camera): void;
  149439. /**
  149440. * Enables the effect on given cameras
  149441. * @param cameras The camera to enable.
  149442. * @hidden
  149443. */
  149444. _enable(cameras: Nullable<Camera[]>): void;
  149445. /**
  149446. * Disables the effect on the given cameras
  149447. * @param cameras The camera to disable.
  149448. * @hidden
  149449. */
  149450. _disable(cameras: Camera): void;
  149451. /**
  149452. * Disables the effect on the given cameras
  149453. * @param cameras The camera to disable.
  149454. * @hidden
  149455. */
  149456. _disable(cameras: Nullable<Camera[]>): void;
  149457. /**
  149458. * Gets a list of the post processes contained in the effect.
  149459. * @param camera The camera to get the post processes on.
  149460. * @returns The list of the post processes in the effect.
  149461. */
  149462. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  149463. }
  149464. }
  149465. declare module BABYLON {
  149466. /** @hidden */
  149467. export var extractHighlightsPixelShader: {
  149468. name: string;
  149469. shader: string;
  149470. };
  149471. }
  149472. declare module BABYLON {
  149473. /**
  149474. * 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.
  149475. */
  149476. export class ExtractHighlightsPostProcess extends PostProcess {
  149477. /**
  149478. * The luminance threshold, pixels below this value will be set to black.
  149479. */
  149480. threshold: number;
  149481. /** @hidden */
  149482. _exposure: number;
  149483. /**
  149484. * Post process which has the input texture to be used when performing highlight extraction
  149485. * @hidden
  149486. */
  149487. _inputPostProcess: Nullable<PostProcess>;
  149488. /**
  149489. * Gets a string identifying the name of the class
  149490. * @returns "ExtractHighlightsPostProcess" string
  149491. */
  149492. getClassName(): string;
  149493. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149494. }
  149495. }
  149496. declare module BABYLON {
  149497. /** @hidden */
  149498. export var bloomMergePixelShader: {
  149499. name: string;
  149500. shader: string;
  149501. };
  149502. }
  149503. declare module BABYLON {
  149504. /**
  149505. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149506. */
  149507. export class BloomMergePostProcess extends PostProcess {
  149508. /** Weight of the bloom to be added to the original input. */
  149509. weight: number;
  149510. /**
  149511. * Gets a string identifying the name of the class
  149512. * @returns "BloomMergePostProcess" string
  149513. */
  149514. getClassName(): string;
  149515. /**
  149516. * Creates a new instance of @see BloomMergePostProcess
  149517. * @param name The name of the effect.
  149518. * @param originalFromInput Post process which's input will be used for the merge.
  149519. * @param blurred Blurred highlights post process which's output will be used.
  149520. * @param weight Weight of the bloom to be added to the original input.
  149521. * @param options The required width/height ratio to downsize to before computing the render pass.
  149522. * @param camera The camera to apply the render pass to.
  149523. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149524. * @param engine The engine which the post process will be applied. (default: current engine)
  149525. * @param reusable If the post process can be reused on the same frame. (default: false)
  149526. * @param textureType Type of textures used when performing the post process. (default: 0)
  149527. * @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)
  149528. */
  149529. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  149530. /** Weight of the bloom to be added to the original input. */
  149531. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149532. }
  149533. }
  149534. declare module BABYLON {
  149535. /**
  149536. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  149537. */
  149538. export class BloomEffect extends PostProcessRenderEffect {
  149539. private bloomScale;
  149540. /**
  149541. * @hidden Internal
  149542. */
  149543. _effects: Array<PostProcess>;
  149544. /**
  149545. * @hidden Internal
  149546. */
  149547. _downscale: ExtractHighlightsPostProcess;
  149548. private _blurX;
  149549. private _blurY;
  149550. private _merge;
  149551. /**
  149552. * The luminance threshold to find bright areas of the image to bloom.
  149553. */
  149554. get threshold(): number;
  149555. set threshold(value: number);
  149556. /**
  149557. * The strength of the bloom.
  149558. */
  149559. get weight(): number;
  149560. set weight(value: number);
  149561. /**
  149562. * Specifies the size of the bloom blur kernel, relative to the final output size
  149563. */
  149564. get kernel(): number;
  149565. set kernel(value: number);
  149566. /**
  149567. * Creates a new instance of @see BloomEffect
  149568. * @param scene The scene the effect belongs to.
  149569. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  149570. * @param bloomKernel The size of the kernel to be used when applying the blur.
  149571. * @param bloomWeight The the strength of bloom.
  149572. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149573. * @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)
  149574. */
  149575. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  149576. /**
  149577. * Disposes each of the internal effects for a given camera.
  149578. * @param camera The camera to dispose the effect on.
  149579. */
  149580. disposeEffects(camera: Camera): void;
  149581. /**
  149582. * @hidden Internal
  149583. */
  149584. _updateEffects(): void;
  149585. /**
  149586. * Internal
  149587. * @returns if all the contained post processes are ready.
  149588. * @hidden
  149589. */
  149590. _isReady(): boolean;
  149591. }
  149592. }
  149593. declare module BABYLON {
  149594. /** @hidden */
  149595. export var chromaticAberrationPixelShader: {
  149596. name: string;
  149597. shader: string;
  149598. };
  149599. }
  149600. declare module BABYLON {
  149601. /**
  149602. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  149603. */
  149604. export class ChromaticAberrationPostProcess extends PostProcess {
  149605. /**
  149606. * The amount of seperation of rgb channels (default: 30)
  149607. */
  149608. aberrationAmount: number;
  149609. /**
  149610. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  149611. */
  149612. radialIntensity: number;
  149613. /**
  149614. * 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))
  149615. */
  149616. direction: Vector2;
  149617. /**
  149618. * 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))
  149619. */
  149620. centerPosition: Vector2;
  149621. /** The width of the screen to apply the effect on */
  149622. screenWidth: number;
  149623. /** The height of the screen to apply the effect on */
  149624. screenHeight: number;
  149625. /**
  149626. * Gets a string identifying the name of the class
  149627. * @returns "ChromaticAberrationPostProcess" string
  149628. */
  149629. getClassName(): string;
  149630. /**
  149631. * Creates a new instance ChromaticAberrationPostProcess
  149632. * @param name The name of the effect.
  149633. * @param screenWidth The width of the screen to apply the effect on.
  149634. * @param screenHeight The height of the screen to apply the effect on.
  149635. * @param options The required width/height ratio to downsize to before computing the render pass.
  149636. * @param camera The camera to apply the render pass to.
  149637. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149638. * @param engine The engine which the post process will be applied. (default: current engine)
  149639. * @param reusable If the post process can be reused on the same frame. (default: false)
  149640. * @param textureType Type of textures used when performing the post process. (default: 0)
  149641. * @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)
  149642. */
  149643. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149644. /** @hidden */
  149645. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  149646. }
  149647. }
  149648. declare module BABYLON {
  149649. /** @hidden */
  149650. export var circleOfConfusionPixelShader: {
  149651. name: string;
  149652. shader: string;
  149653. };
  149654. }
  149655. declare module BABYLON {
  149656. /**
  149657. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  149658. */
  149659. export class CircleOfConfusionPostProcess extends PostProcess {
  149660. /**
  149661. * 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.
  149662. */
  149663. lensSize: number;
  149664. /**
  149665. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149666. */
  149667. fStop: number;
  149668. /**
  149669. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149670. */
  149671. focusDistance: number;
  149672. /**
  149673. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  149674. */
  149675. focalLength: number;
  149676. /**
  149677. * Gets a string identifying the name of the class
  149678. * @returns "CircleOfConfusionPostProcess" string
  149679. */
  149680. getClassName(): string;
  149681. private _depthTexture;
  149682. /**
  149683. * Creates a new instance CircleOfConfusionPostProcess
  149684. * @param name The name of the effect.
  149685. * @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.
  149686. * @param options The required width/height ratio to downsize to before computing the render pass.
  149687. * @param camera The camera to apply the render pass to.
  149688. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149689. * @param engine The engine which the post process will be applied. (default: current engine)
  149690. * @param reusable If the post process can be reused on the same frame. (default: false)
  149691. * @param textureType Type of textures used when performing the post process. (default: 0)
  149692. * @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)
  149693. */
  149694. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149695. /**
  149696. * 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.
  149697. */
  149698. set depthTexture(value: RenderTargetTexture);
  149699. }
  149700. }
  149701. declare module BABYLON {
  149702. /** @hidden */
  149703. export var colorCorrectionPixelShader: {
  149704. name: string;
  149705. shader: string;
  149706. };
  149707. }
  149708. declare module BABYLON {
  149709. /**
  149710. *
  149711. * This post-process allows the modification of rendered colors by using
  149712. * a 'look-up table' (LUT). This effect is also called Color Grading.
  149713. *
  149714. * The object needs to be provided an url to a texture containing the color
  149715. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  149716. * Use an image editing software to tweak the LUT to match your needs.
  149717. *
  149718. * For an example of a color LUT, see here:
  149719. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  149720. * For explanations on color grading, see here:
  149721. * @see http://udn.epicgames.com/Three/ColorGrading.html
  149722. *
  149723. */
  149724. export class ColorCorrectionPostProcess extends PostProcess {
  149725. private _colorTableTexture;
  149726. /**
  149727. * Gets the color table url used to create the LUT texture
  149728. */
  149729. colorTableUrl: string;
  149730. /**
  149731. * Gets a string identifying the name of the class
  149732. * @returns "ColorCorrectionPostProcess" string
  149733. */
  149734. getClassName(): string;
  149735. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149736. /** @hidden */
  149737. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  149738. }
  149739. }
  149740. declare module BABYLON {
  149741. /** @hidden */
  149742. export var convolutionPixelShader: {
  149743. name: string;
  149744. shader: string;
  149745. };
  149746. }
  149747. declare module BABYLON {
  149748. /**
  149749. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  149750. * input texture to perform effects such as edge detection or sharpening
  149751. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149752. */
  149753. export class ConvolutionPostProcess extends PostProcess {
  149754. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  149755. kernel: number[];
  149756. /**
  149757. * Gets a string identifying the name of the class
  149758. * @returns "ConvolutionPostProcess" string
  149759. */
  149760. getClassName(): string;
  149761. /**
  149762. * Creates a new instance ConvolutionPostProcess
  149763. * @param name The name of the effect.
  149764. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  149765. * @param options The required width/height ratio to downsize to before computing the render pass.
  149766. * @param camera The camera to apply the render pass to.
  149767. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149768. * @param engine The engine which the post process will be applied. (default: current engine)
  149769. * @param reusable If the post process can be reused on the same frame. (default: false)
  149770. * @param textureType Type of textures used when performing the post process. (default: 0)
  149771. */
  149772. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149773. /** @hidden */
  149774. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  149775. /**
  149776. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149777. */
  149778. static EdgeDetect0Kernel: number[];
  149779. /**
  149780. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149781. */
  149782. static EdgeDetect1Kernel: number[];
  149783. /**
  149784. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149785. */
  149786. static EdgeDetect2Kernel: number[];
  149787. /**
  149788. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149789. */
  149790. static SharpenKernel: number[];
  149791. /**
  149792. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149793. */
  149794. static EmbossKernel: number[];
  149795. /**
  149796. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149797. */
  149798. static GaussianKernel: number[];
  149799. }
  149800. }
  149801. declare module BABYLON {
  149802. /**
  149803. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  149804. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  149805. * based on samples that have a large difference in distance than the center pixel.
  149806. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  149807. */
  149808. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  149809. /**
  149810. * The direction the blur should be applied
  149811. */
  149812. direction: Vector2;
  149813. /**
  149814. * Gets a string identifying the name of the class
  149815. * @returns "DepthOfFieldBlurPostProcess" string
  149816. */
  149817. getClassName(): string;
  149818. /**
  149819. * Creates a new instance CircleOfConfusionPostProcess
  149820. * @param name The name of the effect.
  149821. * @param scene The scene the effect belongs to.
  149822. * @param direction The direction the blur should be applied.
  149823. * @param kernel The size of the kernel used to blur.
  149824. * @param options The required width/height ratio to downsize to before computing the render pass.
  149825. * @param camera The camera to apply the render pass to.
  149826. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  149827. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  149828. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149829. * @param engine The engine which the post process will be applied. (default: current engine)
  149830. * @param reusable If the post process can be reused on the same frame. (default: false)
  149831. * @param textureType Type of textures used when performing the post process. (default: 0)
  149832. * @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)
  149833. */
  149834. 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);
  149835. }
  149836. }
  149837. declare module BABYLON {
  149838. /** @hidden */
  149839. export var depthOfFieldMergePixelShader: {
  149840. name: string;
  149841. shader: string;
  149842. };
  149843. }
  149844. declare module BABYLON {
  149845. /**
  149846. * Options to be set when merging outputs from the default pipeline.
  149847. */
  149848. export class DepthOfFieldMergePostProcessOptions {
  149849. /**
  149850. * The original image to merge on top of
  149851. */
  149852. originalFromInput: PostProcess;
  149853. /**
  149854. * Parameters to perform the merge of the depth of field effect
  149855. */
  149856. depthOfField?: {
  149857. circleOfConfusion: PostProcess;
  149858. blurSteps: Array<PostProcess>;
  149859. };
  149860. /**
  149861. * Parameters to perform the merge of bloom effect
  149862. */
  149863. bloom?: {
  149864. blurred: PostProcess;
  149865. weight: number;
  149866. };
  149867. }
  149868. /**
  149869. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149870. */
  149871. export class DepthOfFieldMergePostProcess extends PostProcess {
  149872. private blurSteps;
  149873. /**
  149874. * Gets a string identifying the name of the class
  149875. * @returns "DepthOfFieldMergePostProcess" string
  149876. */
  149877. getClassName(): string;
  149878. /**
  149879. * Creates a new instance of DepthOfFieldMergePostProcess
  149880. * @param name The name of the effect.
  149881. * @param originalFromInput Post process which's input will be used for the merge.
  149882. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149883. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149884. * @param options The required width/height ratio to downsize to before computing the render pass.
  149885. * @param camera The camera to apply the render pass to.
  149886. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149887. * @param engine The engine which the post process will be applied. (default: current engine)
  149888. * @param reusable If the post process can be reused on the same frame. (default: false)
  149889. * @param textureType Type of textures used when performing the post process. (default: 0)
  149890. * @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)
  149891. */
  149892. 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);
  149893. /**
  149894. * Updates the effect with the current post process compile time values and recompiles the shader.
  149895. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149896. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149897. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149898. * @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
  149899. * @param onCompiled Called when the shader has been compiled.
  149900. * @param onError Called if there is an error when compiling a shader.
  149901. */
  149902. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149903. }
  149904. }
  149905. declare module BABYLON {
  149906. /**
  149907. * Specifies the level of max blur that should be applied when using the depth of field effect
  149908. */
  149909. export enum DepthOfFieldEffectBlurLevel {
  149910. /**
  149911. * Subtle blur
  149912. */
  149913. Low = 0,
  149914. /**
  149915. * Medium blur
  149916. */
  149917. Medium = 1,
  149918. /**
  149919. * Large blur
  149920. */
  149921. High = 2
  149922. }
  149923. /**
  149924. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149925. */
  149926. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149927. private _circleOfConfusion;
  149928. /**
  149929. * @hidden Internal, blurs from high to low
  149930. */
  149931. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149932. private _depthOfFieldBlurY;
  149933. private _dofMerge;
  149934. /**
  149935. * @hidden Internal post processes in depth of field effect
  149936. */
  149937. _effects: Array<PostProcess>;
  149938. /**
  149939. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149940. */
  149941. set focalLength(value: number);
  149942. get focalLength(): number;
  149943. /**
  149944. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149945. */
  149946. set fStop(value: number);
  149947. get fStop(): number;
  149948. /**
  149949. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149950. */
  149951. set focusDistance(value: number);
  149952. get focusDistance(): number;
  149953. /**
  149954. * 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.
  149955. */
  149956. set lensSize(value: number);
  149957. get lensSize(): number;
  149958. /**
  149959. * Creates a new instance DepthOfFieldEffect
  149960. * @param scene The scene the effect belongs to.
  149961. * @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.
  149962. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149963. * @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)
  149964. */
  149965. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149966. /**
  149967. * Get the current class name of the current effet
  149968. * @returns "DepthOfFieldEffect"
  149969. */
  149970. getClassName(): string;
  149971. /**
  149972. * 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.
  149973. */
  149974. set depthTexture(value: RenderTargetTexture);
  149975. /**
  149976. * Disposes each of the internal effects for a given camera.
  149977. * @param camera The camera to dispose the effect on.
  149978. */
  149979. disposeEffects(camera: Camera): void;
  149980. /**
  149981. * @hidden Internal
  149982. */
  149983. _updateEffects(): void;
  149984. /**
  149985. * Internal
  149986. * @returns if all the contained post processes are ready.
  149987. * @hidden
  149988. */
  149989. _isReady(): boolean;
  149990. }
  149991. }
  149992. declare module BABYLON {
  149993. /** @hidden */
  149994. export var displayPassPixelShader: {
  149995. name: string;
  149996. shader: string;
  149997. };
  149998. }
  149999. declare module BABYLON {
  150000. /**
  150001. * DisplayPassPostProcess which produces an output the same as it's input
  150002. */
  150003. export class DisplayPassPostProcess extends PostProcess {
  150004. /**
  150005. * Gets a string identifying the name of the class
  150006. * @returns "DisplayPassPostProcess" string
  150007. */
  150008. getClassName(): string;
  150009. /**
  150010. * Creates the DisplayPassPostProcess
  150011. * @param name The name of the effect.
  150012. * @param options The required width/height ratio to downsize to before computing the render pass.
  150013. * @param camera The camera to apply the render pass to.
  150014. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150015. * @param engine The engine which the post process will be applied. (default: current engine)
  150016. * @param reusable If the post process can be reused on the same frame. (default: false)
  150017. */
  150018. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150019. /** @hidden */
  150020. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  150021. }
  150022. }
  150023. declare module BABYLON {
  150024. /** @hidden */
  150025. export var filterPixelShader: {
  150026. name: string;
  150027. shader: string;
  150028. };
  150029. }
  150030. declare module BABYLON {
  150031. /**
  150032. * Applies a kernel filter to the image
  150033. */
  150034. export class FilterPostProcess extends PostProcess {
  150035. /** The matrix to be applied to the image */
  150036. kernelMatrix: Matrix;
  150037. /**
  150038. * Gets a string identifying the name of the class
  150039. * @returns "FilterPostProcess" string
  150040. */
  150041. getClassName(): string;
  150042. /**
  150043. *
  150044. * @param name The name of the effect.
  150045. * @param kernelMatrix The matrix to be applied to the image
  150046. * @param options The required width/height ratio to downsize to before computing the render pass.
  150047. * @param camera The camera to apply the render pass to.
  150048. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150049. * @param engine The engine which the post process will be applied. (default: current engine)
  150050. * @param reusable If the post process can be reused on the same frame. (default: false)
  150051. */
  150052. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150053. /** @hidden */
  150054. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  150055. }
  150056. }
  150057. declare module BABYLON {
  150058. /** @hidden */
  150059. export var fxaaPixelShader: {
  150060. name: string;
  150061. shader: string;
  150062. };
  150063. }
  150064. declare module BABYLON {
  150065. /** @hidden */
  150066. export var fxaaVertexShader: {
  150067. name: string;
  150068. shader: string;
  150069. };
  150070. }
  150071. declare module BABYLON {
  150072. /**
  150073. * Fxaa post process
  150074. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  150075. */
  150076. export class FxaaPostProcess extends PostProcess {
  150077. /**
  150078. * Gets a string identifying the name of the class
  150079. * @returns "FxaaPostProcess" string
  150080. */
  150081. getClassName(): string;
  150082. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  150083. private _getDefines;
  150084. /** @hidden */
  150085. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  150086. }
  150087. }
  150088. declare module BABYLON {
  150089. /** @hidden */
  150090. export var grainPixelShader: {
  150091. name: string;
  150092. shader: string;
  150093. };
  150094. }
  150095. declare module BABYLON {
  150096. /**
  150097. * The GrainPostProcess adds noise to the image at mid luminance levels
  150098. */
  150099. export class GrainPostProcess extends PostProcess {
  150100. /**
  150101. * The intensity of the grain added (default: 30)
  150102. */
  150103. intensity: number;
  150104. /**
  150105. * If the grain should be randomized on every frame
  150106. */
  150107. animated: boolean;
  150108. /**
  150109. * Gets a string identifying the name of the class
  150110. * @returns "GrainPostProcess" string
  150111. */
  150112. getClassName(): string;
  150113. /**
  150114. * Creates a new instance of @see GrainPostProcess
  150115. * @param name The name of the effect.
  150116. * @param options The required width/height ratio to downsize to before computing the render pass.
  150117. * @param camera The camera to apply the render pass to.
  150118. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150119. * @param engine The engine which the post process will be applied. (default: current engine)
  150120. * @param reusable If the post process can be reused on the same frame. (default: false)
  150121. * @param textureType Type of textures used when performing the post process. (default: 0)
  150122. * @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)
  150123. */
  150124. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150125. /** @hidden */
  150126. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  150127. }
  150128. }
  150129. declare module BABYLON {
  150130. /** @hidden */
  150131. export var highlightsPixelShader: {
  150132. name: string;
  150133. shader: string;
  150134. };
  150135. }
  150136. declare module BABYLON {
  150137. /**
  150138. * Extracts highlights from the image
  150139. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  150140. */
  150141. export class HighlightsPostProcess extends PostProcess {
  150142. /**
  150143. * Gets a string identifying the name of the class
  150144. * @returns "HighlightsPostProcess" string
  150145. */
  150146. getClassName(): string;
  150147. /**
  150148. * Extracts highlights from the image
  150149. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  150150. * @param name The name of the effect.
  150151. * @param options The required width/height ratio to downsize to before computing the render pass.
  150152. * @param camera The camera to apply the render pass to.
  150153. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150154. * @param engine The engine which the post process will be applied. (default: current engine)
  150155. * @param reusable If the post process can be reused on the same frame. (default: false)
  150156. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  150157. */
  150158. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  150159. }
  150160. }
  150161. declare module BABYLON {
  150162. /** @hidden */
  150163. export var mrtFragmentDeclaration: {
  150164. name: string;
  150165. shader: string;
  150166. };
  150167. }
  150168. declare module BABYLON {
  150169. /** @hidden */
  150170. export var geometryPixelShader: {
  150171. name: string;
  150172. shader: string;
  150173. };
  150174. }
  150175. declare module BABYLON {
  150176. /** @hidden */
  150177. export var geometryVertexShader: {
  150178. name: string;
  150179. shader: string;
  150180. };
  150181. }
  150182. declare module BABYLON {
  150183. /** @hidden */
  150184. interface ISavedTransformationMatrix {
  150185. world: Matrix;
  150186. viewProjection: Matrix;
  150187. }
  150188. /**
  150189. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  150190. */
  150191. export class GeometryBufferRenderer {
  150192. /**
  150193. * Constant used to retrieve the position texture index in the G-Buffer textures array
  150194. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  150195. */
  150196. static readonly POSITION_TEXTURE_TYPE: number;
  150197. /**
  150198. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  150199. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  150200. */
  150201. static readonly VELOCITY_TEXTURE_TYPE: number;
  150202. /**
  150203. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  150204. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  150205. */
  150206. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  150207. /**
  150208. * Dictionary used to store the previous transformation matrices of each rendered mesh
  150209. * in order to compute objects velocities when enableVelocity is set to "true"
  150210. * @hidden
  150211. */
  150212. _previousTransformationMatrices: {
  150213. [index: number]: ISavedTransformationMatrix;
  150214. };
  150215. /**
  150216. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  150217. * in order to compute objects velocities when enableVelocity is set to "true"
  150218. * @hidden
  150219. */
  150220. _previousBonesTransformationMatrices: {
  150221. [index: number]: Float32Array;
  150222. };
  150223. /**
  150224. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  150225. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  150226. */
  150227. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  150228. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  150229. renderTransparentMeshes: boolean;
  150230. private _scene;
  150231. private _resizeObserver;
  150232. private _multiRenderTarget;
  150233. private _ratio;
  150234. private _enablePosition;
  150235. private _enableVelocity;
  150236. private _enableReflectivity;
  150237. private _positionIndex;
  150238. private _velocityIndex;
  150239. private _reflectivityIndex;
  150240. protected _effect: Effect;
  150241. protected _cachedDefines: string;
  150242. /**
  150243. * Set the render list (meshes to be rendered) used in the G buffer.
  150244. */
  150245. set renderList(meshes: Mesh[]);
  150246. /**
  150247. * Gets wether or not G buffer are supported by the running hardware.
  150248. * This requires draw buffer supports
  150249. */
  150250. get isSupported(): boolean;
  150251. /**
  150252. * Returns the index of the given texture type in the G-Buffer textures array
  150253. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  150254. * @returns the index of the given texture type in the G-Buffer textures array
  150255. */
  150256. getTextureIndex(textureType: number): number;
  150257. /**
  150258. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  150259. */
  150260. get enablePosition(): boolean;
  150261. /**
  150262. * Sets whether or not objects positions are enabled for the G buffer.
  150263. */
  150264. set enablePosition(enable: boolean);
  150265. /**
  150266. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  150267. */
  150268. get enableVelocity(): boolean;
  150269. /**
  150270. * Sets wether or not objects velocities are enabled for the G buffer.
  150271. */
  150272. set enableVelocity(enable: boolean);
  150273. /**
  150274. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  150275. */
  150276. get enableReflectivity(): boolean;
  150277. /**
  150278. * Sets wether or not objects roughness are enabled for the G buffer.
  150279. */
  150280. set enableReflectivity(enable: boolean);
  150281. /**
  150282. * Gets the scene associated with the buffer.
  150283. */
  150284. get scene(): Scene;
  150285. /**
  150286. * Gets the ratio used by the buffer during its creation.
  150287. * How big is the buffer related to the main canvas.
  150288. */
  150289. get ratio(): number;
  150290. /** @hidden */
  150291. static _SceneComponentInitialization: (scene: Scene) => void;
  150292. /**
  150293. * Creates a new G Buffer for the scene
  150294. * @param scene The scene the buffer belongs to
  150295. * @param ratio How big is the buffer related to the main canvas.
  150296. */
  150297. constructor(scene: Scene, ratio?: number);
  150298. /**
  150299. * Checks wether everything is ready to render a submesh to the G buffer.
  150300. * @param subMesh the submesh to check readiness for
  150301. * @param useInstances is the mesh drawn using instance or not
  150302. * @returns true if ready otherwise false
  150303. */
  150304. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  150305. /**
  150306. * Gets the current underlying G Buffer.
  150307. * @returns the buffer
  150308. */
  150309. getGBuffer(): MultiRenderTarget;
  150310. /**
  150311. * Gets the number of samples used to render the buffer (anti aliasing).
  150312. */
  150313. get samples(): number;
  150314. /**
  150315. * Sets the number of samples used to render the buffer (anti aliasing).
  150316. */
  150317. set samples(value: number);
  150318. /**
  150319. * Disposes the renderer and frees up associated resources.
  150320. */
  150321. dispose(): void;
  150322. protected _createRenderTargets(): void;
  150323. private _copyBonesTransformationMatrices;
  150324. }
  150325. }
  150326. declare module BABYLON {
  150327. interface Scene {
  150328. /** @hidden (Backing field) */
  150329. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  150330. /**
  150331. * Gets or Sets the current geometry buffer associated to the scene.
  150332. */
  150333. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  150334. /**
  150335. * Enables a GeometryBufferRender and associates it with the scene
  150336. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  150337. * @returns the GeometryBufferRenderer
  150338. */
  150339. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  150340. /**
  150341. * Disables the GeometryBufferRender associated with the scene
  150342. */
  150343. disableGeometryBufferRenderer(): void;
  150344. }
  150345. /**
  150346. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  150347. * in several rendering techniques.
  150348. */
  150349. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  150350. /**
  150351. * The component name helpful to identify the component in the list of scene components.
  150352. */
  150353. readonly name: string;
  150354. /**
  150355. * The scene the component belongs to.
  150356. */
  150357. scene: Scene;
  150358. /**
  150359. * Creates a new instance of the component for the given scene
  150360. * @param scene Defines the scene to register the component in
  150361. */
  150362. constructor(scene: Scene);
  150363. /**
  150364. * Registers the component in a given scene
  150365. */
  150366. register(): void;
  150367. /**
  150368. * Rebuilds the elements related to this component in case of
  150369. * context lost for instance.
  150370. */
  150371. rebuild(): void;
  150372. /**
  150373. * Disposes the component and the associated ressources
  150374. */
  150375. dispose(): void;
  150376. private _gatherRenderTargets;
  150377. }
  150378. }
  150379. declare module BABYLON {
  150380. /** @hidden */
  150381. export var motionBlurPixelShader: {
  150382. name: string;
  150383. shader: string;
  150384. };
  150385. }
  150386. declare module BABYLON {
  150387. /**
  150388. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  150389. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  150390. * As an example, all you have to do is to create the post-process:
  150391. * var mb = new BABYLON.MotionBlurPostProcess(
  150392. * 'mb', // The name of the effect.
  150393. * scene, // The scene containing the objects to blur according to their velocity.
  150394. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  150395. * camera // The camera to apply the render pass to.
  150396. * );
  150397. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  150398. */
  150399. export class MotionBlurPostProcess extends PostProcess {
  150400. /**
  150401. * Defines how much the image is blurred by the movement. Default value is equal to 1
  150402. */
  150403. motionStrength: number;
  150404. /**
  150405. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  150406. */
  150407. get motionBlurSamples(): number;
  150408. /**
  150409. * Sets the number of iterations to be used for motion blur quality
  150410. */
  150411. set motionBlurSamples(samples: number);
  150412. private _motionBlurSamples;
  150413. private _geometryBufferRenderer;
  150414. /**
  150415. * Gets a string identifying the name of the class
  150416. * @returns "MotionBlurPostProcess" string
  150417. */
  150418. getClassName(): string;
  150419. /**
  150420. * Creates a new instance MotionBlurPostProcess
  150421. * @param name The name of the effect.
  150422. * @param scene The scene containing the objects to blur according to their velocity.
  150423. * @param options The required width/height ratio to downsize to before computing the render pass.
  150424. * @param camera The camera to apply the render pass to.
  150425. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150426. * @param engine The engine which the post process will be applied. (default: current engine)
  150427. * @param reusable If the post process can be reused on the same frame. (default: false)
  150428. * @param textureType Type of textures used when performing the post process. (default: 0)
  150429. * @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)
  150430. */
  150431. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150432. /**
  150433. * Excludes the given skinned mesh from computing bones velocities.
  150434. * 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.
  150435. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  150436. */
  150437. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  150438. /**
  150439. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  150440. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  150441. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  150442. */
  150443. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  150444. /**
  150445. * Disposes the post process.
  150446. * @param camera The camera to dispose the post process on.
  150447. */
  150448. dispose(camera?: Camera): void;
  150449. /** @hidden */
  150450. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  150451. }
  150452. }
  150453. declare module BABYLON {
  150454. /** @hidden */
  150455. export var refractionPixelShader: {
  150456. name: string;
  150457. shader: string;
  150458. };
  150459. }
  150460. declare module BABYLON {
  150461. /**
  150462. * Post process which applies a refractin texture
  150463. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  150464. */
  150465. export class RefractionPostProcess extends PostProcess {
  150466. private _refTexture;
  150467. private _ownRefractionTexture;
  150468. /** the base color of the refraction (used to taint the rendering) */
  150469. color: Color3;
  150470. /** simulated refraction depth */
  150471. depth: number;
  150472. /** the coefficient of the base color (0 to remove base color tainting) */
  150473. colorLevel: number;
  150474. /** Gets the url used to load the refraction texture */
  150475. refractionTextureUrl: string;
  150476. /**
  150477. * Gets or sets the refraction texture
  150478. * Please note that you are responsible for disposing the texture if you set it manually
  150479. */
  150480. get refractionTexture(): Texture;
  150481. set refractionTexture(value: Texture);
  150482. /**
  150483. * Gets a string identifying the name of the class
  150484. * @returns "RefractionPostProcess" string
  150485. */
  150486. getClassName(): string;
  150487. /**
  150488. * Initializes the RefractionPostProcess
  150489. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  150490. * @param name The name of the effect.
  150491. * @param refractionTextureUrl Url of the refraction texture to use
  150492. * @param color the base color of the refraction (used to taint the rendering)
  150493. * @param depth simulated refraction depth
  150494. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  150495. * @param camera The camera to apply the render pass to.
  150496. * @param options The required width/height ratio to downsize to before computing the render pass.
  150497. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150498. * @param engine The engine which the post process will be applied. (default: current engine)
  150499. * @param reusable If the post process can be reused on the same frame. (default: false)
  150500. */
  150501. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150502. /**
  150503. * Disposes of the post process
  150504. * @param camera Camera to dispose post process on
  150505. */
  150506. dispose(camera: Camera): void;
  150507. /** @hidden */
  150508. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  150509. }
  150510. }
  150511. declare module BABYLON {
  150512. /** @hidden */
  150513. export var sharpenPixelShader: {
  150514. name: string;
  150515. shader: string;
  150516. };
  150517. }
  150518. declare module BABYLON {
  150519. /**
  150520. * The SharpenPostProcess applies a sharpen kernel to every pixel
  150521. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  150522. */
  150523. export class SharpenPostProcess extends PostProcess {
  150524. /**
  150525. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  150526. */
  150527. colorAmount: number;
  150528. /**
  150529. * How much sharpness should be applied (default: 0.3)
  150530. */
  150531. edgeAmount: number;
  150532. /**
  150533. * Gets a string identifying the name of the class
  150534. * @returns "SharpenPostProcess" string
  150535. */
  150536. getClassName(): string;
  150537. /**
  150538. * Creates a new instance ConvolutionPostProcess
  150539. * @param name The name of the effect.
  150540. * @param options The required width/height ratio to downsize to before computing the render pass.
  150541. * @param camera The camera to apply the render pass to.
  150542. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150543. * @param engine The engine which the post process will be applied. (default: current engine)
  150544. * @param reusable If the post process can be reused on the same frame. (default: false)
  150545. * @param textureType Type of textures used when performing the post process. (default: 0)
  150546. * @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)
  150547. */
  150548. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150549. /** @hidden */
  150550. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  150551. }
  150552. }
  150553. declare module BABYLON {
  150554. /**
  150555. * PostProcessRenderPipeline
  150556. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150557. */
  150558. export class PostProcessRenderPipeline {
  150559. private engine;
  150560. private _renderEffects;
  150561. private _renderEffectsForIsolatedPass;
  150562. /**
  150563. * List of inspectable custom properties (used by the Inspector)
  150564. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  150565. */
  150566. inspectableCustomProperties: IInspectable[];
  150567. /**
  150568. * @hidden
  150569. */
  150570. protected _cameras: Camera[];
  150571. /** @hidden */
  150572. _name: string;
  150573. /**
  150574. * Gets pipeline name
  150575. */
  150576. get name(): string;
  150577. /** Gets the list of attached cameras */
  150578. get cameras(): Camera[];
  150579. /**
  150580. * Initializes a PostProcessRenderPipeline
  150581. * @param engine engine to add the pipeline to
  150582. * @param name name of the pipeline
  150583. */
  150584. constructor(engine: Engine, name: string);
  150585. /**
  150586. * Gets the class name
  150587. * @returns "PostProcessRenderPipeline"
  150588. */
  150589. getClassName(): string;
  150590. /**
  150591. * If all the render effects in the pipeline are supported
  150592. */
  150593. get isSupported(): boolean;
  150594. /**
  150595. * Adds an effect to the pipeline
  150596. * @param renderEffect the effect to add
  150597. */
  150598. addEffect(renderEffect: PostProcessRenderEffect): void;
  150599. /** @hidden */
  150600. _rebuild(): void;
  150601. /** @hidden */
  150602. _enableEffect(renderEffectName: string, cameras: Camera): void;
  150603. /** @hidden */
  150604. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  150605. /** @hidden */
  150606. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  150607. /** @hidden */
  150608. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  150609. /** @hidden */
  150610. _attachCameras(cameras: Camera, unique: boolean): void;
  150611. /** @hidden */
  150612. _attachCameras(cameras: Camera[], unique: boolean): void;
  150613. /** @hidden */
  150614. _detachCameras(cameras: Camera): void;
  150615. /** @hidden */
  150616. _detachCameras(cameras: Nullable<Camera[]>): void;
  150617. /** @hidden */
  150618. _update(): void;
  150619. /** @hidden */
  150620. _reset(): void;
  150621. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  150622. /**
  150623. * Sets the required values to the prepass renderer.
  150624. * @param prePassRenderer defines the prepass renderer to setup.
  150625. * @returns true if the pre pass is needed.
  150626. */
  150627. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150628. /**
  150629. * Disposes of the pipeline
  150630. */
  150631. dispose(): void;
  150632. }
  150633. }
  150634. declare module BABYLON {
  150635. /**
  150636. * PostProcessRenderPipelineManager class
  150637. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150638. */
  150639. export class PostProcessRenderPipelineManager {
  150640. private _renderPipelines;
  150641. /**
  150642. * Initializes a PostProcessRenderPipelineManager
  150643. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150644. */
  150645. constructor();
  150646. /**
  150647. * Gets the list of supported render pipelines
  150648. */
  150649. get supportedPipelines(): PostProcessRenderPipeline[];
  150650. /**
  150651. * Adds a pipeline to the manager
  150652. * @param renderPipeline The pipeline to add
  150653. */
  150654. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  150655. /**
  150656. * Attaches a camera to the pipeline
  150657. * @param renderPipelineName The name of the pipeline to attach to
  150658. * @param cameras the camera to attach
  150659. * @param unique if the camera can be attached multiple times to the pipeline
  150660. */
  150661. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  150662. /**
  150663. * Detaches a camera from the pipeline
  150664. * @param renderPipelineName The name of the pipeline to detach from
  150665. * @param cameras the camera to detach
  150666. */
  150667. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  150668. /**
  150669. * Enables an effect by name on a pipeline
  150670. * @param renderPipelineName the name of the pipeline to enable the effect in
  150671. * @param renderEffectName the name of the effect to enable
  150672. * @param cameras the cameras that the effect should be enabled on
  150673. */
  150674. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  150675. /**
  150676. * Disables an effect by name on a pipeline
  150677. * @param renderPipelineName the name of the pipeline to disable the effect in
  150678. * @param renderEffectName the name of the effect to disable
  150679. * @param cameras the cameras that the effect should be disabled on
  150680. */
  150681. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  150682. /**
  150683. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  150684. */
  150685. update(): void;
  150686. /** @hidden */
  150687. _rebuild(): void;
  150688. /**
  150689. * Disposes of the manager and pipelines
  150690. */
  150691. dispose(): void;
  150692. }
  150693. }
  150694. declare module BABYLON {
  150695. interface Scene {
  150696. /** @hidden (Backing field) */
  150697. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150698. /**
  150699. * Gets the postprocess render pipeline manager
  150700. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150701. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150702. */
  150703. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150704. }
  150705. /**
  150706. * Defines the Render Pipeline scene component responsible to rendering pipelines
  150707. */
  150708. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  150709. /**
  150710. * The component name helpfull to identify the component in the list of scene components.
  150711. */
  150712. readonly name: string;
  150713. /**
  150714. * The scene the component belongs to.
  150715. */
  150716. scene: Scene;
  150717. /**
  150718. * Creates a new instance of the component for the given scene
  150719. * @param scene Defines the scene to register the component in
  150720. */
  150721. constructor(scene: Scene);
  150722. /**
  150723. * Registers the component in a given scene
  150724. */
  150725. register(): void;
  150726. /**
  150727. * Rebuilds the elements related to this component in case of
  150728. * context lost for instance.
  150729. */
  150730. rebuild(): void;
  150731. /**
  150732. * Disposes the component and the associated ressources
  150733. */
  150734. dispose(): void;
  150735. private _gatherRenderTargets;
  150736. }
  150737. }
  150738. declare module BABYLON {
  150739. /**
  150740. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  150741. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150742. */
  150743. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150744. private _scene;
  150745. private _camerasToBeAttached;
  150746. /**
  150747. * ID of the sharpen post process,
  150748. */
  150749. private readonly SharpenPostProcessId;
  150750. /**
  150751. * @ignore
  150752. * ID of the image processing post process;
  150753. */
  150754. readonly ImageProcessingPostProcessId: string;
  150755. /**
  150756. * @ignore
  150757. * ID of the Fast Approximate Anti-Aliasing post process;
  150758. */
  150759. readonly FxaaPostProcessId: string;
  150760. /**
  150761. * ID of the chromatic aberration post process,
  150762. */
  150763. private readonly ChromaticAberrationPostProcessId;
  150764. /**
  150765. * ID of the grain post process
  150766. */
  150767. private readonly GrainPostProcessId;
  150768. /**
  150769. * Sharpen post process which will apply a sharpen convolution to enhance edges
  150770. */
  150771. sharpen: SharpenPostProcess;
  150772. private _sharpenEffect;
  150773. private bloom;
  150774. /**
  150775. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  150776. */
  150777. depthOfField: DepthOfFieldEffect;
  150778. /**
  150779. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150780. */
  150781. fxaa: FxaaPostProcess;
  150782. /**
  150783. * Image post processing pass used to perform operations such as tone mapping or color grading.
  150784. */
  150785. imageProcessing: ImageProcessingPostProcess;
  150786. /**
  150787. * Chromatic aberration post process which will shift rgb colors in the image
  150788. */
  150789. chromaticAberration: ChromaticAberrationPostProcess;
  150790. private _chromaticAberrationEffect;
  150791. /**
  150792. * Grain post process which add noise to the image
  150793. */
  150794. grain: GrainPostProcess;
  150795. private _grainEffect;
  150796. /**
  150797. * Glow post process which adds a glow to emissive areas of the image
  150798. */
  150799. private _glowLayer;
  150800. /**
  150801. * Animations which can be used to tweak settings over a period of time
  150802. */
  150803. animations: Animation[];
  150804. private _imageProcessingConfigurationObserver;
  150805. private _sharpenEnabled;
  150806. private _bloomEnabled;
  150807. private _depthOfFieldEnabled;
  150808. private _depthOfFieldBlurLevel;
  150809. private _fxaaEnabled;
  150810. private _imageProcessingEnabled;
  150811. private _defaultPipelineTextureType;
  150812. private _bloomScale;
  150813. private _chromaticAberrationEnabled;
  150814. private _grainEnabled;
  150815. private _buildAllowed;
  150816. /**
  150817. * Gets active scene
  150818. */
  150819. get scene(): Scene;
  150820. /**
  150821. * Enable or disable the sharpen process from the pipeline
  150822. */
  150823. set sharpenEnabled(enabled: boolean);
  150824. get sharpenEnabled(): boolean;
  150825. private _resizeObserver;
  150826. private _hardwareScaleLevel;
  150827. private _bloomKernel;
  150828. /**
  150829. * Specifies the size of the bloom blur kernel, relative to the final output size
  150830. */
  150831. get bloomKernel(): number;
  150832. set bloomKernel(value: number);
  150833. /**
  150834. * Specifies the weight of the bloom in the final rendering
  150835. */
  150836. private _bloomWeight;
  150837. /**
  150838. * Specifies the luma threshold for the area that will be blurred by the bloom
  150839. */
  150840. private _bloomThreshold;
  150841. private _hdr;
  150842. /**
  150843. * The strength of the bloom.
  150844. */
  150845. set bloomWeight(value: number);
  150846. get bloomWeight(): number;
  150847. /**
  150848. * The strength of the bloom.
  150849. */
  150850. set bloomThreshold(value: number);
  150851. get bloomThreshold(): number;
  150852. /**
  150853. * The scale of the bloom, lower value will provide better performance.
  150854. */
  150855. set bloomScale(value: number);
  150856. get bloomScale(): number;
  150857. /**
  150858. * Enable or disable the bloom from the pipeline
  150859. */
  150860. set bloomEnabled(enabled: boolean);
  150861. get bloomEnabled(): boolean;
  150862. private _rebuildBloom;
  150863. /**
  150864. * If the depth of field is enabled.
  150865. */
  150866. get depthOfFieldEnabled(): boolean;
  150867. set depthOfFieldEnabled(enabled: boolean);
  150868. /**
  150869. * Blur level of the depth of field effect. (Higher blur will effect performance)
  150870. */
  150871. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  150872. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  150873. /**
  150874. * If the anti aliasing is enabled.
  150875. */
  150876. set fxaaEnabled(enabled: boolean);
  150877. get fxaaEnabled(): boolean;
  150878. private _samples;
  150879. /**
  150880. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150881. */
  150882. set samples(sampleCount: number);
  150883. get samples(): number;
  150884. /**
  150885. * If image processing is enabled.
  150886. */
  150887. set imageProcessingEnabled(enabled: boolean);
  150888. get imageProcessingEnabled(): boolean;
  150889. /**
  150890. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150891. */
  150892. set glowLayerEnabled(enabled: boolean);
  150893. get glowLayerEnabled(): boolean;
  150894. /**
  150895. * Gets the glow layer (or null if not defined)
  150896. */
  150897. get glowLayer(): Nullable<GlowLayer>;
  150898. /**
  150899. * Enable or disable the chromaticAberration process from the pipeline
  150900. */
  150901. set chromaticAberrationEnabled(enabled: boolean);
  150902. get chromaticAberrationEnabled(): boolean;
  150903. /**
  150904. * Enable or disable the grain process from the pipeline
  150905. */
  150906. set grainEnabled(enabled: boolean);
  150907. get grainEnabled(): boolean;
  150908. /**
  150909. * @constructor
  150910. * @param name - The rendering pipeline name (default: "")
  150911. * @param hdr - If high dynamic range textures should be used (default: true)
  150912. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150913. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150914. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150915. */
  150916. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150917. /**
  150918. * Get the class name
  150919. * @returns "DefaultRenderingPipeline"
  150920. */
  150921. getClassName(): string;
  150922. /**
  150923. * Force the compilation of the entire pipeline.
  150924. */
  150925. prepare(): void;
  150926. private _hasCleared;
  150927. private _prevPostProcess;
  150928. private _prevPrevPostProcess;
  150929. private _setAutoClearAndTextureSharing;
  150930. private _depthOfFieldSceneObserver;
  150931. private _buildPipeline;
  150932. private _disposePostProcesses;
  150933. /**
  150934. * Adds a camera to the pipeline
  150935. * @param camera the camera to be added
  150936. */
  150937. addCamera(camera: Camera): void;
  150938. /**
  150939. * Removes a camera from the pipeline
  150940. * @param camera the camera to remove
  150941. */
  150942. removeCamera(camera: Camera): void;
  150943. /**
  150944. * Dispose of the pipeline and stop all post processes
  150945. */
  150946. dispose(): void;
  150947. /**
  150948. * Serialize the rendering pipeline (Used when exporting)
  150949. * @returns the serialized object
  150950. */
  150951. serialize(): any;
  150952. /**
  150953. * Parse the serialized pipeline
  150954. * @param source Source pipeline.
  150955. * @param scene The scene to load the pipeline to.
  150956. * @param rootUrl The URL of the serialized pipeline.
  150957. * @returns An instantiated pipeline from the serialized object.
  150958. */
  150959. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150960. }
  150961. }
  150962. declare module BABYLON {
  150963. /** @hidden */
  150964. export var lensHighlightsPixelShader: {
  150965. name: string;
  150966. shader: string;
  150967. };
  150968. }
  150969. declare module BABYLON {
  150970. /** @hidden */
  150971. export var depthOfFieldPixelShader: {
  150972. name: string;
  150973. shader: string;
  150974. };
  150975. }
  150976. declare module BABYLON {
  150977. /**
  150978. * BABYLON.JS Chromatic Aberration GLSL Shader
  150979. * Author: Olivier Guyot
  150980. * Separates very slightly R, G and B colors on the edges of the screen
  150981. * Inspired by Francois Tarlier & Martins Upitis
  150982. */
  150983. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150984. /**
  150985. * @ignore
  150986. * The chromatic aberration PostProcess id in the pipeline
  150987. */
  150988. LensChromaticAberrationEffect: string;
  150989. /**
  150990. * @ignore
  150991. * The highlights enhancing PostProcess id in the pipeline
  150992. */
  150993. HighlightsEnhancingEffect: string;
  150994. /**
  150995. * @ignore
  150996. * The depth-of-field PostProcess id in the pipeline
  150997. */
  150998. LensDepthOfFieldEffect: string;
  150999. private _scene;
  151000. private _depthTexture;
  151001. private _grainTexture;
  151002. private _chromaticAberrationPostProcess;
  151003. private _highlightsPostProcess;
  151004. private _depthOfFieldPostProcess;
  151005. private _edgeBlur;
  151006. private _grainAmount;
  151007. private _chromaticAberration;
  151008. private _distortion;
  151009. private _highlightsGain;
  151010. private _highlightsThreshold;
  151011. private _dofDistance;
  151012. private _dofAperture;
  151013. private _dofDarken;
  151014. private _dofPentagon;
  151015. private _blurNoise;
  151016. /**
  151017. * @constructor
  151018. *
  151019. * Effect parameters are as follow:
  151020. * {
  151021. * chromatic_aberration: number; // from 0 to x (1 for realism)
  151022. * edge_blur: number; // from 0 to x (1 for realism)
  151023. * distortion: number; // from 0 to x (1 for realism)
  151024. * grain_amount: number; // from 0 to 1
  151025. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  151026. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  151027. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  151028. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  151029. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  151030. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  151031. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  151032. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  151033. * }
  151034. * Note: if an effect parameter is unset, effect is disabled
  151035. *
  151036. * @param name The rendering pipeline name
  151037. * @param parameters - An object containing all parameters (see above)
  151038. * @param scene The scene linked to this pipeline
  151039. * @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)
  151040. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151041. */
  151042. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  151043. /**
  151044. * Get the class name
  151045. * @returns "LensRenderingPipeline"
  151046. */
  151047. getClassName(): string;
  151048. /**
  151049. * Gets associated scene
  151050. */
  151051. get scene(): Scene;
  151052. /**
  151053. * Gets or sets the edge blur
  151054. */
  151055. get edgeBlur(): number;
  151056. set edgeBlur(value: number);
  151057. /**
  151058. * Gets or sets the grain amount
  151059. */
  151060. get grainAmount(): number;
  151061. set grainAmount(value: number);
  151062. /**
  151063. * Gets or sets the chromatic aberration amount
  151064. */
  151065. get chromaticAberration(): number;
  151066. set chromaticAberration(value: number);
  151067. /**
  151068. * Gets or sets the depth of field aperture
  151069. */
  151070. get dofAperture(): number;
  151071. set dofAperture(value: number);
  151072. /**
  151073. * Gets or sets the edge distortion
  151074. */
  151075. get edgeDistortion(): number;
  151076. set edgeDistortion(value: number);
  151077. /**
  151078. * Gets or sets the depth of field distortion
  151079. */
  151080. get dofDistortion(): number;
  151081. set dofDistortion(value: number);
  151082. /**
  151083. * Gets or sets the darken out of focus amount
  151084. */
  151085. get darkenOutOfFocus(): number;
  151086. set darkenOutOfFocus(value: number);
  151087. /**
  151088. * Gets or sets a boolean indicating if blur noise is enabled
  151089. */
  151090. get blurNoise(): boolean;
  151091. set blurNoise(value: boolean);
  151092. /**
  151093. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  151094. */
  151095. get pentagonBokeh(): boolean;
  151096. set pentagonBokeh(value: boolean);
  151097. /**
  151098. * Gets or sets the highlight grain amount
  151099. */
  151100. get highlightsGain(): number;
  151101. set highlightsGain(value: number);
  151102. /**
  151103. * Gets or sets the highlight threshold
  151104. */
  151105. get highlightsThreshold(): number;
  151106. set highlightsThreshold(value: number);
  151107. /**
  151108. * Sets the amount of blur at the edges
  151109. * @param amount blur amount
  151110. */
  151111. setEdgeBlur(amount: number): void;
  151112. /**
  151113. * Sets edge blur to 0
  151114. */
  151115. disableEdgeBlur(): void;
  151116. /**
  151117. * Sets the amout of grain
  151118. * @param amount Amount of grain
  151119. */
  151120. setGrainAmount(amount: number): void;
  151121. /**
  151122. * Set grain amount to 0
  151123. */
  151124. disableGrain(): void;
  151125. /**
  151126. * Sets the chromatic aberration amount
  151127. * @param amount amount of chromatic aberration
  151128. */
  151129. setChromaticAberration(amount: number): void;
  151130. /**
  151131. * Sets chromatic aberration amount to 0
  151132. */
  151133. disableChromaticAberration(): void;
  151134. /**
  151135. * Sets the EdgeDistortion amount
  151136. * @param amount amount of EdgeDistortion
  151137. */
  151138. setEdgeDistortion(amount: number): void;
  151139. /**
  151140. * Sets edge distortion to 0
  151141. */
  151142. disableEdgeDistortion(): void;
  151143. /**
  151144. * Sets the FocusDistance amount
  151145. * @param amount amount of FocusDistance
  151146. */
  151147. setFocusDistance(amount: number): void;
  151148. /**
  151149. * Disables depth of field
  151150. */
  151151. disableDepthOfField(): void;
  151152. /**
  151153. * Sets the Aperture amount
  151154. * @param amount amount of Aperture
  151155. */
  151156. setAperture(amount: number): void;
  151157. /**
  151158. * Sets the DarkenOutOfFocus amount
  151159. * @param amount amount of DarkenOutOfFocus
  151160. */
  151161. setDarkenOutOfFocus(amount: number): void;
  151162. private _pentagonBokehIsEnabled;
  151163. /**
  151164. * Creates a pentagon bokeh effect
  151165. */
  151166. enablePentagonBokeh(): void;
  151167. /**
  151168. * Disables the pentagon bokeh effect
  151169. */
  151170. disablePentagonBokeh(): void;
  151171. /**
  151172. * Enables noise blur
  151173. */
  151174. enableNoiseBlur(): void;
  151175. /**
  151176. * Disables noise blur
  151177. */
  151178. disableNoiseBlur(): void;
  151179. /**
  151180. * Sets the HighlightsGain amount
  151181. * @param amount amount of HighlightsGain
  151182. */
  151183. setHighlightsGain(amount: number): void;
  151184. /**
  151185. * Sets the HighlightsThreshold amount
  151186. * @param amount amount of HighlightsThreshold
  151187. */
  151188. setHighlightsThreshold(amount: number): void;
  151189. /**
  151190. * Disables highlights
  151191. */
  151192. disableHighlights(): void;
  151193. /**
  151194. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  151195. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  151196. */
  151197. dispose(disableDepthRender?: boolean): void;
  151198. private _createChromaticAberrationPostProcess;
  151199. private _createHighlightsPostProcess;
  151200. private _createDepthOfFieldPostProcess;
  151201. private _createGrainTexture;
  151202. }
  151203. }
  151204. declare module BABYLON {
  151205. /**
  151206. * Contains all parameters needed for the prepass to perform
  151207. * screen space subsurface scattering
  151208. */
  151209. export class SSAO2Configuration implements PrePassEffectConfiguration {
  151210. /**
  151211. * Is subsurface enabled
  151212. */
  151213. enabled: boolean;
  151214. /**
  151215. * Name of the configuration
  151216. */
  151217. name: string;
  151218. /**
  151219. * Textures that should be present in the MRT for this effect to work
  151220. */
  151221. readonly texturesRequired: number[];
  151222. /**
  151223. * Builds a ssao2 configuration object
  151224. * @param scene The scene
  151225. */
  151226. constructor();
  151227. /**
  151228. * Disposes the configuration
  151229. */
  151230. dispose(): void;
  151231. }
  151232. }
  151233. declare module BABYLON {
  151234. /** @hidden */
  151235. export var ssao2PixelShader: {
  151236. name: string;
  151237. shader: string;
  151238. };
  151239. }
  151240. declare module BABYLON {
  151241. /** @hidden */
  151242. export var ssaoCombinePixelShader: {
  151243. name: string;
  151244. shader: string;
  151245. };
  151246. }
  151247. declare module BABYLON {
  151248. /**
  151249. * Render pipeline to produce ssao effect
  151250. */
  151251. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  151252. /**
  151253. * @ignore
  151254. * The PassPostProcess id in the pipeline that contains the original scene color
  151255. */
  151256. SSAOOriginalSceneColorEffect: string;
  151257. /**
  151258. * @ignore
  151259. * The SSAO PostProcess id in the pipeline
  151260. */
  151261. SSAORenderEffect: string;
  151262. /**
  151263. * @ignore
  151264. * The horizontal blur PostProcess id in the pipeline
  151265. */
  151266. SSAOBlurHRenderEffect: string;
  151267. /**
  151268. * @ignore
  151269. * The vertical blur PostProcess id in the pipeline
  151270. */
  151271. SSAOBlurVRenderEffect: string;
  151272. /**
  151273. * @ignore
  151274. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  151275. */
  151276. SSAOCombineRenderEffect: string;
  151277. /**
  151278. * The output strength of the SSAO post-process. Default value is 1.0.
  151279. */
  151280. totalStrength: number;
  151281. /**
  151282. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  151283. */
  151284. maxZ: number;
  151285. /**
  151286. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  151287. */
  151288. minZAspect: number;
  151289. private _samples;
  151290. /**
  151291. * Number of samples used for the SSAO calculations. Default value is 8
  151292. */
  151293. set samples(n: number);
  151294. get samples(): number;
  151295. private _textureSamples;
  151296. /**
  151297. * Number of samples to use for antialiasing
  151298. */
  151299. set textureSamples(n: number);
  151300. get textureSamples(): number;
  151301. /**
  151302. * Force rendering the geometry through geometry buffer
  151303. */
  151304. private _forceGeometryBuffer;
  151305. /**
  151306. * Ratio object used for SSAO ratio and blur ratio
  151307. */
  151308. private _ratio;
  151309. /**
  151310. * Dynamically generated sphere sampler.
  151311. */
  151312. private _sampleSphere;
  151313. private _ssao2PrePassConfiguration;
  151314. /**
  151315. * Blur filter offsets
  151316. */
  151317. private _samplerOffsets;
  151318. private _expensiveBlur;
  151319. /**
  151320. * If bilateral blur should be used
  151321. */
  151322. set expensiveBlur(b: boolean);
  151323. get expensiveBlur(): boolean;
  151324. /**
  151325. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  151326. */
  151327. radius: number;
  151328. /**
  151329. * The base color of the SSAO post-process
  151330. * The final result is "base + ssao" between [0, 1]
  151331. */
  151332. base: number;
  151333. /**
  151334. * Support test.
  151335. */
  151336. static get IsSupported(): boolean;
  151337. private _scene;
  151338. private _randomTexture;
  151339. private _originalColorPostProcess;
  151340. private _ssaoPostProcess;
  151341. private _blurHPostProcess;
  151342. private _blurVPostProcess;
  151343. private _ssaoCombinePostProcess;
  151344. private _prePassRenderer;
  151345. /**
  151346. * Gets active scene
  151347. */
  151348. get scene(): Scene;
  151349. /**
  151350. * @constructor
  151351. * @param name The rendering pipeline name
  151352. * @param scene The scene linked to this pipeline
  151353. * @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 }
  151354. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151355. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  151356. */
  151357. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  151358. /**
  151359. * Get the class name
  151360. * @returns "SSAO2RenderingPipeline"
  151361. */
  151362. getClassName(): string;
  151363. /**
  151364. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  151365. */
  151366. dispose(disableGeometryBufferRenderer?: boolean): void;
  151367. private _createBlurPostProcess;
  151368. /** @hidden */
  151369. _rebuild(): void;
  151370. private _bits;
  151371. private _radicalInverse_VdC;
  151372. private _hammersley;
  151373. private _hemisphereSample_uniform;
  151374. private _generateHemisphere;
  151375. private _getDefinesForSSAO;
  151376. private _createSSAOPostProcess;
  151377. private _createSSAOCombinePostProcess;
  151378. private _createRandomTexture;
  151379. /**
  151380. * Serialize the rendering pipeline (Used when exporting)
  151381. * @returns the serialized object
  151382. */
  151383. serialize(): any;
  151384. /**
  151385. * Parse the serialized pipeline
  151386. * @param source Source pipeline.
  151387. * @param scene The scene to load the pipeline to.
  151388. * @param rootUrl The URL of the serialized pipeline.
  151389. * @returns An instantiated pipeline from the serialized object.
  151390. */
  151391. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  151392. /**
  151393. * Sets the required values to the prepass renderer.
  151394. * @param prePassRenderer defines the prepass renderer to setup
  151395. * @returns true if the pre pass is needed.
  151396. */
  151397. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  151398. }
  151399. }
  151400. declare module BABYLON {
  151401. /** @hidden */
  151402. export var ssaoPixelShader: {
  151403. name: string;
  151404. shader: string;
  151405. };
  151406. }
  151407. declare module BABYLON {
  151408. /**
  151409. * Render pipeline to produce ssao effect
  151410. */
  151411. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  151412. /**
  151413. * @ignore
  151414. * The PassPostProcess id in the pipeline that contains the original scene color
  151415. */
  151416. SSAOOriginalSceneColorEffect: string;
  151417. /**
  151418. * @ignore
  151419. * The SSAO PostProcess id in the pipeline
  151420. */
  151421. SSAORenderEffect: string;
  151422. /**
  151423. * @ignore
  151424. * The horizontal blur PostProcess id in the pipeline
  151425. */
  151426. SSAOBlurHRenderEffect: string;
  151427. /**
  151428. * @ignore
  151429. * The vertical blur PostProcess id in the pipeline
  151430. */
  151431. SSAOBlurVRenderEffect: string;
  151432. /**
  151433. * @ignore
  151434. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  151435. */
  151436. SSAOCombineRenderEffect: string;
  151437. /**
  151438. * The output strength of the SSAO post-process. Default value is 1.0.
  151439. */
  151440. totalStrength: number;
  151441. /**
  151442. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  151443. */
  151444. radius: number;
  151445. /**
  151446. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  151447. * Must not be equal to fallOff and superior to fallOff.
  151448. * Default value is 0.0075
  151449. */
  151450. area: number;
  151451. /**
  151452. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  151453. * Must not be equal to area and inferior to area.
  151454. * Default value is 0.000001
  151455. */
  151456. fallOff: number;
  151457. /**
  151458. * The base color of the SSAO post-process
  151459. * The final result is "base + ssao" between [0, 1]
  151460. */
  151461. base: number;
  151462. private _scene;
  151463. private _depthTexture;
  151464. private _randomTexture;
  151465. private _originalColorPostProcess;
  151466. private _ssaoPostProcess;
  151467. private _blurHPostProcess;
  151468. private _blurVPostProcess;
  151469. private _ssaoCombinePostProcess;
  151470. private _firstUpdate;
  151471. /**
  151472. * Gets active scene
  151473. */
  151474. get scene(): Scene;
  151475. /**
  151476. * @constructor
  151477. * @param name - The rendering pipeline name
  151478. * @param scene - The scene linked to this pipeline
  151479. * @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 }
  151480. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  151481. */
  151482. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  151483. /**
  151484. * Get the class name
  151485. * @returns "SSAORenderingPipeline"
  151486. */
  151487. getClassName(): string;
  151488. /**
  151489. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  151490. */
  151491. dispose(disableDepthRender?: boolean): void;
  151492. private _createBlurPostProcess;
  151493. /** @hidden */
  151494. _rebuild(): void;
  151495. private _createSSAOPostProcess;
  151496. private _createSSAOCombinePostProcess;
  151497. private _createRandomTexture;
  151498. }
  151499. }
  151500. declare module BABYLON {
  151501. /** @hidden */
  151502. export var screenSpaceReflectionPixelShader: {
  151503. name: string;
  151504. shader: string;
  151505. };
  151506. }
  151507. declare module BABYLON {
  151508. /**
  151509. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  151510. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  151511. */
  151512. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  151513. /**
  151514. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  151515. */
  151516. threshold: number;
  151517. /**
  151518. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  151519. */
  151520. strength: number;
  151521. /**
  151522. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  151523. */
  151524. reflectionSpecularFalloffExponent: number;
  151525. /**
  151526. * 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]
  151527. */
  151528. step: number;
  151529. /**
  151530. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  151531. */
  151532. roughnessFactor: number;
  151533. private _geometryBufferRenderer;
  151534. private _enableSmoothReflections;
  151535. private _reflectionSamples;
  151536. private _smoothSteps;
  151537. /**
  151538. * Gets a string identifying the name of the class
  151539. * @returns "ScreenSpaceReflectionPostProcess" string
  151540. */
  151541. getClassName(): string;
  151542. /**
  151543. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  151544. * @param name The name of the effect.
  151545. * @param scene The scene containing the objects to calculate reflections.
  151546. * @param options The required width/height ratio to downsize to before computing the render pass.
  151547. * @param camera The camera to apply the render pass to.
  151548. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151549. * @param engine The engine which the post process will be applied. (default: current engine)
  151550. * @param reusable If the post process can be reused on the same frame. (default: false)
  151551. * @param textureType Type of textures used when performing the post process. (default: 0)
  151552. * @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)
  151553. */
  151554. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151555. /**
  151556. * Gets wether or not smoothing reflections is enabled.
  151557. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  151558. */
  151559. get enableSmoothReflections(): boolean;
  151560. /**
  151561. * Sets wether or not smoothing reflections is enabled.
  151562. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  151563. */
  151564. set enableSmoothReflections(enabled: boolean);
  151565. /**
  151566. * Gets the number of samples taken while computing reflections. More samples count is high,
  151567. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  151568. */
  151569. get reflectionSamples(): number;
  151570. /**
  151571. * Sets the number of samples taken while computing reflections. More samples count is high,
  151572. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  151573. */
  151574. set reflectionSamples(samples: number);
  151575. /**
  151576. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  151577. * more the post-process will require GPU power and can generate a drop in FPS.
  151578. * Default value (5.0) work pretty well in all cases but can be adjusted.
  151579. */
  151580. get smoothSteps(): number;
  151581. set smoothSteps(steps: number);
  151582. private _updateEffectDefines;
  151583. /** @hidden */
  151584. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  151585. }
  151586. }
  151587. declare module BABYLON {
  151588. /** @hidden */
  151589. export var standardPixelShader: {
  151590. name: string;
  151591. shader: string;
  151592. };
  151593. }
  151594. declare module BABYLON {
  151595. /**
  151596. * Standard rendering pipeline
  151597. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151598. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  151599. */
  151600. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  151601. /**
  151602. * Public members
  151603. */
  151604. /**
  151605. * Post-process which contains the original scene color before the pipeline applies all the effects
  151606. */
  151607. originalPostProcess: Nullable<PostProcess>;
  151608. /**
  151609. * Post-process used to down scale an image x4
  151610. */
  151611. downSampleX4PostProcess: Nullable<PostProcess>;
  151612. /**
  151613. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  151614. */
  151615. brightPassPostProcess: Nullable<PostProcess>;
  151616. /**
  151617. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  151618. */
  151619. blurHPostProcesses: PostProcess[];
  151620. /**
  151621. * Post-process array storing all the vertical blur post-processes used by the pipeline
  151622. */
  151623. blurVPostProcesses: PostProcess[];
  151624. /**
  151625. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  151626. */
  151627. textureAdderPostProcess: Nullable<PostProcess>;
  151628. /**
  151629. * Post-process used to create volumetric lighting effect
  151630. */
  151631. volumetricLightPostProcess: Nullable<PostProcess>;
  151632. /**
  151633. * Post-process used to smooth the previous volumetric light post-process on the X axis
  151634. */
  151635. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  151636. /**
  151637. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  151638. */
  151639. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  151640. /**
  151641. * Post-process used to merge the volumetric light effect and the real scene color
  151642. */
  151643. volumetricLightMergePostProces: Nullable<PostProcess>;
  151644. /**
  151645. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  151646. */
  151647. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  151648. /**
  151649. * Base post-process used to calculate the average luminance of the final image for HDR
  151650. */
  151651. luminancePostProcess: Nullable<PostProcess>;
  151652. /**
  151653. * Post-processes used to create down sample post-processes in order to get
  151654. * the average luminance of the final image for HDR
  151655. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  151656. */
  151657. luminanceDownSamplePostProcesses: PostProcess[];
  151658. /**
  151659. * Post-process used to create a HDR effect (light adaptation)
  151660. */
  151661. hdrPostProcess: Nullable<PostProcess>;
  151662. /**
  151663. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  151664. */
  151665. textureAdderFinalPostProcess: Nullable<PostProcess>;
  151666. /**
  151667. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  151668. */
  151669. lensFlareFinalPostProcess: Nullable<PostProcess>;
  151670. /**
  151671. * Post-process used to merge the final HDR post-process and the real scene color
  151672. */
  151673. hdrFinalPostProcess: Nullable<PostProcess>;
  151674. /**
  151675. * Post-process used to create a lens flare effect
  151676. */
  151677. lensFlarePostProcess: Nullable<PostProcess>;
  151678. /**
  151679. * Post-process that merges the result of the lens flare post-process and the real scene color
  151680. */
  151681. lensFlareComposePostProcess: Nullable<PostProcess>;
  151682. /**
  151683. * Post-process used to create a motion blur effect
  151684. */
  151685. motionBlurPostProcess: Nullable<PostProcess>;
  151686. /**
  151687. * Post-process used to create a depth of field effect
  151688. */
  151689. depthOfFieldPostProcess: Nullable<PostProcess>;
  151690. /**
  151691. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  151692. */
  151693. fxaaPostProcess: Nullable<FxaaPostProcess>;
  151694. /**
  151695. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  151696. */
  151697. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  151698. /**
  151699. * Represents the brightness threshold in order to configure the illuminated surfaces
  151700. */
  151701. brightThreshold: number;
  151702. /**
  151703. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  151704. */
  151705. blurWidth: number;
  151706. /**
  151707. * Sets if the blur for highlighted surfaces must be only horizontal
  151708. */
  151709. horizontalBlur: boolean;
  151710. /**
  151711. * Gets the overall exposure used by the pipeline
  151712. */
  151713. get exposure(): number;
  151714. /**
  151715. * Sets the overall exposure used by the pipeline
  151716. */
  151717. set exposure(value: number);
  151718. /**
  151719. * Texture used typically to simulate "dirty" on camera lens
  151720. */
  151721. lensTexture: Nullable<Texture>;
  151722. /**
  151723. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  151724. */
  151725. volumetricLightCoefficient: number;
  151726. /**
  151727. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  151728. */
  151729. volumetricLightPower: number;
  151730. /**
  151731. * Used the set the blur intensity to smooth the volumetric lights
  151732. */
  151733. volumetricLightBlurScale: number;
  151734. /**
  151735. * Light (spot or directional) used to generate the volumetric lights rays
  151736. * The source light must have a shadow generate so the pipeline can get its
  151737. * depth map
  151738. */
  151739. sourceLight: Nullable<SpotLight | DirectionalLight>;
  151740. /**
  151741. * For eye adaptation, represents the minimum luminance the eye can see
  151742. */
  151743. hdrMinimumLuminance: number;
  151744. /**
  151745. * For eye adaptation, represents the decrease luminance speed
  151746. */
  151747. hdrDecreaseRate: number;
  151748. /**
  151749. * For eye adaptation, represents the increase luminance speed
  151750. */
  151751. hdrIncreaseRate: number;
  151752. /**
  151753. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151754. */
  151755. get hdrAutoExposure(): boolean;
  151756. /**
  151757. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151758. */
  151759. set hdrAutoExposure(value: boolean);
  151760. /**
  151761. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  151762. */
  151763. lensColorTexture: Nullable<Texture>;
  151764. /**
  151765. * The overall strengh for the lens flare effect
  151766. */
  151767. lensFlareStrength: number;
  151768. /**
  151769. * Dispersion coefficient for lens flare ghosts
  151770. */
  151771. lensFlareGhostDispersal: number;
  151772. /**
  151773. * Main lens flare halo width
  151774. */
  151775. lensFlareHaloWidth: number;
  151776. /**
  151777. * Based on the lens distortion effect, defines how much the lens flare result
  151778. * is distorted
  151779. */
  151780. lensFlareDistortionStrength: number;
  151781. /**
  151782. * Configures the blur intensity used for for lens flare (halo)
  151783. */
  151784. lensFlareBlurWidth: number;
  151785. /**
  151786. * Lens star texture must be used to simulate rays on the flares and is available
  151787. * in the documentation
  151788. */
  151789. lensStarTexture: Nullable<Texture>;
  151790. /**
  151791. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  151792. * flare effect by taking account of the dirt texture
  151793. */
  151794. lensFlareDirtTexture: Nullable<Texture>;
  151795. /**
  151796. * Represents the focal length for the depth of field effect
  151797. */
  151798. depthOfFieldDistance: number;
  151799. /**
  151800. * Represents the blur intensity for the blurred part of the depth of field effect
  151801. */
  151802. depthOfFieldBlurWidth: number;
  151803. /**
  151804. * Gets how much the image is blurred by the movement while using the motion blur post-process
  151805. */
  151806. get motionStrength(): number;
  151807. /**
  151808. * Sets how much the image is blurred by the movement while using the motion blur post-process
  151809. */
  151810. set motionStrength(strength: number);
  151811. /**
  151812. * Gets wether or not the motion blur post-process is object based or screen based.
  151813. */
  151814. get objectBasedMotionBlur(): boolean;
  151815. /**
  151816. * Sets wether or not the motion blur post-process should be object based or screen based
  151817. */
  151818. set objectBasedMotionBlur(value: boolean);
  151819. /**
  151820. * List of animations for the pipeline (IAnimatable implementation)
  151821. */
  151822. animations: Animation[];
  151823. /**
  151824. * Private members
  151825. */
  151826. private _scene;
  151827. private _currentDepthOfFieldSource;
  151828. private _basePostProcess;
  151829. private _fixedExposure;
  151830. private _currentExposure;
  151831. private _hdrAutoExposure;
  151832. private _hdrCurrentLuminance;
  151833. private _motionStrength;
  151834. private _isObjectBasedMotionBlur;
  151835. private _floatTextureType;
  151836. private _camerasToBeAttached;
  151837. private _ratio;
  151838. private _bloomEnabled;
  151839. private _depthOfFieldEnabled;
  151840. private _vlsEnabled;
  151841. private _lensFlareEnabled;
  151842. private _hdrEnabled;
  151843. private _motionBlurEnabled;
  151844. private _fxaaEnabled;
  151845. private _screenSpaceReflectionsEnabled;
  151846. private _motionBlurSamples;
  151847. private _volumetricLightStepsCount;
  151848. private _samples;
  151849. /**
  151850. * @ignore
  151851. * Specifies if the bloom pipeline is enabled
  151852. */
  151853. get BloomEnabled(): boolean;
  151854. set BloomEnabled(enabled: boolean);
  151855. /**
  151856. * @ignore
  151857. * Specifies if the depth of field pipeline is enabed
  151858. */
  151859. get DepthOfFieldEnabled(): boolean;
  151860. set DepthOfFieldEnabled(enabled: boolean);
  151861. /**
  151862. * @ignore
  151863. * Specifies if the lens flare pipeline is enabed
  151864. */
  151865. get LensFlareEnabled(): boolean;
  151866. set LensFlareEnabled(enabled: boolean);
  151867. /**
  151868. * @ignore
  151869. * Specifies if the HDR pipeline is enabled
  151870. */
  151871. get HDREnabled(): boolean;
  151872. set HDREnabled(enabled: boolean);
  151873. /**
  151874. * @ignore
  151875. * Specifies if the volumetric lights scattering effect is enabled
  151876. */
  151877. get VLSEnabled(): boolean;
  151878. set VLSEnabled(enabled: boolean);
  151879. /**
  151880. * @ignore
  151881. * Specifies if the motion blur effect is enabled
  151882. */
  151883. get MotionBlurEnabled(): boolean;
  151884. set MotionBlurEnabled(enabled: boolean);
  151885. /**
  151886. * Specifies if anti-aliasing is enabled
  151887. */
  151888. get fxaaEnabled(): boolean;
  151889. set fxaaEnabled(enabled: boolean);
  151890. /**
  151891. * Specifies if screen space reflections are enabled.
  151892. */
  151893. get screenSpaceReflectionsEnabled(): boolean;
  151894. set screenSpaceReflectionsEnabled(enabled: boolean);
  151895. /**
  151896. * Specifies the number of steps used to calculate the volumetric lights
  151897. * Typically in interval [50, 200]
  151898. */
  151899. get volumetricLightStepsCount(): number;
  151900. set volumetricLightStepsCount(count: number);
  151901. /**
  151902. * Specifies the number of samples used for the motion blur effect
  151903. * Typically in interval [16, 64]
  151904. */
  151905. get motionBlurSamples(): number;
  151906. set motionBlurSamples(samples: number);
  151907. /**
  151908. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151909. */
  151910. get samples(): number;
  151911. set samples(sampleCount: number);
  151912. /**
  151913. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151914. * @constructor
  151915. * @param name The rendering pipeline name
  151916. * @param scene The scene linked to this pipeline
  151917. * @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)
  151918. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151919. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151920. */
  151921. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151922. private _buildPipeline;
  151923. private _createDownSampleX4PostProcess;
  151924. private _createBrightPassPostProcess;
  151925. private _createBlurPostProcesses;
  151926. private _createTextureAdderPostProcess;
  151927. private _createVolumetricLightPostProcess;
  151928. private _createLuminancePostProcesses;
  151929. private _createHdrPostProcess;
  151930. private _createLensFlarePostProcess;
  151931. private _createDepthOfFieldPostProcess;
  151932. private _createMotionBlurPostProcess;
  151933. private _getDepthTexture;
  151934. private _disposePostProcesses;
  151935. /**
  151936. * Dispose of the pipeline and stop all post processes
  151937. */
  151938. dispose(): void;
  151939. /**
  151940. * Serialize the rendering pipeline (Used when exporting)
  151941. * @returns the serialized object
  151942. */
  151943. serialize(): any;
  151944. /**
  151945. * Parse the serialized pipeline
  151946. * @param source Source pipeline.
  151947. * @param scene The scene to load the pipeline to.
  151948. * @param rootUrl The URL of the serialized pipeline.
  151949. * @returns An instantiated pipeline from the serialized object.
  151950. */
  151951. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151952. /**
  151953. * Luminance steps
  151954. */
  151955. static LuminanceSteps: number;
  151956. }
  151957. }
  151958. declare module BABYLON {
  151959. /** @hidden */
  151960. export var stereoscopicInterlacePixelShader: {
  151961. name: string;
  151962. shader: string;
  151963. };
  151964. }
  151965. declare module BABYLON {
  151966. /**
  151967. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151968. */
  151969. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151970. private _stepSize;
  151971. private _passedProcess;
  151972. /**
  151973. * Gets a string identifying the name of the class
  151974. * @returns "StereoscopicInterlacePostProcessI" string
  151975. */
  151976. getClassName(): string;
  151977. /**
  151978. * Initializes a StereoscopicInterlacePostProcessI
  151979. * @param name The name of the effect.
  151980. * @param rigCameras The rig cameras to be appled to the post process
  151981. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151982. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151983. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151984. * @param engine The engine which the post process will be applied. (default: current engine)
  151985. * @param reusable If the post process can be reused on the same frame. (default: false)
  151986. */
  151987. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151988. }
  151989. /**
  151990. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151991. */
  151992. export class StereoscopicInterlacePostProcess extends PostProcess {
  151993. private _stepSize;
  151994. private _passedProcess;
  151995. /**
  151996. * Gets a string identifying the name of the class
  151997. * @returns "StereoscopicInterlacePostProcess" string
  151998. */
  151999. getClassName(): string;
  152000. /**
  152001. * Initializes a StereoscopicInterlacePostProcess
  152002. * @param name The name of the effect.
  152003. * @param rigCameras The rig cameras to be appled to the post process
  152004. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  152005. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152006. * @param engine The engine which the post process will be applied. (default: current engine)
  152007. * @param reusable If the post process can be reused on the same frame. (default: false)
  152008. */
  152009. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  152010. }
  152011. }
  152012. declare module BABYLON {
  152013. /** @hidden */
  152014. export var tonemapPixelShader: {
  152015. name: string;
  152016. shader: string;
  152017. };
  152018. }
  152019. declare module BABYLON {
  152020. /** Defines operator used for tonemapping */
  152021. export enum TonemappingOperator {
  152022. /** Hable */
  152023. Hable = 0,
  152024. /** Reinhard */
  152025. Reinhard = 1,
  152026. /** HejiDawson */
  152027. HejiDawson = 2,
  152028. /** Photographic */
  152029. Photographic = 3
  152030. }
  152031. /**
  152032. * Defines a post process to apply tone mapping
  152033. */
  152034. export class TonemapPostProcess extends PostProcess {
  152035. private _operator;
  152036. /** Defines the required exposure adjustement */
  152037. exposureAdjustment: number;
  152038. /**
  152039. * Gets a string identifying the name of the class
  152040. * @returns "TonemapPostProcess" string
  152041. */
  152042. getClassName(): string;
  152043. /**
  152044. * Creates a new TonemapPostProcess
  152045. * @param name defines the name of the postprocess
  152046. * @param _operator defines the operator to use
  152047. * @param exposureAdjustment defines the required exposure adjustement
  152048. * @param camera defines the camera to use (can be null)
  152049. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  152050. * @param engine defines the hosting engine (can be ignore if camera is set)
  152051. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  152052. */
  152053. constructor(name: string, _operator: TonemappingOperator,
  152054. /** Defines the required exposure adjustement */
  152055. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  152056. }
  152057. }
  152058. declare module BABYLON {
  152059. /** @hidden */
  152060. export var volumetricLightScatteringPixelShader: {
  152061. name: string;
  152062. shader: string;
  152063. };
  152064. }
  152065. declare module BABYLON {
  152066. /** @hidden */
  152067. export var volumetricLightScatteringPassVertexShader: {
  152068. name: string;
  152069. shader: string;
  152070. };
  152071. }
  152072. declare module BABYLON {
  152073. /** @hidden */
  152074. export var volumetricLightScatteringPassPixelShader: {
  152075. name: string;
  152076. shader: string;
  152077. };
  152078. }
  152079. declare module BABYLON {
  152080. /**
  152081. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  152082. */
  152083. export class VolumetricLightScatteringPostProcess extends PostProcess {
  152084. private _volumetricLightScatteringPass;
  152085. private _volumetricLightScatteringRTT;
  152086. private _viewPort;
  152087. private _screenCoordinates;
  152088. private _cachedDefines;
  152089. /**
  152090. * If not undefined, the mesh position is computed from the attached node position
  152091. */
  152092. attachedNode: {
  152093. position: Vector3;
  152094. };
  152095. /**
  152096. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  152097. */
  152098. customMeshPosition: Vector3;
  152099. /**
  152100. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  152101. */
  152102. useCustomMeshPosition: boolean;
  152103. /**
  152104. * If the post-process should inverse the light scattering direction
  152105. */
  152106. invert: boolean;
  152107. /**
  152108. * The internal mesh used by the post-process
  152109. */
  152110. mesh: Mesh;
  152111. /**
  152112. * @hidden
  152113. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  152114. */
  152115. get useDiffuseColor(): boolean;
  152116. set useDiffuseColor(useDiffuseColor: boolean);
  152117. /**
  152118. * Array containing the excluded meshes not rendered in the internal pass
  152119. */
  152120. excludedMeshes: AbstractMesh[];
  152121. /**
  152122. * Controls the overall intensity of the post-process
  152123. */
  152124. exposure: number;
  152125. /**
  152126. * Dissipates each sample's contribution in range [0, 1]
  152127. */
  152128. decay: number;
  152129. /**
  152130. * Controls the overall intensity of each sample
  152131. */
  152132. weight: number;
  152133. /**
  152134. * Controls the density of each sample
  152135. */
  152136. density: number;
  152137. /**
  152138. * @constructor
  152139. * @param name The post-process name
  152140. * @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)
  152141. * @param camera The camera that the post-process will be attached to
  152142. * @param mesh The mesh used to create the light scattering
  152143. * @param samples The post-process quality, default 100
  152144. * @param samplingModeThe post-process filtering mode
  152145. * @param engine The babylon engine
  152146. * @param reusable If the post-process is reusable
  152147. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  152148. */
  152149. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  152150. /**
  152151. * Returns the string "VolumetricLightScatteringPostProcess"
  152152. * @returns "VolumetricLightScatteringPostProcess"
  152153. */
  152154. getClassName(): string;
  152155. private _isReady;
  152156. /**
  152157. * Sets the new light position for light scattering effect
  152158. * @param position The new custom light position
  152159. */
  152160. setCustomMeshPosition(position: Vector3): void;
  152161. /**
  152162. * Returns the light position for light scattering effect
  152163. * @return Vector3 The custom light position
  152164. */
  152165. getCustomMeshPosition(): Vector3;
  152166. /**
  152167. * Disposes the internal assets and detaches the post-process from the camera
  152168. */
  152169. dispose(camera: Camera): void;
  152170. /**
  152171. * Returns the render target texture used by the post-process
  152172. * @return the render target texture used by the post-process
  152173. */
  152174. getPass(): RenderTargetTexture;
  152175. private _meshExcluded;
  152176. private _createPass;
  152177. private _updateMeshScreenCoordinates;
  152178. /**
  152179. * Creates a default mesh for the Volumeric Light Scattering post-process
  152180. * @param name The mesh name
  152181. * @param scene The scene where to create the mesh
  152182. * @return the default mesh
  152183. */
  152184. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  152185. }
  152186. }
  152187. declare module BABYLON {
  152188. /** @hidden */
  152189. export var screenSpaceCurvaturePixelShader: {
  152190. name: string;
  152191. shader: string;
  152192. };
  152193. }
  152194. declare module BABYLON {
  152195. /**
  152196. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  152197. */
  152198. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  152199. /**
  152200. * Defines how much ridge the curvature effect displays.
  152201. */
  152202. ridge: number;
  152203. /**
  152204. * Defines how much valley the curvature effect displays.
  152205. */
  152206. valley: number;
  152207. private _geometryBufferRenderer;
  152208. /**
  152209. * Gets a string identifying the name of the class
  152210. * @returns "ScreenSpaceCurvaturePostProcess" string
  152211. */
  152212. getClassName(): string;
  152213. /**
  152214. * Creates a new instance ScreenSpaceCurvaturePostProcess
  152215. * @param name The name of the effect.
  152216. * @param scene The scene containing the objects to blur according to their velocity.
  152217. * @param options The required width/height ratio to downsize to before computing the render pass.
  152218. * @param camera The camera to apply the render pass to.
  152219. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152220. * @param engine The engine which the post process will be applied. (default: current engine)
  152221. * @param reusable If the post process can be reused on the same frame. (default: false)
  152222. * @param textureType Type of textures used when performing the post process. (default: 0)
  152223. * @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)
  152224. */
  152225. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  152226. /**
  152227. * Support test.
  152228. */
  152229. static get IsSupported(): boolean;
  152230. /** @hidden */
  152231. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  152232. }
  152233. }
  152234. declare module BABYLON {
  152235. interface Scene {
  152236. /** @hidden (Backing field) */
  152237. _boundingBoxRenderer: BoundingBoxRenderer;
  152238. /** @hidden (Backing field) */
  152239. _forceShowBoundingBoxes: boolean;
  152240. /**
  152241. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  152242. */
  152243. forceShowBoundingBoxes: boolean;
  152244. /**
  152245. * Gets the bounding box renderer associated with the scene
  152246. * @returns a BoundingBoxRenderer
  152247. */
  152248. getBoundingBoxRenderer(): BoundingBoxRenderer;
  152249. }
  152250. interface AbstractMesh {
  152251. /** @hidden (Backing field) */
  152252. _showBoundingBox: boolean;
  152253. /**
  152254. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  152255. */
  152256. showBoundingBox: boolean;
  152257. }
  152258. /**
  152259. * Component responsible of rendering the bounding box of the meshes in a scene.
  152260. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  152261. */
  152262. export class BoundingBoxRenderer implements ISceneComponent {
  152263. /**
  152264. * The component name helpfull to identify the component in the list of scene components.
  152265. */
  152266. readonly name: string;
  152267. /**
  152268. * The scene the component belongs to.
  152269. */
  152270. scene: Scene;
  152271. /**
  152272. * Color of the bounding box lines placed in front of an object
  152273. */
  152274. frontColor: Color3;
  152275. /**
  152276. * Color of the bounding box lines placed behind an object
  152277. */
  152278. backColor: Color3;
  152279. /**
  152280. * Defines if the renderer should show the back lines or not
  152281. */
  152282. showBackLines: boolean;
  152283. /**
  152284. * Observable raised before rendering a bounding box
  152285. */
  152286. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  152287. /**
  152288. * Observable raised after rendering a bounding box
  152289. */
  152290. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  152291. /**
  152292. * @hidden
  152293. */
  152294. renderList: SmartArray<BoundingBox>;
  152295. private _colorShader;
  152296. private _vertexBuffers;
  152297. private _indexBuffer;
  152298. private _fillIndexBuffer;
  152299. private _fillIndexData;
  152300. /**
  152301. * Instantiates a new bounding box renderer in a scene.
  152302. * @param scene the scene the renderer renders in
  152303. */
  152304. constructor(scene: Scene);
  152305. /**
  152306. * Registers the component in a given scene
  152307. */
  152308. register(): void;
  152309. private _evaluateSubMesh;
  152310. private _activeMesh;
  152311. private _prepareRessources;
  152312. private _createIndexBuffer;
  152313. /**
  152314. * Rebuilds the elements related to this component in case of
  152315. * context lost for instance.
  152316. */
  152317. rebuild(): void;
  152318. /**
  152319. * @hidden
  152320. */
  152321. reset(): void;
  152322. /**
  152323. * Render the bounding boxes of a specific rendering group
  152324. * @param renderingGroupId defines the rendering group to render
  152325. */
  152326. render(renderingGroupId: number): void;
  152327. /**
  152328. * In case of occlusion queries, we can render the occlusion bounding box through this method
  152329. * @param mesh Define the mesh to render the occlusion bounding box for
  152330. */
  152331. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  152332. /**
  152333. * Dispose and release the resources attached to this renderer.
  152334. */
  152335. dispose(): void;
  152336. }
  152337. }
  152338. declare module BABYLON {
  152339. interface Scene {
  152340. /** @hidden (Backing field) */
  152341. _depthRenderer: {
  152342. [id: string]: DepthRenderer;
  152343. };
  152344. /**
  152345. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  152346. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  152347. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  152348. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  152349. * @returns the created depth renderer
  152350. */
  152351. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  152352. /**
  152353. * Disables a depth renderer for a given camera
  152354. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  152355. */
  152356. disableDepthRenderer(camera?: Nullable<Camera>): void;
  152357. }
  152358. /**
  152359. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  152360. * in several rendering techniques.
  152361. */
  152362. export class DepthRendererSceneComponent implements ISceneComponent {
  152363. /**
  152364. * The component name helpfull to identify the component in the list of scene components.
  152365. */
  152366. readonly name: string;
  152367. /**
  152368. * The scene the component belongs to.
  152369. */
  152370. scene: Scene;
  152371. /**
  152372. * Creates a new instance of the component for the given scene
  152373. * @param scene Defines the scene to register the component in
  152374. */
  152375. constructor(scene: Scene);
  152376. /**
  152377. * Registers the component in a given scene
  152378. */
  152379. register(): void;
  152380. /**
  152381. * Rebuilds the elements related to this component in case of
  152382. * context lost for instance.
  152383. */
  152384. rebuild(): void;
  152385. /**
  152386. * Disposes the component and the associated ressources
  152387. */
  152388. dispose(): void;
  152389. private _gatherRenderTargets;
  152390. private _gatherActiveCameraRenderTargets;
  152391. }
  152392. }
  152393. declare module BABYLON {
  152394. interface AbstractScene {
  152395. /** @hidden (Backing field) */
  152396. _prePassRenderer: Nullable<PrePassRenderer>;
  152397. /**
  152398. * Gets or Sets the current prepass renderer associated to the scene.
  152399. */
  152400. prePassRenderer: Nullable<PrePassRenderer>;
  152401. /**
  152402. * Enables the prepass and associates it with the scene
  152403. * @returns the PrePassRenderer
  152404. */
  152405. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  152406. /**
  152407. * Disables the prepass associated with the scene
  152408. */
  152409. disablePrePassRenderer(): void;
  152410. }
  152411. /**
  152412. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  152413. * in several rendering techniques.
  152414. */
  152415. export class PrePassRendererSceneComponent implements ISceneComponent {
  152416. /**
  152417. * The component name helpful to identify the component in the list of scene components.
  152418. */
  152419. readonly name: string;
  152420. /**
  152421. * The scene the component belongs to.
  152422. */
  152423. scene: Scene;
  152424. /**
  152425. * Creates a new instance of the component for the given scene
  152426. * @param scene Defines the scene to register the component in
  152427. */
  152428. constructor(scene: Scene);
  152429. /**
  152430. * Registers the component in a given scene
  152431. */
  152432. register(): void;
  152433. private _beforeCameraDraw;
  152434. private _afterCameraDraw;
  152435. private _beforeClearStage;
  152436. /**
  152437. * Rebuilds the elements related to this component in case of
  152438. * context lost for instance.
  152439. */
  152440. rebuild(): void;
  152441. /**
  152442. * Disposes the component and the associated ressources
  152443. */
  152444. dispose(): void;
  152445. }
  152446. }
  152447. declare module BABYLON {
  152448. /** @hidden */
  152449. export var fibonacci: {
  152450. name: string;
  152451. shader: string;
  152452. };
  152453. }
  152454. declare module BABYLON {
  152455. /** @hidden */
  152456. export var diffusionProfile: {
  152457. name: string;
  152458. shader: string;
  152459. };
  152460. }
  152461. declare module BABYLON {
  152462. /** @hidden */
  152463. export var subSurfaceScatteringPixelShader: {
  152464. name: string;
  152465. shader: string;
  152466. };
  152467. }
  152468. declare module BABYLON {
  152469. /**
  152470. * Sub surface scattering post process
  152471. */
  152472. export class SubSurfaceScatteringPostProcess extends PostProcess {
  152473. /**
  152474. * Gets a string identifying the name of the class
  152475. * @returns "SubSurfaceScatteringPostProcess" string
  152476. */
  152477. getClassName(): string;
  152478. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  152479. }
  152480. }
  152481. declare module BABYLON {
  152482. /**
  152483. * Contains all parameters needed for the prepass to perform
  152484. * screen space subsurface scattering
  152485. */
  152486. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  152487. /** @hidden */
  152488. static _SceneComponentInitialization: (scene: Scene) => void;
  152489. private _ssDiffusionS;
  152490. private _ssFilterRadii;
  152491. private _ssDiffusionD;
  152492. /**
  152493. * Post process to attach for screen space subsurface scattering
  152494. */
  152495. postProcess: SubSurfaceScatteringPostProcess;
  152496. /**
  152497. * Diffusion profile color for subsurface scattering
  152498. */
  152499. get ssDiffusionS(): number[];
  152500. /**
  152501. * Diffusion profile max color channel value for subsurface scattering
  152502. */
  152503. get ssDiffusionD(): number[];
  152504. /**
  152505. * Diffusion profile filter radius for subsurface scattering
  152506. */
  152507. get ssFilterRadii(): number[];
  152508. /**
  152509. * Is subsurface enabled
  152510. */
  152511. enabled: boolean;
  152512. /**
  152513. * Name of the configuration
  152514. */
  152515. name: string;
  152516. /**
  152517. * Diffusion profile colors for subsurface scattering
  152518. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  152519. * See ...
  152520. * Note that you can only store up to 5 of them
  152521. */
  152522. ssDiffusionProfileColors: Color3[];
  152523. /**
  152524. * Defines the ratio real world => scene units.
  152525. * Used for subsurface scattering
  152526. */
  152527. metersPerUnit: number;
  152528. /**
  152529. * Textures that should be present in the MRT for this effect to work
  152530. */
  152531. readonly texturesRequired: number[];
  152532. private _scene;
  152533. /**
  152534. * Builds a subsurface configuration object
  152535. * @param scene The scene
  152536. */
  152537. constructor(scene: Scene);
  152538. /**
  152539. * Adds a new diffusion profile.
  152540. * Useful for more realistic subsurface scattering on diverse materials.
  152541. * @param color The color of the diffusion profile. Should be the average color of the material.
  152542. * @return The index of the diffusion profile for the material subsurface configuration
  152543. */
  152544. addDiffusionProfile(color: Color3): number;
  152545. /**
  152546. * Creates the sss post process
  152547. * @return The created post process
  152548. */
  152549. createPostProcess(): SubSurfaceScatteringPostProcess;
  152550. /**
  152551. * Deletes all diffusion profiles.
  152552. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  152553. */
  152554. clearAllDiffusionProfiles(): void;
  152555. /**
  152556. * Disposes this object
  152557. */
  152558. dispose(): void;
  152559. /**
  152560. * @hidden
  152561. * https://zero-radiance.github.io/post/sampling-diffusion/
  152562. *
  152563. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  152564. * ------------------------------------------------------------------------------------
  152565. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  152566. * PDF[r, phi, s] = r * R[r, phi, s]
  152567. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  152568. * ------------------------------------------------------------------------------------
  152569. * We importance sample the color channel with the widest scattering distance.
  152570. */
  152571. getDiffusionProfileParameters(color: Color3): number;
  152572. /**
  152573. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  152574. * 'u' is the random number (the value of the CDF): [0, 1).
  152575. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  152576. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  152577. */
  152578. private _sampleBurleyDiffusionProfile;
  152579. }
  152580. }
  152581. declare module BABYLON {
  152582. interface AbstractScene {
  152583. /** @hidden (Backing field) */
  152584. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  152585. /**
  152586. * Gets or Sets the current prepass renderer associated to the scene.
  152587. */
  152588. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  152589. /**
  152590. * Enables the subsurface effect for prepass
  152591. * @returns the SubSurfaceConfiguration
  152592. */
  152593. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  152594. /**
  152595. * Disables the subsurface effect for prepass
  152596. */
  152597. disableSubSurfaceForPrePass(): void;
  152598. }
  152599. /**
  152600. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  152601. * in several rendering techniques.
  152602. */
  152603. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  152604. /**
  152605. * The component name helpful to identify the component in the list of scene components.
  152606. */
  152607. readonly name: string;
  152608. /**
  152609. * The scene the component belongs to.
  152610. */
  152611. scene: Scene;
  152612. /**
  152613. * Creates a new instance of the component for the given scene
  152614. * @param scene Defines the scene to register the component in
  152615. */
  152616. constructor(scene: Scene);
  152617. /**
  152618. * Registers the component in a given scene
  152619. */
  152620. register(): void;
  152621. /**
  152622. * Serializes the component data to the specified json object
  152623. * @param serializationObject The object to serialize to
  152624. */
  152625. serialize(serializationObject: any): void;
  152626. /**
  152627. * Adds all the elements from the container to the scene
  152628. * @param container the container holding the elements
  152629. */
  152630. addFromContainer(container: AbstractScene): void;
  152631. /**
  152632. * Removes all the elements in the container from the scene
  152633. * @param container contains the elements to remove
  152634. * @param dispose if the removed element should be disposed (default: false)
  152635. */
  152636. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  152637. /**
  152638. * Rebuilds the elements related to this component in case of
  152639. * context lost for instance.
  152640. */
  152641. rebuild(): void;
  152642. /**
  152643. * Disposes the component and the associated ressources
  152644. */
  152645. dispose(): void;
  152646. }
  152647. }
  152648. declare module BABYLON {
  152649. /** @hidden */
  152650. export var outlinePixelShader: {
  152651. name: string;
  152652. shader: string;
  152653. };
  152654. }
  152655. declare module BABYLON {
  152656. /** @hidden */
  152657. export var outlineVertexShader: {
  152658. name: string;
  152659. shader: string;
  152660. };
  152661. }
  152662. declare module BABYLON {
  152663. interface Scene {
  152664. /** @hidden */
  152665. _outlineRenderer: OutlineRenderer;
  152666. /**
  152667. * Gets the outline renderer associated with the scene
  152668. * @returns a OutlineRenderer
  152669. */
  152670. getOutlineRenderer(): OutlineRenderer;
  152671. }
  152672. interface AbstractMesh {
  152673. /** @hidden (Backing field) */
  152674. _renderOutline: boolean;
  152675. /**
  152676. * Gets or sets a boolean indicating if the outline must be rendered as well
  152677. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  152678. */
  152679. renderOutline: boolean;
  152680. /** @hidden (Backing field) */
  152681. _renderOverlay: boolean;
  152682. /**
  152683. * Gets or sets a boolean indicating if the overlay must be rendered as well
  152684. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  152685. */
  152686. renderOverlay: boolean;
  152687. }
  152688. /**
  152689. * This class is responsible to draw bothe outline/overlay of meshes.
  152690. * It should not be used directly but through the available method on mesh.
  152691. */
  152692. export class OutlineRenderer implements ISceneComponent {
  152693. /**
  152694. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  152695. */
  152696. private static _StencilReference;
  152697. /**
  152698. * The name of the component. Each component must have a unique name.
  152699. */
  152700. name: string;
  152701. /**
  152702. * The scene the component belongs to.
  152703. */
  152704. scene: Scene;
  152705. /**
  152706. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  152707. */
  152708. zOffset: number;
  152709. private _engine;
  152710. private _effect;
  152711. private _cachedDefines;
  152712. private _savedDepthWrite;
  152713. /**
  152714. * Instantiates a new outline renderer. (There could be only one per scene).
  152715. * @param scene Defines the scene it belongs to
  152716. */
  152717. constructor(scene: Scene);
  152718. /**
  152719. * Register the component to one instance of a scene.
  152720. */
  152721. register(): void;
  152722. /**
  152723. * Rebuilds the elements related to this component in case of
  152724. * context lost for instance.
  152725. */
  152726. rebuild(): void;
  152727. /**
  152728. * Disposes the component and the associated ressources.
  152729. */
  152730. dispose(): void;
  152731. /**
  152732. * Renders the outline in the canvas.
  152733. * @param subMesh Defines the sumesh to render
  152734. * @param batch Defines the batch of meshes in case of instances
  152735. * @param useOverlay Defines if the rendering is for the overlay or the outline
  152736. */
  152737. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  152738. /**
  152739. * Returns whether or not the outline renderer is ready for a given submesh.
  152740. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  152741. * @param subMesh Defines the submesh to check readyness for
  152742. * @param useInstances Defines wheter wee are trying to render instances or not
  152743. * @returns true if ready otherwise false
  152744. */
  152745. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  152746. private _beforeRenderingMesh;
  152747. private _afterRenderingMesh;
  152748. }
  152749. }
  152750. declare module BABYLON {
  152751. /**
  152752. * Defines the basic options interface of a Sprite Frame Source Size.
  152753. */
  152754. export interface ISpriteJSONSpriteSourceSize {
  152755. /**
  152756. * number of the original width of the Frame
  152757. */
  152758. w: number;
  152759. /**
  152760. * number of the original height of the Frame
  152761. */
  152762. h: number;
  152763. }
  152764. /**
  152765. * Defines the basic options interface of a Sprite Frame Data.
  152766. */
  152767. export interface ISpriteJSONSpriteFrameData {
  152768. /**
  152769. * number of the x offset of the Frame
  152770. */
  152771. x: number;
  152772. /**
  152773. * number of the y offset of the Frame
  152774. */
  152775. y: number;
  152776. /**
  152777. * number of the width of the Frame
  152778. */
  152779. w: number;
  152780. /**
  152781. * number of the height of the Frame
  152782. */
  152783. h: number;
  152784. }
  152785. /**
  152786. * Defines the basic options interface of a JSON Sprite.
  152787. */
  152788. export interface ISpriteJSONSprite {
  152789. /**
  152790. * string name of the Frame
  152791. */
  152792. filename: string;
  152793. /**
  152794. * ISpriteJSONSpriteFrame basic object of the frame data
  152795. */
  152796. frame: ISpriteJSONSpriteFrameData;
  152797. /**
  152798. * boolean to flag is the frame was rotated.
  152799. */
  152800. rotated: boolean;
  152801. /**
  152802. * boolean to flag is the frame was trimmed.
  152803. */
  152804. trimmed: boolean;
  152805. /**
  152806. * ISpriteJSONSpriteFrame basic object of the source data
  152807. */
  152808. spriteSourceSize: ISpriteJSONSpriteFrameData;
  152809. /**
  152810. * ISpriteJSONSpriteFrame basic object of the source data
  152811. */
  152812. sourceSize: ISpriteJSONSpriteSourceSize;
  152813. }
  152814. /**
  152815. * Defines the basic options interface of a JSON atlas.
  152816. */
  152817. export interface ISpriteJSONAtlas {
  152818. /**
  152819. * Array of objects that contain the frame data.
  152820. */
  152821. frames: Array<ISpriteJSONSprite>;
  152822. /**
  152823. * object basic object containing the sprite meta data.
  152824. */
  152825. meta?: object;
  152826. }
  152827. }
  152828. declare module BABYLON {
  152829. /** @hidden */
  152830. export var spriteMapPixelShader: {
  152831. name: string;
  152832. shader: string;
  152833. };
  152834. }
  152835. declare module BABYLON {
  152836. /** @hidden */
  152837. export var spriteMapVertexShader: {
  152838. name: string;
  152839. shader: string;
  152840. };
  152841. }
  152842. declare module BABYLON {
  152843. /**
  152844. * Defines the basic options interface of a SpriteMap
  152845. */
  152846. export interface ISpriteMapOptions {
  152847. /**
  152848. * Vector2 of the number of cells in the grid.
  152849. */
  152850. stageSize?: Vector2;
  152851. /**
  152852. * Vector2 of the size of the output plane in World Units.
  152853. */
  152854. outputSize?: Vector2;
  152855. /**
  152856. * Vector3 of the position of the output plane in World Units.
  152857. */
  152858. outputPosition?: Vector3;
  152859. /**
  152860. * Vector3 of the rotation of the output plane.
  152861. */
  152862. outputRotation?: Vector3;
  152863. /**
  152864. * number of layers that the system will reserve in resources.
  152865. */
  152866. layerCount?: number;
  152867. /**
  152868. * number of max animation frames a single cell will reserve in resources.
  152869. */
  152870. maxAnimationFrames?: number;
  152871. /**
  152872. * number cell index of the base tile when the system compiles.
  152873. */
  152874. baseTile?: number;
  152875. /**
  152876. * boolean flip the sprite after its been repositioned by the framing data.
  152877. */
  152878. flipU?: boolean;
  152879. /**
  152880. * Vector3 scalar of the global RGB values of the SpriteMap.
  152881. */
  152882. colorMultiply?: Vector3;
  152883. }
  152884. /**
  152885. * Defines the IDisposable interface in order to be cleanable from resources.
  152886. */
  152887. export interface ISpriteMap extends IDisposable {
  152888. /**
  152889. * String name of the SpriteMap.
  152890. */
  152891. name: string;
  152892. /**
  152893. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  152894. */
  152895. atlasJSON: ISpriteJSONAtlas;
  152896. /**
  152897. * Texture of the SpriteMap.
  152898. */
  152899. spriteSheet: Texture;
  152900. /**
  152901. * The parameters to initialize the SpriteMap with.
  152902. */
  152903. options: ISpriteMapOptions;
  152904. }
  152905. /**
  152906. * Class used to manage a grid restricted sprite deployment on an Output plane.
  152907. */
  152908. export class SpriteMap implements ISpriteMap {
  152909. /** The Name of the spriteMap */
  152910. name: string;
  152911. /** The JSON file with the frame and meta data */
  152912. atlasJSON: ISpriteJSONAtlas;
  152913. /** The systems Sprite Sheet Texture */
  152914. spriteSheet: Texture;
  152915. /** Arguments passed with the Constructor */
  152916. options: ISpriteMapOptions;
  152917. /** Public Sprite Storage array, parsed from atlasJSON */
  152918. sprites: Array<ISpriteJSONSprite>;
  152919. /** Returns the Number of Sprites in the System */
  152920. get spriteCount(): number;
  152921. /** Returns the Position of Output Plane*/
  152922. get position(): Vector3;
  152923. /** Returns the Position of Output Plane*/
  152924. set position(v: Vector3);
  152925. /** Returns the Rotation of Output Plane*/
  152926. get rotation(): Vector3;
  152927. /** Returns the Rotation of Output Plane*/
  152928. set rotation(v: Vector3);
  152929. /** Sets the AnimationMap*/
  152930. get animationMap(): RawTexture;
  152931. /** Sets the AnimationMap*/
  152932. set animationMap(v: RawTexture);
  152933. /** Scene that the SpriteMap was created in */
  152934. private _scene;
  152935. /** Texture Buffer of Float32 that holds tile frame data*/
  152936. private _frameMap;
  152937. /** Texture Buffers of Float32 that holds tileMap data*/
  152938. private _tileMaps;
  152939. /** Texture Buffer of Float32 that holds Animation Data*/
  152940. private _animationMap;
  152941. /** Custom ShaderMaterial Central to the System*/
  152942. private _material;
  152943. /** Custom ShaderMaterial Central to the System*/
  152944. private _output;
  152945. /** Systems Time Ticker*/
  152946. private _time;
  152947. /**
  152948. * Creates a new SpriteMap
  152949. * @param name defines the SpriteMaps Name
  152950. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  152951. * @param spriteSheet is the Texture that the Sprites are on.
  152952. * @param options a basic deployment configuration
  152953. * @param scene The Scene that the map is deployed on
  152954. */
  152955. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  152956. /**
  152957. * Returns tileID location
  152958. * @returns Vector2 the cell position ID
  152959. */
  152960. getTileID(): Vector2;
  152961. /**
  152962. * Gets the UV location of the mouse over the SpriteMap.
  152963. * @returns Vector2 the UV position of the mouse interaction
  152964. */
  152965. getMousePosition(): Vector2;
  152966. /**
  152967. * Creates the "frame" texture Buffer
  152968. * -------------------------------------
  152969. * Structure of frames
  152970. * "filename": "Falling-Water-2.png",
  152971. * "frame": {"x":69,"y":103,"w":24,"h":32},
  152972. * "rotated": true,
  152973. * "trimmed": true,
  152974. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  152975. * "sourceSize": {"w":32,"h":32}
  152976. * @returns RawTexture of the frameMap
  152977. */
  152978. private _createFrameBuffer;
  152979. /**
  152980. * Creates the tileMap texture Buffer
  152981. * @param buffer normally and array of numbers, or a false to generate from scratch
  152982. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  152983. * @returns RawTexture of the tileMap
  152984. */
  152985. private _createTileBuffer;
  152986. /**
  152987. * Modifies the data of the tileMaps
  152988. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  152989. * @param pos is the iVector2 Coordinates of the Tile
  152990. * @param tile The SpriteIndex of the new Tile
  152991. */
  152992. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  152993. /**
  152994. * Creates the animationMap texture Buffer
  152995. * @param buffer normally and array of numbers, or a false to generate from scratch
  152996. * @returns RawTexture of the animationMap
  152997. */
  152998. private _createTileAnimationBuffer;
  152999. /**
  153000. * Modifies the data of the animationMap
  153001. * @param cellID is the Index of the Sprite
  153002. * @param _frame is the target Animation frame
  153003. * @param toCell is the Target Index of the next frame of the animation
  153004. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  153005. * @param speed is a global scalar of the time variable on the map.
  153006. */
  153007. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  153008. /**
  153009. * Exports the .tilemaps file
  153010. */
  153011. saveTileMaps(): void;
  153012. /**
  153013. * Imports the .tilemaps file
  153014. * @param url of the .tilemaps file
  153015. */
  153016. loadTileMaps(url: string): void;
  153017. /**
  153018. * Release associated resources
  153019. */
  153020. dispose(): void;
  153021. }
  153022. }
  153023. declare module BABYLON {
  153024. /**
  153025. * Class used to manage multiple sprites of different sizes on the same spritesheet
  153026. * @see https://doc.babylonjs.com/babylon101/sprites
  153027. */
  153028. export class SpritePackedManager extends SpriteManager {
  153029. /** defines the packed manager's name */
  153030. name: string;
  153031. /**
  153032. * Creates a new sprite manager from a packed sprite sheet
  153033. * @param name defines the manager's name
  153034. * @param imgUrl defines the sprite sheet url
  153035. * @param capacity defines the maximum allowed number of sprites
  153036. * @param scene defines the hosting scene
  153037. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  153038. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  153039. * @param samplingMode defines the smapling mode to use with spritesheet
  153040. * @param fromPacked set to true; do not alter
  153041. */
  153042. constructor(
  153043. /** defines the packed manager's name */
  153044. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  153045. }
  153046. }
  153047. declare module BABYLON {
  153048. /**
  153049. * Defines the list of states available for a task inside a AssetsManager
  153050. */
  153051. export enum AssetTaskState {
  153052. /**
  153053. * Initialization
  153054. */
  153055. INIT = 0,
  153056. /**
  153057. * Running
  153058. */
  153059. RUNNING = 1,
  153060. /**
  153061. * Done
  153062. */
  153063. DONE = 2,
  153064. /**
  153065. * Error
  153066. */
  153067. ERROR = 3
  153068. }
  153069. /**
  153070. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  153071. */
  153072. export abstract class AbstractAssetTask {
  153073. /**
  153074. * Task name
  153075. */ name: string;
  153076. /**
  153077. * Callback called when the task is successful
  153078. */
  153079. onSuccess: (task: any) => void;
  153080. /**
  153081. * Callback called when the task is not successful
  153082. */
  153083. onError: (task: any, message?: string, exception?: any) => void;
  153084. /**
  153085. * Creates a new AssetsManager
  153086. * @param name defines the name of the task
  153087. */
  153088. constructor(
  153089. /**
  153090. * Task name
  153091. */ name: string);
  153092. private _isCompleted;
  153093. private _taskState;
  153094. private _errorObject;
  153095. /**
  153096. * Get if the task is completed
  153097. */
  153098. get isCompleted(): boolean;
  153099. /**
  153100. * Gets the current state of the task
  153101. */
  153102. get taskState(): AssetTaskState;
  153103. /**
  153104. * Gets the current error object (if task is in error)
  153105. */
  153106. get errorObject(): {
  153107. message?: string;
  153108. exception?: any;
  153109. };
  153110. /**
  153111. * Internal only
  153112. * @hidden
  153113. */
  153114. _setErrorObject(message?: string, exception?: any): void;
  153115. /**
  153116. * Execute the current task
  153117. * @param scene defines the scene where you want your assets to be loaded
  153118. * @param onSuccess is a callback called when the task is successfully executed
  153119. * @param onError is a callback called if an error occurs
  153120. */
  153121. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153122. /**
  153123. * Execute the current task
  153124. * @param scene defines the scene where you want your assets to be loaded
  153125. * @param onSuccess is a callback called when the task is successfully executed
  153126. * @param onError is a callback called if an error occurs
  153127. */
  153128. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153129. /**
  153130. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  153131. * This can be used with failed tasks that have the reason for failure fixed.
  153132. */
  153133. reset(): void;
  153134. private onErrorCallback;
  153135. private onDoneCallback;
  153136. }
  153137. /**
  153138. * Define the interface used by progress events raised during assets loading
  153139. */
  153140. export interface IAssetsProgressEvent {
  153141. /**
  153142. * Defines the number of remaining tasks to process
  153143. */
  153144. remainingCount: number;
  153145. /**
  153146. * Defines the total number of tasks
  153147. */
  153148. totalCount: number;
  153149. /**
  153150. * Defines the task that was just processed
  153151. */
  153152. task: AbstractAssetTask;
  153153. }
  153154. /**
  153155. * Class used to share progress information about assets loading
  153156. */
  153157. export class AssetsProgressEvent implements IAssetsProgressEvent {
  153158. /**
  153159. * Defines the number of remaining tasks to process
  153160. */
  153161. remainingCount: number;
  153162. /**
  153163. * Defines the total number of tasks
  153164. */
  153165. totalCount: number;
  153166. /**
  153167. * Defines the task that was just processed
  153168. */
  153169. task: AbstractAssetTask;
  153170. /**
  153171. * Creates a AssetsProgressEvent
  153172. * @param remainingCount defines the number of remaining tasks to process
  153173. * @param totalCount defines the total number of tasks
  153174. * @param task defines the task that was just processed
  153175. */
  153176. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  153177. }
  153178. /**
  153179. * Define a task used by AssetsManager to load assets into a container
  153180. */
  153181. export class ContainerAssetTask extends AbstractAssetTask {
  153182. /**
  153183. * Defines the name of the task
  153184. */
  153185. name: string;
  153186. /**
  153187. * Defines the list of mesh's names you want to load
  153188. */
  153189. meshesNames: any;
  153190. /**
  153191. * Defines the root url to use as a base to load your meshes and associated resources
  153192. */
  153193. rootUrl: string;
  153194. /**
  153195. * Defines the filename or File of the scene to load from
  153196. */
  153197. sceneFilename: string | File;
  153198. /**
  153199. * Get the loaded asset container
  153200. */
  153201. loadedContainer: AssetContainer;
  153202. /**
  153203. * Gets the list of loaded meshes
  153204. */
  153205. loadedMeshes: Array<AbstractMesh>;
  153206. /**
  153207. * Gets the list of loaded particle systems
  153208. */
  153209. loadedParticleSystems: Array<IParticleSystem>;
  153210. /**
  153211. * Gets the list of loaded skeletons
  153212. */
  153213. loadedSkeletons: Array<Skeleton>;
  153214. /**
  153215. * Gets the list of loaded animation groups
  153216. */
  153217. loadedAnimationGroups: Array<AnimationGroup>;
  153218. /**
  153219. * Callback called when the task is successful
  153220. */
  153221. onSuccess: (task: ContainerAssetTask) => void;
  153222. /**
  153223. * Callback called when the task is successful
  153224. */
  153225. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  153226. /**
  153227. * Creates a new ContainerAssetTask
  153228. * @param name defines the name of the task
  153229. * @param meshesNames defines the list of mesh's names you want to load
  153230. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  153231. * @param sceneFilename defines the filename or File of the scene to load from
  153232. */
  153233. constructor(
  153234. /**
  153235. * Defines the name of the task
  153236. */
  153237. name: string,
  153238. /**
  153239. * Defines the list of mesh's names you want to load
  153240. */
  153241. meshesNames: any,
  153242. /**
  153243. * Defines the root url to use as a base to load your meshes and associated resources
  153244. */
  153245. rootUrl: string,
  153246. /**
  153247. * Defines the filename or File of the scene to load from
  153248. */
  153249. sceneFilename: string | File);
  153250. /**
  153251. * Execute the current task
  153252. * @param scene defines the scene where you want your assets to be loaded
  153253. * @param onSuccess is a callback called when the task is successfully executed
  153254. * @param onError is a callback called if an error occurs
  153255. */
  153256. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153257. }
  153258. /**
  153259. * Define a task used by AssetsManager to load meshes
  153260. */
  153261. export class MeshAssetTask extends AbstractAssetTask {
  153262. /**
  153263. * Defines the name of the task
  153264. */
  153265. name: string;
  153266. /**
  153267. * Defines the list of mesh's names you want to load
  153268. */
  153269. meshesNames: any;
  153270. /**
  153271. * Defines the root url to use as a base to load your meshes and associated resources
  153272. */
  153273. rootUrl: string;
  153274. /**
  153275. * Defines the filename or File of the scene to load from
  153276. */
  153277. sceneFilename: string | File;
  153278. /**
  153279. * Gets the list of loaded meshes
  153280. */
  153281. loadedMeshes: Array<AbstractMesh>;
  153282. /**
  153283. * Gets the list of loaded particle systems
  153284. */
  153285. loadedParticleSystems: Array<IParticleSystem>;
  153286. /**
  153287. * Gets the list of loaded skeletons
  153288. */
  153289. loadedSkeletons: Array<Skeleton>;
  153290. /**
  153291. * Gets the list of loaded animation groups
  153292. */
  153293. loadedAnimationGroups: Array<AnimationGroup>;
  153294. /**
  153295. * Callback called when the task is successful
  153296. */
  153297. onSuccess: (task: MeshAssetTask) => void;
  153298. /**
  153299. * Callback called when the task is successful
  153300. */
  153301. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  153302. /**
  153303. * Creates a new MeshAssetTask
  153304. * @param name defines the name of the task
  153305. * @param meshesNames defines the list of mesh's names you want to load
  153306. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  153307. * @param sceneFilename defines the filename or File of the scene to load from
  153308. */
  153309. constructor(
  153310. /**
  153311. * Defines the name of the task
  153312. */
  153313. name: string,
  153314. /**
  153315. * Defines the list of mesh's names you want to load
  153316. */
  153317. meshesNames: any,
  153318. /**
  153319. * Defines the root url to use as a base to load your meshes and associated resources
  153320. */
  153321. rootUrl: string,
  153322. /**
  153323. * Defines the filename or File of the scene to load from
  153324. */
  153325. sceneFilename: string | File);
  153326. /**
  153327. * Execute the current task
  153328. * @param scene defines the scene where you want your assets to be loaded
  153329. * @param onSuccess is a callback called when the task is successfully executed
  153330. * @param onError is a callback called if an error occurs
  153331. */
  153332. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153333. }
  153334. /**
  153335. * Define a task used by AssetsManager to load text content
  153336. */
  153337. export class TextFileAssetTask extends AbstractAssetTask {
  153338. /**
  153339. * Defines the name of the task
  153340. */
  153341. name: string;
  153342. /**
  153343. * Defines the location of the file to load
  153344. */
  153345. url: string;
  153346. /**
  153347. * Gets the loaded text string
  153348. */
  153349. text: string;
  153350. /**
  153351. * Callback called when the task is successful
  153352. */
  153353. onSuccess: (task: TextFileAssetTask) => void;
  153354. /**
  153355. * Callback called when the task is successful
  153356. */
  153357. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  153358. /**
  153359. * Creates a new TextFileAssetTask object
  153360. * @param name defines the name of the task
  153361. * @param url defines the location of the file to load
  153362. */
  153363. constructor(
  153364. /**
  153365. * Defines the name of the task
  153366. */
  153367. name: string,
  153368. /**
  153369. * Defines the location of the file to load
  153370. */
  153371. url: string);
  153372. /**
  153373. * Execute the current task
  153374. * @param scene defines the scene where you want your assets to be loaded
  153375. * @param onSuccess is a callback called when the task is successfully executed
  153376. * @param onError is a callback called if an error occurs
  153377. */
  153378. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153379. }
  153380. /**
  153381. * Define a task used by AssetsManager to load binary data
  153382. */
  153383. export class BinaryFileAssetTask extends AbstractAssetTask {
  153384. /**
  153385. * Defines the name of the task
  153386. */
  153387. name: string;
  153388. /**
  153389. * Defines the location of the file to load
  153390. */
  153391. url: string;
  153392. /**
  153393. * Gets the lodaded data (as an array buffer)
  153394. */
  153395. data: ArrayBuffer;
  153396. /**
  153397. * Callback called when the task is successful
  153398. */
  153399. onSuccess: (task: BinaryFileAssetTask) => void;
  153400. /**
  153401. * Callback called when the task is successful
  153402. */
  153403. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  153404. /**
  153405. * Creates a new BinaryFileAssetTask object
  153406. * @param name defines the name of the new task
  153407. * @param url defines the location of the file to load
  153408. */
  153409. constructor(
  153410. /**
  153411. * Defines the name of the task
  153412. */
  153413. name: string,
  153414. /**
  153415. * Defines the location of the file to load
  153416. */
  153417. url: string);
  153418. /**
  153419. * Execute the current task
  153420. * @param scene defines the scene where you want your assets to be loaded
  153421. * @param onSuccess is a callback called when the task is successfully executed
  153422. * @param onError is a callback called if an error occurs
  153423. */
  153424. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153425. }
  153426. /**
  153427. * Define a task used by AssetsManager to load images
  153428. */
  153429. export class ImageAssetTask extends AbstractAssetTask {
  153430. /**
  153431. * Defines the name of the task
  153432. */
  153433. name: string;
  153434. /**
  153435. * Defines the location of the image to load
  153436. */
  153437. url: string;
  153438. /**
  153439. * Gets the loaded images
  153440. */
  153441. image: HTMLImageElement;
  153442. /**
  153443. * Callback called when the task is successful
  153444. */
  153445. onSuccess: (task: ImageAssetTask) => void;
  153446. /**
  153447. * Callback called when the task is successful
  153448. */
  153449. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  153450. /**
  153451. * Creates a new ImageAssetTask
  153452. * @param name defines the name of the task
  153453. * @param url defines the location of the image to load
  153454. */
  153455. constructor(
  153456. /**
  153457. * Defines the name of the task
  153458. */
  153459. name: string,
  153460. /**
  153461. * Defines the location of the image to load
  153462. */
  153463. url: string);
  153464. /**
  153465. * Execute the current task
  153466. * @param scene defines the scene where you want your assets to be loaded
  153467. * @param onSuccess is a callback called when the task is successfully executed
  153468. * @param onError is a callback called if an error occurs
  153469. */
  153470. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153471. }
  153472. /**
  153473. * Defines the interface used by texture loading tasks
  153474. */
  153475. export interface ITextureAssetTask<TEX extends BaseTexture> {
  153476. /**
  153477. * Gets the loaded texture
  153478. */
  153479. texture: TEX;
  153480. }
  153481. /**
  153482. * Define a task used by AssetsManager to load 2D textures
  153483. */
  153484. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  153485. /**
  153486. * Defines the name of the task
  153487. */
  153488. name: string;
  153489. /**
  153490. * Defines the location of the file to load
  153491. */
  153492. url: string;
  153493. /**
  153494. * Defines if mipmap should not be generated (default is false)
  153495. */
  153496. noMipmap?: boolean | undefined;
  153497. /**
  153498. * Defines if texture must be inverted on Y axis (default is true)
  153499. */
  153500. invertY: boolean;
  153501. /**
  153502. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  153503. */
  153504. samplingMode: number;
  153505. /**
  153506. * Gets the loaded texture
  153507. */
  153508. texture: Texture;
  153509. /**
  153510. * Callback called when the task is successful
  153511. */
  153512. onSuccess: (task: TextureAssetTask) => void;
  153513. /**
  153514. * Callback called when the task is successful
  153515. */
  153516. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  153517. /**
  153518. * Creates a new TextureAssetTask object
  153519. * @param name defines the name of the task
  153520. * @param url defines the location of the file to load
  153521. * @param noMipmap defines if mipmap should not be generated (default is false)
  153522. * @param invertY defines if texture must be inverted on Y axis (default is true)
  153523. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  153524. */
  153525. constructor(
  153526. /**
  153527. * Defines the name of the task
  153528. */
  153529. name: string,
  153530. /**
  153531. * Defines the location of the file to load
  153532. */
  153533. url: string,
  153534. /**
  153535. * Defines if mipmap should not be generated (default is false)
  153536. */
  153537. noMipmap?: boolean | undefined,
  153538. /**
  153539. * Defines if texture must be inverted on Y axis (default is true)
  153540. */
  153541. invertY?: boolean,
  153542. /**
  153543. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  153544. */
  153545. samplingMode?: number);
  153546. /**
  153547. * Execute the current task
  153548. * @param scene defines the scene where you want your assets to be loaded
  153549. * @param onSuccess is a callback called when the task is successfully executed
  153550. * @param onError is a callback called if an error occurs
  153551. */
  153552. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153553. }
  153554. /**
  153555. * Define a task used by AssetsManager to load cube textures
  153556. */
  153557. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  153558. /**
  153559. * Defines the name of the task
  153560. */
  153561. name: string;
  153562. /**
  153563. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  153564. */
  153565. url: string;
  153566. /**
  153567. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  153568. */
  153569. extensions?: string[] | undefined;
  153570. /**
  153571. * Defines if mipmaps should not be generated (default is false)
  153572. */
  153573. noMipmap?: boolean | undefined;
  153574. /**
  153575. * Defines the explicit list of files (undefined by default)
  153576. */
  153577. files?: string[] | undefined;
  153578. /**
  153579. * Gets the loaded texture
  153580. */
  153581. texture: CubeTexture;
  153582. /**
  153583. * Callback called when the task is successful
  153584. */
  153585. onSuccess: (task: CubeTextureAssetTask) => void;
  153586. /**
  153587. * Callback called when the task is successful
  153588. */
  153589. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  153590. /**
  153591. * Creates a new CubeTextureAssetTask
  153592. * @param name defines the name of the task
  153593. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  153594. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  153595. * @param noMipmap defines if mipmaps should not be generated (default is false)
  153596. * @param files defines the explicit list of files (undefined by default)
  153597. */
  153598. constructor(
  153599. /**
  153600. * Defines the name of the task
  153601. */
  153602. name: string,
  153603. /**
  153604. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  153605. */
  153606. url: string,
  153607. /**
  153608. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  153609. */
  153610. extensions?: string[] | undefined,
  153611. /**
  153612. * Defines if mipmaps should not be generated (default is false)
  153613. */
  153614. noMipmap?: boolean | undefined,
  153615. /**
  153616. * Defines the explicit list of files (undefined by default)
  153617. */
  153618. files?: string[] | undefined);
  153619. /**
  153620. * Execute the current task
  153621. * @param scene defines the scene where you want your assets to be loaded
  153622. * @param onSuccess is a callback called when the task is successfully executed
  153623. * @param onError is a callback called if an error occurs
  153624. */
  153625. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153626. }
  153627. /**
  153628. * Define a task used by AssetsManager to load HDR cube textures
  153629. */
  153630. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  153631. /**
  153632. * Defines the name of the task
  153633. */
  153634. name: string;
  153635. /**
  153636. * Defines the location of the file to load
  153637. */
  153638. url: string;
  153639. /**
  153640. * Defines the desired size (the more it increases the longer the generation will be)
  153641. */
  153642. size: number;
  153643. /**
  153644. * Defines if mipmaps should not be generated (default is false)
  153645. */
  153646. noMipmap: boolean;
  153647. /**
  153648. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  153649. */
  153650. generateHarmonics: boolean;
  153651. /**
  153652. * 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)
  153653. */
  153654. gammaSpace: boolean;
  153655. /**
  153656. * Internal Use Only
  153657. */
  153658. reserved: boolean;
  153659. /**
  153660. * Gets the loaded texture
  153661. */
  153662. texture: HDRCubeTexture;
  153663. /**
  153664. * Callback called when the task is successful
  153665. */
  153666. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  153667. /**
  153668. * Callback called when the task is successful
  153669. */
  153670. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  153671. /**
  153672. * Creates a new HDRCubeTextureAssetTask object
  153673. * @param name defines the name of the task
  153674. * @param url defines the location of the file to load
  153675. * @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.
  153676. * @param noMipmap defines if mipmaps should not be generated (default is false)
  153677. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  153678. * @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)
  153679. * @param reserved Internal use only
  153680. */
  153681. constructor(
  153682. /**
  153683. * Defines the name of the task
  153684. */
  153685. name: string,
  153686. /**
  153687. * Defines the location of the file to load
  153688. */
  153689. url: string,
  153690. /**
  153691. * Defines the desired size (the more it increases the longer the generation will be)
  153692. */
  153693. size: number,
  153694. /**
  153695. * Defines if mipmaps should not be generated (default is false)
  153696. */
  153697. noMipmap?: boolean,
  153698. /**
  153699. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  153700. */
  153701. generateHarmonics?: boolean,
  153702. /**
  153703. * 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)
  153704. */
  153705. gammaSpace?: boolean,
  153706. /**
  153707. * Internal Use Only
  153708. */
  153709. reserved?: boolean);
  153710. /**
  153711. * Execute the current task
  153712. * @param scene defines the scene where you want your assets to be loaded
  153713. * @param onSuccess is a callback called when the task is successfully executed
  153714. * @param onError is a callback called if an error occurs
  153715. */
  153716. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153717. }
  153718. /**
  153719. * Define a task used by AssetsManager to load Equirectangular cube textures
  153720. */
  153721. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  153722. /**
  153723. * Defines the name of the task
  153724. */
  153725. name: string;
  153726. /**
  153727. * Defines the location of the file to load
  153728. */
  153729. url: string;
  153730. /**
  153731. * Defines the desired size (the more it increases the longer the generation will be)
  153732. */
  153733. size: number;
  153734. /**
  153735. * Defines if mipmaps should not be generated (default is false)
  153736. */
  153737. noMipmap: boolean;
  153738. /**
  153739. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  153740. * but the standard material would require them in Gamma space) (default is true)
  153741. */
  153742. gammaSpace: boolean;
  153743. /**
  153744. * Gets the loaded texture
  153745. */
  153746. texture: EquiRectangularCubeTexture;
  153747. /**
  153748. * Callback called when the task is successful
  153749. */
  153750. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  153751. /**
  153752. * Callback called when the task is successful
  153753. */
  153754. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  153755. /**
  153756. * Creates a new EquiRectangularCubeTextureAssetTask object
  153757. * @param name defines the name of the task
  153758. * @param url defines the location of the file to load
  153759. * @param size defines the desired size (the more it increases the longer the generation will be)
  153760. * If the size is omitted this implies you are using a preprocessed cubemap.
  153761. * @param noMipmap defines if mipmaps should not be generated (default is false)
  153762. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  153763. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  153764. * (default is true)
  153765. */
  153766. constructor(
  153767. /**
  153768. * Defines the name of the task
  153769. */
  153770. name: string,
  153771. /**
  153772. * Defines the location of the file to load
  153773. */
  153774. url: string,
  153775. /**
  153776. * Defines the desired size (the more it increases the longer the generation will be)
  153777. */
  153778. size: number,
  153779. /**
  153780. * Defines if mipmaps should not be generated (default is false)
  153781. */
  153782. noMipmap?: boolean,
  153783. /**
  153784. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  153785. * but the standard material would require them in Gamma space) (default is true)
  153786. */
  153787. gammaSpace?: boolean);
  153788. /**
  153789. * Execute the current task
  153790. * @param scene defines the scene where you want your assets to be loaded
  153791. * @param onSuccess is a callback called when the task is successfully executed
  153792. * @param onError is a callback called if an error occurs
  153793. */
  153794. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153795. }
  153796. /**
  153797. * This class can be used to easily import assets into a scene
  153798. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  153799. */
  153800. export class AssetsManager {
  153801. private _scene;
  153802. private _isLoading;
  153803. protected _tasks: AbstractAssetTask[];
  153804. protected _waitingTasksCount: number;
  153805. protected _totalTasksCount: number;
  153806. /**
  153807. * Callback called when all tasks are processed
  153808. */
  153809. onFinish: (tasks: AbstractAssetTask[]) => void;
  153810. /**
  153811. * Callback called when a task is successful
  153812. */
  153813. onTaskSuccess: (task: AbstractAssetTask) => void;
  153814. /**
  153815. * Callback called when a task had an error
  153816. */
  153817. onTaskError: (task: AbstractAssetTask) => void;
  153818. /**
  153819. * Callback called when a task is done (whatever the result is)
  153820. */
  153821. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  153822. /**
  153823. * Observable called when all tasks are processed
  153824. */
  153825. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  153826. /**
  153827. * Observable called when a task had an error
  153828. */
  153829. onTaskErrorObservable: Observable<AbstractAssetTask>;
  153830. /**
  153831. * Observable called when all tasks were executed
  153832. */
  153833. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  153834. /**
  153835. * Observable called when a task is done (whatever the result is)
  153836. */
  153837. onProgressObservable: Observable<IAssetsProgressEvent>;
  153838. /**
  153839. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  153840. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  153841. */
  153842. useDefaultLoadingScreen: boolean;
  153843. /**
  153844. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  153845. * when all assets have been downloaded.
  153846. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  153847. */
  153848. autoHideLoadingUI: boolean;
  153849. /**
  153850. * Creates a new AssetsManager
  153851. * @param scene defines the scene to work on
  153852. */
  153853. constructor(scene: Scene);
  153854. /**
  153855. * Add a ContainerAssetTask to the list of active tasks
  153856. * @param taskName defines the name of the new task
  153857. * @param meshesNames defines the name of meshes to load
  153858. * @param rootUrl defines the root url to use to locate files
  153859. * @param sceneFilename defines the filename of the scene file
  153860. * @returns a new ContainerAssetTask object
  153861. */
  153862. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  153863. /**
  153864. * Add a MeshAssetTask to the list of active tasks
  153865. * @param taskName defines the name of the new task
  153866. * @param meshesNames defines the name of meshes to load
  153867. * @param rootUrl defines the root url to use to locate files
  153868. * @param sceneFilename defines the filename of the scene file
  153869. * @returns a new MeshAssetTask object
  153870. */
  153871. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  153872. /**
  153873. * Add a TextFileAssetTask to the list of active tasks
  153874. * @param taskName defines the name of the new task
  153875. * @param url defines the url of the file to load
  153876. * @returns a new TextFileAssetTask object
  153877. */
  153878. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  153879. /**
  153880. * Add a BinaryFileAssetTask to the list of active tasks
  153881. * @param taskName defines the name of the new task
  153882. * @param url defines the url of the file to load
  153883. * @returns a new BinaryFileAssetTask object
  153884. */
  153885. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  153886. /**
  153887. * Add a ImageAssetTask to the list of active tasks
  153888. * @param taskName defines the name of the new task
  153889. * @param url defines the url of the file to load
  153890. * @returns a new ImageAssetTask object
  153891. */
  153892. addImageTask(taskName: string, url: string): ImageAssetTask;
  153893. /**
  153894. * Add a TextureAssetTask to the list of active tasks
  153895. * @param taskName defines the name of the new task
  153896. * @param url defines the url of the file to load
  153897. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153898. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  153899. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  153900. * @returns a new TextureAssetTask object
  153901. */
  153902. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  153903. /**
  153904. * Add a CubeTextureAssetTask to the list of active tasks
  153905. * @param taskName defines the name of the new task
  153906. * @param url defines the url of the file to load
  153907. * @param extensions defines the extension to use to load the cube map (can be null)
  153908. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153909. * @param files defines the list of files to load (can be null)
  153910. * @returns a new CubeTextureAssetTask object
  153911. */
  153912. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  153913. /**
  153914. *
  153915. * Add a HDRCubeTextureAssetTask to the list of active tasks
  153916. * @param taskName defines the name of the new task
  153917. * @param url defines the url of the file to load
  153918. * @param size defines the size you want for the cubemap (can be null)
  153919. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153920. * @param generateHarmonics defines if you want to automatically generate (true by default)
  153921. * @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)
  153922. * @param reserved Internal use only
  153923. * @returns a new HDRCubeTextureAssetTask object
  153924. */
  153925. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  153926. /**
  153927. *
  153928. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  153929. * @param taskName defines the name of the new task
  153930. * @param url defines the url of the file to load
  153931. * @param size defines the size you want for the cubemap (can be null)
  153932. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153933. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  153934. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  153935. * @returns a new EquiRectangularCubeTextureAssetTask object
  153936. */
  153937. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  153938. /**
  153939. * Remove a task from the assets manager.
  153940. * @param task the task to remove
  153941. */
  153942. removeTask(task: AbstractAssetTask): void;
  153943. private _decreaseWaitingTasksCount;
  153944. private _runTask;
  153945. /**
  153946. * Reset the AssetsManager and remove all tasks
  153947. * @return the current instance of the AssetsManager
  153948. */
  153949. reset(): AssetsManager;
  153950. /**
  153951. * Start the loading process
  153952. * @return the current instance of the AssetsManager
  153953. */
  153954. load(): AssetsManager;
  153955. /**
  153956. * Start the loading process as an async operation
  153957. * @return a promise returning the list of failed tasks
  153958. */
  153959. loadAsync(): Promise<void>;
  153960. }
  153961. }
  153962. declare module BABYLON {
  153963. /**
  153964. * Wrapper class for promise with external resolve and reject.
  153965. */
  153966. export class Deferred<T> {
  153967. /**
  153968. * The promise associated with this deferred object.
  153969. */
  153970. readonly promise: Promise<T>;
  153971. private _resolve;
  153972. private _reject;
  153973. /**
  153974. * The resolve method of the promise associated with this deferred object.
  153975. */
  153976. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  153977. /**
  153978. * The reject method of the promise associated with this deferred object.
  153979. */
  153980. get reject(): (reason?: any) => void;
  153981. /**
  153982. * Constructor for this deferred object.
  153983. */
  153984. constructor();
  153985. }
  153986. }
  153987. declare module BABYLON {
  153988. /**
  153989. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  153990. */
  153991. export class MeshExploder {
  153992. private _centerMesh;
  153993. private _meshes;
  153994. private _meshesOrigins;
  153995. private _toCenterVectors;
  153996. private _scaledDirection;
  153997. private _newPosition;
  153998. private _centerPosition;
  153999. /**
  154000. * Explodes meshes from a center mesh.
  154001. * @param meshes The meshes to explode.
  154002. * @param centerMesh The mesh to be center of explosion.
  154003. */
  154004. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  154005. private _setCenterMesh;
  154006. /**
  154007. * Get class name
  154008. * @returns "MeshExploder"
  154009. */
  154010. getClassName(): string;
  154011. /**
  154012. * "Exploded meshes"
  154013. * @returns Array of meshes with the centerMesh at index 0.
  154014. */
  154015. getMeshes(): Array<Mesh>;
  154016. /**
  154017. * Explodes meshes giving a specific direction
  154018. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  154019. */
  154020. explode(direction?: number): void;
  154021. }
  154022. }
  154023. declare module BABYLON {
  154024. /**
  154025. * Class used to help managing file picking and drag'n'drop
  154026. */
  154027. export class FilesInput {
  154028. /**
  154029. * List of files ready to be loaded
  154030. */
  154031. static get FilesToLoad(): {
  154032. [key: string]: File;
  154033. };
  154034. /**
  154035. * Callback called when a file is processed
  154036. */
  154037. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  154038. private _engine;
  154039. private _currentScene;
  154040. private _sceneLoadedCallback;
  154041. private _progressCallback;
  154042. private _additionalRenderLoopLogicCallback;
  154043. private _textureLoadingCallback;
  154044. private _startingProcessingFilesCallback;
  154045. private _onReloadCallback;
  154046. private _errorCallback;
  154047. private _elementToMonitor;
  154048. private _sceneFileToLoad;
  154049. private _filesToLoad;
  154050. /**
  154051. * Creates a new FilesInput
  154052. * @param engine defines the rendering engine
  154053. * @param scene defines the hosting scene
  154054. * @param sceneLoadedCallback callback called when scene is loaded
  154055. * @param progressCallback callback called to track progress
  154056. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  154057. * @param textureLoadingCallback callback called when a texture is loading
  154058. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  154059. * @param onReloadCallback callback called when a reload is requested
  154060. * @param errorCallback callback call if an error occurs
  154061. */
  154062. 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>);
  154063. private _dragEnterHandler;
  154064. private _dragOverHandler;
  154065. private _dropHandler;
  154066. /**
  154067. * Calls this function to listen to drag'n'drop events on a specific DOM element
  154068. * @param elementToMonitor defines the DOM element to track
  154069. */
  154070. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  154071. /** Gets the current list of files to load */
  154072. get filesToLoad(): File[];
  154073. /**
  154074. * Release all associated resources
  154075. */
  154076. dispose(): void;
  154077. private renderFunction;
  154078. private drag;
  154079. private drop;
  154080. private _traverseFolder;
  154081. private _processFiles;
  154082. /**
  154083. * Load files from a drop event
  154084. * @param event defines the drop event to use as source
  154085. */
  154086. loadFiles(event: any): void;
  154087. private _processReload;
  154088. /**
  154089. * Reload the current scene from the loaded files
  154090. */
  154091. reload(): void;
  154092. }
  154093. }
  154094. declare module BABYLON {
  154095. /**
  154096. * Defines the root class used to create scene optimization to use with SceneOptimizer
  154097. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154098. */
  154099. export class SceneOptimization {
  154100. /**
  154101. * Defines the priority of this optimization (0 by default which means first in the list)
  154102. */
  154103. priority: number;
  154104. /**
  154105. * Gets a string describing the action executed by the current optimization
  154106. * @returns description string
  154107. */
  154108. getDescription(): string;
  154109. /**
  154110. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154111. * @param scene defines the current scene where to apply this optimization
  154112. * @param optimizer defines the current optimizer
  154113. * @returns true if everything that can be done was applied
  154114. */
  154115. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154116. /**
  154117. * Creates the SceneOptimization object
  154118. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154119. * @param desc defines the description associated with the optimization
  154120. */
  154121. constructor(
  154122. /**
  154123. * Defines the priority of this optimization (0 by default which means first in the list)
  154124. */
  154125. priority?: number);
  154126. }
  154127. /**
  154128. * Defines an optimization used to reduce the size of render target textures
  154129. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154130. */
  154131. export class TextureOptimization extends SceneOptimization {
  154132. /**
  154133. * Defines the priority of this optimization (0 by default which means first in the list)
  154134. */
  154135. priority: number;
  154136. /**
  154137. * 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
  154138. */
  154139. maximumSize: number;
  154140. /**
  154141. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  154142. */
  154143. step: number;
  154144. /**
  154145. * Gets a string describing the action executed by the current optimization
  154146. * @returns description string
  154147. */
  154148. getDescription(): string;
  154149. /**
  154150. * Creates the TextureOptimization object
  154151. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154152. * @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
  154153. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  154154. */
  154155. constructor(
  154156. /**
  154157. * Defines the priority of this optimization (0 by default which means first in the list)
  154158. */
  154159. priority?: number,
  154160. /**
  154161. * 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
  154162. */
  154163. maximumSize?: number,
  154164. /**
  154165. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  154166. */
  154167. step?: number);
  154168. /**
  154169. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154170. * @param scene defines the current scene where to apply this optimization
  154171. * @param optimizer defines the current optimizer
  154172. * @returns true if everything that can be done was applied
  154173. */
  154174. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154175. }
  154176. /**
  154177. * Defines an optimization used to increase or decrease the rendering resolution
  154178. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154179. */
  154180. export class HardwareScalingOptimization extends SceneOptimization {
  154181. /**
  154182. * Defines the priority of this optimization (0 by default which means first in the list)
  154183. */
  154184. priority: number;
  154185. /**
  154186. * Defines the maximum scale to use (2 by default)
  154187. */
  154188. maximumScale: number;
  154189. /**
  154190. * Defines the step to use between two passes (0.5 by default)
  154191. */
  154192. step: number;
  154193. private _currentScale;
  154194. private _directionOffset;
  154195. /**
  154196. * Gets a string describing the action executed by the current optimization
  154197. * @return description string
  154198. */
  154199. getDescription(): string;
  154200. /**
  154201. * Creates the HardwareScalingOptimization object
  154202. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154203. * @param maximumScale defines the maximum scale to use (2 by default)
  154204. * @param step defines the step to use between two passes (0.5 by default)
  154205. */
  154206. constructor(
  154207. /**
  154208. * Defines the priority of this optimization (0 by default which means first in the list)
  154209. */
  154210. priority?: number,
  154211. /**
  154212. * Defines the maximum scale to use (2 by default)
  154213. */
  154214. maximumScale?: number,
  154215. /**
  154216. * Defines the step to use between two passes (0.5 by default)
  154217. */
  154218. step?: number);
  154219. /**
  154220. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154221. * @param scene defines the current scene where to apply this optimization
  154222. * @param optimizer defines the current optimizer
  154223. * @returns true if everything that can be done was applied
  154224. */
  154225. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154226. }
  154227. /**
  154228. * Defines an optimization used to remove shadows
  154229. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154230. */
  154231. export class ShadowsOptimization extends SceneOptimization {
  154232. /**
  154233. * Gets a string describing the action executed by the current optimization
  154234. * @return description string
  154235. */
  154236. getDescription(): string;
  154237. /**
  154238. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154239. * @param scene defines the current scene where to apply this optimization
  154240. * @param optimizer defines the current optimizer
  154241. * @returns true if everything that can be done was applied
  154242. */
  154243. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154244. }
  154245. /**
  154246. * Defines an optimization used to turn post-processes off
  154247. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154248. */
  154249. export class PostProcessesOptimization extends SceneOptimization {
  154250. /**
  154251. * Gets a string describing the action executed by the current optimization
  154252. * @return description string
  154253. */
  154254. getDescription(): string;
  154255. /**
  154256. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154257. * @param scene defines the current scene where to apply this optimization
  154258. * @param optimizer defines the current optimizer
  154259. * @returns true if everything that can be done was applied
  154260. */
  154261. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154262. }
  154263. /**
  154264. * Defines an optimization used to turn lens flares off
  154265. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154266. */
  154267. export class LensFlaresOptimization extends SceneOptimization {
  154268. /**
  154269. * Gets a string describing the action executed by the current optimization
  154270. * @return description string
  154271. */
  154272. getDescription(): string;
  154273. /**
  154274. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154275. * @param scene defines the current scene where to apply this optimization
  154276. * @param optimizer defines the current optimizer
  154277. * @returns true if everything that can be done was applied
  154278. */
  154279. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154280. }
  154281. /**
  154282. * Defines an optimization based on user defined callback.
  154283. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154284. */
  154285. export class CustomOptimization extends SceneOptimization {
  154286. /**
  154287. * Callback called to apply the custom optimization.
  154288. */
  154289. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  154290. /**
  154291. * Callback called to get custom description
  154292. */
  154293. onGetDescription: () => string;
  154294. /**
  154295. * Gets a string describing the action executed by the current optimization
  154296. * @returns description string
  154297. */
  154298. getDescription(): string;
  154299. /**
  154300. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154301. * @param scene defines the current scene where to apply this optimization
  154302. * @param optimizer defines the current optimizer
  154303. * @returns true if everything that can be done was applied
  154304. */
  154305. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154306. }
  154307. /**
  154308. * Defines an optimization used to turn particles off
  154309. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154310. */
  154311. export class ParticlesOptimization extends SceneOptimization {
  154312. /**
  154313. * Gets a string describing the action executed by the current optimization
  154314. * @return description string
  154315. */
  154316. getDescription(): string;
  154317. /**
  154318. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154319. * @param scene defines the current scene where to apply this optimization
  154320. * @param optimizer defines the current optimizer
  154321. * @returns true if everything that can be done was applied
  154322. */
  154323. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154324. }
  154325. /**
  154326. * Defines an optimization used to turn render targets off
  154327. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154328. */
  154329. export class RenderTargetsOptimization extends SceneOptimization {
  154330. /**
  154331. * Gets a string describing the action executed by the current optimization
  154332. * @return description string
  154333. */
  154334. getDescription(): string;
  154335. /**
  154336. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154337. * @param scene defines the current scene where to apply this optimization
  154338. * @param optimizer defines the current optimizer
  154339. * @returns true if everything that can be done was applied
  154340. */
  154341. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154342. }
  154343. /**
  154344. * Defines an optimization used to merge meshes with compatible materials
  154345. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154346. */
  154347. export class MergeMeshesOptimization extends SceneOptimization {
  154348. private static _UpdateSelectionTree;
  154349. /**
  154350. * Gets or sets a boolean which defines if optimization octree has to be updated
  154351. */
  154352. static get UpdateSelectionTree(): boolean;
  154353. /**
  154354. * Gets or sets a boolean which defines if optimization octree has to be updated
  154355. */
  154356. static set UpdateSelectionTree(value: boolean);
  154357. /**
  154358. * Gets a string describing the action executed by the current optimization
  154359. * @return description string
  154360. */
  154361. getDescription(): string;
  154362. private _canBeMerged;
  154363. /**
  154364. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154365. * @param scene defines the current scene where to apply this optimization
  154366. * @param optimizer defines the current optimizer
  154367. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  154368. * @returns true if everything that can be done was applied
  154369. */
  154370. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  154371. }
  154372. /**
  154373. * Defines a list of options used by SceneOptimizer
  154374. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154375. */
  154376. export class SceneOptimizerOptions {
  154377. /**
  154378. * Defines the target frame rate to reach (60 by default)
  154379. */
  154380. targetFrameRate: number;
  154381. /**
  154382. * Defines the interval between two checkes (2000ms by default)
  154383. */
  154384. trackerDuration: number;
  154385. /**
  154386. * Gets the list of optimizations to apply
  154387. */
  154388. optimizations: SceneOptimization[];
  154389. /**
  154390. * Creates a new list of options used by SceneOptimizer
  154391. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  154392. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  154393. */
  154394. constructor(
  154395. /**
  154396. * Defines the target frame rate to reach (60 by default)
  154397. */
  154398. targetFrameRate?: number,
  154399. /**
  154400. * Defines the interval between two checkes (2000ms by default)
  154401. */
  154402. trackerDuration?: number);
  154403. /**
  154404. * Add a new optimization
  154405. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  154406. * @returns the current SceneOptimizerOptions
  154407. */
  154408. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  154409. /**
  154410. * Add a new custom optimization
  154411. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  154412. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  154413. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154414. * @returns the current SceneOptimizerOptions
  154415. */
  154416. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  154417. /**
  154418. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  154419. * @param targetFrameRate defines the target frame rate (60 by default)
  154420. * @returns a SceneOptimizerOptions object
  154421. */
  154422. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  154423. /**
  154424. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  154425. * @param targetFrameRate defines the target frame rate (60 by default)
  154426. * @returns a SceneOptimizerOptions object
  154427. */
  154428. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  154429. /**
  154430. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  154431. * @param targetFrameRate defines the target frame rate (60 by default)
  154432. * @returns a SceneOptimizerOptions object
  154433. */
  154434. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  154435. }
  154436. /**
  154437. * Class used to run optimizations in order to reach a target frame rate
  154438. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154439. */
  154440. export class SceneOptimizer implements IDisposable {
  154441. private _isRunning;
  154442. private _options;
  154443. private _scene;
  154444. private _currentPriorityLevel;
  154445. private _targetFrameRate;
  154446. private _trackerDuration;
  154447. private _currentFrameRate;
  154448. private _sceneDisposeObserver;
  154449. private _improvementMode;
  154450. /**
  154451. * Defines an observable called when the optimizer reaches the target frame rate
  154452. */
  154453. onSuccessObservable: Observable<SceneOptimizer>;
  154454. /**
  154455. * Defines an observable called when the optimizer enables an optimization
  154456. */
  154457. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  154458. /**
  154459. * Defines an observable called when the optimizer is not able to reach the target frame rate
  154460. */
  154461. onFailureObservable: Observable<SceneOptimizer>;
  154462. /**
  154463. * Gets a boolean indicating if the optimizer is in improvement mode
  154464. */
  154465. get isInImprovementMode(): boolean;
  154466. /**
  154467. * Gets the current priority level (0 at start)
  154468. */
  154469. get currentPriorityLevel(): number;
  154470. /**
  154471. * Gets the current frame rate checked by the SceneOptimizer
  154472. */
  154473. get currentFrameRate(): number;
  154474. /**
  154475. * Gets or sets the current target frame rate (60 by default)
  154476. */
  154477. get targetFrameRate(): number;
  154478. /**
  154479. * Gets or sets the current target frame rate (60 by default)
  154480. */
  154481. set targetFrameRate(value: number);
  154482. /**
  154483. * Gets or sets the current interval between two checks (every 2000ms by default)
  154484. */
  154485. get trackerDuration(): number;
  154486. /**
  154487. * Gets or sets the current interval between two checks (every 2000ms by default)
  154488. */
  154489. set trackerDuration(value: number);
  154490. /**
  154491. * Gets the list of active optimizations
  154492. */
  154493. get optimizations(): SceneOptimization[];
  154494. /**
  154495. * Creates a new SceneOptimizer
  154496. * @param scene defines the scene to work on
  154497. * @param options defines the options to use with the SceneOptimizer
  154498. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  154499. * @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)
  154500. */
  154501. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  154502. /**
  154503. * Stops the current optimizer
  154504. */
  154505. stop(): void;
  154506. /**
  154507. * Reset the optimizer to initial step (current priority level = 0)
  154508. */
  154509. reset(): void;
  154510. /**
  154511. * Start the optimizer. By default it will try to reach a specific framerate
  154512. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  154513. */
  154514. start(): void;
  154515. private _checkCurrentState;
  154516. /**
  154517. * Release all resources
  154518. */
  154519. dispose(): void;
  154520. /**
  154521. * Helper function to create a SceneOptimizer with one single line of code
  154522. * @param scene defines the scene to work on
  154523. * @param options defines the options to use with the SceneOptimizer
  154524. * @param onSuccess defines a callback to call on success
  154525. * @param onFailure defines a callback to call on failure
  154526. * @returns the new SceneOptimizer object
  154527. */
  154528. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  154529. }
  154530. }
  154531. declare module BABYLON {
  154532. /**
  154533. * Class used to serialize a scene into a string
  154534. */
  154535. export class SceneSerializer {
  154536. /**
  154537. * Clear cache used by a previous serialization
  154538. */
  154539. static ClearCache(): void;
  154540. /**
  154541. * Serialize a scene into a JSON compatible object
  154542. * @param scene defines the scene to serialize
  154543. * @returns a JSON compatible object
  154544. */
  154545. static Serialize(scene: Scene): any;
  154546. /**
  154547. * Serialize a mesh into a JSON compatible object
  154548. * @param toSerialize defines the mesh to serialize
  154549. * @param withParents defines if parents must be serialized as well
  154550. * @param withChildren defines if children must be serialized as well
  154551. * @returns a JSON compatible object
  154552. */
  154553. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  154554. }
  154555. }
  154556. declare module BABYLON {
  154557. /**
  154558. * Class used to host texture specific utilities
  154559. */
  154560. export class TextureTools {
  154561. /**
  154562. * Uses the GPU to create a copy texture rescaled at a given size
  154563. * @param texture Texture to copy from
  154564. * @param width defines the desired width
  154565. * @param height defines the desired height
  154566. * @param useBilinearMode defines if bilinear mode has to be used
  154567. * @return the generated texture
  154568. */
  154569. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  154570. }
  154571. }
  154572. declare module BABYLON {
  154573. /**
  154574. * This represents the different options available for the video capture.
  154575. */
  154576. export interface VideoRecorderOptions {
  154577. /** Defines the mime type of the video. */
  154578. mimeType: string;
  154579. /** Defines the FPS the video should be recorded at. */
  154580. fps: number;
  154581. /** Defines the chunk size for the recording data. */
  154582. recordChunckSize: number;
  154583. /** The audio tracks to attach to the recording. */
  154584. audioTracks?: MediaStreamTrack[];
  154585. }
  154586. /**
  154587. * This can help with recording videos from BabylonJS.
  154588. * This is based on the available WebRTC functionalities of the browser.
  154589. *
  154590. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  154591. */
  154592. export class VideoRecorder {
  154593. private static readonly _defaultOptions;
  154594. /**
  154595. * Returns whether or not the VideoRecorder is available in your browser.
  154596. * @param engine Defines the Babylon Engine.
  154597. * @returns true if supported otherwise false.
  154598. */
  154599. static IsSupported(engine: Engine): boolean;
  154600. private readonly _options;
  154601. private _canvas;
  154602. private _mediaRecorder;
  154603. private _recordedChunks;
  154604. private _fileName;
  154605. private _resolve;
  154606. private _reject;
  154607. /**
  154608. * True when a recording is already in progress.
  154609. */
  154610. get isRecording(): boolean;
  154611. /**
  154612. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  154613. * @param engine Defines the BabylonJS Engine you wish to record.
  154614. * @param options Defines options that can be used to customize the capture.
  154615. */
  154616. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  154617. /**
  154618. * Stops the current recording before the default capture timeout passed in the startRecording function.
  154619. */
  154620. stopRecording(): void;
  154621. /**
  154622. * Starts recording the canvas for a max duration specified in parameters.
  154623. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  154624. * If null no automatic download will start and you can rely on the promise to get the data back.
  154625. * @param maxDuration Defines the maximum recording time in seconds.
  154626. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  154627. * @return A promise callback at the end of the recording with the video data in Blob.
  154628. */
  154629. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  154630. /**
  154631. * Releases internal resources used during the recording.
  154632. */
  154633. dispose(): void;
  154634. private _handleDataAvailable;
  154635. private _handleError;
  154636. private _handleStop;
  154637. }
  154638. }
  154639. declare module BABYLON {
  154640. /**
  154641. * Class containing a set of static utilities functions for screenshots
  154642. */
  154643. export class ScreenshotTools {
  154644. /**
  154645. * Captures a screenshot of the current rendering
  154646. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154647. * @param engine defines the rendering engine
  154648. * @param camera defines the source camera
  154649. * @param size This parameter can be set to a single number or to an object with the
  154650. * following (optional) properties: precision, width, height. If a single number is passed,
  154651. * it will be used for both width and height. If an object is passed, the screenshot size
  154652. * will be derived from the parameters. The precision property is a multiplier allowing
  154653. * rendering at a higher or lower resolution
  154654. * @param successCallback defines the callback receives a single parameter which contains the
  154655. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  154656. * src parameter of an <img> to display it
  154657. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  154658. * Check your browser for supported MIME types
  154659. */
  154660. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  154661. /**
  154662. * Captures a screenshot of the current rendering
  154663. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154664. * @param engine defines the rendering engine
  154665. * @param camera defines the source camera
  154666. * @param size This parameter can be set to a single number or to an object with the
  154667. * following (optional) properties: precision, width, height. If a single number is passed,
  154668. * it will be used for both width and height. If an object is passed, the screenshot size
  154669. * will be derived from the parameters. The precision property is a multiplier allowing
  154670. * rendering at a higher or lower resolution
  154671. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  154672. * Check your browser for supported MIME types
  154673. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  154674. * to the src parameter of an <img> to display it
  154675. */
  154676. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  154677. /**
  154678. * Generates an image screenshot from the specified camera.
  154679. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154680. * @param engine The engine to use for rendering
  154681. * @param camera The camera to use for rendering
  154682. * @param size This parameter can be set to a single number or to an object with the
  154683. * following (optional) properties: precision, width, height. If a single number is passed,
  154684. * it will be used for both width and height. If an object is passed, the screenshot size
  154685. * will be derived from the parameters. The precision property is a multiplier allowing
  154686. * rendering at a higher or lower resolution
  154687. * @param successCallback The callback receives a single parameter which contains the
  154688. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  154689. * src parameter of an <img> to display it
  154690. * @param mimeType The MIME type of the screenshot image (default: image/png).
  154691. * Check your browser for supported MIME types
  154692. * @param samples Texture samples (default: 1)
  154693. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  154694. * @param fileName A name for for the downloaded file.
  154695. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  154696. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  154697. */
  154698. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  154699. /**
  154700. * Generates an image screenshot from the specified camera.
  154701. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154702. * @param engine The engine to use for rendering
  154703. * @param camera The camera to use for rendering
  154704. * @param size This parameter can be set to a single number or to an object with the
  154705. * following (optional) properties: precision, width, height. If a single number is passed,
  154706. * it will be used for both width and height. If an object is passed, the screenshot size
  154707. * will be derived from the parameters. The precision property is a multiplier allowing
  154708. * rendering at a higher or lower resolution
  154709. * @param mimeType The MIME type of the screenshot image (default: image/png).
  154710. * Check your browser for supported MIME types
  154711. * @param samples Texture samples (default: 1)
  154712. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  154713. * @param fileName A name for for the downloaded file.
  154714. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  154715. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  154716. * to the src parameter of an <img> to display it
  154717. */
  154718. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  154719. /**
  154720. * Gets height and width for screenshot size
  154721. * @private
  154722. */
  154723. private static _getScreenshotSize;
  154724. }
  154725. }
  154726. declare module BABYLON {
  154727. /**
  154728. * Interface for a data buffer
  154729. */
  154730. export interface IDataBuffer {
  154731. /**
  154732. * Reads bytes from the data buffer.
  154733. * @param byteOffset The byte offset to read
  154734. * @param byteLength The byte length to read
  154735. * @returns A promise that resolves when the bytes are read
  154736. */
  154737. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  154738. /**
  154739. * The byte length of the buffer.
  154740. */
  154741. readonly byteLength: number;
  154742. }
  154743. /**
  154744. * Utility class for reading from a data buffer
  154745. */
  154746. export class DataReader {
  154747. /**
  154748. * The data buffer associated with this data reader.
  154749. */
  154750. readonly buffer: IDataBuffer;
  154751. /**
  154752. * The current byte offset from the beginning of the data buffer.
  154753. */
  154754. byteOffset: number;
  154755. private _dataView;
  154756. private _dataByteOffset;
  154757. /**
  154758. * Constructor
  154759. * @param buffer The buffer to read
  154760. */
  154761. constructor(buffer: IDataBuffer);
  154762. /**
  154763. * Loads the given byte length.
  154764. * @param byteLength The byte length to load
  154765. * @returns A promise that resolves when the load is complete
  154766. */
  154767. loadAsync(byteLength: number): Promise<void>;
  154768. /**
  154769. * Read a unsigned 32-bit integer from the currently loaded data range.
  154770. * @returns The 32-bit integer read
  154771. */
  154772. readUint32(): number;
  154773. /**
  154774. * Read a byte array from the currently loaded data range.
  154775. * @param byteLength The byte length to read
  154776. * @returns The byte array read
  154777. */
  154778. readUint8Array(byteLength: number): Uint8Array;
  154779. /**
  154780. * Read a string from the currently loaded data range.
  154781. * @param byteLength The byte length to read
  154782. * @returns The string read
  154783. */
  154784. readString(byteLength: number): string;
  154785. /**
  154786. * Skips the given byte length the currently loaded data range.
  154787. * @param byteLength The byte length to skip
  154788. */
  154789. skipBytes(byteLength: number): void;
  154790. }
  154791. }
  154792. declare module BABYLON {
  154793. /**
  154794. * Class for storing data to local storage if available or in-memory storage otherwise
  154795. */
  154796. export class DataStorage {
  154797. private static _Storage;
  154798. private static _GetStorage;
  154799. /**
  154800. * Reads a string from the data storage
  154801. * @param key The key to read
  154802. * @param defaultValue The value if the key doesn't exist
  154803. * @returns The string value
  154804. */
  154805. static ReadString(key: string, defaultValue: string): string;
  154806. /**
  154807. * Writes a string to the data storage
  154808. * @param key The key to write
  154809. * @param value The value to write
  154810. */
  154811. static WriteString(key: string, value: string): void;
  154812. /**
  154813. * Reads a boolean from the data storage
  154814. * @param key The key to read
  154815. * @param defaultValue The value if the key doesn't exist
  154816. * @returns The boolean value
  154817. */
  154818. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  154819. /**
  154820. * Writes a boolean to the data storage
  154821. * @param key The key to write
  154822. * @param value The value to write
  154823. */
  154824. static WriteBoolean(key: string, value: boolean): void;
  154825. /**
  154826. * Reads a number from the data storage
  154827. * @param key The key to read
  154828. * @param defaultValue The value if the key doesn't exist
  154829. * @returns The number value
  154830. */
  154831. static ReadNumber(key: string, defaultValue: number): number;
  154832. /**
  154833. * Writes a number to the data storage
  154834. * @param key The key to write
  154835. * @param value The value to write
  154836. */
  154837. static WriteNumber(key: string, value: number): void;
  154838. }
  154839. }
  154840. declare module BABYLON {
  154841. /**
  154842. * Class used to record delta files between 2 scene states
  154843. */
  154844. export class SceneRecorder {
  154845. private _trackedScene;
  154846. private _savedJSON;
  154847. /**
  154848. * Track a given scene. This means the current scene state will be considered the original state
  154849. * @param scene defines the scene to track
  154850. */
  154851. track(scene: Scene): void;
  154852. /**
  154853. * Get the delta between current state and original state
  154854. * @returns a string containing the delta
  154855. */
  154856. getDelta(): any;
  154857. private _compareArray;
  154858. private _compareObjects;
  154859. private _compareCollections;
  154860. private static GetShadowGeneratorById;
  154861. /**
  154862. * Apply a given delta to a given scene
  154863. * @param deltaJSON defines the JSON containing the delta
  154864. * @param scene defines the scene to apply the delta to
  154865. */
  154866. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  154867. private static _ApplyPropertiesToEntity;
  154868. private static _ApplyDeltaForEntity;
  154869. }
  154870. }
  154871. declare module BABYLON {
  154872. /**
  154873. * A 3D trajectory consisting of an order list of vectors describing a
  154874. * path of motion through 3D space.
  154875. */
  154876. export class Trajectory {
  154877. private _points;
  154878. private readonly _segmentLength;
  154879. /**
  154880. * Serialize to JSON.
  154881. * @returns serialized JSON string
  154882. */
  154883. serialize(): string;
  154884. /**
  154885. * Deserialize from JSON.
  154886. * @param json serialized JSON string
  154887. * @returns deserialized Trajectory
  154888. */
  154889. static Deserialize(json: string): Trajectory;
  154890. /**
  154891. * Create a new empty Trajectory.
  154892. * @param segmentLength radius of discretization for Trajectory points
  154893. */
  154894. constructor(segmentLength?: number);
  154895. /**
  154896. * Get the length of the Trajectory.
  154897. * @returns length of the Trajectory
  154898. */
  154899. getLength(): number;
  154900. /**
  154901. * Append a new point to the Trajectory.
  154902. * NOTE: This implementation has many allocations.
  154903. * @param point point to append to the Trajectory
  154904. */
  154905. add(point: DeepImmutable<Vector3>): void;
  154906. /**
  154907. * Create a new Trajectory with a segment length chosen to make it
  154908. * probable that the new Trajectory will have a specified number of
  154909. * segments. This operation is imprecise.
  154910. * @param targetResolution number of segments desired
  154911. * @returns new Trajectory with approximately the requested number of segments
  154912. */
  154913. resampleAtTargetResolution(targetResolution: number): Trajectory;
  154914. /**
  154915. * Convert Trajectory segments into tokenized representation. This
  154916. * representation is an array of numbers where each nth number is the
  154917. * index of the token which is most similar to the nth segment of the
  154918. * Trajectory.
  154919. * @param tokens list of vectors which serve as discrete tokens
  154920. * @returns list of indices of most similar token per segment
  154921. */
  154922. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  154923. private static _forwardDir;
  154924. private static _inverseFromVec;
  154925. private static _upDir;
  154926. private static _fromToVec;
  154927. private static _lookMatrix;
  154928. /**
  154929. * Transform the rotation (i.e., direction) of a segment to isolate
  154930. * the relative transformation represented by the segment. This operation
  154931. * may or may not succeed due to singularities in the equations that define
  154932. * motion relativity in this context.
  154933. * @param priorVec the origin of the prior segment
  154934. * @param fromVec the origin of the current segment
  154935. * @param toVec the destination of the current segment
  154936. * @param result reference to output variable
  154937. * @returns whether or not transformation was successful
  154938. */
  154939. private static _transformSegmentDirToRef;
  154940. private static _bestMatch;
  154941. private static _score;
  154942. private static _bestScore;
  154943. /**
  154944. * Determine which token vector is most similar to the
  154945. * segment vector.
  154946. * @param segment segment vector
  154947. * @param tokens token vector list
  154948. * @returns index of the most similar token to the segment
  154949. */
  154950. private static _tokenizeSegment;
  154951. }
  154952. /**
  154953. * Class representing a set of known, named trajectories to which Trajectories can be
  154954. * added and using which Trajectories can be recognized.
  154955. */
  154956. export class TrajectoryClassifier {
  154957. private _maximumAllowableMatchCost;
  154958. private _vector3Alphabet;
  154959. private _levenshteinAlphabet;
  154960. private _nameToDescribedTrajectory;
  154961. /**
  154962. * Serialize to JSON.
  154963. * @returns JSON serialization
  154964. */
  154965. serialize(): string;
  154966. /**
  154967. * Deserialize from JSON.
  154968. * @param json JSON serialization
  154969. * @returns deserialized TrajectorySet
  154970. */
  154971. static Deserialize(json: string): TrajectoryClassifier;
  154972. /**
  154973. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  154974. * VERY naive, need to be generating these things from known
  154975. * sets. Better version later, probably eliminating this one.
  154976. * @returns auto-generated TrajectorySet
  154977. */
  154978. static Generate(): TrajectoryClassifier;
  154979. private constructor();
  154980. /**
  154981. * Add a new Trajectory to the set with a given name.
  154982. * @param trajectory new Trajectory to be added
  154983. * @param classification name to which to add the Trajectory
  154984. */
  154985. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  154986. /**
  154987. * Remove a known named trajectory and all Trajectories associated with it.
  154988. * @param classification name to remove
  154989. * @returns whether anything was removed
  154990. */
  154991. deleteClassification(classification: string): boolean;
  154992. /**
  154993. * Attempt to recognize a Trajectory from among all the classifications
  154994. * already known to the classifier.
  154995. * @param trajectory Trajectory to be recognized
  154996. * @returns classification of Trajectory if recognized, null otherwise
  154997. */
  154998. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  154999. }
  155000. }
  155001. declare module BABYLON {
  155002. /**
  155003. * An interface for all Hit test features
  155004. */
  155005. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  155006. /**
  155007. * Triggered when new babylon (transformed) hit test results are available
  155008. */
  155009. onHitTestResultObservable: Observable<T[]>;
  155010. }
  155011. /**
  155012. * Options used for hit testing
  155013. */
  155014. export interface IWebXRLegacyHitTestOptions {
  155015. /**
  155016. * Only test when user interacted with the scene. Default - hit test every frame
  155017. */
  155018. testOnPointerDownOnly?: boolean;
  155019. /**
  155020. * The node to use to transform the local results to world coordinates
  155021. */
  155022. worldParentNode?: TransformNode;
  155023. }
  155024. /**
  155025. * Interface defining the babylon result of raycasting/hit-test
  155026. */
  155027. export interface IWebXRLegacyHitResult {
  155028. /**
  155029. * Transformation matrix that can be applied to a node that will put it in the hit point location
  155030. */
  155031. transformationMatrix: Matrix;
  155032. /**
  155033. * The native hit test result
  155034. */
  155035. xrHitResult: XRHitResult | XRHitTestResult;
  155036. }
  155037. /**
  155038. * The currently-working hit-test module.
  155039. * Hit test (or Ray-casting) is used to interact with the real world.
  155040. * For further information read here - https://github.com/immersive-web/hit-test
  155041. */
  155042. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  155043. /**
  155044. * options to use when constructing this feature
  155045. */
  155046. readonly options: IWebXRLegacyHitTestOptions;
  155047. private _direction;
  155048. private _mat;
  155049. private _onSelectEnabled;
  155050. private _origin;
  155051. /**
  155052. * The module's name
  155053. */
  155054. static readonly Name: string;
  155055. /**
  155056. * The (Babylon) version of this module.
  155057. * This is an integer representing the implementation version.
  155058. * This number does not correspond to the WebXR specs version
  155059. */
  155060. static readonly Version: number;
  155061. /**
  155062. * Populated with the last native XR Hit Results
  155063. */
  155064. lastNativeXRHitResults: XRHitResult[];
  155065. /**
  155066. * Triggered when new babylon (transformed) hit test results are available
  155067. */
  155068. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  155069. /**
  155070. * Creates a new instance of the (legacy version) hit test feature
  155071. * @param _xrSessionManager an instance of WebXRSessionManager
  155072. * @param options options to use when constructing this feature
  155073. */
  155074. constructor(_xrSessionManager: WebXRSessionManager,
  155075. /**
  155076. * options to use when constructing this feature
  155077. */
  155078. options?: IWebXRLegacyHitTestOptions);
  155079. /**
  155080. * execute a hit test with an XR Ray
  155081. *
  155082. * @param xrSession a native xrSession that will execute this hit test
  155083. * @param xrRay the ray (position and direction) to use for ray-casting
  155084. * @param referenceSpace native XR reference space to use for the hit-test
  155085. * @param filter filter function that will filter the results
  155086. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  155087. */
  155088. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  155089. /**
  155090. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  155091. * @param event the (select) event to use to select with
  155092. * @param referenceSpace the reference space to use for this hit test
  155093. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  155094. */
  155095. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155096. /**
  155097. * attach this feature
  155098. * Will usually be called by the features manager
  155099. *
  155100. * @returns true if successful.
  155101. */
  155102. attach(): boolean;
  155103. /**
  155104. * detach this feature.
  155105. * Will usually be called by the features manager
  155106. *
  155107. * @returns true if successful.
  155108. */
  155109. detach(): boolean;
  155110. /**
  155111. * Dispose this feature and all of the resources attached
  155112. */
  155113. dispose(): void;
  155114. protected _onXRFrame(frame: XRFrame): void;
  155115. private _onHitTestResults;
  155116. private _onSelect;
  155117. }
  155118. }
  155119. declare module BABYLON {
  155120. /**
  155121. * Options used for hit testing (version 2)
  155122. */
  155123. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  155124. /**
  155125. * Do not create a permanent hit test. Will usually be used when only
  155126. * transient inputs are needed.
  155127. */
  155128. disablePermanentHitTest?: boolean;
  155129. /**
  155130. * Enable transient (for example touch-based) hit test inspections
  155131. */
  155132. enableTransientHitTest?: boolean;
  155133. /**
  155134. * Offset ray for the permanent hit test
  155135. */
  155136. offsetRay?: Vector3;
  155137. /**
  155138. * Offset ray for the transient hit test
  155139. */
  155140. transientOffsetRay?: Vector3;
  155141. /**
  155142. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  155143. */
  155144. useReferenceSpace?: boolean;
  155145. /**
  155146. * Override the default entity type(s) of the hit-test result
  155147. */
  155148. entityTypes?: XRHitTestTrackableType[];
  155149. }
  155150. /**
  155151. * Interface defining the babylon result of hit-test
  155152. */
  155153. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  155154. /**
  155155. * The input source that generated this hit test (if transient)
  155156. */
  155157. inputSource?: XRInputSource;
  155158. /**
  155159. * Is this a transient hit test
  155160. */
  155161. isTransient?: boolean;
  155162. /**
  155163. * Position of the hit test result
  155164. */
  155165. position: Vector3;
  155166. /**
  155167. * Rotation of the hit test result
  155168. */
  155169. rotationQuaternion: Quaternion;
  155170. /**
  155171. * The native hit test result
  155172. */
  155173. xrHitResult: XRHitTestResult;
  155174. }
  155175. /**
  155176. * The currently-working hit-test module.
  155177. * Hit test (or Ray-casting) is used to interact with the real world.
  155178. * For further information read here - https://github.com/immersive-web/hit-test
  155179. *
  155180. * Tested on chrome (mobile) 80.
  155181. */
  155182. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  155183. /**
  155184. * options to use when constructing this feature
  155185. */
  155186. readonly options: IWebXRHitTestOptions;
  155187. private _tmpMat;
  155188. private _tmpPos;
  155189. private _tmpQuat;
  155190. private _transientXrHitTestSource;
  155191. private _xrHitTestSource;
  155192. private initHitTestSource;
  155193. /**
  155194. * The module's name
  155195. */
  155196. static readonly Name: string;
  155197. /**
  155198. * The (Babylon) version of this module.
  155199. * This is an integer representing the implementation version.
  155200. * This number does not correspond to the WebXR specs version
  155201. */
  155202. static readonly Version: number;
  155203. /**
  155204. * When set to true, each hit test will have its own position/rotation objects
  155205. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  155206. * the developers will clone them or copy them as they see fit.
  155207. */
  155208. autoCloneTransformation: boolean;
  155209. /**
  155210. * Triggered when new babylon (transformed) hit test results are available
  155211. * Note - this will be called when results come back from the device. It can be an empty array!!
  155212. */
  155213. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  155214. /**
  155215. * Use this to temporarily pause hit test checks.
  155216. */
  155217. paused: boolean;
  155218. /**
  155219. * Creates a new instance of the hit test feature
  155220. * @param _xrSessionManager an instance of WebXRSessionManager
  155221. * @param options options to use when constructing this feature
  155222. */
  155223. constructor(_xrSessionManager: WebXRSessionManager,
  155224. /**
  155225. * options to use when constructing this feature
  155226. */
  155227. options?: IWebXRHitTestOptions);
  155228. /**
  155229. * attach this feature
  155230. * Will usually be called by the features manager
  155231. *
  155232. * @returns true if successful.
  155233. */
  155234. attach(): boolean;
  155235. /**
  155236. * detach this feature.
  155237. * Will usually be called by the features manager
  155238. *
  155239. * @returns true if successful.
  155240. */
  155241. detach(): boolean;
  155242. /**
  155243. * Dispose this feature and all of the resources attached
  155244. */
  155245. dispose(): void;
  155246. protected _onXRFrame(frame: XRFrame): void;
  155247. private _processWebXRHitTestResult;
  155248. }
  155249. }
  155250. declare module BABYLON {
  155251. /**
  155252. * Configuration options of the anchor system
  155253. */
  155254. export interface IWebXRAnchorSystemOptions {
  155255. /**
  155256. * a node that will be used to convert local to world coordinates
  155257. */
  155258. worldParentNode?: TransformNode;
  155259. /**
  155260. * If set to true a reference of the created anchors will be kept until the next session starts
  155261. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  155262. */
  155263. doNotRemoveAnchorsOnSessionEnded?: boolean;
  155264. }
  155265. /**
  155266. * A babylon container for an XR Anchor
  155267. */
  155268. export interface IWebXRAnchor {
  155269. /**
  155270. * A babylon-assigned ID for this anchor
  155271. */
  155272. id: number;
  155273. /**
  155274. * Transformation matrix to apply to an object attached to this anchor
  155275. */
  155276. transformationMatrix: Matrix;
  155277. /**
  155278. * The native anchor object
  155279. */
  155280. xrAnchor: XRAnchor;
  155281. /**
  155282. * if defined, this object will be constantly updated by the anchor's position and rotation
  155283. */
  155284. attachedNode?: TransformNode;
  155285. }
  155286. /**
  155287. * An implementation of the anchor system for WebXR.
  155288. * For further information see https://github.com/immersive-web/anchors/
  155289. */
  155290. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  155291. private _options;
  155292. private _lastFrameDetected;
  155293. private _trackedAnchors;
  155294. private _referenceSpaceForFrameAnchors;
  155295. private _futureAnchors;
  155296. /**
  155297. * The module's name
  155298. */
  155299. static readonly Name: string;
  155300. /**
  155301. * The (Babylon) version of this module.
  155302. * This is an integer representing the implementation version.
  155303. * This number does not correspond to the WebXR specs version
  155304. */
  155305. static readonly Version: number;
  155306. /**
  155307. * Observers registered here will be executed when a new anchor was added to the session
  155308. */
  155309. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  155310. /**
  155311. * Observers registered here will be executed when an anchor was removed from the session
  155312. */
  155313. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  155314. /**
  155315. * Observers registered here will be executed when an existing anchor updates
  155316. * This can execute N times every frame
  155317. */
  155318. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  155319. /**
  155320. * Set the reference space to use for anchor creation, when not using a hit test.
  155321. * Will default to the session's reference space if not defined
  155322. */
  155323. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  155324. /**
  155325. * constructs a new anchor system
  155326. * @param _xrSessionManager an instance of WebXRSessionManager
  155327. * @param _options configuration object for this feature
  155328. */
  155329. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  155330. private _tmpVector;
  155331. private _tmpQuaternion;
  155332. private _populateTmpTransformation;
  155333. /**
  155334. * Create a new anchor point using a hit test result at a specific point in the scene
  155335. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  155336. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  155337. *
  155338. * @param hitTestResult The hit test result to use for this anchor creation
  155339. * @param position an optional position offset for this anchor
  155340. * @param rotationQuaternion an optional rotation offset for this anchor
  155341. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  155342. */
  155343. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  155344. /**
  155345. * Add a new anchor at a specific position and rotation
  155346. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  155347. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  155348. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  155349. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  155350. *
  155351. * @param position the position in which to add an anchor
  155352. * @param rotationQuaternion an optional rotation for the anchor transformation
  155353. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  155354. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  155355. */
  155356. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  155357. /**
  155358. * detach this feature.
  155359. * Will usually be called by the features manager
  155360. *
  155361. * @returns true if successful.
  155362. */
  155363. detach(): boolean;
  155364. /**
  155365. * Dispose this feature and all of the resources attached
  155366. */
  155367. dispose(): void;
  155368. protected _onXRFrame(frame: XRFrame): void;
  155369. /**
  155370. * avoiding using Array.find for global support.
  155371. * @param xrAnchor the plane to find in the array
  155372. */
  155373. private _findIndexInAnchorArray;
  155374. private _updateAnchorWithXRFrame;
  155375. private _createAnchorAtTransformation;
  155376. }
  155377. }
  155378. declare module BABYLON {
  155379. /**
  155380. * Options used in the plane detector module
  155381. */
  155382. export interface IWebXRPlaneDetectorOptions {
  155383. /**
  155384. * The node to use to transform the local results to world coordinates
  155385. */
  155386. worldParentNode?: TransformNode;
  155387. /**
  155388. * If set to true a reference of the created planes will be kept until the next session starts
  155389. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  155390. */
  155391. doNotRemovePlanesOnSessionEnded?: boolean;
  155392. }
  155393. /**
  155394. * A babylon interface for a WebXR plane.
  155395. * A Plane is actually a polygon, built from N points in space
  155396. *
  155397. * Supported in chrome 79, not supported in canary 81 ATM
  155398. */
  155399. export interface IWebXRPlane {
  155400. /**
  155401. * a babylon-assigned ID for this polygon
  155402. */
  155403. id: number;
  155404. /**
  155405. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  155406. */
  155407. polygonDefinition: Array<Vector3>;
  155408. /**
  155409. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  155410. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  155411. */
  155412. transformationMatrix: Matrix;
  155413. /**
  155414. * the native xr-plane object
  155415. */
  155416. xrPlane: XRPlane;
  155417. }
  155418. /**
  155419. * The plane detector is used to detect planes in the real world when in AR
  155420. * For more information see https://github.com/immersive-web/real-world-geometry/
  155421. */
  155422. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  155423. private _options;
  155424. private _detectedPlanes;
  155425. private _enabled;
  155426. private _lastFrameDetected;
  155427. /**
  155428. * The module's name
  155429. */
  155430. static readonly Name: string;
  155431. /**
  155432. * The (Babylon) version of this module.
  155433. * This is an integer representing the implementation version.
  155434. * This number does not correspond to the WebXR specs version
  155435. */
  155436. static readonly Version: number;
  155437. /**
  155438. * Observers registered here will be executed when a new plane was added to the session
  155439. */
  155440. onPlaneAddedObservable: Observable<IWebXRPlane>;
  155441. /**
  155442. * Observers registered here will be executed when a plane is no longer detected in the session
  155443. */
  155444. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  155445. /**
  155446. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  155447. * This can execute N times every frame
  155448. */
  155449. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  155450. /**
  155451. * construct a new Plane Detector
  155452. * @param _xrSessionManager an instance of xr Session manager
  155453. * @param _options configuration to use when constructing this feature
  155454. */
  155455. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  155456. /**
  155457. * detach this feature.
  155458. * Will usually be called by the features manager
  155459. *
  155460. * @returns true if successful.
  155461. */
  155462. detach(): boolean;
  155463. /**
  155464. * Dispose this feature and all of the resources attached
  155465. */
  155466. dispose(): void;
  155467. protected _onXRFrame(frame: XRFrame): void;
  155468. private _init;
  155469. private _updatePlaneWithXRPlane;
  155470. /**
  155471. * avoiding using Array.find for global support.
  155472. * @param xrPlane the plane to find in the array
  155473. */
  155474. private findIndexInPlaneArray;
  155475. }
  155476. }
  155477. declare module BABYLON {
  155478. /**
  155479. * Options interface for the background remover plugin
  155480. */
  155481. export interface IWebXRBackgroundRemoverOptions {
  155482. /**
  155483. * Further background meshes to disable when entering AR
  155484. */
  155485. backgroundMeshes?: AbstractMesh[];
  155486. /**
  155487. * flags to configure the removal of the environment helper.
  155488. * If not set, the entire background will be removed. If set, flags should be set as well.
  155489. */
  155490. environmentHelperRemovalFlags?: {
  155491. /**
  155492. * Should the skybox be removed (default false)
  155493. */
  155494. skyBox?: boolean;
  155495. /**
  155496. * Should the ground be removed (default false)
  155497. */
  155498. ground?: boolean;
  155499. };
  155500. /**
  155501. * don't disable the environment helper
  155502. */
  155503. ignoreEnvironmentHelper?: boolean;
  155504. }
  155505. /**
  155506. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  155507. */
  155508. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  155509. /**
  155510. * read-only options to be used in this module
  155511. */
  155512. readonly options: IWebXRBackgroundRemoverOptions;
  155513. /**
  155514. * The module's name
  155515. */
  155516. static readonly Name: string;
  155517. /**
  155518. * The (Babylon) version of this module.
  155519. * This is an integer representing the implementation version.
  155520. * This number does not correspond to the WebXR specs version
  155521. */
  155522. static readonly Version: number;
  155523. /**
  155524. * registered observers will be triggered when the background state changes
  155525. */
  155526. onBackgroundStateChangedObservable: Observable<boolean>;
  155527. /**
  155528. * constructs a new background remover module
  155529. * @param _xrSessionManager the session manager for this module
  155530. * @param options read-only options to be used in this module
  155531. */
  155532. constructor(_xrSessionManager: WebXRSessionManager,
  155533. /**
  155534. * read-only options to be used in this module
  155535. */
  155536. options?: IWebXRBackgroundRemoverOptions);
  155537. /**
  155538. * attach this feature
  155539. * Will usually be called by the features manager
  155540. *
  155541. * @returns true if successful.
  155542. */
  155543. attach(): boolean;
  155544. /**
  155545. * detach this feature.
  155546. * Will usually be called by the features manager
  155547. *
  155548. * @returns true if successful.
  155549. */
  155550. detach(): boolean;
  155551. /**
  155552. * Dispose this feature and all of the resources attached
  155553. */
  155554. dispose(): void;
  155555. protected _onXRFrame(_xrFrame: XRFrame): void;
  155556. private _setBackgroundState;
  155557. }
  155558. }
  155559. declare module BABYLON {
  155560. /**
  155561. * Options for the controller physics feature
  155562. */
  155563. export class IWebXRControllerPhysicsOptions {
  155564. /**
  155565. * Should the headset get its own impostor
  155566. */
  155567. enableHeadsetImpostor?: boolean;
  155568. /**
  155569. * Optional parameters for the headset impostor
  155570. */
  155571. headsetImpostorParams?: {
  155572. /**
  155573. * The type of impostor to create. Default is sphere
  155574. */
  155575. impostorType: number;
  155576. /**
  155577. * the size of the impostor. Defaults to 10cm
  155578. */
  155579. impostorSize?: number | {
  155580. width: number;
  155581. height: number;
  155582. depth: number;
  155583. };
  155584. /**
  155585. * Friction definitions
  155586. */
  155587. friction?: number;
  155588. /**
  155589. * Restitution
  155590. */
  155591. restitution?: number;
  155592. };
  155593. /**
  155594. * The physics properties of the future impostors
  155595. */
  155596. physicsProperties?: {
  155597. /**
  155598. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  155599. * Note that this requires a physics engine that supports mesh impostors!
  155600. */
  155601. useControllerMesh?: boolean;
  155602. /**
  155603. * The type of impostor to create. Default is sphere
  155604. */
  155605. impostorType?: number;
  155606. /**
  155607. * the size of the impostor. Defaults to 10cm
  155608. */
  155609. impostorSize?: number | {
  155610. width: number;
  155611. height: number;
  155612. depth: number;
  155613. };
  155614. /**
  155615. * Friction definitions
  155616. */
  155617. friction?: number;
  155618. /**
  155619. * Restitution
  155620. */
  155621. restitution?: number;
  155622. };
  155623. /**
  155624. * the xr input to use with this pointer selection
  155625. */
  155626. xrInput: WebXRInput;
  155627. }
  155628. /**
  155629. * Add physics impostor to your webxr controllers,
  155630. * including naive calculation of their linear and angular velocity
  155631. */
  155632. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  155633. private readonly _options;
  155634. private _attachController;
  155635. private _controllers;
  155636. private _debugMode;
  155637. private _delta;
  155638. private _headsetImpostor?;
  155639. private _headsetMesh?;
  155640. private _lastTimestamp;
  155641. private _tmpQuaternion;
  155642. private _tmpVector;
  155643. /**
  155644. * The module's name
  155645. */
  155646. static readonly Name: string;
  155647. /**
  155648. * The (Babylon) version of this module.
  155649. * This is an integer representing the implementation version.
  155650. * This number does not correspond to the webxr specs version
  155651. */
  155652. static readonly Version: number;
  155653. /**
  155654. * Construct a new Controller Physics Feature
  155655. * @param _xrSessionManager the corresponding xr session manager
  155656. * @param _options options to create this feature with
  155657. */
  155658. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  155659. /**
  155660. * @hidden
  155661. * enable debugging - will show console outputs and the impostor mesh
  155662. */
  155663. _enablePhysicsDebug(): void;
  155664. /**
  155665. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  155666. * @param xrController the controller to add
  155667. */
  155668. addController(xrController: WebXRInputSource): void;
  155669. /**
  155670. * attach this feature
  155671. * Will usually be called by the features manager
  155672. *
  155673. * @returns true if successful.
  155674. */
  155675. attach(): boolean;
  155676. /**
  155677. * detach this feature.
  155678. * Will usually be called by the features manager
  155679. *
  155680. * @returns true if successful.
  155681. */
  155682. detach(): boolean;
  155683. /**
  155684. * Get the headset impostor, if enabled
  155685. * @returns the impostor
  155686. */
  155687. getHeadsetImpostor(): PhysicsImpostor | undefined;
  155688. /**
  155689. * Get the physics impostor of a specific controller.
  155690. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  155691. * @param controller the controller or the controller id of which to get the impostor
  155692. * @returns the impostor or null
  155693. */
  155694. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  155695. /**
  155696. * Update the physics properties provided in the constructor
  155697. * @param newProperties the new properties object
  155698. */
  155699. setPhysicsProperties(newProperties: {
  155700. impostorType?: number;
  155701. impostorSize?: number | {
  155702. width: number;
  155703. height: number;
  155704. depth: number;
  155705. };
  155706. friction?: number;
  155707. restitution?: number;
  155708. }): void;
  155709. protected _onXRFrame(_xrFrame: any): void;
  155710. private _detachController;
  155711. }
  155712. }
  155713. declare module BABYLON {
  155714. /**
  155715. * A babylon interface for a "WebXR" feature point.
  155716. * Represents the position and confidence value of a given feature point.
  155717. */
  155718. export interface IWebXRFeaturePoint {
  155719. /**
  155720. * Represents the position of the feature point in world space.
  155721. */
  155722. position: Vector3;
  155723. /**
  155724. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  155725. */
  155726. confidenceValue: number;
  155727. }
  155728. /**
  155729. * The feature point system is used to detect feature points from real world geometry.
  155730. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  155731. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  155732. */
  155733. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  155734. private _enabled;
  155735. private _featurePointCloud;
  155736. /**
  155737. * The module's name
  155738. */
  155739. static readonly Name: string;
  155740. /**
  155741. * The (Babylon) version of this module.
  155742. * This is an integer representing the implementation version.
  155743. * This number does not correspond to the WebXR specs version
  155744. */
  155745. static readonly Version: number;
  155746. /**
  155747. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  155748. * Will notify the observers about which feature points have been added.
  155749. */
  155750. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  155751. /**
  155752. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  155753. * Will notify the observers about which feature points have been updated.
  155754. */
  155755. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  155756. /**
  155757. * The current feature point cloud maintained across frames.
  155758. */
  155759. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  155760. /**
  155761. * construct the feature point system
  155762. * @param _xrSessionManager an instance of xr Session manager
  155763. */
  155764. constructor(_xrSessionManager: WebXRSessionManager);
  155765. /**
  155766. * Detach this feature.
  155767. * Will usually be called by the features manager
  155768. *
  155769. * @returns true if successful.
  155770. */
  155771. detach(): boolean;
  155772. /**
  155773. * Dispose this feature and all of the resources attached
  155774. */
  155775. dispose(): void;
  155776. /**
  155777. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  155778. */
  155779. protected _onXRFrame(frame: XRFrame): void;
  155780. /**
  155781. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  155782. */
  155783. private _init;
  155784. }
  155785. }
  155786. declare module BABYLON {
  155787. /**
  155788. * Configuration interface for the hand tracking feature
  155789. */
  155790. export interface IWebXRHandTrackingOptions {
  155791. /**
  155792. * The xrInput that will be used as source for new hands
  155793. */
  155794. xrInput: WebXRInput;
  155795. /**
  155796. * Configuration object for the joint meshes
  155797. */
  155798. jointMeshes?: {
  155799. /**
  155800. * Should the meshes created be invisible (defaults to false)
  155801. */
  155802. invisible?: boolean;
  155803. /**
  155804. * A source mesh to be used to create instances. Defaults to a sphere.
  155805. * This mesh will be the source for all other (25) meshes.
  155806. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  155807. */
  155808. sourceMesh?: Mesh;
  155809. /**
  155810. * Should the source mesh stay visible. Defaults to false
  155811. */
  155812. keepOriginalVisible?: boolean;
  155813. /**
  155814. * Scale factor for all instances (defaults to 2)
  155815. */
  155816. scaleFactor?: number;
  155817. /**
  155818. * Should each instance have its own physics impostor
  155819. */
  155820. enablePhysics?: boolean;
  155821. /**
  155822. * If enabled, override default physics properties
  155823. */
  155824. physicsProps?: {
  155825. friction?: number;
  155826. restitution?: number;
  155827. impostorType?: number;
  155828. };
  155829. /**
  155830. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  155831. */
  155832. handMesh?: AbstractMesh;
  155833. };
  155834. }
  155835. /**
  155836. * Parts of the hands divided to writs and finger names
  155837. */
  155838. export const enum HandPart {
  155839. /**
  155840. * HandPart - Wrist
  155841. */
  155842. WRIST = "wrist",
  155843. /**
  155844. * HandPart - The THumb
  155845. */
  155846. THUMB = "thumb",
  155847. /**
  155848. * HandPart - Index finger
  155849. */
  155850. INDEX = "index",
  155851. /**
  155852. * HandPart - Middle finger
  155853. */
  155854. MIDDLE = "middle",
  155855. /**
  155856. * HandPart - Ring finger
  155857. */
  155858. RING = "ring",
  155859. /**
  155860. * HandPart - Little finger
  155861. */
  155862. LITTLE = "little"
  155863. }
  155864. /**
  155865. * Representing a single hand (with its corresponding native XRHand object)
  155866. */
  155867. export class WebXRHand implements IDisposable {
  155868. /** the controller to which the hand correlates */
  155869. readonly xrController: WebXRInputSource;
  155870. /** the meshes to be used to track the hand joints */
  155871. readonly trackedMeshes: AbstractMesh[];
  155872. /**
  155873. * Hand-parts definition (key is HandPart)
  155874. */
  155875. handPartsDefinition: {
  155876. [key: string]: number[];
  155877. };
  155878. /**
  155879. * Populate the HandPartsDefinition object.
  155880. * This is called as a side effect since certain browsers don't have XRHand defined.
  155881. */
  155882. private generateHandPartsDefinition;
  155883. /**
  155884. * Construct a new hand object
  155885. * @param xrController the controller to which the hand correlates
  155886. * @param trackedMeshes the meshes to be used to track the hand joints
  155887. */
  155888. constructor(
  155889. /** the controller to which the hand correlates */
  155890. xrController: WebXRInputSource,
  155891. /** the meshes to be used to track the hand joints */
  155892. trackedMeshes: AbstractMesh[]);
  155893. /**
  155894. * Update this hand from the latest xr frame
  155895. * @param xrFrame xrFrame to update from
  155896. * @param referenceSpace The current viewer reference space
  155897. * @param scaleFactor optional scale factor for the meshes
  155898. */
  155899. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  155900. /**
  155901. * Get meshes of part of the hand
  155902. * @param part the part of hand to get
  155903. * @returns An array of meshes that correlate to the hand part requested
  155904. */
  155905. getHandPartMeshes(part: HandPart): AbstractMesh[];
  155906. /**
  155907. * Dispose this Hand object
  155908. */
  155909. dispose(): void;
  155910. }
  155911. /**
  155912. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  155913. */
  155914. export class WebXRHandTracking extends WebXRAbstractFeature {
  155915. /**
  155916. * options to use when constructing this feature
  155917. */
  155918. readonly options: IWebXRHandTrackingOptions;
  155919. private static _idCounter;
  155920. /**
  155921. * The module's name
  155922. */
  155923. static readonly Name: string;
  155924. /**
  155925. * The (Babylon) version of this module.
  155926. * This is an integer representing the implementation version.
  155927. * This number does not correspond to the WebXR specs version
  155928. */
  155929. static readonly Version: number;
  155930. /**
  155931. * This observable will notify registered observers when a new hand object was added and initialized
  155932. */
  155933. onHandAddedObservable: Observable<WebXRHand>;
  155934. /**
  155935. * This observable will notify its observers right before the hand object is disposed
  155936. */
  155937. onHandRemovedObservable: Observable<WebXRHand>;
  155938. private _hands;
  155939. /**
  155940. * Creates a new instance of the hit test feature
  155941. * @param _xrSessionManager an instance of WebXRSessionManager
  155942. * @param options options to use when constructing this feature
  155943. */
  155944. constructor(_xrSessionManager: WebXRSessionManager,
  155945. /**
  155946. * options to use when constructing this feature
  155947. */
  155948. options: IWebXRHandTrackingOptions);
  155949. /**
  155950. * Check if the needed objects are defined.
  155951. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  155952. */
  155953. isCompatible(): boolean;
  155954. /**
  155955. * attach this feature
  155956. * Will usually be called by the features manager
  155957. *
  155958. * @returns true if successful.
  155959. */
  155960. attach(): boolean;
  155961. /**
  155962. * detach this feature.
  155963. * Will usually be called by the features manager
  155964. *
  155965. * @returns true if successful.
  155966. */
  155967. detach(): boolean;
  155968. /**
  155969. * Dispose this feature and all of the resources attached
  155970. */
  155971. dispose(): void;
  155972. /**
  155973. * Get the hand object according to the controller id
  155974. * @param controllerId the controller id to which we want to get the hand
  155975. * @returns null if not found or the WebXRHand object if found
  155976. */
  155977. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  155978. /**
  155979. * Get a hand object according to the requested handedness
  155980. * @param handedness the handedness to request
  155981. * @returns null if not found or the WebXRHand object if found
  155982. */
  155983. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  155984. protected _onXRFrame(_xrFrame: XRFrame): void;
  155985. private _attachHand;
  155986. private _detachHand;
  155987. }
  155988. }
  155989. declare module BABYLON {
  155990. /**
  155991. * The motion controller class for all microsoft mixed reality controllers
  155992. */
  155993. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  155994. protected readonly _mapping: {
  155995. defaultButton: {
  155996. valueNodeName: string;
  155997. unpressedNodeName: string;
  155998. pressedNodeName: string;
  155999. };
  156000. defaultAxis: {
  156001. valueNodeName: string;
  156002. minNodeName: string;
  156003. maxNodeName: string;
  156004. };
  156005. buttons: {
  156006. "xr-standard-trigger": {
  156007. rootNodeName: string;
  156008. componentProperty: string;
  156009. states: string[];
  156010. };
  156011. "xr-standard-squeeze": {
  156012. rootNodeName: string;
  156013. componentProperty: string;
  156014. states: string[];
  156015. };
  156016. "xr-standard-touchpad": {
  156017. rootNodeName: string;
  156018. labelAnchorNodeName: string;
  156019. touchPointNodeName: string;
  156020. };
  156021. "xr-standard-thumbstick": {
  156022. rootNodeName: string;
  156023. componentProperty: string;
  156024. states: string[];
  156025. };
  156026. };
  156027. axes: {
  156028. "xr-standard-touchpad": {
  156029. "x-axis": {
  156030. rootNodeName: string;
  156031. };
  156032. "y-axis": {
  156033. rootNodeName: string;
  156034. };
  156035. };
  156036. "xr-standard-thumbstick": {
  156037. "x-axis": {
  156038. rootNodeName: string;
  156039. };
  156040. "y-axis": {
  156041. rootNodeName: string;
  156042. };
  156043. };
  156044. };
  156045. };
  156046. /**
  156047. * The base url used to load the left and right controller models
  156048. */
  156049. static MODEL_BASE_URL: string;
  156050. /**
  156051. * The name of the left controller model file
  156052. */
  156053. static MODEL_LEFT_FILENAME: string;
  156054. /**
  156055. * The name of the right controller model file
  156056. */
  156057. static MODEL_RIGHT_FILENAME: string;
  156058. profileId: string;
  156059. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  156060. protected _getFilenameAndPath(): {
  156061. filename: string;
  156062. path: string;
  156063. };
  156064. protected _getModelLoadingConstraints(): boolean;
  156065. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  156066. protected _setRootMesh(meshes: AbstractMesh[]): void;
  156067. protected _updateModel(): void;
  156068. }
  156069. }
  156070. declare module BABYLON {
  156071. /**
  156072. * The motion controller class for oculus touch (quest, rift).
  156073. * This class supports legacy mapping as well the standard xr mapping
  156074. */
  156075. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  156076. private _forceLegacyControllers;
  156077. private _modelRootNode;
  156078. /**
  156079. * The base url used to load the left and right controller models
  156080. */
  156081. static MODEL_BASE_URL: string;
  156082. /**
  156083. * The name of the left controller model file
  156084. */
  156085. static MODEL_LEFT_FILENAME: string;
  156086. /**
  156087. * The name of the right controller model file
  156088. */
  156089. static MODEL_RIGHT_FILENAME: string;
  156090. /**
  156091. * Base Url for the Quest controller model.
  156092. */
  156093. static QUEST_MODEL_BASE_URL: string;
  156094. profileId: string;
  156095. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  156096. protected _getFilenameAndPath(): {
  156097. filename: string;
  156098. path: string;
  156099. };
  156100. protected _getModelLoadingConstraints(): boolean;
  156101. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  156102. protected _setRootMesh(meshes: AbstractMesh[]): void;
  156103. protected _updateModel(): void;
  156104. /**
  156105. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  156106. * between the touch and touch 2.
  156107. */
  156108. private _isQuest;
  156109. }
  156110. }
  156111. declare module BABYLON {
  156112. /**
  156113. * The motion controller class for the standard HTC-Vive controllers
  156114. */
  156115. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  156116. private _modelRootNode;
  156117. /**
  156118. * The base url used to load the left and right controller models
  156119. */
  156120. static MODEL_BASE_URL: string;
  156121. /**
  156122. * File name for the controller model.
  156123. */
  156124. static MODEL_FILENAME: string;
  156125. profileId: string;
  156126. /**
  156127. * Create a new Vive motion controller object
  156128. * @param scene the scene to use to create this controller
  156129. * @param gamepadObject the corresponding gamepad object
  156130. * @param handedness the handedness of the controller
  156131. */
  156132. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  156133. protected _getFilenameAndPath(): {
  156134. filename: string;
  156135. path: string;
  156136. };
  156137. protected _getModelLoadingConstraints(): boolean;
  156138. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  156139. protected _setRootMesh(meshes: AbstractMesh[]): void;
  156140. protected _updateModel(): void;
  156141. }
  156142. }
  156143. declare module BABYLON {
  156144. /**
  156145. * A cursor which tracks a point on a path
  156146. */
  156147. export class PathCursor {
  156148. private path;
  156149. /**
  156150. * Stores path cursor callbacks for when an onchange event is triggered
  156151. */
  156152. private _onchange;
  156153. /**
  156154. * The value of the path cursor
  156155. */
  156156. value: number;
  156157. /**
  156158. * The animation array of the path cursor
  156159. */
  156160. animations: Animation[];
  156161. /**
  156162. * Initializes the path cursor
  156163. * @param path The path to track
  156164. */
  156165. constructor(path: Path2);
  156166. /**
  156167. * Gets the cursor point on the path
  156168. * @returns A point on the path cursor at the cursor location
  156169. */
  156170. getPoint(): Vector3;
  156171. /**
  156172. * Moves the cursor ahead by the step amount
  156173. * @param step The amount to move the cursor forward
  156174. * @returns This path cursor
  156175. */
  156176. moveAhead(step?: number): PathCursor;
  156177. /**
  156178. * Moves the cursor behind by the step amount
  156179. * @param step The amount to move the cursor back
  156180. * @returns This path cursor
  156181. */
  156182. moveBack(step?: number): PathCursor;
  156183. /**
  156184. * Moves the cursor by the step amount
  156185. * If the step amount is greater than one, an exception is thrown
  156186. * @param step The amount to move the cursor
  156187. * @returns This path cursor
  156188. */
  156189. move(step: number): PathCursor;
  156190. /**
  156191. * Ensures that the value is limited between zero and one
  156192. * @returns This path cursor
  156193. */
  156194. private ensureLimits;
  156195. /**
  156196. * Runs onchange callbacks on change (used by the animation engine)
  156197. * @returns This path cursor
  156198. */
  156199. private raiseOnChange;
  156200. /**
  156201. * Executes a function on change
  156202. * @param f A path cursor onchange callback
  156203. * @returns This path cursor
  156204. */
  156205. onchange(f: (cursor: PathCursor) => void): PathCursor;
  156206. }
  156207. }
  156208. declare module BABYLON {
  156209. /** @hidden */
  156210. export var blurPixelShader: {
  156211. name: string;
  156212. shader: string;
  156213. };
  156214. }
  156215. declare module BABYLON {
  156216. /** @hidden */
  156217. export var pointCloudVertexDeclaration: {
  156218. name: string;
  156219. shader: string;
  156220. };
  156221. }
  156222. // Mixins
  156223. interface Window {
  156224. mozIndexedDB: IDBFactory;
  156225. webkitIndexedDB: IDBFactory;
  156226. msIndexedDB: IDBFactory;
  156227. webkitURL: typeof URL;
  156228. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  156229. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  156230. WebGLRenderingContext: WebGLRenderingContext;
  156231. MSGesture: MSGesture;
  156232. CANNON: any;
  156233. AudioContext: AudioContext;
  156234. webkitAudioContext: AudioContext;
  156235. PointerEvent: any;
  156236. Math: Math;
  156237. Uint8Array: Uint8ArrayConstructor;
  156238. Float32Array: Float32ArrayConstructor;
  156239. mozURL: typeof URL;
  156240. msURL: typeof URL;
  156241. VRFrameData: any; // WebVR, from specs 1.1
  156242. DracoDecoderModule: any;
  156243. setImmediate(handler: (...args: any[]) => void): number;
  156244. }
  156245. interface HTMLCanvasElement {
  156246. requestPointerLock(): void;
  156247. msRequestPointerLock?(): void;
  156248. mozRequestPointerLock?(): void;
  156249. webkitRequestPointerLock?(): void;
  156250. /** Track wether a record is in progress */
  156251. isRecording: boolean;
  156252. /** Capture Stream method defined by some browsers */
  156253. captureStream(fps?: number): MediaStream;
  156254. }
  156255. interface CanvasRenderingContext2D {
  156256. msImageSmoothingEnabled: boolean;
  156257. }
  156258. interface MouseEvent {
  156259. mozMovementX: number;
  156260. mozMovementY: number;
  156261. webkitMovementX: number;
  156262. webkitMovementY: number;
  156263. msMovementX: number;
  156264. msMovementY: number;
  156265. }
  156266. interface Navigator {
  156267. mozGetVRDevices: (any: any) => any;
  156268. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  156269. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  156270. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  156271. webkitGetGamepads(): Gamepad[];
  156272. msGetGamepads(): Gamepad[];
  156273. webkitGamepads(): Gamepad[];
  156274. }
  156275. interface HTMLVideoElement {
  156276. mozSrcObject: any;
  156277. }
  156278. interface Math {
  156279. fround(x: number): number;
  156280. imul(a: number, b: number): number;
  156281. }
  156282. interface WebGLRenderingContext {
  156283. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  156284. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  156285. vertexAttribDivisor(index: number, divisor: number): void;
  156286. createVertexArray(): any;
  156287. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  156288. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  156289. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  156290. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  156291. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  156292. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  156293. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  156294. // Queries
  156295. createQuery(): WebGLQuery;
  156296. deleteQuery(query: WebGLQuery): void;
  156297. beginQuery(target: number, query: WebGLQuery): void;
  156298. endQuery(target: number): void;
  156299. getQueryParameter(query: WebGLQuery, pname: number): any;
  156300. getQuery(target: number, pname: number): any;
  156301. MAX_SAMPLES: number;
  156302. RGBA8: number;
  156303. READ_FRAMEBUFFER: number;
  156304. DRAW_FRAMEBUFFER: number;
  156305. UNIFORM_BUFFER: number;
  156306. HALF_FLOAT_OES: number;
  156307. RGBA16F: number;
  156308. RGBA32F: number;
  156309. R32F: number;
  156310. RG32F: number;
  156311. RGB32F: number;
  156312. R16F: number;
  156313. RG16F: number;
  156314. RGB16F: number;
  156315. RED: number;
  156316. RG: number;
  156317. R8: number;
  156318. RG8: number;
  156319. UNSIGNED_INT_24_8: number;
  156320. DEPTH24_STENCIL8: number;
  156321. MIN: number;
  156322. MAX: number;
  156323. /* Multiple Render Targets */
  156324. drawBuffers(buffers: number[]): void;
  156325. readBuffer(src: number): void;
  156326. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  156327. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  156328. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  156329. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  156330. // Occlusion Query
  156331. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  156332. ANY_SAMPLES_PASSED: number;
  156333. QUERY_RESULT_AVAILABLE: number;
  156334. QUERY_RESULT: number;
  156335. }
  156336. interface WebGLProgram {
  156337. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  156338. }
  156339. interface EXT_disjoint_timer_query {
  156340. QUERY_COUNTER_BITS_EXT: number;
  156341. TIME_ELAPSED_EXT: number;
  156342. TIMESTAMP_EXT: number;
  156343. GPU_DISJOINT_EXT: number;
  156344. QUERY_RESULT_EXT: number;
  156345. QUERY_RESULT_AVAILABLE_EXT: number;
  156346. queryCounterEXT(query: WebGLQuery, target: number): void;
  156347. createQueryEXT(): WebGLQuery;
  156348. beginQueryEXT(target: number, query: WebGLQuery): void;
  156349. endQueryEXT(target: number): void;
  156350. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  156351. deleteQueryEXT(query: WebGLQuery): void;
  156352. }
  156353. interface WebGLUniformLocation {
  156354. _currentState: any;
  156355. }
  156356. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  156357. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  156358. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  156359. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  156360. interface WebGLRenderingContext {
  156361. readonly RASTERIZER_DISCARD: number;
  156362. readonly DEPTH_COMPONENT24: number;
  156363. readonly TEXTURE_3D: number;
  156364. readonly TEXTURE_2D_ARRAY: number;
  156365. readonly TEXTURE_COMPARE_FUNC: number;
  156366. readonly TEXTURE_COMPARE_MODE: number;
  156367. readonly COMPARE_REF_TO_TEXTURE: number;
  156368. readonly TEXTURE_WRAP_R: number;
  156369. readonly HALF_FLOAT: number;
  156370. readonly RGB8: number;
  156371. readonly RED_INTEGER: number;
  156372. readonly RG_INTEGER: number;
  156373. readonly RGB_INTEGER: number;
  156374. readonly RGBA_INTEGER: number;
  156375. readonly R8_SNORM: number;
  156376. readonly RG8_SNORM: number;
  156377. readonly RGB8_SNORM: number;
  156378. readonly RGBA8_SNORM: number;
  156379. readonly R8I: number;
  156380. readonly RG8I: number;
  156381. readonly RGB8I: number;
  156382. readonly RGBA8I: number;
  156383. readonly R8UI: number;
  156384. readonly RG8UI: number;
  156385. readonly RGB8UI: number;
  156386. readonly RGBA8UI: number;
  156387. readonly R16I: number;
  156388. readonly RG16I: number;
  156389. readonly RGB16I: number;
  156390. readonly RGBA16I: number;
  156391. readonly R16UI: number;
  156392. readonly RG16UI: number;
  156393. readonly RGB16UI: number;
  156394. readonly RGBA16UI: number;
  156395. readonly R32I: number;
  156396. readonly RG32I: number;
  156397. readonly RGB32I: number;
  156398. readonly RGBA32I: number;
  156399. readonly R32UI: number;
  156400. readonly RG32UI: number;
  156401. readonly RGB32UI: number;
  156402. readonly RGBA32UI: number;
  156403. readonly RGB10_A2UI: number;
  156404. readonly R11F_G11F_B10F: number;
  156405. readonly RGB9_E5: number;
  156406. readonly RGB10_A2: number;
  156407. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  156408. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  156409. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  156410. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  156411. readonly DEPTH_COMPONENT32F: number;
  156412. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  156413. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  156414. 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;
  156415. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  156416. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  156417. readonly TRANSFORM_FEEDBACK: number;
  156418. readonly INTERLEAVED_ATTRIBS: number;
  156419. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  156420. createTransformFeedback(): WebGLTransformFeedback;
  156421. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  156422. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  156423. beginTransformFeedback(primitiveMode: number): void;
  156424. endTransformFeedback(): void;
  156425. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  156426. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  156427. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  156428. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  156429. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  156430. }
  156431. interface ImageBitmap {
  156432. readonly width: number;
  156433. readonly height: number;
  156434. close(): void;
  156435. }
  156436. interface WebGLQuery extends WebGLObject {
  156437. }
  156438. declare var WebGLQuery: {
  156439. prototype: WebGLQuery;
  156440. new(): WebGLQuery;
  156441. };
  156442. interface WebGLSampler extends WebGLObject {
  156443. }
  156444. declare var WebGLSampler: {
  156445. prototype: WebGLSampler;
  156446. new(): WebGLSampler;
  156447. };
  156448. interface WebGLSync extends WebGLObject {
  156449. }
  156450. declare var WebGLSync: {
  156451. prototype: WebGLSync;
  156452. new(): WebGLSync;
  156453. };
  156454. interface WebGLTransformFeedback extends WebGLObject {
  156455. }
  156456. declare var WebGLTransformFeedback: {
  156457. prototype: WebGLTransformFeedback;
  156458. new(): WebGLTransformFeedback;
  156459. };
  156460. interface WebGLVertexArrayObject extends WebGLObject {
  156461. }
  156462. declare var WebGLVertexArrayObject: {
  156463. prototype: WebGLVertexArrayObject;
  156464. new(): WebGLVertexArrayObject;
  156465. };
  156466. // Type definitions for WebVR API
  156467. // Project: https://w3c.github.io/webvr/
  156468. // Definitions by: six a <https://github.com/lostfictions>
  156469. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  156470. interface VRDisplay extends EventTarget {
  156471. /**
  156472. * Dictionary of capabilities describing the VRDisplay.
  156473. */
  156474. readonly capabilities: VRDisplayCapabilities;
  156475. /**
  156476. * z-depth defining the far plane of the eye view frustum
  156477. * enables mapping of values in the render target depth
  156478. * attachment to scene coordinates. Initially set to 10000.0.
  156479. */
  156480. depthFar: number;
  156481. /**
  156482. * z-depth defining the near plane of the eye view frustum
  156483. * enables mapping of values in the render target depth
  156484. * attachment to scene coordinates. Initially set to 0.01.
  156485. */
  156486. depthNear: number;
  156487. /**
  156488. * An identifier for this distinct VRDisplay. Used as an
  156489. * association point in the Gamepad API.
  156490. */
  156491. readonly displayId: number;
  156492. /**
  156493. * A display name, a user-readable name identifying it.
  156494. */
  156495. readonly displayName: string;
  156496. readonly isConnected: boolean;
  156497. readonly isPresenting: boolean;
  156498. /**
  156499. * If this VRDisplay supports room-scale experiences, the optional
  156500. * stage attribute contains details on the room-scale parameters.
  156501. */
  156502. readonly stageParameters: VRStageParameters | null;
  156503. /**
  156504. * Passing the value returned by `requestAnimationFrame` to
  156505. * `cancelAnimationFrame` will unregister the callback.
  156506. * @param handle Define the hanle of the request to cancel
  156507. */
  156508. cancelAnimationFrame(handle: number): void;
  156509. /**
  156510. * Stops presenting to the VRDisplay.
  156511. * @returns a promise to know when it stopped
  156512. */
  156513. exitPresent(): Promise<void>;
  156514. /**
  156515. * Return the current VREyeParameters for the given eye.
  156516. * @param whichEye Define the eye we want the parameter for
  156517. * @returns the eye parameters
  156518. */
  156519. getEyeParameters(whichEye: string): VREyeParameters;
  156520. /**
  156521. * Populates the passed VRFrameData with the information required to render
  156522. * the current frame.
  156523. * @param frameData Define the data structure to populate
  156524. * @returns true if ok otherwise false
  156525. */
  156526. getFrameData(frameData: VRFrameData): boolean;
  156527. /**
  156528. * Get the layers currently being presented.
  156529. * @returns the list of VR layers
  156530. */
  156531. getLayers(): VRLayer[];
  156532. /**
  156533. * Return a VRPose containing the future predicted pose of the VRDisplay
  156534. * when the current frame will be presented. The value returned will not
  156535. * change until JavaScript has returned control to the browser.
  156536. *
  156537. * The VRPose will contain the position, orientation, velocity,
  156538. * and acceleration of each of these properties.
  156539. * @returns the pose object
  156540. */
  156541. getPose(): VRPose;
  156542. /**
  156543. * Return the current instantaneous pose of the VRDisplay, with no
  156544. * prediction applied.
  156545. * @returns the current instantaneous pose
  156546. */
  156547. getImmediatePose(): VRPose;
  156548. /**
  156549. * The callback passed to `requestAnimationFrame` will be called
  156550. * any time a new frame should be rendered. When the VRDisplay is
  156551. * presenting the callback will be called at the native refresh
  156552. * rate of the HMD. When not presenting this function acts
  156553. * identically to how window.requestAnimationFrame acts. Content should
  156554. * make no assumptions of frame rate or vsync behavior as the HMD runs
  156555. * asynchronously from other displays and at differing refresh rates.
  156556. * @param callback Define the eaction to run next frame
  156557. * @returns the request handle it
  156558. */
  156559. requestAnimationFrame(callback: FrameRequestCallback): number;
  156560. /**
  156561. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  156562. * Repeat calls while already presenting will update the VRLayers being displayed.
  156563. * @param layers Define the list of layer to present
  156564. * @returns a promise to know when the request has been fulfilled
  156565. */
  156566. requestPresent(layers: VRLayer[]): Promise<void>;
  156567. /**
  156568. * Reset the pose for this display, treating its current position and
  156569. * orientation as the "origin/zero" values. VRPose.position,
  156570. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  156571. * updated when calling resetPose(). This should be called in only
  156572. * sitting-space experiences.
  156573. */
  156574. resetPose(): void;
  156575. /**
  156576. * The VRLayer provided to the VRDisplay will be captured and presented
  156577. * in the HMD. Calling this function has the same effect on the source
  156578. * canvas as any other operation that uses its source image, and canvases
  156579. * created without preserveDrawingBuffer set to true will be cleared.
  156580. * @param pose Define the pose to submit
  156581. */
  156582. submitFrame(pose?: VRPose): void;
  156583. }
  156584. declare var VRDisplay: {
  156585. prototype: VRDisplay;
  156586. new(): VRDisplay;
  156587. };
  156588. interface VRLayer {
  156589. leftBounds?: number[] | Float32Array | null;
  156590. rightBounds?: number[] | Float32Array | null;
  156591. source?: HTMLCanvasElement | null;
  156592. }
  156593. interface VRDisplayCapabilities {
  156594. readonly canPresent: boolean;
  156595. readonly hasExternalDisplay: boolean;
  156596. readonly hasOrientation: boolean;
  156597. readonly hasPosition: boolean;
  156598. readonly maxLayers: number;
  156599. }
  156600. interface VREyeParameters {
  156601. /** @deprecated */
  156602. readonly fieldOfView: VRFieldOfView;
  156603. readonly offset: Float32Array;
  156604. readonly renderHeight: number;
  156605. readonly renderWidth: number;
  156606. }
  156607. interface VRFieldOfView {
  156608. readonly downDegrees: number;
  156609. readonly leftDegrees: number;
  156610. readonly rightDegrees: number;
  156611. readonly upDegrees: number;
  156612. }
  156613. interface VRFrameData {
  156614. readonly leftProjectionMatrix: Float32Array;
  156615. readonly leftViewMatrix: Float32Array;
  156616. readonly pose: VRPose;
  156617. readonly rightProjectionMatrix: Float32Array;
  156618. readonly rightViewMatrix: Float32Array;
  156619. readonly timestamp: number;
  156620. }
  156621. interface VRPose {
  156622. readonly angularAcceleration: Float32Array | null;
  156623. readonly angularVelocity: Float32Array | null;
  156624. readonly linearAcceleration: Float32Array | null;
  156625. readonly linearVelocity: Float32Array | null;
  156626. readonly orientation: Float32Array | null;
  156627. readonly position: Float32Array | null;
  156628. readonly timestamp: number;
  156629. }
  156630. interface VRStageParameters {
  156631. sittingToStandingTransform?: Float32Array;
  156632. sizeX?: number;
  156633. sizeY?: number;
  156634. }
  156635. interface Navigator {
  156636. getVRDisplays(): Promise<VRDisplay[]>;
  156637. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  156638. }
  156639. interface Window {
  156640. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  156641. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  156642. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  156643. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  156644. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  156645. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  156646. }
  156647. interface Gamepad {
  156648. readonly displayId: number;
  156649. }
  156650. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  156651. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  156652. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  156653. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  156654. type XRHandedness = "none" | "left" | "right";
  156655. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  156656. type XREye = "none" | "left" | "right";
  156657. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  156658. interface XRSpace extends EventTarget {}
  156659. interface XRRenderState {
  156660. depthNear?: number;
  156661. depthFar?: number;
  156662. inlineVerticalFieldOfView?: number;
  156663. baseLayer?: XRWebGLLayer;
  156664. }
  156665. interface XRInputSource {
  156666. handedness: XRHandedness;
  156667. targetRayMode: XRTargetRayMode;
  156668. targetRaySpace: XRSpace;
  156669. gripSpace: XRSpace | undefined;
  156670. gamepad: Gamepad | undefined;
  156671. profiles: Array<string>;
  156672. hand: XRHand | undefined;
  156673. }
  156674. interface XRSessionInit {
  156675. optionalFeatures?: string[];
  156676. requiredFeatures?: string[];
  156677. }
  156678. interface XRSession {
  156679. addEventListener: Function;
  156680. removeEventListener: Function;
  156681. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  156682. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  156683. requestAnimationFrame: Function;
  156684. end(): Promise<void>;
  156685. renderState: XRRenderState;
  156686. inputSources: Array<XRInputSource>;
  156687. // hit test
  156688. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  156689. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  156690. // legacy AR hit test
  156691. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  156692. // legacy plane detection
  156693. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  156694. }
  156695. interface XRReferenceSpace extends XRSpace {
  156696. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  156697. onreset: any;
  156698. }
  156699. type XRPlaneSet = Set<XRPlane>;
  156700. type XRAnchorSet = Set<XRAnchor>;
  156701. interface XRFrame {
  156702. session: XRSession;
  156703. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  156704. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  156705. // AR
  156706. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  156707. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  156708. // Anchors
  156709. trackedAnchors?: XRAnchorSet;
  156710. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  156711. // Planes
  156712. worldInformation: {
  156713. detectedPlanes?: XRPlaneSet;
  156714. };
  156715. // Hand tracking
  156716. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  156717. }
  156718. interface XRViewerPose extends XRPose {
  156719. views: Array<XRView>;
  156720. }
  156721. interface XRPose {
  156722. transform: XRRigidTransform;
  156723. emulatedPosition: boolean;
  156724. }
  156725. interface XRWebGLLayerOptions {
  156726. antialias?: boolean;
  156727. depth?: boolean;
  156728. stencil?: boolean;
  156729. alpha?: boolean;
  156730. multiview?: boolean;
  156731. framebufferScaleFactor?: number;
  156732. }
  156733. declare var XRWebGLLayer: {
  156734. prototype: XRWebGLLayer;
  156735. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  156736. };
  156737. interface XRWebGLLayer {
  156738. framebuffer: WebGLFramebuffer;
  156739. framebufferWidth: number;
  156740. framebufferHeight: number;
  156741. getViewport: Function;
  156742. }
  156743. declare class XRRigidTransform {
  156744. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  156745. position: DOMPointReadOnly;
  156746. orientation: DOMPointReadOnly;
  156747. matrix: Float32Array;
  156748. inverse: XRRigidTransform;
  156749. }
  156750. interface XRView {
  156751. eye: XREye;
  156752. projectionMatrix: Float32Array;
  156753. transform: XRRigidTransform;
  156754. }
  156755. interface XRInputSourceChangeEvent {
  156756. session: XRSession;
  156757. removed: Array<XRInputSource>;
  156758. added: Array<XRInputSource>;
  156759. }
  156760. interface XRInputSourceEvent extends Event {
  156761. readonly frame: XRFrame;
  156762. readonly inputSource: XRInputSource;
  156763. }
  156764. // Experimental(er) features
  156765. declare class XRRay {
  156766. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  156767. origin: DOMPointReadOnly;
  156768. direction: DOMPointReadOnly;
  156769. matrix: Float32Array;
  156770. }
  156771. declare enum XRHitTestTrackableType {
  156772. "point",
  156773. "plane",
  156774. "mesh",
  156775. }
  156776. interface XRHitResult {
  156777. hitMatrix: Float32Array;
  156778. }
  156779. interface XRTransientInputHitTestResult {
  156780. readonly inputSource: XRInputSource;
  156781. readonly results: Array<XRHitTestResult>;
  156782. }
  156783. interface XRHitTestResult {
  156784. getPose(baseSpace: XRSpace): XRPose | undefined;
  156785. // When anchor system is enabled
  156786. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  156787. }
  156788. interface XRHitTestSource {
  156789. cancel(): void;
  156790. }
  156791. interface XRTransientInputHitTestSource {
  156792. cancel(): void;
  156793. }
  156794. interface XRHitTestOptionsInit {
  156795. space: XRSpace;
  156796. entityTypes?: Array<XRHitTestTrackableType>;
  156797. offsetRay?: XRRay;
  156798. }
  156799. interface XRTransientInputHitTestOptionsInit {
  156800. profile: string;
  156801. entityTypes?: Array<XRHitTestTrackableType>;
  156802. offsetRay?: XRRay;
  156803. }
  156804. interface XRAnchor {
  156805. anchorSpace: XRSpace;
  156806. delete(): void;
  156807. }
  156808. interface XRPlane {
  156809. orientation: "Horizontal" | "Vertical";
  156810. planeSpace: XRSpace;
  156811. polygon: Array<DOMPointReadOnly>;
  156812. lastChangedTime: number;
  156813. }
  156814. interface XRJointSpace extends XRSpace {}
  156815. interface XRJointPose extends XRPose {
  156816. radius: number | undefined;
  156817. }
  156818. interface XRHand /*extends Iterablele<XRJointSpace>*/ {
  156819. readonly length: number;
  156820. [index: number]: XRJointSpace;
  156821. // Specs have the function 'joint(idx: number)', but chrome doesn't support it yet.
  156822. readonly WRIST: number;
  156823. readonly THUMB_METACARPAL: number;
  156824. readonly THUMB_PHALANX_PROXIMAL: number;
  156825. readonly THUMB_PHALANX_DISTAL: number;
  156826. readonly THUMB_PHALANX_TIP: number;
  156827. readonly INDEX_METACARPAL: number;
  156828. readonly INDEX_PHALANX_PROXIMAL: number;
  156829. readonly INDEX_PHALANX_INTERMEDIATE: number;
  156830. readonly INDEX_PHALANX_DISTAL: number;
  156831. readonly INDEX_PHALANX_TIP: number;
  156832. readonly MIDDLE_METACARPAL: number;
  156833. readonly MIDDLE_PHALANX_PROXIMAL: number;
  156834. readonly MIDDLE_PHALANX_INTERMEDIATE: number;
  156835. readonly MIDDLE_PHALANX_DISTAL: number;
  156836. readonly MIDDLE_PHALANX_TIP: number;
  156837. readonly RING_METACARPAL: number;
  156838. readonly RING_PHALANX_PROXIMAL: number;
  156839. readonly RING_PHALANX_INTERMEDIATE: number;
  156840. readonly RING_PHALANX_DISTAL: number;
  156841. readonly RING_PHALANX_TIP: number;
  156842. readonly LITTLE_METACARPAL: number;
  156843. readonly LITTLE_PHALANX_PROXIMAL: number;
  156844. readonly LITTLE_PHALANX_INTERMEDIATE: number;
  156845. readonly LITTLE_PHALANX_DISTAL: number;
  156846. readonly LITTLE_PHALANX_TIP: number;
  156847. }
  156848. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  156849. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  156850. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  156851. interface XRSession {
  156852. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  156853. }
  156854. interface XRFrame {
  156855. featurePointCloud? : Array<number>;
  156856. }